cfbd 5.22.0 → 5.24.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, 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, 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, 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, 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, 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';
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.
@@ -38,9 +38,17 @@ export declare const getTeamsAts: <ThrowOnError extends boolean = false>(options
38
38
  */
39
39
  export declare const getRoster: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetRosterData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetRosterResponse, unknown, ThrowOnError>;
40
40
  /**
41
- * Returns the available conferences.
41
+ * Returns conferences and member counts.
42
42
  */
43
- export declare const getConferences: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetConferencesResponse, unknown, ThrowOnError>;
43
+ export declare const getConferences: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetConferencesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetConferencesResponse, unknown, ThrowOnError>;
44
+ /**
45
+ * Returns team conference changes by season.
46
+ */
47
+ export declare const getTeamConferenceChanges: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetTeamConferenceChangesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetTeamConferenceChangesResponse, unknown, ThrowOnError>;
48
+ /**
49
+ * Returns historical team conference affiliations.
50
+ */
51
+ export declare const getTeamConferenceAffiliations: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetTeamConferenceAffiliationsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetTeamConferenceAffiliationsResponse, unknown, ThrowOnError>;
44
52
  /**
45
53
  * Returns 247Sports Team Talent Composite ratings for a season.
46
54
  */
@@ -93,6 +101,11 @@ export declare const getTeamRecruitingRankings: <ThrowOnError extends boolean =
93
101
  * Returns recruiting ratings aggregated by team and position group.
94
102
  */
95
103
  export declare const getAggregatedTeamRecruitingRatings: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetAggregatedTeamRecruitingRatingsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAggregatedTeamRecruitingRatingsResponse, unknown, ThrowOnError>;
104
+ /**
105
+ * Returns Context & Opponent-Relative Efficiency (CORE) ratings.
106
+ * At least one of `year` or `team` is required.
107
+ */
108
+ export declare const getCore: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetCoreData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCoreResponse, unknown, ThrowOnError>;
96
109
  /**
97
110
  * Returns SP+ ratings by team and season.
98
111
  */
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.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.getExpandedSrs = 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.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 = void 0;
15
+ 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.getExpandedSrs = exports.getSrs = exports.getConferenceSp = exports.getSp = exports.getCore = 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.getTeamConferenceAffiliations = exports.getTeamConferenceChanges = 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.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 = 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
  /**
@@ -89,13 +89,29 @@ var getRoster = function (options) {
89
89
  };
90
90
  exports.getRoster = getRoster;
91
91
  /**
92
- * Returns the available conferences.
92
+ * Returns conferences and member counts.
93
93
  */
94
94
  var getConferences = function (options) {
95
95
  var _a;
96
96
  return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/conferences' }));
97
97
  };
98
98
  exports.getConferences = getConferences;
99
+ /**
100
+ * Returns team conference changes by season.
101
+ */
102
+ var getTeamConferenceChanges = function (options) {
103
+ var _a;
104
+ return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/conferences/changes' }));
105
+ };
106
+ exports.getTeamConferenceChanges = getTeamConferenceChanges;
107
+ /**
108
+ * Returns historical team conference affiliations.
109
+ */
110
+ var getTeamConferenceAffiliations = function (options) {
111
+ var _a;
112
+ return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/conferences/affiliations' }));
113
+ };
114
+ exports.getTeamConferenceAffiliations = getTeamConferenceAffiliations;
99
115
  /**
100
116
  * Returns 247Sports Team Talent Composite ratings for a season.
101
117
  */
@@ -200,6 +216,15 @@ var getAggregatedTeamRecruitingRatings = function (options) {
200
216
  return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/recruiting/groups' }));
201
217
  };
202
218
  exports.getAggregatedTeamRecruitingRatings = getAggregatedTeamRecruitingRatings;
219
+ /**
220
+ * Returns Context & Opponent-Relative Efficiency (CORE) ratings.
221
+ * At least one of `year` or `team` is required.
222
+ */
223
+ var getCore = function (options) {
224
+ var _a;
225
+ return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/ratings/core' }));
226
+ };
227
+ exports.getCore = getCore;
203
228
  /**
204
229
  * Returns SP+ ratings by team and season.
205
230
  */
@@ -462,8 +462,10 @@ export type Conference = {
462
462
  name: string;
463
463
  shortName: (string) | null;
464
464
  abbreviation: (string) | null;
465
- classification: ((DivisionClassification) | null);
465
+ classification: ((ConferenceClassification) | null);
466
+ memberCount: number;
466
467
  };
468
+ export type ConferenceClassification = 'fbs' | 'fcs' | 'ii' | 'ii/iii' | 'iii';
467
469
  export type ConferenceSP = {
468
470
  year: number;
469
471
  conference: string;
@@ -499,6 +501,7 @@ export type ConferenceSP = {
499
501
  rating: (number) | null;
500
502
  };
501
503
  };
504
+ export type CoreRatingSeasonType = 'regular' | 'postseason';
502
505
  export type DetailedCoachSeason = {
503
506
  games: number;
504
507
  wins: number;
@@ -1460,6 +1463,52 @@ export type TeamATS = {
1460
1463
  atsPushes: number;
1461
1464
  avgCoverMargin: (number) | null;
1462
1465
  };
1466
+ export type TeamConferenceAffiliation = {
1467
+ teamId: number;
1468
+ team: string;
1469
+ conferenceId: number;
1470
+ conference: string;
1471
+ conferenceAbbreviation: (string) | null;
1472
+ classification: ((ConferenceClassification) | null);
1473
+ conferenceDivision: (string) | null;
1474
+ startYear: number;
1475
+ endYear: (number) | null;
1476
+ };
1477
+ export type TeamConferenceChange = {
1478
+ teamId: number;
1479
+ team: string;
1480
+ fromConferenceId: number;
1481
+ fromConference: string;
1482
+ fromConferenceAbbreviation: (string) | null;
1483
+ fromClassification: ((ConferenceClassification) | null);
1484
+ toConferenceId: number;
1485
+ toConference: string;
1486
+ toConferenceAbbreviation: (string) | null;
1487
+ toClassification: ((ConferenceClassification) | null);
1488
+ effectiveYear: number;
1489
+ };
1490
+ export type TeamCoreRating = {
1491
+ year: number;
1492
+ throughSeasonType: CoreRatingSeasonType;
1493
+ throughWeek: number;
1494
+ team: string;
1495
+ conference: (string) | null;
1496
+ /**
1497
+ * Offense-minus-defense composite; higher is better.
1498
+ */
1499
+ overall: number;
1500
+ /**
1501
+ * Points created above average per 100 qualifying plays; higher is better.
1502
+ */
1503
+ offense: number;
1504
+ /**
1505
+ * Points allowed above average per 100 qualifying plays; lower is better.
1506
+ */
1507
+ defense: number;
1508
+ offensePlays: number;
1509
+ defensePlays: number;
1510
+ modelVersion: string;
1511
+ };
1463
1512
  export type TeamElo = {
1464
1513
  year: number;
1465
1514
  team: string;
@@ -1900,8 +1949,60 @@ export type GetRosterData = {
1900
1949
  };
1901
1950
  export type GetRosterResponse = (Array<RosterPlayer>);
1902
1951
  export type GetRosterError = unknown;
1952
+ export type GetConferencesData = {
1953
+ query?: {
1954
+ /**
1955
+ * Conference classification.
1956
+ */
1957
+ classification?: ConferenceClassification;
1958
+ /**
1959
+ * Season year used to calculate membership.
1960
+ */
1961
+ year?: number;
1962
+ };
1963
+ };
1903
1964
  export type GetConferencesResponse = (Array<Conference>);
1904
1965
  export type GetConferencesError = unknown;
1966
+ export type GetTeamConferenceChangesData = {
1967
+ query: {
1968
+ /**
1969
+ * Season year.
1970
+ */
1971
+ year: number;
1972
+ };
1973
+ };
1974
+ export type GetTeamConferenceChangesResponse = (Array<TeamConferenceChange>);
1975
+ export type GetTeamConferenceChangesError = unknown;
1976
+ export type GetTeamConferenceAffiliationsData = {
1977
+ query?: {
1978
+ /**
1979
+ * Conference classification.
1980
+ */
1981
+ classification?: ConferenceClassification;
1982
+ /**
1983
+ * Conference name or abbreviation.
1984
+ */
1985
+ conference?: string;
1986
+ /**
1987
+ * Latest season year to include.
1988
+ */
1989
+ maxYear?: number;
1990
+ /**
1991
+ * Earliest season year to include.
1992
+ */
1993
+ minYear?: number;
1994
+ /**
1995
+ * Team school name or abbreviation.
1996
+ */
1997
+ team?: string;
1998
+ /**
1999
+ * Season year. Cannot be combined with `minYear` or `maxYear`.
2000
+ */
2001
+ year?: number;
2002
+ };
2003
+ };
2004
+ export type GetTeamConferenceAffiliationsResponse = (Array<TeamConferenceAffiliation>);
2005
+ export type GetTeamConferenceAffiliationsError = unknown;
1905
2006
  export type GetTalentData = {
1906
2007
  query: {
1907
2008
  /**
@@ -2214,6 +2315,24 @@ export type GetAggregatedTeamRecruitingRatingsData = {
2214
2315
  };
2215
2316
  export type GetAggregatedTeamRecruitingRatingsResponse = (Array<AggregatedTeamRecruiting>);
2216
2317
  export type GetAggregatedTeamRecruitingRatingsError = unknown;
2318
+ export type GetCoreData = {
2319
+ query?: {
2320
+ /**
2321
+ * Conference name or abbreviation.
2322
+ */
2323
+ conference?: string;
2324
+ /**
2325
+ * Exact team name. Required unless `year` is specified.
2326
+ */
2327
+ team?: string;
2328
+ /**
2329
+ * Season year. Required unless `team` is specified.
2330
+ */
2331
+ year?: number;
2332
+ };
2333
+ };
2334
+ export type GetCoreResponse = (Array<TeamCoreRating>);
2335
+ export type GetCoreError = unknown;
2217
2336
  export type GetSpData = {
2218
2337
  query?: {
2219
2338
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "cfbd",
3
- "version": "5.22.0",
3
+ "version": "5.24.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, 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, 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, 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, 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, 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';
5
5
 
6
6
  export const client = createClient(createConfig({ baseUrl: 'https://api.collegefootballdata.com' }));
7
7
 
@@ -96,15 +96,35 @@ export const getRoster = <ThrowOnError extends boolean = false>(options?: Option
96
96
  };
97
97
 
98
98
  /**
99
- * Returns the available conferences.
99
+ * Returns conferences and member counts.
100
100
  */
101
- export const getConferences = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => {
101
+ export const getConferences = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetConferencesData, ThrowOnError>) => {
102
102
  return (options?.client ?? client).get<GetConferencesResponse, GetConferencesError, ThrowOnError>({
103
103
  ...options,
104
104
  url: '/conferences'
105
105
  });
106
106
  };
107
107
 
108
+ /**
109
+ * Returns team conference changes by season.
110
+ */
111
+ export const getTeamConferenceChanges = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetTeamConferenceChangesData, ThrowOnError>) => {
112
+ return (options?.client ?? client).get<GetTeamConferenceChangesResponse, GetTeamConferenceChangesError, ThrowOnError>({
113
+ ...options,
114
+ url: '/conferences/changes'
115
+ });
116
+ };
117
+
118
+ /**
119
+ * Returns historical team conference affiliations.
120
+ */
121
+ export const getTeamConferenceAffiliations = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetTeamConferenceAffiliationsData, ThrowOnError>) => {
122
+ return (options?.client ?? client).get<GetTeamConferenceAffiliationsResponse, GetTeamConferenceAffiliationsError, ThrowOnError>({
123
+ ...options,
124
+ url: '/conferences/affiliations'
125
+ });
126
+ };
127
+
108
128
  /**
109
129
  * Returns 247Sports Team Talent Composite ratings for a season.
110
130
  */
@@ -235,6 +255,17 @@ export const getAggregatedTeamRecruitingRatings = <ThrowOnError extends boolean
235
255
  });
236
256
  };
237
257
 
258
+ /**
259
+ * Returns Context & Opponent-Relative Efficiency (CORE) ratings.
260
+ * At least one of `year` or `team` is required.
261
+ */
262
+ export const getCore = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetCoreData, ThrowOnError>) => {
263
+ return (options?.client ?? client).get<GetCoreResponse, GetCoreError, ThrowOnError>({
264
+ ...options,
265
+ url: '/ratings/core'
266
+ });
267
+ };
268
+
238
269
  /**
239
270
  * Returns SP+ ratings by team and season.
240
271
  */
package/src/types.gen.ts CHANGED
@@ -494,9 +494,12 @@ export type Conference = {
494
494
  name: string;
495
495
  shortName: (string) | null;
496
496
  abbreviation: (string) | null;
497
- classification: ((DivisionClassification) | null);
497
+ classification: ((ConferenceClassification) | null);
498
+ memberCount: number;
498
499
  };
499
500
 
501
+ export type ConferenceClassification = 'fbs' | 'fcs' | 'ii' | 'ii/iii' | 'iii';
502
+
500
503
  export type ConferenceSP = {
501
504
  year: number;
502
505
  conference: string;
@@ -533,6 +536,8 @@ export type ConferenceSP = {
533
536
  };
534
537
  };
535
538
 
539
+ export type CoreRatingSeasonType = 'regular' | 'postseason';
540
+
536
541
  export type DetailedCoachSeason = {
537
542
  games: number;
538
543
  wins: number;
@@ -1583,6 +1588,55 @@ export type TeamATS = {
1583
1588
  avgCoverMargin: (number) | null;
1584
1589
  };
1585
1590
 
1591
+ export type TeamConferenceAffiliation = {
1592
+ teamId: number;
1593
+ team: string;
1594
+ conferenceId: number;
1595
+ conference: string;
1596
+ conferenceAbbreviation: (string) | null;
1597
+ classification: ((ConferenceClassification) | null);
1598
+ conferenceDivision: (string) | null;
1599
+ startYear: number;
1600
+ endYear: (number) | null;
1601
+ };
1602
+
1603
+ export type TeamConferenceChange = {
1604
+ teamId: number;
1605
+ team: string;
1606
+ fromConferenceId: number;
1607
+ fromConference: string;
1608
+ fromConferenceAbbreviation: (string) | null;
1609
+ fromClassification: ((ConferenceClassification) | null);
1610
+ toConferenceId: number;
1611
+ toConference: string;
1612
+ toConferenceAbbreviation: (string) | null;
1613
+ toClassification: ((ConferenceClassification) | null);
1614
+ effectiveYear: number;
1615
+ };
1616
+
1617
+ export type TeamCoreRating = {
1618
+ year: number;
1619
+ throughSeasonType: CoreRatingSeasonType;
1620
+ throughWeek: number;
1621
+ team: string;
1622
+ conference: (string) | null;
1623
+ /**
1624
+ * Offense-minus-defense composite; higher is better.
1625
+ */
1626
+ overall: number;
1627
+ /**
1628
+ * Points created above average per 100 qualifying plays; higher is better.
1629
+ */
1630
+ offense: number;
1631
+ /**
1632
+ * Points allowed above average per 100 qualifying plays; lower is better.
1633
+ */
1634
+ defense: number;
1635
+ offensePlays: number;
1636
+ defensePlays: number;
1637
+ modelVersion: string;
1638
+ };
1639
+
1586
1640
  export type TeamElo = {
1587
1641
  year: number;
1588
1642
  team: string;
@@ -2078,10 +2132,69 @@ export type GetRosterResponse = (Array<RosterPlayer>);
2078
2132
 
2079
2133
  export type GetRosterError = unknown;
2080
2134
 
2135
+ export type GetConferencesData = {
2136
+ query?: {
2137
+ /**
2138
+ * Conference classification.
2139
+ */
2140
+ classification?: ConferenceClassification;
2141
+ /**
2142
+ * Season year used to calculate membership.
2143
+ */
2144
+ year?: number;
2145
+ };
2146
+ };
2147
+
2081
2148
  export type GetConferencesResponse = (Array<Conference>);
2082
2149
 
2083
2150
  export type GetConferencesError = unknown;
2084
2151
 
2152
+ export type GetTeamConferenceChangesData = {
2153
+ query: {
2154
+ /**
2155
+ * Season year.
2156
+ */
2157
+ year: number;
2158
+ };
2159
+ };
2160
+
2161
+ export type GetTeamConferenceChangesResponse = (Array<TeamConferenceChange>);
2162
+
2163
+ export type GetTeamConferenceChangesError = unknown;
2164
+
2165
+ export type GetTeamConferenceAffiliationsData = {
2166
+ query?: {
2167
+ /**
2168
+ * Conference classification.
2169
+ */
2170
+ classification?: ConferenceClassification;
2171
+ /**
2172
+ * Conference name or abbreviation.
2173
+ */
2174
+ conference?: string;
2175
+ /**
2176
+ * Latest season year to include.
2177
+ */
2178
+ maxYear?: number;
2179
+ /**
2180
+ * Earliest season year to include.
2181
+ */
2182
+ minYear?: number;
2183
+ /**
2184
+ * Team school name or abbreviation.
2185
+ */
2186
+ team?: string;
2187
+ /**
2188
+ * Season year. Cannot be combined with `minYear` or `maxYear`.
2189
+ */
2190
+ year?: number;
2191
+ };
2192
+ };
2193
+
2194
+ export type GetTeamConferenceAffiliationsResponse = (Array<TeamConferenceAffiliation>);
2195
+
2196
+ export type GetTeamConferenceAffiliationsError = unknown;
2197
+
2085
2198
  export type GetTalentData = {
2086
2199
  query: {
2087
2200
  /**
@@ -2431,6 +2544,27 @@ export type GetAggregatedTeamRecruitingRatingsResponse = (Array<AggregatedTeamRe
2431
2544
 
2432
2545
  export type GetAggregatedTeamRecruitingRatingsError = unknown;
2433
2546
 
2547
+ export type GetCoreData = {
2548
+ query?: {
2549
+ /**
2550
+ * Conference name or abbreviation.
2551
+ */
2552
+ conference?: string;
2553
+ /**
2554
+ * Exact team name. Required unless `year` is specified.
2555
+ */
2556
+ team?: string;
2557
+ /**
2558
+ * Season year. Required unless `team` is specified.
2559
+ */
2560
+ year?: number;
2561
+ };
2562
+ };
2563
+
2564
+ export type GetCoreResponse = (Array<TeamCoreRating>);
2565
+
2566
+ export type GetCoreError = unknown;
2567
+
2434
2568
  export type GetSpData = {
2435
2569
  query?: {
2436
2570
  /**
package/cfbd-5.22.0.tgz DELETED
Binary file