cfbd 5.14.2 → 5.16.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, 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, 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, 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';
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
@@ -53,6 +53,14 @@ export declare const getVenues: <ThrowOnError extends boolean = false>(options?:
53
53
  * Retrieves aggregated player statistics for a given season
54
54
  */
55
55
  export declare const getPlayerSeasonStats: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPlayerSeasonStatsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlayerSeasonStatsResponse, unknown, ThrowOnError>;
56
+ /**
57
+ * Retrieves player passing and rushing success rates by season
58
+ */
59
+ export declare const getPlayerSeasonSuccessRates: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetPlayerSeasonSuccessRatesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlayerSeasonSuccessRatesResponse, unknown, ThrowOnError>;
60
+ /**
61
+ * Retrieves player passing and rushing success rates by game
62
+ */
63
+ export declare const getPlayerGameSuccessRates: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPlayerGameSuccessRatesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlayerGameSuccessRatesResponse, unknown, ThrowOnError>;
56
64
  /**
57
65
  * Retrieves aggregated team season statistics
58
66
  */
@@ -189,6 +197,10 @@ export declare const getLines: <ThrowOnError extends boolean = false>(options?:
189
197
  * Retrieves information about the user, including their Patreon level and remaining API calls.
190
198
  */
191
199
  export declare const getUserInfo: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetUserInfoResponse, unknown, ThrowOnError>;
200
+ /**
201
+ * Retrieves bounded API usage for the authenticated user's shared CFB/CBB call pool.
202
+ */
203
+ export declare const getUsage: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetUsageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetUsageResponse, unknown, ThrowOnError>;
192
204
  /**
193
205
  * Retrieves historical game data
194
206
  */
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.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.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.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 = void 0;
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;
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
  /**
@@ -120,6 +120,22 @@ var getPlayerSeasonStats = function (options) {
120
120
  return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/stats/player/season' }));
121
121
  };
122
122
  exports.getPlayerSeasonStats = getPlayerSeasonStats;
123
+ /**
124
+ * Retrieves player passing and rushing success rates by season
125
+ */
126
+ var getPlayerSeasonSuccessRates = function (options) {
127
+ var _a;
128
+ return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/stats/player/success' }));
129
+ };
130
+ exports.getPlayerSeasonSuccessRates = getPlayerSeasonSuccessRates;
131
+ /**
132
+ * Retrieves player passing and rushing success rates by game
133
+ */
134
+ var getPlayerGameSuccessRates = function (options) {
135
+ var _a;
136
+ return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/stats/player/success/game' }));
137
+ };
138
+ exports.getPlayerGameSuccessRates = getPlayerGameSuccessRates;
123
139
  /**
124
140
  * Retrieves aggregated team season statistics
125
141
  */
@@ -392,6 +408,14 @@ var getUserInfo = function (options) {
392
408
  return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/info' }));
393
409
  };
394
410
  exports.getUserInfo = getUserInfo;
411
+ /**
412
+ * Retrieves bounded API usage for the authenticated user's shared CFB/CBB call pool.
413
+ */
414
+ var getUsage = function (options) {
415
+ var _a;
416
+ return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/info/usage' }));
417
+ };
418
+ exports.getUsage = getUsage;
395
419
  /**
396
420
  * Retrieves historical game data
397
421
  */
@@ -765,6 +765,20 @@ export type PlayerGamePredictedPointsAdded = {
765
765
  all: number;
766
766
  };
767
767
  };
768
+ export type PlayerGameSuccessRate = {
769
+ season: number;
770
+ seasonType: SeasonTypeDB;
771
+ week: number;
772
+ gameId: number;
773
+ id: string;
774
+ name: string;
775
+ position: string;
776
+ team: string;
777
+ conference: string;
778
+ opponent: string;
779
+ passing: PlayerSuccessRateSplit;
780
+ rushing: PlayerSuccessRateSplit;
781
+ };
768
782
  export type PlayerGameUsage = {
769
783
  total: number;
770
784
  quarter1: (number) | null;
@@ -883,6 +897,16 @@ export type PlayerSeasonPredictedPointsAdded = {
883
897
  all: number;
884
898
  };
885
899
  };
900
+ export type PlayerSeasonSuccessRate = {
901
+ season: number;
902
+ id: string;
903
+ name: string;
904
+ position: string;
905
+ team: string;
906
+ conference: string;
907
+ passing: PlayerSuccessRateSplit;
908
+ rushing: PlayerSuccessRateSplit;
909
+ };
886
910
  export type PlayerStat = {
887
911
  season: number;
888
912
  playerId: string;
@@ -903,6 +927,11 @@ export type PlayerStatsByQuarter = {
903
927
  rushing: number;
904
928
  passing: number;
905
929
  };
930
+ export type PlayerSuccessRateSplit = {
931
+ plays: number;
932
+ successes: number;
933
+ successRate: (number) | null;
934
+ };
906
935
  export type PlayerTransfer = {
907
936
  season: number;
908
937
  firstName: string;
@@ -1387,9 +1416,52 @@ export type TeamTalent = {
1387
1416
  talent: number;
1388
1417
  };
1389
1418
  export type TransferEligibility = 'Withdrawn' | 'TBD' | 'PendingAppeal' | 'SittingOne' | 'Immediate';
1419
+ export type UserFeatureAccess = {
1420
+ adjustedMetrics: boolean;
1421
+ weather: boolean;
1422
+ scoreboard: boolean;
1423
+ livePlayByPlay: boolean;
1424
+ graphQl: boolean;
1425
+ };
1390
1426
  export type UserInfo = {
1391
1427
  patronLevel: number;
1392
- remainingCalls: number;
1428
+ tierName: string;
1429
+ monthlyLimit: (number) | null;
1430
+ remainingCalls: (number) | null;
1431
+ usedCalls: (number) | null;
1432
+ resetAt: string;
1433
+ sharedPool: boolean;
1434
+ products: Array<(string)>;
1435
+ features: UserFeatureAccess;
1436
+ };
1437
+ export type UserUsage = {
1438
+ window: UserUsageWindow;
1439
+ api: UserUsageApi;
1440
+ totals: UserUsageTotals;
1441
+ topEndpoints: Array<UserUsageEndpoint>;
1442
+ recentRequests: Array<UserUsageRecentRequest>;
1443
+ };
1444
+ export type UserUsageApi = 'all' | 'cfb' | 'cbb';
1445
+ export type UserUsageEndpoint = {
1446
+ api: UserUsageApi;
1447
+ endpoint: string;
1448
+ requests: number;
1449
+ lastUsedAt: string;
1450
+ };
1451
+ export type UserUsageRecentRequest = {
1452
+ api: UserUsageApi;
1453
+ endpoint: string;
1454
+ requestedAt: string;
1455
+ };
1456
+ export type UserUsageTotals = {
1457
+ requests: number;
1458
+ cfbRequests: number;
1459
+ cbbRequests: number;
1460
+ uniqueEndpoints: number;
1461
+ };
1462
+ export type UserUsageWindow = {
1463
+ start: string;
1464
+ end: string;
1393
1465
  };
1394
1466
  export type Venue = {
1395
1467
  id: (number) | null;
@@ -1617,6 +1689,86 @@ export type GetPlayerSeasonStatsData = {
1617
1689
  };
1618
1690
  export type GetPlayerSeasonStatsResponse = (Array<PlayerStat>);
1619
1691
  export type GetPlayerSeasonStatsError = unknown;
1692
+ export type GetPlayerSeasonSuccessRatesData = {
1693
+ query?: {
1694
+ /**
1695
+ * Optional conference abbreviation filter
1696
+ */
1697
+ conference?: string;
1698
+ /**
1699
+ * Optional ending week range
1700
+ */
1701
+ endWeek?: number;
1702
+ /**
1703
+ * Optional flag to exclude garbage time plays
1704
+ */
1705
+ excludeGarbageTime?: boolean;
1706
+ /**
1707
+ * Player ID filter, required if year not specified
1708
+ */
1709
+ playerId?: number;
1710
+ /**
1711
+ * Optional season type filter
1712
+ */
1713
+ seasonType?: SeasonType;
1714
+ /**
1715
+ * Optional starting week range
1716
+ */
1717
+ startWeek?: number;
1718
+ /**
1719
+ * Optional team filter
1720
+ */
1721
+ team?: string;
1722
+ /**
1723
+ * Optional minimum credited passing plus rushing plays
1724
+ */
1725
+ threshold?: number;
1726
+ /**
1727
+ * Year filter, required if playerId not specified
1728
+ */
1729
+ year?: number;
1730
+ };
1731
+ };
1732
+ export type GetPlayerSeasonSuccessRatesResponse = (Array<PlayerSeasonSuccessRate>);
1733
+ export type GetPlayerSeasonSuccessRatesError = unknown;
1734
+ export type GetPlayerGameSuccessRatesData = {
1735
+ query: {
1736
+ /**
1737
+ * Optional conference abbreviation filter
1738
+ */
1739
+ conference?: string;
1740
+ /**
1741
+ * Optional flag to exclude garbage time plays
1742
+ */
1743
+ excludeGarbageTime?: boolean;
1744
+ /**
1745
+ * Optional player ID filter
1746
+ */
1747
+ playerId?: number;
1748
+ /**
1749
+ * Optional season type filter
1750
+ */
1751
+ seasonType?: SeasonType;
1752
+ /**
1753
+ * Optional team filter
1754
+ */
1755
+ team?: string;
1756
+ /**
1757
+ * Optional minimum credited passing plus rushing plays
1758
+ */
1759
+ threshold?: number;
1760
+ /**
1761
+ * Week filter, required if team and playerId not specified
1762
+ */
1763
+ week?: number;
1764
+ /**
1765
+ * Required year filter
1766
+ */
1767
+ year: number;
1768
+ };
1769
+ };
1770
+ export type GetPlayerGameSuccessRatesResponse = (Array<PlayerGameSuccessRate>);
1771
+ export type GetPlayerGameSuccessRatesError = unknown;
1620
1772
  export type GetTeamStatsData = {
1621
1773
  query?: {
1622
1774
  /**
@@ -2313,6 +2465,24 @@ export type GetLinesResponse = (Array<BettingGame>);
2313
2465
  export type GetLinesError = unknown;
2314
2466
  export type GetUserInfoResponse = (((UserInfo) | null));
2315
2467
  export type GetUserInfoError = unknown;
2468
+ export type GetUsageData = {
2469
+ query?: {
2470
+ /**
2471
+ * Optional API filter: all, cfb, or cbb
2472
+ */
2473
+ api?: UserUsageApi;
2474
+ /**
2475
+ * Number of trailing days to include, defaults to 7 and is capped at 31
2476
+ */
2477
+ days?: number;
2478
+ /**
2479
+ * Number of endpoint and recent request rows to return, defaults to 10 and is capped at 50
2480
+ */
2481
+ limit?: number;
2482
+ };
2483
+ };
2484
+ export type GetUsageResponse = (((UserUsage) | null));
2485
+ export type GetUsageError = unknown;
2316
2486
  export type GetGamesData = {
2317
2487
  query?: {
2318
2488
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "cfbd",
3
- "version": "5.14.2",
3
+ "version": "5.16.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, 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, 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, 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
 
@@ -135,6 +135,26 @@ export const getPlayerSeasonStats = <ThrowOnError extends boolean = false>(optio
135
135
  });
136
136
  };
137
137
 
138
+ /**
139
+ * Retrieves player passing and rushing success rates by season
140
+ */
141
+ export const getPlayerSeasonSuccessRates = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetPlayerSeasonSuccessRatesData, ThrowOnError>) => {
142
+ return (options?.client ?? client).get<GetPlayerSeasonSuccessRatesResponse, GetPlayerSeasonSuccessRatesError, ThrowOnError>({
143
+ ...options,
144
+ url: '/stats/player/success'
145
+ });
146
+ };
147
+
148
+ /**
149
+ * Retrieves player passing and rushing success rates by game
150
+ */
151
+ export const getPlayerGameSuccessRates = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPlayerGameSuccessRatesData, ThrowOnError>) => {
152
+ return (options?.client ?? client).get<GetPlayerGameSuccessRatesResponse, GetPlayerGameSuccessRatesError, ThrowOnError>({
153
+ ...options,
154
+ url: '/stats/player/success/game'
155
+ });
156
+ };
157
+
138
158
  /**
139
159
  * Retrieves aggregated team season statistics
140
160
  */
@@ -475,6 +495,16 @@ export const getUserInfo = <ThrowOnError extends boolean = false>(options?: Opti
475
495
  });
476
496
  };
477
497
 
498
+ /**
499
+ * Retrieves bounded API usage for the authenticated user's shared CFB/CBB call pool.
500
+ */
501
+ export const getUsage = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetUsageData, ThrowOnError>) => {
502
+ return (options?.client ?? client).get<GetUsageResponse, GetUsageError, ThrowOnError>({
503
+ ...options,
504
+ url: '/info/usage'
505
+ });
506
+ };
507
+
478
508
  /**
479
509
  * Retrieves historical game data
480
510
  */
package/src/types.gen.ts CHANGED
@@ -811,6 +811,21 @@ export type PlayerGamePredictedPointsAdded = {
811
811
  };
812
812
  };
813
813
 
814
+ export type PlayerGameSuccessRate = {
815
+ season: number;
816
+ seasonType: SeasonTypeDB;
817
+ week: number;
818
+ gameId: number;
819
+ id: string;
820
+ name: string;
821
+ position: string;
822
+ team: string;
823
+ conference: string;
824
+ opponent: string;
825
+ passing: PlayerSuccessRateSplit;
826
+ rushing: PlayerSuccessRateSplit;
827
+ };
828
+
814
829
  export type PlayerGameUsage = {
815
830
  total: number;
816
831
  quarter1: (number) | null;
@@ -938,6 +953,17 @@ export type PlayerSeasonPredictedPointsAdded = {
938
953
  };
939
954
  };
940
955
 
956
+ export type PlayerSeasonSuccessRate = {
957
+ season: number;
958
+ id: string;
959
+ name: string;
960
+ position: string;
961
+ team: string;
962
+ conference: string;
963
+ passing: PlayerSuccessRateSplit;
964
+ rushing: PlayerSuccessRateSplit;
965
+ };
966
+
941
967
  export type PlayerStat = {
942
968
  season: number;
943
969
  playerId: string;
@@ -960,6 +986,12 @@ export type PlayerStatsByQuarter = {
960
986
  passing: number;
961
987
  };
962
988
 
989
+ export type PlayerSuccessRateSplit = {
990
+ plays: number;
991
+ successes: number;
992
+ successRate: (number) | null;
993
+ };
994
+
963
995
  export type PlayerTransfer = {
964
996
  season: number;
965
997
  firstName: string;
@@ -1485,9 +1517,59 @@ export type TeamTalent = {
1485
1517
 
1486
1518
  export type TransferEligibility = 'Withdrawn' | 'TBD' | 'PendingAppeal' | 'SittingOne' | 'Immediate';
1487
1519
 
1520
+ export type UserFeatureAccess = {
1521
+ adjustedMetrics: boolean;
1522
+ weather: boolean;
1523
+ scoreboard: boolean;
1524
+ livePlayByPlay: boolean;
1525
+ graphQl: boolean;
1526
+ };
1527
+
1488
1528
  export type UserInfo = {
1489
1529
  patronLevel: number;
1490
- remainingCalls: number;
1530
+ tierName: string;
1531
+ monthlyLimit: (number) | null;
1532
+ remainingCalls: (number) | null;
1533
+ usedCalls: (number) | null;
1534
+ resetAt: string;
1535
+ sharedPool: boolean;
1536
+ products: Array<(string)>;
1537
+ features: UserFeatureAccess;
1538
+ };
1539
+
1540
+ export type UserUsage = {
1541
+ window: UserUsageWindow;
1542
+ api: UserUsageApi;
1543
+ totals: UserUsageTotals;
1544
+ topEndpoints: Array<UserUsageEndpoint>;
1545
+ recentRequests: Array<UserUsageRecentRequest>;
1546
+ };
1547
+
1548
+ export type UserUsageApi = 'all' | 'cfb' | 'cbb';
1549
+
1550
+ export type UserUsageEndpoint = {
1551
+ api: UserUsageApi;
1552
+ endpoint: string;
1553
+ requests: number;
1554
+ lastUsedAt: string;
1555
+ };
1556
+
1557
+ export type UserUsageRecentRequest = {
1558
+ api: UserUsageApi;
1559
+ endpoint: string;
1560
+ requestedAt: string;
1561
+ };
1562
+
1563
+ export type UserUsageTotals = {
1564
+ requests: number;
1565
+ cfbRequests: number;
1566
+ cbbRequests: number;
1567
+ uniqueEndpoints: number;
1568
+ };
1569
+
1570
+ export type UserUsageWindow = {
1571
+ start: string;
1572
+ end: string;
1491
1573
  };
1492
1574
 
1493
1575
  export type Venue = {
@@ -1754,6 +1836,92 @@ export type GetPlayerSeasonStatsResponse = (Array<PlayerStat>);
1754
1836
 
1755
1837
  export type GetPlayerSeasonStatsError = unknown;
1756
1838
 
1839
+ export type GetPlayerSeasonSuccessRatesData = {
1840
+ query?: {
1841
+ /**
1842
+ * Optional conference abbreviation filter
1843
+ */
1844
+ conference?: string;
1845
+ /**
1846
+ * Optional ending week range
1847
+ */
1848
+ endWeek?: number;
1849
+ /**
1850
+ * Optional flag to exclude garbage time plays
1851
+ */
1852
+ excludeGarbageTime?: boolean;
1853
+ /**
1854
+ * Player ID filter, required if year not specified
1855
+ */
1856
+ playerId?: number;
1857
+ /**
1858
+ * Optional season type filter
1859
+ */
1860
+ seasonType?: SeasonType;
1861
+ /**
1862
+ * Optional starting week range
1863
+ */
1864
+ startWeek?: number;
1865
+ /**
1866
+ * Optional team filter
1867
+ */
1868
+ team?: string;
1869
+ /**
1870
+ * Optional minimum credited passing plus rushing plays
1871
+ */
1872
+ threshold?: number;
1873
+ /**
1874
+ * Year filter, required if playerId not specified
1875
+ */
1876
+ year?: number;
1877
+ };
1878
+ };
1879
+
1880
+ export type GetPlayerSeasonSuccessRatesResponse = (Array<PlayerSeasonSuccessRate>);
1881
+
1882
+ export type GetPlayerSeasonSuccessRatesError = unknown;
1883
+
1884
+ export type GetPlayerGameSuccessRatesData = {
1885
+ query: {
1886
+ /**
1887
+ * Optional conference abbreviation filter
1888
+ */
1889
+ conference?: string;
1890
+ /**
1891
+ * Optional flag to exclude garbage time plays
1892
+ */
1893
+ excludeGarbageTime?: boolean;
1894
+ /**
1895
+ * Optional player ID filter
1896
+ */
1897
+ playerId?: number;
1898
+ /**
1899
+ * Optional season type filter
1900
+ */
1901
+ seasonType?: SeasonType;
1902
+ /**
1903
+ * Optional team filter
1904
+ */
1905
+ team?: string;
1906
+ /**
1907
+ * Optional minimum credited passing plus rushing plays
1908
+ */
1909
+ threshold?: number;
1910
+ /**
1911
+ * Week filter, required if team and playerId not specified
1912
+ */
1913
+ week?: number;
1914
+ /**
1915
+ * Required year filter
1916
+ */
1917
+ year: number;
1918
+ };
1919
+ };
1920
+
1921
+ export type GetPlayerGameSuccessRatesResponse = (Array<PlayerGameSuccessRate>);
1922
+
1923
+ export type GetPlayerGameSuccessRatesError = unknown;
1924
+
1757
1925
  export type GetTeamStatsData = {
1758
1926
  query?: {
1759
1927
  /**
@@ -2547,6 +2715,27 @@ export type GetUserInfoResponse = (((UserInfo) | null));
2547
2715
 
2548
2716
  export type GetUserInfoError = unknown;
2549
2717
 
2718
+ export type GetUsageData = {
2719
+ query?: {
2720
+ /**
2721
+ * Optional API filter: all, cfb, or cbb
2722
+ */
2723
+ api?: UserUsageApi;
2724
+ /**
2725
+ * Number of trailing days to include, defaults to 7 and is capped at 31
2726
+ */
2727
+ days?: number;
2728
+ /**
2729
+ * Number of endpoint and recent request rows to return, defaults to 10 and is capped at 50
2730
+ */
2731
+ limit?: number;
2732
+ };
2733
+ };
2734
+
2735
+ export type GetUsageResponse = (((UserUsage) | null));
2736
+
2737
+ export type GetUsageError = unknown;
2738
+
2550
2739
  export type GetGamesData = {
2551
2740
  query?: {
2552
2741
  /**
package/cfbd-5.14.2.tgz DELETED
Binary file