cfbd 5.14.2 → 5.15.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.
- package/cfbd-5.15.0.tgz +0 -0
- package/dist/sdk.gen.d.ts +5 -1
- package/dist/sdk.gen.js +10 -2
- package/dist/types.gen.d.ts +62 -1
- package/package.json +1 -1
- package/src/sdk.gen.ts +11 -1
- package/src/types.gen.ts +72 -1
- package/cfbd-5.14.2.tgz +0 -0
package/cfbd-5.15.0.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, 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, 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
|
|
@@ -189,6 +189,10 @@ export declare const getLines: <ThrowOnError extends boolean = false>(options?:
|
|
|
189
189
|
* Retrieves information about the user, including their Patreon level and remaining API calls.
|
|
190
190
|
*/
|
|
191
191
|
export declare const getUserInfo: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetUserInfoResponse, unknown, ThrowOnError>;
|
|
192
|
+
/**
|
|
193
|
+
* Retrieves bounded API usage for the authenticated user's shared CFB/CBB call pool.
|
|
194
|
+
*/
|
|
195
|
+
export declare const getUsage: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetUsageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetUsageResponse, unknown, ThrowOnError>;
|
|
192
196
|
/**
|
|
193
197
|
* Retrieves historical game data
|
|
194
198
|
*/
|
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.
|
|
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.getGames = exports.getUsage = exports.getUserInfo = exports.getLines = exports.getLivePlays = exports.getFieldGoalExpectedPoints = exports.getPregameWinProbabilities = exports.getWinProbability = exports.getPredictedPointsAddedByPlayerSeason = exports.getPredictedPointsAddedByPlayerGame = exports.getPredictedPointsAddedByGame = exports.getPredictedPointsAddedByTeam = exports.getPredictedPoints = exports.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 = exports.getGameTeamStats = 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
|
/**
|
|
@@ -392,6 +392,14 @@ var getUserInfo = function (options) {
|
|
|
392
392
|
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
393
|
};
|
|
394
394
|
exports.getUserInfo = getUserInfo;
|
|
395
|
+
/**
|
|
396
|
+
* Retrieves bounded API usage for the authenticated user's shared CFB/CBB call pool.
|
|
397
|
+
*/
|
|
398
|
+
var getUsage = function (options) {
|
|
399
|
+
var _a;
|
|
400
|
+
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' }));
|
|
401
|
+
};
|
|
402
|
+
exports.getUsage = getUsage;
|
|
395
403
|
/**
|
|
396
404
|
* Retrieves historical game data
|
|
397
405
|
*/
|
package/dist/types.gen.d.ts
CHANGED
|
@@ -1387,9 +1387,52 @@ export type TeamTalent = {
|
|
|
1387
1387
|
talent: number;
|
|
1388
1388
|
};
|
|
1389
1389
|
export type TransferEligibility = 'Withdrawn' | 'TBD' | 'PendingAppeal' | 'SittingOne' | 'Immediate';
|
|
1390
|
+
export type UserFeatureAccess = {
|
|
1391
|
+
adjustedMetrics: boolean;
|
|
1392
|
+
weather: boolean;
|
|
1393
|
+
scoreboard: boolean;
|
|
1394
|
+
livePlayByPlay: boolean;
|
|
1395
|
+
graphQl: boolean;
|
|
1396
|
+
};
|
|
1390
1397
|
export type UserInfo = {
|
|
1391
1398
|
patronLevel: number;
|
|
1392
|
-
|
|
1399
|
+
tierName: string;
|
|
1400
|
+
monthlyLimit: (number) | null;
|
|
1401
|
+
remainingCalls: (number) | null;
|
|
1402
|
+
usedCalls: (number) | null;
|
|
1403
|
+
resetAt: string;
|
|
1404
|
+
sharedPool: boolean;
|
|
1405
|
+
products: Array<(string)>;
|
|
1406
|
+
features: UserFeatureAccess;
|
|
1407
|
+
};
|
|
1408
|
+
export type UserUsage = {
|
|
1409
|
+
window: UserUsageWindow;
|
|
1410
|
+
api: UserUsageApi;
|
|
1411
|
+
totals: UserUsageTotals;
|
|
1412
|
+
topEndpoints: Array<UserUsageEndpoint>;
|
|
1413
|
+
recentRequests: Array<UserUsageRecentRequest>;
|
|
1414
|
+
};
|
|
1415
|
+
export type UserUsageApi = 'all' | 'cfb' | 'cbb';
|
|
1416
|
+
export type UserUsageEndpoint = {
|
|
1417
|
+
api: UserUsageApi;
|
|
1418
|
+
endpoint: string;
|
|
1419
|
+
requests: number;
|
|
1420
|
+
lastUsedAt: string;
|
|
1421
|
+
};
|
|
1422
|
+
export type UserUsageRecentRequest = {
|
|
1423
|
+
api: UserUsageApi;
|
|
1424
|
+
endpoint: string;
|
|
1425
|
+
requestedAt: string;
|
|
1426
|
+
};
|
|
1427
|
+
export type UserUsageTotals = {
|
|
1428
|
+
requests: number;
|
|
1429
|
+
cfbRequests: number;
|
|
1430
|
+
cbbRequests: number;
|
|
1431
|
+
uniqueEndpoints: number;
|
|
1432
|
+
};
|
|
1433
|
+
export type UserUsageWindow = {
|
|
1434
|
+
start: string;
|
|
1435
|
+
end: string;
|
|
1393
1436
|
};
|
|
1394
1437
|
export type Venue = {
|
|
1395
1438
|
id: (number) | null;
|
|
@@ -2313,6 +2356,24 @@ export type GetLinesResponse = (Array<BettingGame>);
|
|
|
2313
2356
|
export type GetLinesError = unknown;
|
|
2314
2357
|
export type GetUserInfoResponse = (((UserInfo) | null));
|
|
2315
2358
|
export type GetUserInfoError = unknown;
|
|
2359
|
+
export type GetUsageData = {
|
|
2360
|
+
query?: {
|
|
2361
|
+
/**
|
|
2362
|
+
* Optional API filter: all, cfb, or cbb
|
|
2363
|
+
*/
|
|
2364
|
+
api?: UserUsageApi;
|
|
2365
|
+
/**
|
|
2366
|
+
* Number of trailing days to include, defaults to 7 and is capped at 31
|
|
2367
|
+
*/
|
|
2368
|
+
days?: number;
|
|
2369
|
+
/**
|
|
2370
|
+
* Number of endpoint and recent request rows to return, defaults to 10 and is capped at 50
|
|
2371
|
+
*/
|
|
2372
|
+
limit?: number;
|
|
2373
|
+
};
|
|
2374
|
+
};
|
|
2375
|
+
export type GetUsageResponse = (((UserUsage) | null));
|
|
2376
|
+
export type GetUsageError = unknown;
|
|
2316
2377
|
export type GetGamesData = {
|
|
2317
2378
|
query?: {
|
|
2318
2379
|
/**
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "cfbd",
|
|
3
|
-
"version": "5.
|
|
3
|
+
"version": "5.15.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, 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
|
|
|
@@ -475,6 +475,16 @@ export const getUserInfo = <ThrowOnError extends boolean = false>(options?: Opti
|
|
|
475
475
|
});
|
|
476
476
|
};
|
|
477
477
|
|
|
478
|
+
/**
|
|
479
|
+
* Retrieves bounded API usage for the authenticated user's shared CFB/CBB call pool.
|
|
480
|
+
*/
|
|
481
|
+
export const getUsage = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetUsageData, ThrowOnError>) => {
|
|
482
|
+
return (options?.client ?? client).get<GetUsageResponse, GetUsageError, ThrowOnError>({
|
|
483
|
+
...options,
|
|
484
|
+
url: '/info/usage'
|
|
485
|
+
});
|
|
486
|
+
};
|
|
487
|
+
|
|
478
488
|
/**
|
|
479
489
|
* Retrieves historical game data
|
|
480
490
|
*/
|
package/src/types.gen.ts
CHANGED
|
@@ -1485,9 +1485,59 @@ export type TeamTalent = {
|
|
|
1485
1485
|
|
|
1486
1486
|
export type TransferEligibility = 'Withdrawn' | 'TBD' | 'PendingAppeal' | 'SittingOne' | 'Immediate';
|
|
1487
1487
|
|
|
1488
|
+
export type UserFeatureAccess = {
|
|
1489
|
+
adjustedMetrics: boolean;
|
|
1490
|
+
weather: boolean;
|
|
1491
|
+
scoreboard: boolean;
|
|
1492
|
+
livePlayByPlay: boolean;
|
|
1493
|
+
graphQl: boolean;
|
|
1494
|
+
};
|
|
1495
|
+
|
|
1488
1496
|
export type UserInfo = {
|
|
1489
1497
|
patronLevel: number;
|
|
1490
|
-
|
|
1498
|
+
tierName: string;
|
|
1499
|
+
monthlyLimit: (number) | null;
|
|
1500
|
+
remainingCalls: (number) | null;
|
|
1501
|
+
usedCalls: (number) | null;
|
|
1502
|
+
resetAt: string;
|
|
1503
|
+
sharedPool: boolean;
|
|
1504
|
+
products: Array<(string)>;
|
|
1505
|
+
features: UserFeatureAccess;
|
|
1506
|
+
};
|
|
1507
|
+
|
|
1508
|
+
export type UserUsage = {
|
|
1509
|
+
window: UserUsageWindow;
|
|
1510
|
+
api: UserUsageApi;
|
|
1511
|
+
totals: UserUsageTotals;
|
|
1512
|
+
topEndpoints: Array<UserUsageEndpoint>;
|
|
1513
|
+
recentRequests: Array<UserUsageRecentRequest>;
|
|
1514
|
+
};
|
|
1515
|
+
|
|
1516
|
+
export type UserUsageApi = 'all' | 'cfb' | 'cbb';
|
|
1517
|
+
|
|
1518
|
+
export type UserUsageEndpoint = {
|
|
1519
|
+
api: UserUsageApi;
|
|
1520
|
+
endpoint: string;
|
|
1521
|
+
requests: number;
|
|
1522
|
+
lastUsedAt: string;
|
|
1523
|
+
};
|
|
1524
|
+
|
|
1525
|
+
export type UserUsageRecentRequest = {
|
|
1526
|
+
api: UserUsageApi;
|
|
1527
|
+
endpoint: string;
|
|
1528
|
+
requestedAt: string;
|
|
1529
|
+
};
|
|
1530
|
+
|
|
1531
|
+
export type UserUsageTotals = {
|
|
1532
|
+
requests: number;
|
|
1533
|
+
cfbRequests: number;
|
|
1534
|
+
cbbRequests: number;
|
|
1535
|
+
uniqueEndpoints: number;
|
|
1536
|
+
};
|
|
1537
|
+
|
|
1538
|
+
export type UserUsageWindow = {
|
|
1539
|
+
start: string;
|
|
1540
|
+
end: string;
|
|
1491
1541
|
};
|
|
1492
1542
|
|
|
1493
1543
|
export type Venue = {
|
|
@@ -2547,6 +2597,27 @@ export type GetUserInfoResponse = (((UserInfo) | null));
|
|
|
2547
2597
|
|
|
2548
2598
|
export type GetUserInfoError = unknown;
|
|
2549
2599
|
|
|
2600
|
+
export type GetUsageData = {
|
|
2601
|
+
query?: {
|
|
2602
|
+
/**
|
|
2603
|
+
* Optional API filter: all, cfb, or cbb
|
|
2604
|
+
*/
|
|
2605
|
+
api?: UserUsageApi;
|
|
2606
|
+
/**
|
|
2607
|
+
* Number of trailing days to include, defaults to 7 and is capped at 31
|
|
2608
|
+
*/
|
|
2609
|
+
days?: number;
|
|
2610
|
+
/**
|
|
2611
|
+
* Number of endpoint and recent request rows to return, defaults to 10 and is capped at 50
|
|
2612
|
+
*/
|
|
2613
|
+
limit?: number;
|
|
2614
|
+
};
|
|
2615
|
+
};
|
|
2616
|
+
|
|
2617
|
+
export type GetUsageResponse = (((UserUsage) | null));
|
|
2618
|
+
|
|
2619
|
+
export type GetUsageError = unknown;
|
|
2620
|
+
|
|
2550
2621
|
export type GetGamesData = {
|
|
2551
2622
|
query?: {
|
|
2552
2623
|
/**
|
package/cfbd-5.14.2.tgz
DELETED
|
Binary file
|