cfbd 5.17.0 → 5.18.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Binary file
package/dist/sdk.gen.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { type OptionsLegacyParser } from '@hey-api/client-fetch';
2
- import type { GetAdjustedTeamSeasonStatsData, GetAdjustedTeamSeasonStatsResponse, GetAdjustedPlayerPassingStatsData, GetAdjustedPlayerPassingStatsResponse, GetAdjustedPlayerRushingStatsData, GetAdjustedPlayerRushingStatsResponse, GetKickerPaarData, GetKickerPaarResponse, GetTeamsData, GetTeamsResponse, GetFbsTeamsData, GetFbsTeamsResponse, GetMatchupData, GetTeamsAtsData, GetTeamsAtsResponse, GetRosterData, GetRosterResponse, GetConferencesResponse, GetTalentData, GetTalentResponse, GetVenuesResponse, GetPlayerSeasonStatsData, GetPlayerSeasonStatsResponse, GetPlayerSeasonSuccessRatesData, GetPlayerSeasonSuccessRatesResponse, GetPlayerGameSuccessRatesData, GetPlayerGameSuccessRatesResponse, GetTeamStatsData, GetTeamStatsResponse, GetCategoriesResponse, GetAdvancedSeasonStatsData, GetAdvancedSeasonStatsResponse, GetAdvancedGameStatsData, GetAdvancedGameStatsResponse, GetGameHavocStatsData, GetGameHavocStatsResponse, GetRecruitsData, GetRecruitsResponse, GetTeamRecruitingRankingsData, GetTeamRecruitingRankingsResponse, GetAggregatedTeamRecruitingRatingsData, GetAggregatedTeamRecruitingRatingsResponse, GetSpData, GetSpResponse, GetConferenceSpData, GetConferenceSpResponse, GetSrsData, GetSrsResponse, GetEloData, GetEloResponse, GetFpiData, GetFpiResponse, GetRankingsData, GetRankingsResponse, GetPlaysData, GetPlaysResponse, GetPlayTypesResponse, GetPlayStatsData, GetPlayStatsResponse, GetPlayStatTypesResponse, SearchPlayersData, SearchPlayersResponse, GetPlayerUsageData, GetPlayerUsageResponse, GetPlayerSeasonOverviewData, GetReturningProductionData, GetReturningProductionResponse, GetTransferPortalData, GetTransferPortalResponse, GetPredictedPointsData, GetPredictedPointsResponse, GetPredictedPointsAddedByTeamData, GetPredictedPointsAddedByTeamResponse, GetPredictedPointsAddedByGameData, GetPredictedPointsAddedByGameResponse, GetPredictedPointsAddedByPlayerGameData, GetPredictedPointsAddedByPlayerGameResponse, GetPredictedPointsAddedByPlayerSeasonData, GetPredictedPointsAddedByPlayerSeasonResponse, GetWinProbabilityData, GetWinProbabilityResponse, GetPregameWinProbabilitiesData, GetPregameWinProbabilitiesResponse, GetFieldGoalExpectedPointsResponse, GetLivePlaysData, GetLinesData, GetLinesResponse, GetUserInfoResponse, GetUsageData, GetUsageResponse, GetGamesData, GetGamesResponse, GetGameTeamStatsData, GetGameTeamStatsResponse, GetGamePlayerStatsData, GetGamePlayerStatsResponse, GetMediaData, GetMediaResponse, GetWeatherData, GetWeatherResponse, GetRecordsData, GetRecordsResponse, GetCalendarData, GetCalendarResponse, GetScoreboardData, GetScoreboardResponse, GetDrivesData, GetDrivesResponse, GetDraftTeamsResponse, GetDraftPositionsResponse, GetDraftPicksData, GetDraftPicksResponse, GetCoachesData, GetCoachesResponse, GetAdvancedBoxScoreData } from './types.gen';
2
+ import type { GetAdjustedTeamSeasonStatsData, GetAdjustedTeamSeasonStatsResponse, GetAdjustedPlayerPassingStatsData, GetAdjustedPlayerPassingStatsResponse, GetAdjustedPlayerRushingStatsData, GetAdjustedPlayerRushingStatsResponse, GetKickerPaarData, GetKickerPaarResponse, GetTeamsData, GetTeamsResponse, GetFbsTeamsData, GetFbsTeamsResponse, GetMatchupData, GetTeamsAtsData, GetTeamsAtsResponse, GetRosterData, GetRosterResponse, GetConferencesResponse, GetTalentData, GetTalentResponse, GetVenuesResponse, GetPlayerSeasonStatsData, GetPlayerSeasonStatsResponse, GetPlayerSeasonSuccessRatesData, GetPlayerSeasonSuccessRatesResponse, GetPlayerGameSuccessRatesData, GetPlayerGameSuccessRatesResponse, GetTeamStatsData, GetTeamStatsResponse, GetCategoriesResponse, GetAdvancedSeasonStatsData, GetAdvancedSeasonStatsResponse, GetAdvancedGameStatsData, GetAdvancedGameStatsResponse, GetGameHavocStatsData, GetGameHavocStatsResponse, GetRecruitsData, GetRecruitsResponse, GetTeamRecruitingRankingsData, GetTeamRecruitingRankingsResponse, GetAggregatedTeamRecruitingRatingsData, GetAggregatedTeamRecruitingRatingsResponse, GetSpData, GetSpResponse, GetConferenceSpData, GetConferenceSpResponse, GetSrsData, GetSrsResponse, 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, 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, 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
  * Retrieve opponent-adjusted team season statistics
@@ -116,7 +116,7 @@ export declare const getFpi: <ThrowOnError extends boolean = false>(options?: Op
116
116
  /**
117
117
  * Retrieves historical poll data
118
118
  */
119
- export declare const getRankings: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetRankingsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetRankingsResponse, unknown, ThrowOnError>;
119
+ export declare const getRankings: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetRankingsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetRankingsResponse, GetRankingsError, ThrowOnError>;
120
120
  /**
121
121
  * Retrieves historical play data
122
122
  */
@@ -133,6 +133,18 @@ export declare const getPlayStats: <ThrowOnError extends boolean = false>(option
133
133
  * Retrieves available play stat types
134
134
  */
135
135
  export declare const getPlayStatTypes: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlayStatTypesResponse, unknown, ThrowOnError>;
136
+ /**
137
+ * Retrieves the complete College Football Playoff bracket for a season
138
+ */
139
+ export declare const getCfpPlayoff: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetCfpPlayoffData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").CfpPlayoff, GetCfpPlayoffError, ThrowOnError>;
140
+ /**
141
+ * Retrieves College Football Playoff participants for a season
142
+ */
143
+ export declare const getCfpParticipants: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetCfpParticipantsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCfpParticipantsResponse, GetCfpParticipantsError, ThrowOnError>;
144
+ /**
145
+ * Retrieves College Football Playoff matchups for a season
146
+ */
147
+ export declare const getCfpGames: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetCfpGamesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCfpGamesResponse, GetCfpGamesError, ThrowOnError>;
136
148
  /**
137
149
  * Search for players (lists top 100 results)
138
150
  */
@@ -204,7 +216,7 @@ export declare const getUsage: <ThrowOnError extends boolean = false>(options?:
204
216
  /**
205
217
  * Retrieves historical game data
206
218
  */
207
- export declare const getGames: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetGamesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetGamesResponse, unknown, ThrowOnError>;
219
+ export declare const getGames: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetGamesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetGamesResponse, GetGamesError, ThrowOnError>;
208
220
  /**
209
221
  * Retrieves team box score statistics
210
222
  */
package/dist/sdk.gen.js CHANGED
@@ -12,8 +12,8 @@ var __assign = (this && this.__assign) || function () {
12
12
  return __assign.apply(this, arguments);
13
13
  };
14
14
  Object.defineProperty(exports, "__esModule", { value: true });
15
- exports.getUserInfo = exports.getLines = exports.getLivePlays = exports.getFieldGoalExpectedPoints = exports.getPregameWinProbabilities = exports.getWinProbability = exports.getPredictedPointsAddedByPlayerSeason = exports.getPredictedPointsAddedByPlayerGame = exports.getPredictedPointsAddedByGame = exports.getPredictedPointsAddedByTeam = exports.getPredictedPoints = exports.getTransferPortal = exports.getReturningProduction = exports.getPlayerSeasonOverview = exports.getPlayerUsage = exports.searchPlayers = exports.getPlayStatTypes = exports.getPlayStats = exports.getPlayTypes = exports.getPlays = exports.getRankings = exports.getFpi = exports.getElo = exports.getSrs = exports.getConferenceSp = exports.getSp = exports.getAggregatedTeamRecruitingRatings = exports.getTeamRecruitingRankings = exports.getRecruits = exports.getGameHavocStats = exports.getAdvancedGameStats = exports.getAdvancedSeasonStats = exports.getCategories = exports.getTeamStats = exports.getPlayerGameSuccessRates = exports.getPlayerSeasonSuccessRates = exports.getPlayerSeasonStats = exports.getVenues = exports.getTalent = exports.getConferences = exports.getRoster = exports.getTeamsAts = exports.getMatchup = exports.getFbsTeams = exports.getTeams = exports.getKickerPaar = exports.getAdjustedPlayerRushingStats = exports.getAdjustedPlayerPassingStats = exports.getAdjustedTeamSeasonStats = exports.client = void 0;
16
- exports.getAdvancedBoxScore = 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 = void 0;
15
+ exports.getFieldGoalExpectedPoints = exports.getPregameWinProbabilities = exports.getWinProbability = exports.getPredictedPointsAddedByPlayerSeason = exports.getPredictedPointsAddedByPlayerGame = exports.getPredictedPointsAddedByGame = exports.getPredictedPointsAddedByTeam = exports.getPredictedPoints = exports.getTransferPortal = exports.getReturningProduction = 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.getSrs = exports.getConferenceSp = exports.getSp = exports.getAggregatedTeamRecruitingRatings = exports.getTeamRecruitingRankings = exports.getRecruits = exports.getGameHavocStats = exports.getAdvancedGameStats = exports.getAdvancedSeasonStats = exports.getCategories = exports.getTeamStats = exports.getPlayerGameSuccessRates = exports.getPlayerSeasonSuccessRates = exports.getPlayerSeasonStats = exports.getVenues = exports.getTalent = exports.getConferences = exports.getRoster = exports.getTeamsAts = exports.getMatchup = exports.getFbsTeams = exports.getTeams = exports.getKickerPaar = exports.getAdjustedPlayerRushingStats = exports.getAdjustedPlayerPassingStats = exports.getAdjustedTeamSeasonStats = exports.client = void 0;
16
+ exports.getAdvancedBoxScore = 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 = 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
  /**
@@ -280,6 +280,30 @@ var getPlayStatTypes = function (options) {
280
280
  return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/plays/stats/types' }));
281
281
  };
282
282
  exports.getPlayStatTypes = getPlayStatTypes;
283
+ /**
284
+ * Retrieves the complete College Football Playoff bracket for a season
285
+ */
286
+ var getCfpPlayoff = function (options) {
287
+ var _a;
288
+ return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/playoffs/cfp' }));
289
+ };
290
+ exports.getCfpPlayoff = getCfpPlayoff;
291
+ /**
292
+ * Retrieves College Football Playoff participants for a season
293
+ */
294
+ var getCfpParticipants = function (options) {
295
+ var _a;
296
+ return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/playoffs/cfp/participants' }));
297
+ };
298
+ exports.getCfpParticipants = getCfpParticipants;
299
+ /**
300
+ * Retrieves College Football Playoff matchups for a season
301
+ */
302
+ var getCfpGames = function (options) {
303
+ var _a;
304
+ return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/playoffs/cfp/games' }));
305
+ };
306
+ exports.getCfpGames = getCfpGames;
283
307
  /**
284
308
  * Search for players (lists top 100 results)
285
309
  */
@@ -302,6 +302,20 @@ export type CalendarWeek = {
302
302
  */
303
303
  lastGameStart: string;
304
304
  };
305
+ export type CfpPlayoff = {
306
+ season: number;
307
+ competition: PlayoffCompetition_Cfp;
308
+ format: string;
309
+ teamCount: number;
310
+ status: PlayoffStatus;
311
+ participants: Array<PlayoffParticipant>;
312
+ rounds: Array<PlayoffRoundRecord>;
313
+ champion: ((PlayoffTeam) | null);
314
+ };
315
+ export type CfpPlayoffNotFound = {
316
+ message: 'CFP playoff not found';
317
+ };
318
+ export type message = 'CFP playoff not found';
305
319
  export type Coach = {
306
320
  firstName: string;
307
321
  lastName: string;
@@ -478,6 +492,7 @@ export type Game = {
478
492
  excitementIndex: (number) | null;
479
493
  highlights: (string) | null;
480
494
  notes: (string) | null;
495
+ playoff: ((GamePlayoff) | null);
481
496
  };
482
497
  export type GameHavocStats = {
483
498
  gameId: number;
@@ -556,6 +571,16 @@ export type GamePlayerStatTypes = {
556
571
  name: string;
557
572
  athletes: Array<GamePlayerStatPlayer>;
558
573
  };
574
+ export type GamePlayoff = {
575
+ competition: PlayoffCompetition;
576
+ format: string;
577
+ round: PlayoffRound;
578
+ roundName: string;
579
+ bracketSlot: string;
580
+ homeSeed: (number) | null;
581
+ awaySeed: (number) | null;
582
+ bowlName: (string) | null;
583
+ };
559
584
  export type GameStatus = 'scheduled' | 'in_progress' | 'completed';
560
585
  export type GameTeamStats = {
561
586
  id: number;
@@ -980,6 +1005,76 @@ export type PlayerWeightedEPA = {
980
1005
  wepa: number;
981
1006
  plays: number;
982
1007
  };
1008
+ export type PlayoffAdvancement = {
1009
+ matchupId: number;
1010
+ bracketSlot: string;
1011
+ position: number;
1012
+ };
1013
+ export type PlayoffBidType = 'automatic' | 'at_large';
1014
+ export type PlayoffCompetition = 'cfp';
1015
+ export type PlayoffCompetition_Cfp = 'cfp';
1016
+ export type PlayoffLinkedGame = {
1017
+ id: number;
1018
+ startDate: string;
1019
+ completed: boolean;
1020
+ homeTeam: PlayoffTeam;
1021
+ homePoints: (number) | null;
1022
+ awayTeam: PlayoffTeam;
1023
+ awayPoints: (number) | null;
1024
+ venueId: (number) | null;
1025
+ venue: (string) | null;
1026
+ };
1027
+ export type PlayoffMatchup = {
1028
+ id: number;
1029
+ bracketSlot: string;
1030
+ round: PlayoffRound;
1031
+ roundName: string;
1032
+ roundOrder: number;
1033
+ matchupOrder: number;
1034
+ startDate: (string) | null;
1035
+ bowlName: (string) | null;
1036
+ slots: Array<PlayoffMatchupSlot>;
1037
+ game: ((PlayoffLinkedGame) | null);
1038
+ advancesTo: ((PlayoffAdvancement) | null);
1039
+ };
1040
+ export type PlayoffMatchupSlot = {
1041
+ position: number;
1042
+ seed: (number) | null;
1043
+ participant: ((PlayoffTeam) | null);
1044
+ source: ((PlayoffMatchupSlotSource) | null);
1045
+ };
1046
+ export type PlayoffMatchupSlotSource = {
1047
+ matchupId: number;
1048
+ bracketSlot: string;
1049
+ outcome: 'winner';
1050
+ };
1051
+ export type outcome = 'winner';
1052
+ export type PlayoffOutcome = 'active' | 'eliminated' | 'champion';
1053
+ export type PlayoffParticipant = {
1054
+ team: PlayoffTeam;
1055
+ committeeRank: (number) | null;
1056
+ seed: number;
1057
+ bidType: PlayoffBidType;
1058
+ qualificationReason: (string) | null;
1059
+ conferenceChampion: boolean;
1060
+ qualifyingConference: (string) | null;
1061
+ firstRoundBye: boolean;
1062
+ outcome: PlayoffOutcome;
1063
+ eliminatedRound: ((PlayoffRound) | null);
1064
+ };
1065
+ export type PlayoffRound = 'first_round' | 'quarterfinal' | 'semifinal' | 'championship';
1066
+ export type PlayoffRoundRecord = {
1067
+ code: PlayoffRound;
1068
+ name: string;
1069
+ order: number;
1070
+ matchups: Array<PlayoffMatchup>;
1071
+ };
1072
+ export type PlayoffStatus = 'scheduled' | 'selected' | 'in_progress' | 'completed';
1073
+ export type PlayoffTeam = {
1074
+ id: number;
1075
+ school: string;
1076
+ conference: (string) | null;
1077
+ };
983
1078
  export type PlayStat = {
984
1079
  gameId: number;
985
1080
  season: number;
@@ -1033,6 +1128,7 @@ export type PlayWinProbability = {
1033
1128
  };
1034
1129
  export type Poll = {
1035
1130
  poll: string;
1131
+ isFinal: (boolean) | null;
1036
1132
  ranks: Array<PollRank>;
1037
1133
  };
1038
1134
  export type PollRank = {
@@ -1063,6 +1159,7 @@ export type PregameWinProbability = {
1063
1159
  spread: number;
1064
1160
  homeWinProbability: number;
1065
1161
  };
1162
+ export type RankingPoll = 'cfp';
1066
1163
  export type Recruit = {
1067
1164
  id: string;
1068
1165
  athleteId: (string) | null;
@@ -2045,6 +2142,18 @@ export type GetFpiResponse = (Array<TeamFPI>);
2045
2142
  export type GetFpiError = unknown;
2046
2143
  export type GetRankingsData = {
2047
2144
  query: {
2145
+ /**
2146
+ * Return the marked final CFP snapshot
2147
+ */
2148
+ final?: boolean;
2149
+ /**
2150
+ * Return the latest CFP snapshot, preferring the marked final
2151
+ */
2152
+ latest?: boolean;
2153
+ /**
2154
+ * Optional poll filter
2155
+ */
2156
+ poll?: RankingPoll;
2048
2157
  /**
2049
2158
  * Optional season type filter
2050
2159
  */
@@ -2060,7 +2169,9 @@ export type GetRankingsData = {
2060
2169
  };
2061
2170
  };
2062
2171
  export type GetRankingsResponse = (Array<PollWeek>);
2063
- export type GetRankingsError = unknown;
2172
+ export type GetRankingsError = ({
2173
+ message: string;
2174
+ });
2064
2175
  export type GetPlaysData = {
2065
2176
  query: {
2066
2177
  /**
@@ -2153,6 +2264,46 @@ export type GetPlayStatsResponse = (Array<PlayStat>);
2153
2264
  export type GetPlayStatsError = unknown;
2154
2265
  export type GetPlayStatTypesResponse = (Array<PlayStatType>);
2155
2266
  export type GetPlayStatTypesError = unknown;
2267
+ export type GetCfpPlayoffData = {
2268
+ query: {
2269
+ /**
2270
+ * Required year filter
2271
+ */
2272
+ year: number;
2273
+ };
2274
+ };
2275
+ export type GetCfpPlayoffResponse = (CfpPlayoff);
2276
+ export type GetCfpPlayoffError = ({
2277
+ message: string;
2278
+ } | CfpPlayoffNotFound);
2279
+ export type GetCfpParticipantsData = {
2280
+ query: {
2281
+ /**
2282
+ * Required year filter
2283
+ */
2284
+ year: number;
2285
+ };
2286
+ };
2287
+ export type GetCfpParticipantsResponse = (Array<PlayoffParticipant>);
2288
+ export type GetCfpParticipantsError = ({
2289
+ message: string;
2290
+ } | CfpPlayoffNotFound);
2291
+ export type GetCfpGamesData = {
2292
+ query: {
2293
+ /**
2294
+ * Optional playoff round filter
2295
+ */
2296
+ round?: PlayoffRound;
2297
+ /**
2298
+ * Required year filter
2299
+ */
2300
+ year: number;
2301
+ };
2302
+ };
2303
+ export type GetCfpGamesResponse = (Array<PlayoffMatchup>);
2304
+ export type GetCfpGamesError = ({
2305
+ message: string;
2306
+ } | CfpPlayoffNotFound);
2156
2307
  export type SearchPlayersData = {
2157
2308
  query: {
2158
2309
  /**
@@ -2501,6 +2652,10 @@ export type GetGamesData = {
2501
2652
  * Optional division classification filter
2502
2653
  */
2503
2654
  classification?: DivisionClassification;
2655
+ /**
2656
+ * Optional playoff competition filter
2657
+ */
2658
+ competition?: PlayoffCompetition;
2504
2659
  /**
2505
2660
  * Optional conference filter
2506
2661
  */
@@ -2513,6 +2668,10 @@ export type GetGamesData = {
2513
2668
  * Game id filter to retrieve a single game
2514
2669
  */
2515
2670
  id?: number;
2671
+ /**
2672
+ * Optional playoff round filter; requires competition
2673
+ */
2674
+ round?: PlayoffRound;
2516
2675
  /**
2517
2676
  * Optional season type filter
2518
2677
  */
@@ -2532,7 +2691,9 @@ export type GetGamesData = {
2532
2691
  };
2533
2692
  };
2534
2693
  export type GetGamesResponse = (Array<Game>);
2535
- export type GetGamesError = unknown;
2694
+ export type GetGamesError = ({
2695
+ message: string;
2696
+ });
2536
2697
  export type GetGameTeamStatsData = {
2537
2698
  query?: {
2538
2699
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "cfbd",
3
- "version": "5.17.0",
3
+ "version": "5.18.0",
4
4
  "description": "This API is in limited Beta for Patreon subscribers. It may have bugs and is subject to changes. API keys can be acquired from the CollegeFootballData.com website.",
5
5
  "repository": {
6
6
  "type": "git",
package/src/sdk.gen.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  // This file is auto-generated by @hey-api/openapi-ts
2
2
 
3
3
  import { createClient, createConfig, type OptionsLegacyParser } from '@hey-api/client-fetch';
4
- import type { GetAdjustedTeamSeasonStatsData, GetAdjustedTeamSeasonStatsError, GetAdjustedTeamSeasonStatsResponse, GetAdjustedPlayerPassingStatsData, GetAdjustedPlayerPassingStatsError, GetAdjustedPlayerPassingStatsResponse, GetAdjustedPlayerRushingStatsData, GetAdjustedPlayerRushingStatsError, GetAdjustedPlayerRushingStatsResponse, GetKickerPaarData, GetKickerPaarError, GetKickerPaarResponse, GetTeamsData, GetTeamsError, GetTeamsResponse, GetFbsTeamsData, GetFbsTeamsError, GetFbsTeamsResponse, GetMatchupData, GetMatchupError, GetMatchupResponse, GetTeamsAtsData, GetTeamsAtsError, GetTeamsAtsResponse, GetRosterData, GetRosterError, GetRosterResponse, GetConferencesError, GetConferencesResponse, GetTalentData, GetTalentError, GetTalentResponse, GetVenuesError, GetVenuesResponse, GetPlayerSeasonStatsData, GetPlayerSeasonStatsError, GetPlayerSeasonStatsResponse, GetPlayerSeasonSuccessRatesData, GetPlayerSeasonSuccessRatesError, GetPlayerSeasonSuccessRatesResponse, GetPlayerGameSuccessRatesData, GetPlayerGameSuccessRatesError, GetPlayerGameSuccessRatesResponse, GetTeamStatsData, GetTeamStatsError, GetTeamStatsResponse, GetCategoriesError, GetCategoriesResponse, GetAdvancedSeasonStatsData, GetAdvancedSeasonStatsError, GetAdvancedSeasonStatsResponse, GetAdvancedGameStatsData, GetAdvancedGameStatsError, GetAdvancedGameStatsResponse, GetGameHavocStatsData, GetGameHavocStatsError, GetGameHavocStatsResponse, GetRecruitsData, GetRecruitsError, GetRecruitsResponse, GetTeamRecruitingRankingsData, GetTeamRecruitingRankingsError, GetTeamRecruitingRankingsResponse, GetAggregatedTeamRecruitingRatingsData, GetAggregatedTeamRecruitingRatingsError, GetAggregatedTeamRecruitingRatingsResponse, GetSpData, GetSpError, GetSpResponse, GetConferenceSpData, GetConferenceSpError, GetConferenceSpResponse, GetSrsData, GetSrsError, GetSrsResponse, GetEloData, GetEloError, GetEloResponse, GetFpiData, GetFpiError, GetFpiResponse, GetRankingsData, GetRankingsError, GetRankingsResponse, GetPlaysData, GetPlaysError, GetPlaysResponse, GetPlayTypesError, GetPlayTypesResponse, GetPlayStatsData, GetPlayStatsError, GetPlayStatsResponse, GetPlayStatTypesError, GetPlayStatTypesResponse, SearchPlayersData, SearchPlayersError, SearchPlayersResponse, GetPlayerUsageData, GetPlayerUsageError, GetPlayerUsageResponse, GetPlayerSeasonOverviewData, GetPlayerSeasonOverviewError, GetPlayerSeasonOverviewResponse, GetReturningProductionData, GetReturningProductionError, GetReturningProductionResponse, GetTransferPortalData, GetTransferPortalError, GetTransferPortalResponse, GetPredictedPointsData, GetPredictedPointsError, GetPredictedPointsResponse, GetPredictedPointsAddedByTeamData, GetPredictedPointsAddedByTeamError, GetPredictedPointsAddedByTeamResponse, GetPredictedPointsAddedByGameData, GetPredictedPointsAddedByGameError, GetPredictedPointsAddedByGameResponse, GetPredictedPointsAddedByPlayerGameData, GetPredictedPointsAddedByPlayerGameError, GetPredictedPointsAddedByPlayerGameResponse, GetPredictedPointsAddedByPlayerSeasonData, GetPredictedPointsAddedByPlayerSeasonError, GetPredictedPointsAddedByPlayerSeasonResponse, GetWinProbabilityData, GetWinProbabilityError, GetWinProbabilityResponse, GetPregameWinProbabilitiesData, GetPregameWinProbabilitiesError, GetPregameWinProbabilitiesResponse, GetFieldGoalExpectedPointsError, GetFieldGoalExpectedPointsResponse, GetLivePlaysData, GetLivePlaysError, GetLivePlaysResponse, GetLinesData, GetLinesError, GetLinesResponse, GetUserInfoError, GetUserInfoResponse, GetUsageData, GetUsageError, GetUsageResponse, GetGamesData, GetGamesError, GetGamesResponse, GetGameTeamStatsData, GetGameTeamStatsError, GetGameTeamStatsResponse, GetGamePlayerStatsData, GetGamePlayerStatsError, GetGamePlayerStatsResponse, GetMediaData, GetMediaError, GetMediaResponse, GetWeatherData, GetWeatherError, GetWeatherResponse, GetRecordsData, GetRecordsError, GetRecordsResponse, GetCalendarData, GetCalendarError, GetCalendarResponse, GetScoreboardData, GetScoreboardError, GetScoreboardResponse, GetDrivesData, GetDrivesError, GetDrivesResponse, GetDraftTeamsError, GetDraftTeamsResponse, GetDraftPositionsError, GetDraftPositionsResponse, GetDraftPicksData, GetDraftPicksError, GetDraftPicksResponse, GetCoachesData, GetCoachesError, GetCoachesResponse, GetAdvancedBoxScoreData, GetAdvancedBoxScoreError, GetAdvancedBoxScoreResponse } from './types.gen';
4
+ import type { GetAdjustedTeamSeasonStatsData, GetAdjustedTeamSeasonStatsError, GetAdjustedTeamSeasonStatsResponse, GetAdjustedPlayerPassingStatsData, GetAdjustedPlayerPassingStatsError, GetAdjustedPlayerPassingStatsResponse, GetAdjustedPlayerRushingStatsData, GetAdjustedPlayerRushingStatsError, GetAdjustedPlayerRushingStatsResponse, GetKickerPaarData, GetKickerPaarError, GetKickerPaarResponse, GetTeamsData, GetTeamsError, GetTeamsResponse, GetFbsTeamsData, GetFbsTeamsError, GetFbsTeamsResponse, GetMatchupData, GetMatchupError, GetMatchupResponse, GetTeamsAtsData, GetTeamsAtsError, GetTeamsAtsResponse, GetRosterData, GetRosterError, GetRosterResponse, GetConferencesError, GetConferencesResponse, GetTalentData, GetTalentError, GetTalentResponse, GetVenuesError, GetVenuesResponse, GetPlayerSeasonStatsData, GetPlayerSeasonStatsError, GetPlayerSeasonStatsResponse, GetPlayerSeasonSuccessRatesData, GetPlayerSeasonSuccessRatesError, GetPlayerSeasonSuccessRatesResponse, GetPlayerGameSuccessRatesData, GetPlayerGameSuccessRatesError, GetPlayerGameSuccessRatesResponse, GetTeamStatsData, GetTeamStatsError, GetTeamStatsResponse, GetCategoriesError, GetCategoriesResponse, GetAdvancedSeasonStatsData, GetAdvancedSeasonStatsError, GetAdvancedSeasonStatsResponse, GetAdvancedGameStatsData, GetAdvancedGameStatsError, GetAdvancedGameStatsResponse, GetGameHavocStatsData, GetGameHavocStatsError, GetGameHavocStatsResponse, GetRecruitsData, GetRecruitsError, GetRecruitsResponse, GetTeamRecruitingRankingsData, GetTeamRecruitingRankingsError, GetTeamRecruitingRankingsResponse, GetAggregatedTeamRecruitingRatingsData, GetAggregatedTeamRecruitingRatingsError, GetAggregatedTeamRecruitingRatingsResponse, GetSpData, GetSpError, GetSpResponse, GetConferenceSpData, GetConferenceSpError, GetConferenceSpResponse, GetSrsData, GetSrsError, GetSrsResponse, GetEloData, GetEloError, GetEloResponse, GetFpiData, GetFpiError, GetFpiResponse, GetRankingsData, GetRankingsError, GetRankingsResponse, GetPlaysData, GetPlaysError, GetPlaysResponse, GetPlayTypesError, GetPlayTypesResponse, GetPlayStatsData, GetPlayStatsError, GetPlayStatsResponse, GetPlayStatTypesError, GetPlayStatTypesResponse, GetCfpPlayoffData, GetCfpPlayoffError, GetCfpPlayoffResponse, GetCfpParticipantsData, GetCfpParticipantsError, GetCfpParticipantsResponse, GetCfpGamesData, GetCfpGamesError, GetCfpGamesResponse, SearchPlayersData, SearchPlayersError, SearchPlayersResponse, GetPlayerUsageData, GetPlayerUsageError, GetPlayerUsageResponse, GetPlayerSeasonOverviewData, GetPlayerSeasonOverviewError, GetPlayerSeasonOverviewResponse, GetReturningProductionData, GetReturningProductionError, GetReturningProductionResponse, GetTransferPortalData, GetTransferPortalError, GetTransferPortalResponse, GetPredictedPointsData, GetPredictedPointsError, GetPredictedPointsResponse, GetPredictedPointsAddedByTeamData, GetPredictedPointsAddedByTeamError, GetPredictedPointsAddedByTeamResponse, GetPredictedPointsAddedByGameData, GetPredictedPointsAddedByGameError, GetPredictedPointsAddedByGameResponse, GetPredictedPointsAddedByPlayerGameData, GetPredictedPointsAddedByPlayerGameError, GetPredictedPointsAddedByPlayerGameResponse, GetPredictedPointsAddedByPlayerSeasonData, GetPredictedPointsAddedByPlayerSeasonError, GetPredictedPointsAddedByPlayerSeasonResponse, GetWinProbabilityData, GetWinProbabilityError, GetWinProbabilityResponse, GetPregameWinProbabilitiesData, GetPregameWinProbabilitiesError, GetPregameWinProbabilitiesResponse, GetFieldGoalExpectedPointsError, GetFieldGoalExpectedPointsResponse, GetLivePlaysData, GetLivePlaysError, GetLivePlaysResponse, GetLinesData, GetLinesError, GetLinesResponse, GetUserInfoError, GetUserInfoResponse, GetUsageData, GetUsageError, GetUsageResponse, GetGamesData, GetGamesError, GetGamesResponse, GetGameTeamStatsData, GetGameTeamStatsError, GetGameTeamStatsResponse, GetGamePlayerStatsData, GetGamePlayerStatsError, GetGamePlayerStatsResponse, GetMediaData, GetMediaError, GetMediaResponse, GetWeatherData, GetWeatherError, GetWeatherResponse, GetRecordsData, GetRecordsError, GetRecordsResponse, GetCalendarData, GetCalendarError, GetCalendarResponse, GetScoreboardData, GetScoreboardError, GetScoreboardResponse, GetDrivesData, GetDrivesError, GetDrivesResponse, GetDraftTeamsError, GetDraftTeamsResponse, GetDraftPositionsError, GetDraftPositionsResponse, GetDraftPicksData, GetDraftPicksError, GetDraftPicksResponse, GetCoachesData, GetCoachesError, GetCoachesResponse, GetAdvancedBoxScoreData, GetAdvancedBoxScoreError, GetAdvancedBoxScoreResponse } from './types.gen';
5
5
 
6
6
  export const client = createClient(createConfig({ baseUrl: 'https://api.collegefootballdata.com' }));
7
7
 
@@ -335,6 +335,36 @@ export const getPlayStatTypes = <ThrowOnError extends boolean = false>(options?:
335
335
  });
336
336
  };
337
337
 
338
+ /**
339
+ * Retrieves the complete College Football Playoff bracket for a season
340
+ */
341
+ export const getCfpPlayoff = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetCfpPlayoffData, ThrowOnError>) => {
342
+ return (options?.client ?? client).get<GetCfpPlayoffResponse, GetCfpPlayoffError, ThrowOnError>({
343
+ ...options,
344
+ url: '/playoffs/cfp'
345
+ });
346
+ };
347
+
348
+ /**
349
+ * Retrieves College Football Playoff participants for a season
350
+ */
351
+ export const getCfpParticipants = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetCfpParticipantsData, ThrowOnError>) => {
352
+ return (options?.client ?? client).get<GetCfpParticipantsResponse, GetCfpParticipantsError, ThrowOnError>({
353
+ ...options,
354
+ url: '/playoffs/cfp/participants'
355
+ });
356
+ };
357
+
358
+ /**
359
+ * Retrieves College Football Playoff matchups for a season
360
+ */
361
+ export const getCfpGames = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetCfpGamesData, ThrowOnError>) => {
362
+ return (options?.client ?? client).get<GetCfpGamesResponse, GetCfpGamesError, ThrowOnError>({
363
+ ...options,
364
+ url: '/playoffs/cfp/games'
365
+ });
366
+ };
367
+
338
368
  /**
339
369
  * Search for players (lists top 100 results)
340
370
  */
package/src/types.gen.ts CHANGED
@@ -311,6 +311,23 @@ export type CalendarWeek = {
311
311
  lastGameStart: string;
312
312
  };
313
313
 
314
+ export type CfpPlayoff = {
315
+ season: number;
316
+ competition: PlayoffCompetition_Cfp;
317
+ format: string;
318
+ teamCount: number;
319
+ status: PlayoffStatus;
320
+ participants: Array<PlayoffParticipant>;
321
+ rounds: Array<PlayoffRoundRecord>;
322
+ champion: ((PlayoffTeam) | null);
323
+ };
324
+
325
+ export type CfpPlayoffNotFound = {
326
+ message: 'CFP playoff not found';
327
+ };
328
+
329
+ export type message = 'CFP playoff not found';
330
+
314
331
  export type Coach = {
315
332
  firstName: string;
316
333
  lastName: string;
@@ -497,6 +514,7 @@ export type Game = {
497
514
  excitementIndex: (number) | null;
498
515
  highlights: (string) | null;
499
516
  notes: (string) | null;
517
+ playoff: ((GamePlayoff) | null);
500
518
  };
501
519
 
502
520
  export type GameHavocStats = {
@@ -585,6 +603,17 @@ export type GamePlayerStatTypes = {
585
603
  athletes: Array<GamePlayerStatPlayer>;
586
604
  };
587
605
 
606
+ export type GamePlayoff = {
607
+ competition: PlayoffCompetition;
608
+ format: string;
609
+ round: PlayoffRound;
610
+ roundName: string;
611
+ bracketSlot: string;
612
+ homeSeed: (number) | null;
613
+ awaySeed: (number) | null;
614
+ bowlName: (string) | null;
615
+ };
616
+
588
617
  export type GameStatus = 'scheduled' | 'in_progress' | 'completed';
589
618
 
590
619
  export type GameTeamStats = {
@@ -1044,6 +1073,91 @@ export type PlayerWeightedEPA = {
1044
1073
  plays: number;
1045
1074
  };
1046
1075
 
1076
+ export type PlayoffAdvancement = {
1077
+ matchupId: number;
1078
+ bracketSlot: string;
1079
+ position: number;
1080
+ };
1081
+
1082
+ export type PlayoffBidType = 'automatic' | 'at_large';
1083
+
1084
+ export type PlayoffCompetition = 'cfp';
1085
+
1086
+ export type PlayoffCompetition_Cfp = 'cfp';
1087
+
1088
+ export type PlayoffLinkedGame = {
1089
+ id: number;
1090
+ startDate: string;
1091
+ completed: boolean;
1092
+ homeTeam: PlayoffTeam;
1093
+ homePoints: (number) | null;
1094
+ awayTeam: PlayoffTeam;
1095
+ awayPoints: (number) | null;
1096
+ venueId: (number) | null;
1097
+ venue: (string) | null;
1098
+ };
1099
+
1100
+ export type PlayoffMatchup = {
1101
+ id: number;
1102
+ bracketSlot: string;
1103
+ round: PlayoffRound;
1104
+ roundName: string;
1105
+ roundOrder: number;
1106
+ matchupOrder: number;
1107
+ startDate: (string) | null;
1108
+ bowlName: (string) | null;
1109
+ slots: Array<PlayoffMatchupSlot>;
1110
+ game: ((PlayoffLinkedGame) | null);
1111
+ advancesTo: ((PlayoffAdvancement) | null);
1112
+ };
1113
+
1114
+ export type PlayoffMatchupSlot = {
1115
+ position: number;
1116
+ seed: (number) | null;
1117
+ participant: ((PlayoffTeam) | null);
1118
+ source: ((PlayoffMatchupSlotSource) | null);
1119
+ };
1120
+
1121
+ export type PlayoffMatchupSlotSource = {
1122
+ matchupId: number;
1123
+ bracketSlot: string;
1124
+ outcome: 'winner';
1125
+ };
1126
+
1127
+ export type outcome = 'winner';
1128
+
1129
+ export type PlayoffOutcome = 'active' | 'eliminated' | 'champion';
1130
+
1131
+ export type PlayoffParticipant = {
1132
+ team: PlayoffTeam;
1133
+ committeeRank: (number) | null;
1134
+ seed: number;
1135
+ bidType: PlayoffBidType;
1136
+ qualificationReason: (string) | null;
1137
+ conferenceChampion: boolean;
1138
+ qualifyingConference: (string) | null;
1139
+ firstRoundBye: boolean;
1140
+ outcome: PlayoffOutcome;
1141
+ eliminatedRound: ((PlayoffRound) | null);
1142
+ };
1143
+
1144
+ export type PlayoffRound = 'first_round' | 'quarterfinal' | 'semifinal' | 'championship';
1145
+
1146
+ export type PlayoffRoundRecord = {
1147
+ code: PlayoffRound;
1148
+ name: string;
1149
+ order: number;
1150
+ matchups: Array<PlayoffMatchup>;
1151
+ };
1152
+
1153
+ export type PlayoffStatus = 'scheduled' | 'selected' | 'in_progress' | 'completed';
1154
+
1155
+ export type PlayoffTeam = {
1156
+ id: number;
1157
+ school: string;
1158
+ conference: (string) | null;
1159
+ };
1160
+
1047
1161
  export type PlayStat = {
1048
1162
  gameId: number;
1049
1163
  season: number;
@@ -1101,6 +1215,7 @@ export type PlayWinProbability = {
1101
1215
 
1102
1216
  export type Poll = {
1103
1217
  poll: string;
1218
+ isFinal: (boolean) | null;
1104
1219
  ranks: Array<PollRank>;
1105
1220
  };
1106
1221
 
@@ -1136,6 +1251,8 @@ export type PregameWinProbability = {
1136
1251
  homeWinProbability: number;
1137
1252
  };
1138
1253
 
1254
+ export type RankingPoll = 'cfp';
1255
+
1139
1256
  export type Recruit = {
1140
1257
  id: string;
1141
1258
  athleteId: (string) | null;
@@ -2237,6 +2354,18 @@ export type GetFpiError = unknown;
2237
2354
 
2238
2355
  export type GetRankingsData = {
2239
2356
  query: {
2357
+ /**
2358
+ * Return the marked final CFP snapshot
2359
+ */
2360
+ final?: boolean;
2361
+ /**
2362
+ * Return the latest CFP snapshot, preferring the marked final
2363
+ */
2364
+ latest?: boolean;
2365
+ /**
2366
+ * Optional poll filter
2367
+ */
2368
+ poll?: RankingPoll;
2240
2369
  /**
2241
2370
  * Optional season type filter
2242
2371
  */
@@ -2254,7 +2383,9 @@ export type GetRankingsData = {
2254
2383
 
2255
2384
  export type GetRankingsResponse = (Array<PollWeek>);
2256
2385
 
2257
- export type GetRankingsError = unknown;
2386
+ export type GetRankingsError = ({
2387
+ message: string;
2388
+ });
2258
2389
 
2259
2390
  export type GetPlaysData = {
2260
2391
  query: {
@@ -2358,6 +2489,55 @@ export type GetPlayStatTypesResponse = (Array<PlayStatType>);
2358
2489
 
2359
2490
  export type GetPlayStatTypesError = unknown;
2360
2491
 
2492
+ export type GetCfpPlayoffData = {
2493
+ query: {
2494
+ /**
2495
+ * Required year filter
2496
+ */
2497
+ year: number;
2498
+ };
2499
+ };
2500
+
2501
+ export type GetCfpPlayoffResponse = (CfpPlayoff);
2502
+
2503
+ export type GetCfpPlayoffError = ({
2504
+ message: string;
2505
+ } | CfpPlayoffNotFound);
2506
+
2507
+ export type GetCfpParticipantsData = {
2508
+ query: {
2509
+ /**
2510
+ * Required year filter
2511
+ */
2512
+ year: number;
2513
+ };
2514
+ };
2515
+
2516
+ export type GetCfpParticipantsResponse = (Array<PlayoffParticipant>);
2517
+
2518
+ export type GetCfpParticipantsError = ({
2519
+ message: string;
2520
+ } | CfpPlayoffNotFound);
2521
+
2522
+ export type GetCfpGamesData = {
2523
+ query: {
2524
+ /**
2525
+ * Optional playoff round filter
2526
+ */
2527
+ round?: PlayoffRound;
2528
+ /**
2529
+ * Required year filter
2530
+ */
2531
+ year: number;
2532
+ };
2533
+ };
2534
+
2535
+ export type GetCfpGamesResponse = (Array<PlayoffMatchup>);
2536
+
2537
+ export type GetCfpGamesError = ({
2538
+ message: string;
2539
+ } | CfpPlayoffNotFound);
2540
+
2361
2541
  export type SearchPlayersData = {
2362
2542
  query: {
2363
2543
  /**
@@ -2755,6 +2935,10 @@ export type GetGamesData = {
2755
2935
  * Optional division classification filter
2756
2936
  */
2757
2937
  classification?: DivisionClassification;
2938
+ /**
2939
+ * Optional playoff competition filter
2940
+ */
2941
+ competition?: PlayoffCompetition;
2758
2942
  /**
2759
2943
  * Optional conference filter
2760
2944
  */
@@ -2767,6 +2951,10 @@ export type GetGamesData = {
2767
2951
  * Game id filter to retrieve a single game
2768
2952
  */
2769
2953
  id?: number;
2954
+ /**
2955
+ * Optional playoff round filter; requires competition
2956
+ */
2957
+ round?: PlayoffRound;
2770
2958
  /**
2771
2959
  * Optional season type filter
2772
2960
  */
@@ -2788,7 +2976,9 @@ export type GetGamesData = {
2788
2976
 
2789
2977
  export type GetGamesResponse = (Array<Game>);
2790
2978
 
2791
- export type GetGamesError = unknown;
2979
+ export type GetGamesError = ({
2980
+ message: string;
2981
+ });
2792
2982
 
2793
2983
  export type GetGameTeamStatsData = {
2794
2984
  query?: {
package/cfbd-5.17.0.tgz DELETED
Binary file