cfbd 5.4.6-alpha.0 → 5.8.2

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.
package/README.md CHANGED
@@ -1,10 +1,10 @@
1
1
  # cfbd
2
- 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.
2
+ This is an API for query various college football datasets and analytics. API keys can be acquired from the CollegeFootballData.com website.
3
3
 
4
4
  This TypeScript package is automatically generated by the [Hey API](https://heyapi.vercel.app/) project:
5
5
 
6
- - API version: 5.0.10
7
- - Package version: 5.0.10-alpha.0
6
+ - API version: 5.5.1
7
+ - Package version: 5.5.1
8
8
 
9
9
  ## Requirements.
10
10
 
package/cfbd-5.8.2.tgz ADDED
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, GetRosterData, GetRosterResponse, GetConferencesResponse, GetTalentData, GetTalentResponse, GetVenuesResponse, GetPlayerSeasonStatsData, GetPlayerSeasonStatsResponse, GetTeamStatsData, GetTeamStatsResponse, GetCategoriesResponse, GetAdvancedSeasonStatsData, GetAdvancedSeasonStatsResponse, GetAdvancedGameStatsData, GetAdvancedGameStatsResponse, 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, GetReturningProductionData, GetReturningProductionResponse, GetTransferPortalData, GetTransferPortalResponse, GetPredictedPointsData, GetPredictedPointsResponse, GetPredictedPointsAddedByTeamData, GetPredictedPointsAddedByTeamResponse, GetPredictedPointsAddedByGameData, GetPredictedPointsAddedByGameResponse, GetPredictedPointsAddedByPlayerGameData, GetPredictedPointsAddedByPlayerGameResponse, GetPredictedPointsAddedByPlayerSeasonData, GetPredictedPointsAddedByPlayerSeasonResponse, GetWinProbabilityData, GetWinProbabilityResponse, GetPregameWinProbabilitiesData, GetPregameWinProbabilitiesResponse, GetFieldGoalExpectedPointsResponse, GetLivePlaysData, GetLinesData, GetLinesResponse, 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, GetRosterData, GetRosterResponse, GetConferencesResponse, GetTalentData, GetTalentResponse, GetVenuesResponse, GetPlayerSeasonStatsData, GetPlayerSeasonStatsResponse, GetTeamStatsData, GetTeamStatsResponse, GetCategoriesResponse, GetAdvancedSeasonStatsData, GetAdvancedSeasonStatsResponse, GetAdvancedGameStatsData, GetAdvancedGameStatsResponse, 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, GetReturningProductionData, GetReturningProductionResponse, GetTransferPortalData, GetTransferPortalResponse, GetPredictedPointsData, GetPredictedPointsResponse, GetPredictedPointsAddedByTeamData, GetPredictedPointsAddedByTeamResponse, GetPredictedPointsAddedByGameData, GetPredictedPointsAddedByGameResponse, GetPredictedPointsAddedByPlayerGameData, GetPredictedPointsAddedByPlayerGameResponse, GetPredictedPointsAddedByPlayerSeasonData, GetPredictedPointsAddedByPlayerSeasonResponse, GetWinProbabilityData, GetWinProbabilityResponse, GetPregameWinProbabilitiesData, GetPregameWinProbabilitiesResponse, GetFieldGoalExpectedPointsResponse, GetLivePlaysData, GetLinesData, GetLinesResponse, GetUserInfoResponse, 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';
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
@@ -173,6 +173,10 @@ export declare const getLivePlays: <ThrowOnError extends boolean = false>(option
173
173
  * Retrieves historical betting data
174
174
  */
175
175
  export declare const getLines: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetLinesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetLinesResponse, unknown, ThrowOnError>;
176
+ /**
177
+ * Retrieves information about the user, including their Patreon level and remaining API calls.
178
+ */
179
+ export declare const getUserInfo: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetUserInfoResponse, unknown, ThrowOnError>;
176
180
  /**
177
181
  * Retrieves historical game data
178
182
  */
package/dist/sdk.gen.js CHANGED
@@ -12,10 +12,10 @@ 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.getRecords = exports.getWeather = exports.getMedia = exports.getGamePlayerStats = exports.getGameTeamStats = exports.getGames = 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.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.getAdvancedGameStats = exports.getAdvancedSeasonStats = exports.getCategories = exports.getTeamStats = exports.getPlayerSeasonStats = exports.getVenues = exports.getTalent = exports.getConferences = exports.getRoster = 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 = void 0;
15
+ exports.getWeather = exports.getMedia = exports.getGamePlayerStats = exports.getGameTeamStats = exports.getGames = 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.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.getAdvancedGameStats = exports.getAdvancedSeasonStats = exports.getCategories = exports.getTeamStats = exports.getPlayerSeasonStats = exports.getVenues = exports.getTalent = exports.getConferences = exports.getRoster = 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 = void 0;
17
17
  var client_fetch_1 = require("@hey-api/client-fetch");
18
- exports.client = (0, client_fetch_1.createClient)((0, client_fetch_1.createConfig)({ baseUrl: 'https://apinext.collegefootballdata.com' }));
18
+ exports.client = (0, client_fetch_1.createClient)((0, client_fetch_1.createConfig)({ baseUrl: 'https://api.collegefootballdata.com' }));
19
19
  /**
20
20
  * Retrieve opponent-adjusted team season statistics
21
21
  */
@@ -360,6 +360,14 @@ var getLines = function (options) {
360
360
  return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/lines' }));
361
361
  };
362
362
  exports.getLines = getLines;
363
+ /**
364
+ * Retrieves information about the user, including their Patreon level and remaining API calls.
365
+ */
366
+ var getUserInfo = function (options) {
367
+ var _a;
368
+ return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/info' }));
369
+ };
370
+ exports.getUserInfo = getUserInfo;
363
371
  /**
364
372
  * Retrieves historical game data
365
373
  */
@@ -72,36 +72,36 @@ export type AdvancedGameStat = {
72
72
  opponent: string;
73
73
  offense: {
74
74
  passingPlays: {
75
- explosiveness: number;
75
+ explosiveness: (number) | null;
76
76
  successRate: number;
77
77
  totalPPA: number;
78
78
  ppa: number;
79
79
  };
80
80
  rushingPlays: {
81
- explosiveness: number;
81
+ explosiveness: (number) | null;
82
82
  successRate: number;
83
83
  totalPPA: number;
84
84
  ppa: number;
85
85
  };
86
86
  passingDowns: {
87
- explosiveness: number;
87
+ explosiveness: (number) | null;
88
88
  successRate: number;
89
89
  ppa: number;
90
90
  };
91
91
  standardDowns: {
92
- explosiveness: number;
92
+ explosiveness: (number) | null;
93
93
  successRate: number;
94
94
  ppa: number;
95
95
  };
96
96
  openFieldYardsTotal: number;
97
- openFieldYards: number;
97
+ openFieldYards: (number) | null;
98
98
  secondLevelYardsTotal: number;
99
99
  secondLevelYards: number;
100
100
  lineYardsTotal: number;
101
101
  lineYards: number;
102
102
  stuffRate: number;
103
- powerSuccess: number;
104
- explosiveness: number;
103
+ powerSuccess: (number) | null;
104
+ explosiveness: (number) | null;
105
105
  successRate: number;
106
106
  totalPPA: number;
107
107
  ppa: number;
@@ -110,35 +110,35 @@ export type AdvancedGameStat = {
110
110
  };
111
111
  defense: {
112
112
  passingPlays: {
113
- explosiveness: number;
113
+ explosiveness: (number) | null;
114
114
  successRate: number;
115
115
  totalPPA: number;
116
116
  ppa: number;
117
117
  };
118
118
  rushingPlays: {
119
- explosiveness: number;
119
+ explosiveness: (number) | null;
120
120
  successRate: number;
121
121
  totalPPA: number;
122
122
  ppa: number;
123
123
  };
124
124
  passingDowns: {
125
- explosiveness: number;
125
+ explosiveness: (number) | null;
126
126
  successRate: number;
127
127
  ppa: number;
128
128
  };
129
129
  standardDowns: {
130
- explosiveness: number;
130
+ explosiveness: (number) | null;
131
131
  successRate: number;
132
132
  ppa: number;
133
133
  };
134
- openFieldYardsTotal: number;
134
+ openFieldYardsTotal: (number) | null;
135
135
  openFieldYards: number;
136
136
  secondLevelYardsTotal: number;
137
137
  secondLevelYards: number;
138
138
  lineYardsTotal: number;
139
139
  lineYards: number;
140
140
  stuffRate: number;
141
- powerSuccess: number;
141
+ powerSuccess: (number) | null;
142
142
  explosiveness: number;
143
143
  successRate: number;
144
144
  totalPPA: number;
@@ -153,27 +153,27 @@ export type AdvancedSeasonStat = {
153
153
  conference: string;
154
154
  offense: {
155
155
  passingPlays: {
156
- explosiveness: number;
156
+ explosiveness: (number) | null;
157
157
  successRate: number;
158
158
  totalPPA: number;
159
159
  ppa: number;
160
160
  rate: number;
161
161
  };
162
162
  rushingPlays: {
163
- explosiveness: number;
163
+ explosiveness: (number) | null;
164
164
  successRate: number;
165
165
  totalPPA: number;
166
166
  ppa: number;
167
167
  rate: number;
168
168
  };
169
169
  passingDowns: {
170
- explosiveness: number;
170
+ explosiveness: (number) | null;
171
171
  successRate: number;
172
172
  ppa: number;
173
173
  rate: number;
174
174
  };
175
175
  standardDowns: {
176
- explosiveness: number;
176
+ explosiveness: (number) | null;
177
177
  successRate: number;
178
178
  ppa: number;
179
179
  rate: number;
@@ -196,8 +196,8 @@ export type AdvancedSeasonStat = {
196
196
  lineYardsTotal: number;
197
197
  lineYards: number;
198
198
  stuffRate: number;
199
- powerSuccess: number;
200
- explosiveness: number;
199
+ powerSuccess: (number) | null;
200
+ explosiveness: (number) | null;
201
201
  successRate: number;
202
202
  totalPPA: number;
203
203
  ppa: number;
@@ -206,28 +206,28 @@ export type AdvancedSeasonStat = {
206
206
  };
207
207
  defense: {
208
208
  passingPlays: {
209
- explosiveness: number;
209
+ explosiveness: (number) | null;
210
210
  successRate: number;
211
211
  totalPPA: number;
212
212
  ppa: number;
213
213
  rate: number;
214
214
  };
215
215
  rushingPlays: {
216
- explosiveness: number;
216
+ explosiveness: (number) | null;
217
217
  successRate: number;
218
218
  totalPPA: number;
219
219
  ppa: number;
220
220
  rate: number;
221
221
  };
222
222
  passingDowns: {
223
- explosiveness: number;
223
+ explosiveness: (number) | null;
224
224
  successRate: number;
225
225
  totalPPA: number;
226
226
  ppa: number;
227
227
  rate: number;
228
228
  };
229
229
  standardDowns: {
230
- explosiveness: number;
230
+ explosiveness: (number) | null;
231
231
  successRate: number;
232
232
  ppa: number;
233
233
  rate: number;
@@ -250,8 +250,8 @@ export type AdvancedSeasonStat = {
250
250
  lineYardsTotal: number;
251
251
  lineYards: number;
252
252
  stuffRate: number;
253
- powerSuccess: number;
254
- explosiveness: number;
253
+ powerSuccess: (number) | null;
254
+ explosiveness: (number) | null;
255
255
  successRate: number;
256
256
  totalPPA: number;
257
257
  ppa: number;
@@ -670,11 +670,11 @@ export type MatchupGame = {
670
670
  seasonType: string;
671
671
  date: string;
672
672
  neutralSite: boolean;
673
- venue: string;
673
+ venue: (string) | null;
674
674
  homeTeam: string;
675
- homeScore: number;
675
+ homeScore: (number) | null;
676
676
  awayTeam: string;
677
- awayScore: number;
677
+ awayScore: (number) | null;
678
678
  winner: (string) | null;
679
679
  };
680
680
  export type MediaType = 'tv' | 'radio' | 'web' | 'ppv' | 'mobile';
@@ -727,10 +727,10 @@ export type PlayerGamePredictedPointsAdded = {
727
727
  };
728
728
  export type PlayerGameUsage = {
729
729
  total: number;
730
- quarter1: number;
731
- quarter2: number;
732
- quarter3: number;
733
- quarter4: number;
730
+ quarter1: (number) | null;
731
+ quarter2: (number) | null;
732
+ quarter3: (number) | null;
733
+ quarter4: (number) | null;
734
734
  rushing: number;
735
735
  passing: number;
736
736
  player: string;
@@ -794,18 +794,19 @@ export type PlayerStat = {
794
794
  season: number;
795
795
  playerId: string;
796
796
  player: string;
797
+ position: string;
797
798
  team: string;
798
799
  conference: string;
799
800
  category: string;
800
801
  statType: string;
801
- stat: number;
802
+ stat: string;
802
803
  };
803
804
  export type PlayerStatsByQuarter = {
804
805
  total: number;
805
- quarter1: number;
806
- quarter2: number;
807
- quarter3: number;
808
- quarter4: number;
806
+ quarter1: (number) | null;
807
+ quarter2: (number) | null;
808
+ quarter3: (number) | null;
809
+ quarter4: (number) | null;
809
810
  rushing: number;
810
811
  passing: number;
811
812
  };
@@ -829,14 +830,14 @@ export type PlayerUsage = {
829
830
  team: string;
830
831
  conference: string;
831
832
  usage: {
832
- passingDowns: number;
833
- standardDowns: number;
834
- thirdDown: number;
835
- secondDown: number;
836
- firstDown: number;
837
- rush: number;
838
- pass: number;
839
- overall: number;
833
+ passingDowns: (number) | null;
834
+ standardDowns: (number) | null;
835
+ thirdDown: (number) | null;
836
+ secondDown: (number) | null;
837
+ firstDown: (number) | null;
838
+ rush: (number) | null;
839
+ pass: (number) | null;
840
+ overall: (number) | null;
840
841
  };
841
842
  };
842
843
  export type PlayerWeightedEPA = {
@@ -980,6 +981,9 @@ export type RosterPlayer = {
980
981
  height: (number) | null;
981
982
  weight: (number) | null;
982
983
  jersey: (number) | null;
984
+ /**
985
+ * @deprecated
986
+ */
983
987
  year: number;
984
988
  position: (string) | null;
985
989
  homeCity: (string) | null;
@@ -1040,10 +1044,10 @@ export type ScoreboardGame = {
1040
1044
  export type SeasonType = 'regular' | 'postseason' | 'both' | 'allstar' | 'spring_regular' | 'spring_postseason';
1041
1045
  export type StatsByQuarter = {
1042
1046
  total: number;
1043
- quarter1: number;
1044
- quarter2: number;
1045
- quarter3: number;
1046
- quarter4: number;
1047
+ quarter1: (number) | null;
1048
+ quarter2: (number) | null;
1049
+ quarter3: (number) | null;
1050
+ quarter4: (number) | null;
1047
1051
  };
1048
1052
  export type Team = {
1049
1053
  id: number;
@@ -1212,9 +1216,9 @@ export type TeamSeasonPredictedPointsAdded = {
1212
1216
  export type TeamSP = {
1213
1217
  year: number;
1214
1218
  team: string;
1215
- conference: string;
1219
+ conference: (string) | null;
1216
1220
  rating: number;
1217
- ranking: number;
1221
+ ranking: (number) | null;
1218
1222
  secondOrderWins: (number) | null;
1219
1223
  sos: (number) | null;
1220
1224
  offense: {
@@ -1227,7 +1231,7 @@ export type TeamSP = {
1227
1231
  explosiveness: (number) | null;
1228
1232
  success: (number) | null;
1229
1233
  rating: number;
1230
- ranking: number;
1234
+ ranking: (number) | null;
1231
1235
  };
1232
1236
  defense: {
1233
1237
  havoc: {
@@ -1242,7 +1246,7 @@ export type TeamSP = {
1242
1246
  explosiveness: (number) | null;
1243
1247
  success: (number) | null;
1244
1248
  rating: number;
1245
- ranking: number;
1249
+ ranking: (number) | null;
1246
1250
  };
1247
1251
  specialTeams: {
1248
1252
  rating: (number) | null;
@@ -1254,7 +1258,7 @@ export type TeamSRS = {
1254
1258
  conference: (string) | null;
1255
1259
  division: (string) | null;
1256
1260
  rating: number;
1257
- ranking: number;
1261
+ ranking: (number) | null;
1258
1262
  };
1259
1263
  export type TeamStat = {
1260
1264
  season: number;
@@ -1275,6 +1279,10 @@ export type TeamTalent = {
1275
1279
  talent: number;
1276
1280
  };
1277
1281
  export type TransferEligibility = 'Withdrawn' | 'TBD' | 'PendingAppeal' | 'SittingOne' | 'Immediate';
1282
+ export type UserInfo = {
1283
+ patronLevel: number;
1284
+ remainingCalls: number;
1285
+ };
1278
1286
  export type Venue = {
1279
1287
  id: (number) | null;
1280
1288
  name: (string) | null;
@@ -2133,6 +2141,8 @@ export type GetLinesData = {
2133
2141
  };
2134
2142
  export type GetLinesResponse = (Array<BettingGame>);
2135
2143
  export type GetLinesError = unknown;
2144
+ export type GetUserInfoResponse = (((UserInfo) | null));
2145
+ export type GetUserInfoError = unknown;
2136
2146
  export type GetGamesData = {
2137
2147
  query?: {
2138
2148
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "cfbd",
3
- "version": "5.4.6-alpha.0",
3
+ "version": "5.8.2",
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,9 +1,9 @@
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, GetRosterData, GetRosterError, GetRosterResponse, GetConferencesError, GetConferencesResponse, GetTalentData, GetTalentError, GetTalentResponse, GetVenuesError, GetVenuesResponse, GetPlayerSeasonStatsData, GetPlayerSeasonStatsError, GetPlayerSeasonStatsResponse, GetTeamStatsData, GetTeamStatsError, GetTeamStatsResponse, GetCategoriesError, GetCategoriesResponse, GetAdvancedSeasonStatsData, GetAdvancedSeasonStatsError, GetAdvancedSeasonStatsResponse, GetAdvancedGameStatsData, GetAdvancedGameStatsError, GetAdvancedGameStatsResponse, 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, 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, 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, GetRosterData, GetRosterError, GetRosterResponse, GetConferencesError, GetConferencesResponse, GetTalentData, GetTalentError, GetTalentResponse, GetVenuesError, GetVenuesResponse, GetPlayerSeasonStatsData, GetPlayerSeasonStatsError, GetPlayerSeasonStatsResponse, GetTeamStatsData, GetTeamStatsError, GetTeamStatsResponse, GetCategoriesError, GetCategoriesResponse, GetAdvancedSeasonStatsData, GetAdvancedSeasonStatsError, GetAdvancedSeasonStatsResponse, GetAdvancedGameStatsData, GetAdvancedGameStatsError, GetAdvancedGameStatsResponse, 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, 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, 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
- export const client = createClient(createConfig({ baseUrl: 'https://apinext.collegefootballdata.com' }));
6
+ export const client = createClient(createConfig({ baseUrl: 'https://api.collegefootballdata.com' }));
7
7
 
8
8
  /**
9
9
  * Retrieve opponent-adjusted team season statistics
@@ -435,6 +435,16 @@ export const getLines = <ThrowOnError extends boolean = false>(options?: Options
435
435
  });
436
436
  };
437
437
 
438
+ /**
439
+ * Retrieves information about the user, including their Patreon level and remaining API calls.
440
+ */
441
+ export const getUserInfo = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => {
442
+ return (options?.client ?? client).get<GetUserInfoResponse, GetUserInfoError, ThrowOnError>({
443
+ ...options,
444
+ url: '/info'
445
+ });
446
+ };
447
+
438
448
  /**
439
449
  * Retrieves historical game data
440
450
  */
package/src/types.gen.ts CHANGED
@@ -76,36 +76,36 @@ export type AdvancedGameStat = {
76
76
  opponent: string;
77
77
  offense: {
78
78
  passingPlays: {
79
- explosiveness: number;
79
+ explosiveness: (number) | null;
80
80
  successRate: number;
81
81
  totalPPA: number;
82
82
  ppa: number;
83
83
  };
84
84
  rushingPlays: {
85
- explosiveness: number;
85
+ explosiveness: (number) | null;
86
86
  successRate: number;
87
87
  totalPPA: number;
88
88
  ppa: number;
89
89
  };
90
90
  passingDowns: {
91
- explosiveness: number;
91
+ explosiveness: (number) | null;
92
92
  successRate: number;
93
93
  ppa: number;
94
94
  };
95
95
  standardDowns: {
96
- explosiveness: number;
96
+ explosiveness: (number) | null;
97
97
  successRate: number;
98
98
  ppa: number;
99
99
  };
100
100
  openFieldYardsTotal: number;
101
- openFieldYards: number;
101
+ openFieldYards: (number) | null;
102
102
  secondLevelYardsTotal: number;
103
103
  secondLevelYards: number;
104
104
  lineYardsTotal: number;
105
105
  lineYards: number;
106
106
  stuffRate: number;
107
- powerSuccess: number;
108
- explosiveness: number;
107
+ powerSuccess: (number) | null;
108
+ explosiveness: (number) | null;
109
109
  successRate: number;
110
110
  totalPPA: number;
111
111
  ppa: number;
@@ -114,35 +114,35 @@ export type AdvancedGameStat = {
114
114
  };
115
115
  defense: {
116
116
  passingPlays: {
117
- explosiveness: number;
117
+ explosiveness: (number) | null;
118
118
  successRate: number;
119
119
  totalPPA: number;
120
120
  ppa: number;
121
121
  };
122
122
  rushingPlays: {
123
- explosiveness: number;
123
+ explosiveness: (number) | null;
124
124
  successRate: number;
125
125
  totalPPA: number;
126
126
  ppa: number;
127
127
  };
128
128
  passingDowns: {
129
- explosiveness: number;
129
+ explosiveness: (number) | null;
130
130
  successRate: number;
131
131
  ppa: number;
132
132
  };
133
133
  standardDowns: {
134
- explosiveness: number;
134
+ explosiveness: (number) | null;
135
135
  successRate: number;
136
136
  ppa: number;
137
137
  };
138
- openFieldYardsTotal: number;
138
+ openFieldYardsTotal: (number) | null;
139
139
  openFieldYards: number;
140
140
  secondLevelYardsTotal: number;
141
141
  secondLevelYards: number;
142
142
  lineYardsTotal: number;
143
143
  lineYards: number;
144
144
  stuffRate: number;
145
- powerSuccess: number;
145
+ powerSuccess: (number) | null;
146
146
  explosiveness: number;
147
147
  successRate: number;
148
148
  totalPPA: number;
@@ -158,27 +158,27 @@ export type AdvancedSeasonStat = {
158
158
  conference: string;
159
159
  offense: {
160
160
  passingPlays: {
161
- explosiveness: number;
161
+ explosiveness: (number) | null;
162
162
  successRate: number;
163
163
  totalPPA: number;
164
164
  ppa: number;
165
165
  rate: number;
166
166
  };
167
167
  rushingPlays: {
168
- explosiveness: number;
168
+ explosiveness: (number) | null;
169
169
  successRate: number;
170
170
  totalPPA: number;
171
171
  ppa: number;
172
172
  rate: number;
173
173
  };
174
174
  passingDowns: {
175
- explosiveness: number;
175
+ explosiveness: (number) | null;
176
176
  successRate: number;
177
177
  ppa: number;
178
178
  rate: number;
179
179
  };
180
180
  standardDowns: {
181
- explosiveness: number;
181
+ explosiveness: (number) | null;
182
182
  successRate: number;
183
183
  ppa: number;
184
184
  rate: number;
@@ -201,8 +201,8 @@ export type AdvancedSeasonStat = {
201
201
  lineYardsTotal: number;
202
202
  lineYards: number;
203
203
  stuffRate: number;
204
- powerSuccess: number;
205
- explosiveness: number;
204
+ powerSuccess: (number) | null;
205
+ explosiveness: (number) | null;
206
206
  successRate: number;
207
207
  totalPPA: number;
208
208
  ppa: number;
@@ -211,28 +211,28 @@ export type AdvancedSeasonStat = {
211
211
  };
212
212
  defense: {
213
213
  passingPlays: {
214
- explosiveness: number;
214
+ explosiveness: (number) | null;
215
215
  successRate: number;
216
216
  totalPPA: number;
217
217
  ppa: number;
218
218
  rate: number;
219
219
  };
220
220
  rushingPlays: {
221
- explosiveness: number;
221
+ explosiveness: (number) | null;
222
222
  successRate: number;
223
223
  totalPPA: number;
224
224
  ppa: number;
225
225
  rate: number;
226
226
  };
227
227
  passingDowns: {
228
- explosiveness: number;
228
+ explosiveness: (number) | null;
229
229
  successRate: number;
230
230
  totalPPA: number;
231
231
  ppa: number;
232
232
  rate: number;
233
233
  };
234
234
  standardDowns: {
235
- explosiveness: number;
235
+ explosiveness: (number) | null;
236
236
  successRate: number;
237
237
  ppa: number;
238
238
  rate: number;
@@ -255,8 +255,8 @@ export type AdvancedSeasonStat = {
255
255
  lineYardsTotal: number;
256
256
  lineYards: number;
257
257
  stuffRate: number;
258
- powerSuccess: number;
259
- explosiveness: number;
258
+ powerSuccess: (number) | null;
259
+ explosiveness: (number) | null;
260
260
  successRate: number;
261
261
  totalPPA: number;
262
262
  ppa: number;
@@ -711,11 +711,11 @@ export type MatchupGame = {
711
711
  seasonType: string;
712
712
  date: string;
713
713
  neutralSite: boolean;
714
- venue: string;
714
+ venue: (string) | null;
715
715
  homeTeam: string;
716
- homeScore: number;
716
+ homeScore: (number) | null;
717
717
  awayTeam: string;
718
- awayScore: number;
718
+ awayScore: (number) | null;
719
719
  winner: (string) | null;
720
720
  };
721
721
 
@@ -772,10 +772,10 @@ export type PlayerGamePredictedPointsAdded = {
772
772
 
773
773
  export type PlayerGameUsage = {
774
774
  total: number;
775
- quarter1: number;
776
- quarter2: number;
777
- quarter3: number;
778
- quarter4: number;
775
+ quarter1: (number) | null;
776
+ quarter2: (number) | null;
777
+ quarter3: (number) | null;
778
+ quarter4: (number) | null;
779
779
  rushing: number;
780
780
  passing: number;
781
781
  player: string;
@@ -844,19 +844,20 @@ export type PlayerStat = {
844
844
  season: number;
845
845
  playerId: string;
846
846
  player: string;
847
+ position: string;
847
848
  team: string;
848
849
  conference: string;
849
850
  category: string;
850
851
  statType: string;
851
- stat: number;
852
+ stat: string;
852
853
  };
853
854
 
854
855
  export type PlayerStatsByQuarter = {
855
856
  total: number;
856
- quarter1: number;
857
- quarter2: number;
858
- quarter3: number;
859
- quarter4: number;
857
+ quarter1: (number) | null;
858
+ quarter2: (number) | null;
859
+ quarter3: (number) | null;
860
+ quarter4: (number) | null;
860
861
  rushing: number;
861
862
  passing: number;
862
863
  };
@@ -882,14 +883,14 @@ export type PlayerUsage = {
882
883
  team: string;
883
884
  conference: string;
884
885
  usage: {
885
- passingDowns: number;
886
- standardDowns: number;
887
- thirdDown: number;
888
- secondDown: number;
889
- firstDown: number;
890
- rush: number;
891
- pass: number;
892
- overall: number;
886
+ passingDowns: (number) | null;
887
+ standardDowns: (number) | null;
888
+ thirdDown: (number) | null;
889
+ secondDown: (number) | null;
890
+ firstDown: (number) | null;
891
+ rush: (number) | null;
892
+ pass: (number) | null;
893
+ overall: (number) | null;
893
894
  };
894
895
  };
895
896
 
@@ -1047,6 +1048,9 @@ export type RosterPlayer = {
1047
1048
  height: (number) | null;
1048
1049
  weight: (number) | null;
1049
1050
  jersey: (number) | null;
1051
+ /**
1052
+ * @deprecated
1053
+ */
1050
1054
  year: number;
1051
1055
  position: (string) | null;
1052
1056
  homeCity: (string) | null;
@@ -1110,10 +1114,10 @@ export type SeasonType = 'regular' | 'postseason' | 'both' | 'allstar' | 'spring
1110
1114
 
1111
1115
  export type StatsByQuarter = {
1112
1116
  total: number;
1113
- quarter1: number;
1114
- quarter2: number;
1115
- quarter3: number;
1116
- quarter4: number;
1117
+ quarter1: (number) | null;
1118
+ quarter2: (number) | null;
1119
+ quarter3: (number) | null;
1120
+ quarter4: (number) | null;
1117
1121
  };
1118
1122
 
1119
1123
  export type Team = {
@@ -1297,9 +1301,9 @@ export type TeamSeasonPredictedPointsAdded = {
1297
1301
  export type TeamSP = {
1298
1302
  year: number;
1299
1303
  team: string;
1300
- conference: string;
1304
+ conference: (string) | null;
1301
1305
  rating: number;
1302
- ranking: number;
1306
+ ranking: (number) | null;
1303
1307
  secondOrderWins: (number) | null;
1304
1308
  sos: (number) | null;
1305
1309
  offense: {
@@ -1312,7 +1316,7 @@ export type TeamSP = {
1312
1316
  explosiveness: (number) | null;
1313
1317
  success: (number) | null;
1314
1318
  rating: number;
1315
- ranking: number;
1319
+ ranking: (number) | null;
1316
1320
  };
1317
1321
  defense: {
1318
1322
  havoc: {
@@ -1327,7 +1331,7 @@ export type TeamSP = {
1327
1331
  explosiveness: (number) | null;
1328
1332
  success: (number) | null;
1329
1333
  rating: number;
1330
- ranking: number;
1334
+ ranking: (number) | null;
1331
1335
  };
1332
1336
  specialTeams: {
1333
1337
  rating: (number) | null;
@@ -1340,7 +1344,7 @@ export type TeamSRS = {
1340
1344
  conference: (string) | null;
1341
1345
  division: (string) | null;
1342
1346
  rating: number;
1343
- ranking: number;
1347
+ ranking: (number) | null;
1344
1348
  };
1345
1349
 
1346
1350
  export type TeamStat = {
@@ -1366,6 +1370,11 @@ export type TeamTalent = {
1366
1370
 
1367
1371
  export type TransferEligibility = 'Withdrawn' | 'TBD' | 'PendingAppeal' | 'SittingOne' | 'Immediate';
1368
1372
 
1373
+ export type UserInfo = {
1374
+ patronLevel: number;
1375
+ remainingCalls: number;
1376
+ };
1377
+
1369
1378
  export type Venue = {
1370
1379
  id: (number) | null;
1371
1380
  name: (string) | null;
@@ -2348,6 +2357,10 @@ export type GetLinesResponse = (Array<BettingGame>);
2348
2357
 
2349
2358
  export type GetLinesError = unknown;
2350
2359
 
2360
+ export type GetUserInfoResponse = (((UserInfo) | null));
2361
+
2362
+ export type GetUserInfoError = unknown;
2363
+
2351
2364
  export type GetGamesData = {
2352
2365
  query?: {
2353
2366
  /**
Binary file