cfbd 5.13.2 → 5.14.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/.github/workflows/npm-publish.yml +3 -3
- package/cfbd-5.14.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 +67 -0
- package/package.json +1 -1
- package/src/sdk.gen.ts +11 -1
- package/src/types.gen.ts +74 -0
- package/cfbd-5.13.2.tgz +0 -0
|
@@ -4,11 +4,13 @@ on:
|
|
|
4
4
|
push:
|
|
5
5
|
branches:
|
|
6
6
|
- main
|
|
7
|
+
workflow_dispatch:
|
|
7
8
|
|
|
8
9
|
jobs:
|
|
9
10
|
deploy:
|
|
10
11
|
runs-on: ubuntu-latest
|
|
11
12
|
permissions:
|
|
13
|
+
contents: read
|
|
12
14
|
id-token: write
|
|
13
15
|
steps:
|
|
14
16
|
- name: Checkout repo
|
|
@@ -25,6 +27,4 @@ jobs:
|
|
|
25
27
|
yarn build
|
|
26
28
|
npm pack
|
|
27
29
|
- name: Publish to npm
|
|
28
|
-
run: npm publish --
|
|
29
|
-
env:
|
|
30
|
-
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
|
|
30
|
+
run: npm publish --access public
|
package/cfbd-5.14.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, 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, 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
|
|
@@ -133,6 +133,10 @@ export declare const searchPlayers: <ThrowOnError extends boolean = false>(optio
|
|
|
133
133
|
* Retrieves player usage data for a given season
|
|
134
134
|
*/
|
|
135
135
|
export declare const getPlayerUsage: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPlayerUsageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlayerUsageResponse, unknown, ThrowOnError>;
|
|
136
|
+
/**
|
|
137
|
+
* Retrieves a player season overview with box score, usage, and PPA data
|
|
138
|
+
*/
|
|
139
|
+
export declare const getPlayerSeasonOverview: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPlayerSeasonOverviewData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").PlayerSeasonOverview, unknown, ThrowOnError>;
|
|
136
140
|
/**
|
|
137
141
|
* Retrieves returning production data. Either a year or team filter must be specified.
|
|
138
142
|
*/
|
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 = void 0;
|
|
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;
|
|
17
17
|
var client_fetch_1 = require("@hey-api/client-fetch");
|
|
18
18
|
exports.client = (0, client_fetch_1.createClient)((0, client_fetch_1.createConfig)({ baseUrl: 'https://api.collegefootballdata.com' }));
|
|
19
19
|
/**
|
|
@@ -280,6 +280,14 @@ var getPlayerUsage = function (options) {
|
|
|
280
280
|
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/player/usage' }));
|
|
281
281
|
};
|
|
282
282
|
exports.getPlayerUsage = getPlayerUsage;
|
|
283
|
+
/**
|
|
284
|
+
* Retrieves a player season overview with box score, usage, and PPA data
|
|
285
|
+
*/
|
|
286
|
+
var getPlayerSeasonOverview = function (options) {
|
|
287
|
+
var _a;
|
|
288
|
+
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/player/season/overview' }));
|
|
289
|
+
};
|
|
290
|
+
exports.getPlayerSeasonOverview = getPlayerSeasonOverview;
|
|
283
291
|
/**
|
|
284
292
|
* Retrieves returning production data. Either a year or team filter must be specified.
|
|
285
293
|
*/
|
package/dist/types.gen.d.ts
CHANGED
|
@@ -802,6 +802,59 @@ export type PlayerSearchResult = {
|
|
|
802
802
|
teamColor: string;
|
|
803
803
|
teamColorSecondary: string;
|
|
804
804
|
};
|
|
805
|
+
export type PlayerSeasonOverview = {
|
|
806
|
+
season: number;
|
|
807
|
+
id: string;
|
|
808
|
+
name: string;
|
|
809
|
+
position: string;
|
|
810
|
+
team: string;
|
|
811
|
+
conference: string;
|
|
812
|
+
games: number;
|
|
813
|
+
boxScoreStats: {
|
|
814
|
+
categories: Array<PlayerSeasonOverviewCategory>;
|
|
815
|
+
};
|
|
816
|
+
usage?: {
|
|
817
|
+
passingDowns: (number) | null;
|
|
818
|
+
standardDowns: (number) | null;
|
|
819
|
+
thirdDown: (number) | null;
|
|
820
|
+
secondDown: (number) | null;
|
|
821
|
+
firstDown: (number) | null;
|
|
822
|
+
rush: (number) | null;
|
|
823
|
+
pass: (number) | null;
|
|
824
|
+
overall: (number) | null;
|
|
825
|
+
};
|
|
826
|
+
ppa?: PlayerSeasonOverviewPPA;
|
|
827
|
+
};
|
|
828
|
+
export type PlayerSeasonOverviewCategory = {
|
|
829
|
+
name: string;
|
|
830
|
+
stats: Array<PlayerSeasonOverviewStat>;
|
|
831
|
+
};
|
|
832
|
+
export type PlayerSeasonOverviewPPA = {
|
|
833
|
+
average: {
|
|
834
|
+
passingDowns?: number;
|
|
835
|
+
standardDowns?: number;
|
|
836
|
+
thirdDown?: number;
|
|
837
|
+
secondDown?: number;
|
|
838
|
+
firstDown?: number;
|
|
839
|
+
rush?: number;
|
|
840
|
+
pass?: number;
|
|
841
|
+
all: number;
|
|
842
|
+
};
|
|
843
|
+
total: {
|
|
844
|
+
passingDowns?: number;
|
|
845
|
+
standardDowns?: number;
|
|
846
|
+
thirdDown?: number;
|
|
847
|
+
secondDown?: number;
|
|
848
|
+
firstDown?: number;
|
|
849
|
+
rush?: number;
|
|
850
|
+
pass?: number;
|
|
851
|
+
all: number;
|
|
852
|
+
};
|
|
853
|
+
};
|
|
854
|
+
export type PlayerSeasonOverviewStat = {
|
|
855
|
+
name: string;
|
|
856
|
+
value: string;
|
|
857
|
+
};
|
|
805
858
|
export type PlayerSeasonPredictedPointsAdded = {
|
|
806
859
|
season: number;
|
|
807
860
|
id: string;
|
|
@@ -1992,6 +2045,20 @@ export type GetPlayerUsageData = {
|
|
|
1992
2045
|
};
|
|
1993
2046
|
export type GetPlayerUsageResponse = (Array<PlayerUsage>);
|
|
1994
2047
|
export type GetPlayerUsageError = unknown;
|
|
2048
|
+
export type GetPlayerSeasonOverviewData = {
|
|
2049
|
+
query: {
|
|
2050
|
+
/**
|
|
2051
|
+
* Required player id filter
|
|
2052
|
+
*/
|
|
2053
|
+
playerId: number;
|
|
2054
|
+
/**
|
|
2055
|
+
* Required year filter
|
|
2056
|
+
*/
|
|
2057
|
+
year: number;
|
|
2058
|
+
};
|
|
2059
|
+
};
|
|
2060
|
+
export type GetPlayerSeasonOverviewResponse = (PlayerSeasonOverview);
|
|
2061
|
+
export type GetPlayerSeasonOverviewError = unknown;
|
|
1995
2062
|
export type GetReturningProductionData = {
|
|
1996
2063
|
query?: {
|
|
1997
2064
|
/**
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "cfbd",
|
|
3
|
-
"version": "5.
|
|
3
|
+
"version": "5.14.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, 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, GetGamesData, GetGamesError, GetGamesResponse, GetGameTeamStatsData, GetGameTeamStatsError, GetGameTeamStatsResponse, GetGamePlayerStatsData, GetGamePlayerStatsError, GetGamePlayerStatsResponse, GetMediaData, GetMediaError, GetMediaResponse, GetWeatherData, GetWeatherError, GetWeatherResponse, GetRecordsData, GetRecordsError, GetRecordsResponse, GetCalendarData, GetCalendarError, GetCalendarResponse, GetScoreboardData, GetScoreboardError, GetScoreboardResponse, GetDrivesData, GetDrivesError, GetDrivesResponse, GetDraftTeamsError, GetDraftTeamsResponse, GetDraftPositionsError, GetDraftPositionsResponse, GetDraftPicksData, GetDraftPicksError, GetDraftPicksResponse, GetCoachesData, GetCoachesError, GetCoachesResponse, GetAdvancedBoxScoreData, GetAdvancedBoxScoreError, GetAdvancedBoxScoreResponse } from './types.gen';
|
|
5
5
|
|
|
6
6
|
export const client = createClient(createConfig({ baseUrl: 'https://api.collegefootballdata.com' }));
|
|
7
7
|
|
|
@@ -335,6 +335,16 @@ export const getPlayerUsage = <ThrowOnError extends boolean = false>(options: Op
|
|
|
335
335
|
});
|
|
336
336
|
};
|
|
337
337
|
|
|
338
|
+
/**
|
|
339
|
+
* Retrieves a player season overview with box score, usage, and PPA data
|
|
340
|
+
*/
|
|
341
|
+
export const getPlayerSeasonOverview = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPlayerSeasonOverviewData, ThrowOnError>) => {
|
|
342
|
+
return (options?.client ?? client).get<GetPlayerSeasonOverviewResponse, GetPlayerSeasonOverviewError, ThrowOnError>({
|
|
343
|
+
...options,
|
|
344
|
+
url: '/player/season/overview'
|
|
345
|
+
});
|
|
346
|
+
};
|
|
347
|
+
|
|
338
348
|
/**
|
|
339
349
|
* Retrieves returning production data. Either a year or team filter must be specified.
|
|
340
350
|
*/
|
package/src/types.gen.ts
CHANGED
|
@@ -852,6 +852,63 @@ export type PlayerSearchResult = {
|
|
|
852
852
|
teamColorSecondary: string;
|
|
853
853
|
};
|
|
854
854
|
|
|
855
|
+
export type PlayerSeasonOverview = {
|
|
856
|
+
season: number;
|
|
857
|
+
id: string;
|
|
858
|
+
name: string;
|
|
859
|
+
position: string;
|
|
860
|
+
team: string;
|
|
861
|
+
conference: string;
|
|
862
|
+
games: number;
|
|
863
|
+
boxScoreStats: {
|
|
864
|
+
categories: Array<PlayerSeasonOverviewCategory>;
|
|
865
|
+
};
|
|
866
|
+
usage?: {
|
|
867
|
+
passingDowns: (number) | null;
|
|
868
|
+
standardDowns: (number) | null;
|
|
869
|
+
thirdDown: (number) | null;
|
|
870
|
+
secondDown: (number) | null;
|
|
871
|
+
firstDown: (number) | null;
|
|
872
|
+
rush: (number) | null;
|
|
873
|
+
pass: (number) | null;
|
|
874
|
+
overall: (number) | null;
|
|
875
|
+
};
|
|
876
|
+
ppa?: PlayerSeasonOverviewPPA;
|
|
877
|
+
};
|
|
878
|
+
|
|
879
|
+
export type PlayerSeasonOverviewCategory = {
|
|
880
|
+
name: string;
|
|
881
|
+
stats: Array<PlayerSeasonOverviewStat>;
|
|
882
|
+
};
|
|
883
|
+
|
|
884
|
+
export type PlayerSeasonOverviewPPA = {
|
|
885
|
+
average: {
|
|
886
|
+
passingDowns?: number;
|
|
887
|
+
standardDowns?: number;
|
|
888
|
+
thirdDown?: number;
|
|
889
|
+
secondDown?: number;
|
|
890
|
+
firstDown?: number;
|
|
891
|
+
rush?: number;
|
|
892
|
+
pass?: number;
|
|
893
|
+
all: number;
|
|
894
|
+
};
|
|
895
|
+
total: {
|
|
896
|
+
passingDowns?: number;
|
|
897
|
+
standardDowns?: number;
|
|
898
|
+
thirdDown?: number;
|
|
899
|
+
secondDown?: number;
|
|
900
|
+
firstDown?: number;
|
|
901
|
+
rush?: number;
|
|
902
|
+
pass?: number;
|
|
903
|
+
all: number;
|
|
904
|
+
};
|
|
905
|
+
};
|
|
906
|
+
|
|
907
|
+
export type PlayerSeasonOverviewStat = {
|
|
908
|
+
name: string;
|
|
909
|
+
value: string;
|
|
910
|
+
};
|
|
911
|
+
|
|
855
912
|
export type PlayerSeasonPredictedPointsAdded = {
|
|
856
913
|
season: number;
|
|
857
914
|
id: string;
|
|
@@ -2182,6 +2239,23 @@ export type GetPlayerUsageResponse = (Array<PlayerUsage>);
|
|
|
2182
2239
|
|
|
2183
2240
|
export type GetPlayerUsageError = unknown;
|
|
2184
2241
|
|
|
2242
|
+
export type GetPlayerSeasonOverviewData = {
|
|
2243
|
+
query: {
|
|
2244
|
+
/**
|
|
2245
|
+
* Required player id filter
|
|
2246
|
+
*/
|
|
2247
|
+
playerId: number;
|
|
2248
|
+
/**
|
|
2249
|
+
* Required year filter
|
|
2250
|
+
*/
|
|
2251
|
+
year: number;
|
|
2252
|
+
};
|
|
2253
|
+
};
|
|
2254
|
+
|
|
2255
|
+
export type GetPlayerSeasonOverviewResponse = (PlayerSeasonOverview);
|
|
2256
|
+
|
|
2257
|
+
export type GetPlayerSeasonOverviewError = unknown;
|
|
2258
|
+
|
|
2185
2259
|
export type GetReturningProductionData = {
|
|
2186
2260
|
query?: {
|
|
2187
2261
|
/**
|
package/cfbd-5.13.2.tgz
DELETED
|
Binary file
|