cfbd 5.20.1 → 5.22.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.22.0.tgz +0 -0
- package/dist/sdk.gen.d.ts +84 -69
- package/dist/sdk.gen.js +96 -69
- package/dist/types.gen.d.ts +490 -267
- package/package.json +1 -1
- package/src/sdk.gen.ts +102 -69
- package/src/types.gen.ts +518 -267
- package/cfbd-5.20.1.tgz +0 -0
package/src/sdk.gen.ts
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
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, 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, 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
|
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* Returns opponent-adjusted team statistics by season.
|
|
10
10
|
*/
|
|
11
11
|
export const getAdjustedTeamSeasonStats = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetAdjustedTeamSeasonStatsData, ThrowOnError>) => {
|
|
12
12
|
return (options?.client ?? client).get<GetAdjustedTeamSeasonStatsResponse, GetAdjustedTeamSeasonStatsError, ThrowOnError>({
|
|
@@ -16,7 +16,7 @@ export const getAdjustedTeamSeasonStats = <ThrowOnError extends boolean = false>
|
|
|
16
16
|
};
|
|
17
17
|
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
19
|
+
* Returns opponent-adjusted player passing metrics.
|
|
20
20
|
*/
|
|
21
21
|
export const getAdjustedPlayerPassingStats = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetAdjustedPlayerPassingStatsData, ThrowOnError>) => {
|
|
22
22
|
return (options?.client ?? client).get<GetAdjustedPlayerPassingStatsResponse, GetAdjustedPlayerPassingStatsError, ThrowOnError>({
|
|
@@ -26,7 +26,7 @@ export const getAdjustedPlayerPassingStats = <ThrowOnError extends boolean = fal
|
|
|
26
26
|
};
|
|
27
27
|
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
29
|
+
* Returns opponent-adjusted player rushing metrics.
|
|
30
30
|
*/
|
|
31
31
|
export const getAdjustedPlayerRushingStats = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetAdjustedPlayerRushingStatsData, ThrowOnError>) => {
|
|
32
32
|
return (options?.client ?? client).get<GetAdjustedPlayerRushingStatsResponse, GetAdjustedPlayerRushingStatsError, ThrowOnError>({
|
|
@@ -36,7 +36,7 @@ export const getAdjustedPlayerRushingStats = <ThrowOnError extends boolean = fal
|
|
|
36
36
|
};
|
|
37
37
|
|
|
38
38
|
/**
|
|
39
|
-
*
|
|
39
|
+
* Returns Points Added Above Replacement (PAAR) ratings for kickers.
|
|
40
40
|
*/
|
|
41
41
|
export const getKickerPaar = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetKickerPaarData, ThrowOnError>) => {
|
|
42
42
|
return (options?.client ?? client).get<GetKickerPaarResponse, GetKickerPaarError, ThrowOnError>({
|
|
@@ -46,7 +46,7 @@ export const getKickerPaar = <ThrowOnError extends boolean = false>(options?: Op
|
|
|
46
46
|
};
|
|
47
47
|
|
|
48
48
|
/**
|
|
49
|
-
*
|
|
49
|
+
* Returns team information and conference affiliations.
|
|
50
50
|
*/
|
|
51
51
|
export const getTeams = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetTeamsData, ThrowOnError>) => {
|
|
52
52
|
return (options?.client ?? client).get<GetTeamsResponse, GetTeamsError, ThrowOnError>({
|
|
@@ -56,7 +56,7 @@ export const getTeams = <ThrowOnError extends boolean = false>(options?: Options
|
|
|
56
56
|
};
|
|
57
57
|
|
|
58
58
|
/**
|
|
59
|
-
*
|
|
59
|
+
* Returns Football Bowl Subdivision (FBS) teams for a season.
|
|
60
60
|
*/
|
|
61
61
|
export const getFbsTeams = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetFbsTeamsData, ThrowOnError>) => {
|
|
62
62
|
return (options?.client ?? client).get<GetFbsTeamsResponse, GetFbsTeamsError, ThrowOnError>({
|
|
@@ -66,7 +66,7 @@ export const getFbsTeams = <ThrowOnError extends boolean = false>(options?: Opti
|
|
|
66
66
|
};
|
|
67
67
|
|
|
68
68
|
/**
|
|
69
|
-
*
|
|
69
|
+
* Returns historical matchup results between two teams.
|
|
70
70
|
*/
|
|
71
71
|
export const getMatchup = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetMatchupData, ThrowOnError>) => {
|
|
72
72
|
return (options?.client ?? client).get<GetMatchupResponse, GetMatchupError, ThrowOnError>({
|
|
@@ -76,7 +76,7 @@ export const getMatchup = <ThrowOnError extends boolean = false>(options: Option
|
|
|
76
76
|
};
|
|
77
77
|
|
|
78
78
|
/**
|
|
79
|
-
*
|
|
79
|
+
* Returns against-the-spread (ATS) records by team.
|
|
80
80
|
*/
|
|
81
81
|
export const getTeamsAts = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetTeamsAtsData, ThrowOnError>) => {
|
|
82
82
|
return (options?.client ?? client).get<GetTeamsAtsResponse, GetTeamsAtsError, ThrowOnError>({
|
|
@@ -86,7 +86,7 @@ export const getTeamsAts = <ThrowOnError extends boolean = false>(options: Optio
|
|
|
86
86
|
};
|
|
87
87
|
|
|
88
88
|
/**
|
|
89
|
-
*
|
|
89
|
+
* Returns historical roster data.
|
|
90
90
|
*/
|
|
91
91
|
export const getRoster = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetRosterData, ThrowOnError>) => {
|
|
92
92
|
return (options?.client ?? client).get<GetRosterResponse, GetRosterError, ThrowOnError>({
|
|
@@ -96,7 +96,7 @@ export const getRoster = <ThrowOnError extends boolean = false>(options?: Option
|
|
|
96
96
|
};
|
|
97
97
|
|
|
98
98
|
/**
|
|
99
|
-
*
|
|
99
|
+
* Returns the available conferences.
|
|
100
100
|
*/
|
|
101
101
|
export const getConferences = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => {
|
|
102
102
|
return (options?.client ?? client).get<GetConferencesResponse, GetConferencesError, ThrowOnError>({
|
|
@@ -106,7 +106,7 @@ export const getConferences = <ThrowOnError extends boolean = false>(options?: O
|
|
|
106
106
|
};
|
|
107
107
|
|
|
108
108
|
/**
|
|
109
|
-
*
|
|
109
|
+
* Returns 247Sports Team Talent Composite ratings for a season.
|
|
110
110
|
*/
|
|
111
111
|
export const getTalent = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetTalentData, ThrowOnError>) => {
|
|
112
112
|
return (options?.client ?? client).get<GetTalentResponse, GetTalentError, ThrowOnError>({
|
|
@@ -116,7 +116,7 @@ export const getTalent = <ThrowOnError extends boolean = false>(options: Options
|
|
|
116
116
|
};
|
|
117
117
|
|
|
118
118
|
/**
|
|
119
|
-
*
|
|
119
|
+
* Returns college football venues.
|
|
120
120
|
*/
|
|
121
121
|
export const getVenues = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => {
|
|
122
122
|
return (options?.client ?? client).get<GetVenuesResponse, GetVenuesError, ThrowOnError>({
|
|
@@ -126,7 +126,7 @@ export const getVenues = <ThrowOnError extends boolean = false>(options?: Option
|
|
|
126
126
|
};
|
|
127
127
|
|
|
128
128
|
/**
|
|
129
|
-
*
|
|
129
|
+
* Returns player statistics aggregated by season.
|
|
130
130
|
*/
|
|
131
131
|
export const getPlayerSeasonStats = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPlayerSeasonStatsData, ThrowOnError>) => {
|
|
132
132
|
return (options?.client ?? client).get<GetPlayerSeasonStatsResponse, GetPlayerSeasonStatsError, ThrowOnError>({
|
|
@@ -136,7 +136,7 @@ export const getPlayerSeasonStats = <ThrowOnError extends boolean = false>(optio
|
|
|
136
136
|
};
|
|
137
137
|
|
|
138
138
|
/**
|
|
139
|
-
*
|
|
139
|
+
* Returns player passing and rushing success rates by season.
|
|
140
140
|
*/
|
|
141
141
|
export const getPlayerSeasonSuccessRates = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetPlayerSeasonSuccessRatesData, ThrowOnError>) => {
|
|
142
142
|
return (options?.client ?? client).get<GetPlayerSeasonSuccessRatesResponse, GetPlayerSeasonSuccessRatesError, ThrowOnError>({
|
|
@@ -146,7 +146,7 @@ export const getPlayerSeasonSuccessRates = <ThrowOnError extends boolean = false
|
|
|
146
146
|
};
|
|
147
147
|
|
|
148
148
|
/**
|
|
149
|
-
*
|
|
149
|
+
* Returns player passing and rushing success rates by game.
|
|
150
150
|
*/
|
|
151
151
|
export const getPlayerGameSuccessRates = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPlayerGameSuccessRatesData, ThrowOnError>) => {
|
|
152
152
|
return (options?.client ?? client).get<GetPlayerGameSuccessRatesResponse, GetPlayerGameSuccessRatesError, ThrowOnError>({
|
|
@@ -156,7 +156,7 @@ export const getPlayerGameSuccessRates = <ThrowOnError extends boolean = false>(
|
|
|
156
156
|
};
|
|
157
157
|
|
|
158
158
|
/**
|
|
159
|
-
*
|
|
159
|
+
* Returns team statistics aggregated by season.
|
|
160
160
|
*/
|
|
161
161
|
export const getTeamStats = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetTeamStatsData, ThrowOnError>) => {
|
|
162
162
|
return (options?.client ?? client).get<GetTeamStatsResponse, GetTeamStatsError, ThrowOnError>({
|
|
@@ -166,7 +166,7 @@ export const getTeamStats = <ThrowOnError extends boolean = false>(options?: Opt
|
|
|
166
166
|
};
|
|
167
167
|
|
|
168
168
|
/**
|
|
169
|
-
*
|
|
169
|
+
* Returns the available team statistical categories.
|
|
170
170
|
*/
|
|
171
171
|
export const getCategories = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => {
|
|
172
172
|
return (options?.client ?? client).get<GetCategoriesResponse, GetCategoriesError, ThrowOnError>({
|
|
@@ -176,7 +176,7 @@ export const getCategories = <ThrowOnError extends boolean = false>(options?: Op
|
|
|
176
176
|
};
|
|
177
177
|
|
|
178
178
|
/**
|
|
179
|
-
*
|
|
179
|
+
* Returns advanced team statistics aggregated by season.
|
|
180
180
|
*/
|
|
181
181
|
export const getAdvancedSeasonStats = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetAdvancedSeasonStatsData, ThrowOnError>) => {
|
|
182
182
|
return (options?.client ?? client).get<GetAdvancedSeasonStatsResponse, GetAdvancedSeasonStatsError, ThrowOnError>({
|
|
@@ -186,7 +186,7 @@ export const getAdvancedSeasonStats = <ThrowOnError extends boolean = false>(opt
|
|
|
186
186
|
};
|
|
187
187
|
|
|
188
188
|
/**
|
|
189
|
-
*
|
|
189
|
+
* Returns advanced team statistics aggregated by game.
|
|
190
190
|
*/
|
|
191
191
|
export const getAdvancedGameStats = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetAdvancedGameStatsData, ThrowOnError>) => {
|
|
192
192
|
return (options?.client ?? client).get<GetAdvancedGameStatsResponse, GetAdvancedGameStatsError, ThrowOnError>({
|
|
@@ -196,7 +196,7 @@ export const getAdvancedGameStats = <ThrowOnError extends boolean = false>(optio
|
|
|
196
196
|
};
|
|
197
197
|
|
|
198
198
|
/**
|
|
199
|
-
*
|
|
199
|
+
* Returns team havoc statistics aggregated by game.
|
|
200
200
|
*/
|
|
201
201
|
export const getGameHavocStats = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetGameHavocStatsData, ThrowOnError>) => {
|
|
202
202
|
return (options?.client ?? client).get<GetGameHavocStatsResponse, GetGameHavocStatsError, ThrowOnError>({
|
|
@@ -206,7 +206,7 @@ export const getGameHavocStats = <ThrowOnError extends boolean = false>(options?
|
|
|
206
206
|
};
|
|
207
207
|
|
|
208
208
|
/**
|
|
209
|
-
*
|
|
209
|
+
* Returns player recruiting rankings.
|
|
210
210
|
*/
|
|
211
211
|
export const getRecruits = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetRecruitsData, ThrowOnError>) => {
|
|
212
212
|
return (options?.client ?? client).get<GetRecruitsResponse, GetRecruitsError, ThrowOnError>({
|
|
@@ -216,7 +216,7 @@ export const getRecruits = <ThrowOnError extends boolean = false>(options?: Opti
|
|
|
216
216
|
};
|
|
217
217
|
|
|
218
218
|
/**
|
|
219
|
-
*
|
|
219
|
+
* Returns team recruiting rankings.
|
|
220
220
|
*/
|
|
221
221
|
export const getTeamRecruitingRankings = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetTeamRecruitingRankingsData, ThrowOnError>) => {
|
|
222
222
|
return (options?.client ?? client).get<GetTeamRecruitingRankingsResponse, GetTeamRecruitingRankingsError, ThrowOnError>({
|
|
@@ -226,7 +226,7 @@ export const getTeamRecruitingRankings = <ThrowOnError extends boolean = false>(
|
|
|
226
226
|
};
|
|
227
227
|
|
|
228
228
|
/**
|
|
229
|
-
*
|
|
229
|
+
* Returns recruiting ratings aggregated by team and position group.
|
|
230
230
|
*/
|
|
231
231
|
export const getAggregatedTeamRecruitingRatings = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetAggregatedTeamRecruitingRatingsData, ThrowOnError>) => {
|
|
232
232
|
return (options?.client ?? client).get<GetAggregatedTeamRecruitingRatingsResponse, GetAggregatedTeamRecruitingRatingsError, ThrowOnError>({
|
|
@@ -236,7 +236,7 @@ export const getAggregatedTeamRecruitingRatings = <ThrowOnError extends boolean
|
|
|
236
236
|
};
|
|
237
237
|
|
|
238
238
|
/**
|
|
239
|
-
*
|
|
239
|
+
* Returns SP+ ratings by team and season.
|
|
240
240
|
*/
|
|
241
241
|
export const getSp = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetSpData, ThrowOnError>) => {
|
|
242
242
|
return (options?.client ?? client).get<GetSpResponse, GetSpError, ThrowOnError>({
|
|
@@ -246,7 +246,7 @@ export const getSp = <ThrowOnError extends boolean = false>(options?: OptionsLeg
|
|
|
246
246
|
};
|
|
247
247
|
|
|
248
248
|
/**
|
|
249
|
-
*
|
|
249
|
+
* Returns conference-level SP+ ratings by season.
|
|
250
250
|
*/
|
|
251
251
|
export const getConferenceSp = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetConferenceSpData, ThrowOnError>) => {
|
|
252
252
|
return (options?.client ?? client).get<GetConferenceSpResponse, GetConferenceSpError, ThrowOnError>({
|
|
@@ -256,7 +256,7 @@ export const getConferenceSp = <ThrowOnError extends boolean = false>(options?:
|
|
|
256
256
|
};
|
|
257
257
|
|
|
258
258
|
/**
|
|
259
|
-
*
|
|
259
|
+
* Returns Simple Rating System (SRS) ratings by team and season.
|
|
260
260
|
*/
|
|
261
261
|
export const getSrs = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetSrsData, ThrowOnError>) => {
|
|
262
262
|
return (options?.client ?? client).get<GetSrsResponse, GetSrsError, ThrowOnError>({
|
|
@@ -266,7 +266,7 @@ export const getSrs = <ThrowOnError extends boolean = false>(options?: OptionsLe
|
|
|
266
266
|
};
|
|
267
267
|
|
|
268
268
|
/**
|
|
269
|
-
*
|
|
269
|
+
* Returns expanded Simple Rating System (SRS) ratings, including FCS teams.
|
|
270
270
|
*/
|
|
271
271
|
export const getExpandedSrs = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetExpandedSrsData, ThrowOnError>) => {
|
|
272
272
|
return (options?.client ?? client).get<GetExpandedSrsResponse, GetExpandedSrsError, ThrowOnError>({
|
|
@@ -276,7 +276,7 @@ export const getExpandedSrs = <ThrowOnError extends boolean = false>(options?: O
|
|
|
276
276
|
};
|
|
277
277
|
|
|
278
278
|
/**
|
|
279
|
-
*
|
|
279
|
+
* Returns historical Elo ratings.
|
|
280
280
|
*/
|
|
281
281
|
export const getElo = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetEloData, ThrowOnError>) => {
|
|
282
282
|
return (options?.client ?? client).get<GetEloResponse, GetEloError, ThrowOnError>({
|
|
@@ -286,7 +286,7 @@ export const getElo = <ThrowOnError extends boolean = false>(options?: OptionsLe
|
|
|
286
286
|
};
|
|
287
287
|
|
|
288
288
|
/**
|
|
289
|
-
*
|
|
289
|
+
* Returns historical Football Power Index (FPI) ratings.
|
|
290
290
|
*/
|
|
291
291
|
export const getFpi = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetFpiData, ThrowOnError>) => {
|
|
292
292
|
return (options?.client ?? client).get<GetFpiResponse, GetFpiError, ThrowOnError>({
|
|
@@ -296,7 +296,7 @@ export const getFpi = <ThrowOnError extends boolean = false>(options?: OptionsLe
|
|
|
296
296
|
};
|
|
297
297
|
|
|
298
298
|
/**
|
|
299
|
-
*
|
|
299
|
+
* Returns historical poll rankings.
|
|
300
300
|
*/
|
|
301
301
|
export const getRankings = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetRankingsData, ThrowOnError>) => {
|
|
302
302
|
return (options?.client ?? client).get<GetRankingsResponse, GetRankingsError, ThrowOnError>({
|
|
@@ -306,7 +306,7 @@ export const getRankings = <ThrowOnError extends boolean = false>(options: Optio
|
|
|
306
306
|
};
|
|
307
307
|
|
|
308
308
|
/**
|
|
309
|
-
*
|
|
309
|
+
* Returns historical play-by-play data.
|
|
310
310
|
*/
|
|
311
311
|
export const getPlays = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPlaysData, ThrowOnError>) => {
|
|
312
312
|
return (options?.client ?? client).get<GetPlaysResponse, GetPlaysError, ThrowOnError>({
|
|
@@ -316,7 +316,7 @@ export const getPlays = <ThrowOnError extends boolean = false>(options: OptionsL
|
|
|
316
316
|
};
|
|
317
317
|
|
|
318
318
|
/**
|
|
319
|
-
*
|
|
319
|
+
* Returns the available play types.
|
|
320
320
|
*/
|
|
321
321
|
export const getPlayTypes = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => {
|
|
322
322
|
return (options?.client ?? client).get<GetPlayTypesResponse, GetPlayTypesError, ThrowOnError>({
|
|
@@ -326,7 +326,7 @@ export const getPlayTypes = <ThrowOnError extends boolean = false>(options?: Opt
|
|
|
326
326
|
};
|
|
327
327
|
|
|
328
328
|
/**
|
|
329
|
-
*
|
|
329
|
+
* Returns player and play-stat associations, limited to 2,000 records.
|
|
330
330
|
*/
|
|
331
331
|
export const getPlayStats = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetPlayStatsData, ThrowOnError>) => {
|
|
332
332
|
return (options?.client ?? client).get<GetPlayStatsResponse, GetPlayStatsError, ThrowOnError>({
|
|
@@ -336,7 +336,7 @@ export const getPlayStats = <ThrowOnError extends boolean = false>(options?: Opt
|
|
|
336
336
|
};
|
|
337
337
|
|
|
338
338
|
/**
|
|
339
|
-
*
|
|
339
|
+
* Returns the available play stat types.
|
|
340
340
|
*/
|
|
341
341
|
export const getPlayStatTypes = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => {
|
|
342
342
|
return (options?.client ?? client).get<GetPlayStatTypesResponse, GetPlayStatTypesError, ThrowOnError>({
|
|
@@ -346,7 +346,7 @@ export const getPlayStatTypes = <ThrowOnError extends boolean = false>(options?:
|
|
|
346
346
|
};
|
|
347
347
|
|
|
348
348
|
/**
|
|
349
|
-
*
|
|
349
|
+
* Returns the complete College Football Playoff bracket for a season.
|
|
350
350
|
*/
|
|
351
351
|
export const getCfpPlayoff = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetCfpPlayoffData, ThrowOnError>) => {
|
|
352
352
|
return (options?.client ?? client).get<GetCfpPlayoffResponse, GetCfpPlayoffError, ThrowOnError>({
|
|
@@ -356,7 +356,7 @@ export const getCfpPlayoff = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
356
356
|
};
|
|
357
357
|
|
|
358
358
|
/**
|
|
359
|
-
*
|
|
359
|
+
* Returns College Football Playoff participants for a season.
|
|
360
360
|
*/
|
|
361
361
|
export const getCfpParticipants = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetCfpParticipantsData, ThrowOnError>) => {
|
|
362
362
|
return (options?.client ?? client).get<GetCfpParticipantsResponse, GetCfpParticipantsError, ThrowOnError>({
|
|
@@ -366,7 +366,7 @@ export const getCfpParticipants = <ThrowOnError extends boolean = false>(options
|
|
|
366
366
|
};
|
|
367
367
|
|
|
368
368
|
/**
|
|
369
|
-
*
|
|
369
|
+
* Returns College Football Playoff matchups for a season.
|
|
370
370
|
*/
|
|
371
371
|
export const getCfpGames = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetCfpGamesData, ThrowOnError>) => {
|
|
372
372
|
return (options?.client ?? client).get<GetCfpGamesResponse, GetCfpGamesError, ThrowOnError>({
|
|
@@ -376,7 +376,7 @@ export const getCfpGames = <ThrowOnError extends boolean = false>(options: Optio
|
|
|
376
376
|
};
|
|
377
377
|
|
|
378
378
|
/**
|
|
379
|
-
*
|
|
379
|
+
* Returns up to 100 players whose names match the search term.
|
|
380
380
|
*/
|
|
381
381
|
export const searchPlayers = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<SearchPlayersData, ThrowOnError>) => {
|
|
382
382
|
return (options?.client ?? client).get<SearchPlayersResponse, SearchPlayersError, ThrowOnError>({
|
|
@@ -386,7 +386,7 @@ export const searchPlayers = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
386
386
|
};
|
|
387
387
|
|
|
388
388
|
/**
|
|
389
|
-
*
|
|
389
|
+
* Returns player usage metrics for a season.
|
|
390
390
|
*/
|
|
391
391
|
export const getPlayerUsage = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPlayerUsageData, ThrowOnError>) => {
|
|
392
392
|
return (options?.client ?? client).get<GetPlayerUsageResponse, GetPlayerUsageError, ThrowOnError>({
|
|
@@ -396,7 +396,8 @@ export const getPlayerUsage = <ThrowOnError extends boolean = false>(options: Op
|
|
|
396
396
|
};
|
|
397
397
|
|
|
398
398
|
/**
|
|
399
|
-
*
|
|
399
|
+
* Returns a player season overview with box score, usage, and Predicted
|
|
400
|
+
* Points Added (PPA) data.
|
|
400
401
|
*/
|
|
401
402
|
export const getPlayerSeasonOverview = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPlayerSeasonOverviewData, ThrowOnError>) => {
|
|
402
403
|
return (options?.client ?? client).get<GetPlayerSeasonOverviewResponse, GetPlayerSeasonOverviewError, ThrowOnError>({
|
|
@@ -406,7 +407,7 @@ export const getPlayerSeasonOverview = <ThrowOnError extends boolean = false>(op
|
|
|
406
407
|
};
|
|
407
408
|
|
|
408
409
|
/**
|
|
409
|
-
*
|
|
410
|
+
* Returns returning production metrics by team and season.
|
|
410
411
|
*/
|
|
411
412
|
export const getReturningProduction = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetReturningProductionData, ThrowOnError>) => {
|
|
412
413
|
return (options?.client ?? client).get<GetReturningProductionResponse, GetReturningProductionError, ThrowOnError>({
|
|
@@ -416,7 +417,7 @@ export const getReturningProduction = <ThrowOnError extends boolean = false>(opt
|
|
|
416
417
|
};
|
|
417
418
|
|
|
418
419
|
/**
|
|
419
|
-
*
|
|
420
|
+
* Returns transfer portal entries for a season.
|
|
420
421
|
*/
|
|
421
422
|
export const getTransferPortal = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetTransferPortalData, ThrowOnError>) => {
|
|
422
423
|
return (options?.client ?? client).get<GetTransferPortalResponse, GetTransferPortalError, ThrowOnError>({
|
|
@@ -426,7 +427,7 @@ export const getTransferPortal = <ThrowOnError extends boolean = false>(options:
|
|
|
426
427
|
};
|
|
427
428
|
|
|
428
429
|
/**
|
|
429
|
-
*
|
|
430
|
+
* Returns predicted points values by down and distance.
|
|
430
431
|
*/
|
|
431
432
|
export const getPredictedPoints = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPredictedPointsData, ThrowOnError>) => {
|
|
432
433
|
return (options?.client ?? client).get<GetPredictedPointsResponse, GetPredictedPointsError, ThrowOnError>({
|
|
@@ -436,7 +437,7 @@ export const getPredictedPoints = <ThrowOnError extends boolean = false>(options
|
|
|
436
437
|
};
|
|
437
438
|
|
|
438
439
|
/**
|
|
439
|
-
*
|
|
440
|
+
* Returns team Predicted Points Added (PPA) metrics by season.
|
|
440
441
|
*/
|
|
441
442
|
export const getPredictedPointsAddedByTeam = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetPredictedPointsAddedByTeamData, ThrowOnError>) => {
|
|
442
443
|
return (options?.client ?? client).get<GetPredictedPointsAddedByTeamResponse, GetPredictedPointsAddedByTeamError, ThrowOnError>({
|
|
@@ -446,7 +447,7 @@ export const getPredictedPointsAddedByTeam = <ThrowOnError extends boolean = fal
|
|
|
446
447
|
};
|
|
447
448
|
|
|
448
449
|
/**
|
|
449
|
-
*
|
|
450
|
+
* Returns team Predicted Points Added (PPA) metrics by game.
|
|
450
451
|
*/
|
|
451
452
|
export const getPredictedPointsAddedByGame = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPredictedPointsAddedByGameData, ThrowOnError>) => {
|
|
452
453
|
return (options?.client ?? client).get<GetPredictedPointsAddedByGameResponse, GetPredictedPointsAddedByGameError, ThrowOnError>({
|
|
@@ -456,7 +457,7 @@ export const getPredictedPointsAddedByGame = <ThrowOnError extends boolean = fal
|
|
|
456
457
|
};
|
|
457
458
|
|
|
458
459
|
/**
|
|
459
|
-
*
|
|
460
|
+
* Returns player Predicted Points Added (PPA) metrics by game.
|
|
460
461
|
*/
|
|
461
462
|
export const getPredictedPointsAddedByPlayerGame = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPredictedPointsAddedByPlayerGameData, ThrowOnError>) => {
|
|
462
463
|
return (options?.client ?? client).get<GetPredictedPointsAddedByPlayerGameResponse, GetPredictedPointsAddedByPlayerGameError, ThrowOnError>({
|
|
@@ -466,7 +467,7 @@ export const getPredictedPointsAddedByPlayerGame = <ThrowOnError extends boolean
|
|
|
466
467
|
};
|
|
467
468
|
|
|
468
469
|
/**
|
|
469
|
-
*
|
|
470
|
+
* Returns player Predicted Points Added (PPA) metrics by season.
|
|
470
471
|
*/
|
|
471
472
|
export const getPredictedPointsAddedByPlayerSeason = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetPredictedPointsAddedByPlayerSeasonData, ThrowOnError>) => {
|
|
472
473
|
return (options?.client ?? client).get<GetPredictedPointsAddedByPlayerSeasonResponse, GetPredictedPointsAddedByPlayerSeasonError, ThrowOnError>({
|
|
@@ -476,7 +477,7 @@ export const getPredictedPointsAddedByPlayerSeason = <ThrowOnError extends boole
|
|
|
476
477
|
};
|
|
477
478
|
|
|
478
479
|
/**
|
|
479
|
-
*
|
|
480
|
+
* Returns play-by-play win probabilities for a game.
|
|
480
481
|
*/
|
|
481
482
|
export const getWinProbability = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetWinProbabilityData, ThrowOnError>) => {
|
|
482
483
|
return (options?.client ?? client).get<GetWinProbabilityResponse, GetWinProbabilityError, ThrowOnError>({
|
|
@@ -486,7 +487,7 @@ export const getWinProbability = <ThrowOnError extends boolean = false>(options:
|
|
|
486
487
|
};
|
|
487
488
|
|
|
488
489
|
/**
|
|
489
|
-
*
|
|
490
|
+
* Returns pregame win probabilities.
|
|
490
491
|
*/
|
|
491
492
|
export const getPregameWinProbabilities = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetPregameWinProbabilitiesData, ThrowOnError>) => {
|
|
492
493
|
return (options?.client ?? client).get<GetPregameWinProbabilitiesResponse, GetPregameWinProbabilitiesError, ThrowOnError>({
|
|
@@ -496,7 +497,7 @@ export const getPregameWinProbabilities = <ThrowOnError extends boolean = false>
|
|
|
496
497
|
};
|
|
497
498
|
|
|
498
499
|
/**
|
|
499
|
-
*
|
|
500
|
+
* Returns expected points values for field goal attempts.
|
|
500
501
|
*/
|
|
501
502
|
export const getFieldGoalExpectedPoints = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => {
|
|
502
503
|
return (options?.client ?? client).get<GetFieldGoalExpectedPointsResponse, GetFieldGoalExpectedPointsError, ThrowOnError>({
|
|
@@ -506,7 +507,7 @@ export const getFieldGoalExpectedPoints = <ThrowOnError extends boolean = false>
|
|
|
506
507
|
};
|
|
507
508
|
|
|
508
509
|
/**
|
|
509
|
-
*
|
|
510
|
+
* Returns live play-by-play data and advanced metrics for a game.
|
|
510
511
|
*/
|
|
511
512
|
export const getLivePlays = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetLivePlaysData, ThrowOnError>) => {
|
|
512
513
|
return (options?.client ?? client).get<GetLivePlaysResponse, GetLivePlaysError, ThrowOnError>({
|
|
@@ -516,7 +517,7 @@ export const getLivePlays = <ThrowOnError extends boolean = false>(options: Opti
|
|
|
516
517
|
};
|
|
517
518
|
|
|
518
519
|
/**
|
|
519
|
-
*
|
|
520
|
+
* Returns historical betting lines and results.
|
|
520
521
|
*/
|
|
521
522
|
export const getLines = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetLinesData, ThrowOnError>) => {
|
|
522
523
|
return (options?.client ?? client).get<GetLinesResponse, GetLinesError, ThrowOnError>({
|
|
@@ -526,7 +527,8 @@ export const getLines = <ThrowOnError extends boolean = false>(options?: Options
|
|
|
526
527
|
};
|
|
527
528
|
|
|
528
529
|
/**
|
|
529
|
-
*
|
|
530
|
+
* Returns the authenticated user's Patreon level and remaining API calls.
|
|
531
|
+
* Returns `null` when the request is not authenticated.
|
|
530
532
|
*/
|
|
531
533
|
export const getUserInfo = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => {
|
|
532
534
|
return (options?.client ?? client).get<GetUserInfoResponse, GetUserInfoError, ThrowOnError>({
|
|
@@ -536,7 +538,8 @@ export const getUserInfo = <ThrowOnError extends boolean = false>(options?: Opti
|
|
|
536
538
|
};
|
|
537
539
|
|
|
538
540
|
/**
|
|
539
|
-
*
|
|
541
|
+
* Returns recent usage for the authenticated user's shared CFB and CBB call
|
|
542
|
+
* pool. Returns `null` when the request is not authenticated.
|
|
540
543
|
*/
|
|
541
544
|
export const getUsage = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetUsageData, ThrowOnError>) => {
|
|
542
545
|
return (options?.client ?? client).get<GetUsageResponse, GetUsageError, ThrowOnError>({
|
|
@@ -546,7 +549,7 @@ export const getUsage = <ThrowOnError extends boolean = false>(options?: Options
|
|
|
546
549
|
};
|
|
547
550
|
|
|
548
551
|
/**
|
|
549
|
-
*
|
|
552
|
+
* Returns historical game data.
|
|
550
553
|
*/
|
|
551
554
|
export const getGames = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetGamesData, ThrowOnError>) => {
|
|
552
555
|
return (options?.client ?? client).get<GetGamesResponse, GetGamesError, ThrowOnError>({
|
|
@@ -556,7 +559,7 @@ export const getGames = <ThrowOnError extends boolean = false>(options?: Options
|
|
|
556
559
|
};
|
|
557
560
|
|
|
558
561
|
/**
|
|
559
|
-
*
|
|
562
|
+
* Returns team box score statistics by game.
|
|
560
563
|
*/
|
|
561
564
|
export const getGameTeamStats = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetGameTeamStatsData, ThrowOnError>) => {
|
|
562
565
|
return (options?.client ?? client).get<GetGameTeamStatsResponse, GetGameTeamStatsError, ThrowOnError>({
|
|
@@ -566,7 +569,7 @@ export const getGameTeamStats = <ThrowOnError extends boolean = false>(options?:
|
|
|
566
569
|
};
|
|
567
570
|
|
|
568
571
|
/**
|
|
569
|
-
*
|
|
572
|
+
* Returns player box score statistics by game.
|
|
570
573
|
*/
|
|
571
574
|
export const getGamePlayerStats = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetGamePlayerStatsData, ThrowOnError>) => {
|
|
572
575
|
return (options?.client ?? client).get<GetGamePlayerStatsResponse, GetGamePlayerStatsError, ThrowOnError>({
|
|
@@ -576,7 +579,7 @@ export const getGamePlayerStats = <ThrowOnError extends boolean = false>(options
|
|
|
576
579
|
};
|
|
577
580
|
|
|
578
581
|
/**
|
|
579
|
-
*
|
|
582
|
+
* Returns broadcast and media information for games.
|
|
580
583
|
*/
|
|
581
584
|
export const getMedia = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetMediaData, ThrowOnError>) => {
|
|
582
585
|
return (options?.client ?? client).get<GetMediaResponse, GetMediaError, ThrowOnError>({
|
|
@@ -586,7 +589,7 @@ export const getMedia = <ThrowOnError extends boolean = false>(options: OptionsL
|
|
|
586
589
|
};
|
|
587
590
|
|
|
588
591
|
/**
|
|
589
|
-
*
|
|
592
|
+
* Returns historical and forecast weather data for games. Requires Patreon.
|
|
590
593
|
*/
|
|
591
594
|
export const getWeather = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetWeatherData, ThrowOnError>) => {
|
|
592
595
|
return (options?.client ?? client).get<GetWeatherResponse, GetWeatherError, ThrowOnError>({
|
|
@@ -596,7 +599,7 @@ export const getWeather = <ThrowOnError extends boolean = false>(options?: Optio
|
|
|
596
599
|
};
|
|
597
600
|
|
|
598
601
|
/**
|
|
599
|
-
*
|
|
602
|
+
* Returns historical team records by season.
|
|
600
603
|
*/
|
|
601
604
|
export const getRecords = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetRecordsData, ThrowOnError>) => {
|
|
602
605
|
return (options?.client ?? client).get<GetRecordsResponse, GetRecordsError, ThrowOnError>({
|
|
@@ -606,7 +609,7 @@ export const getRecords = <ThrowOnError extends boolean = false>(options?: Optio
|
|
|
606
609
|
};
|
|
607
610
|
|
|
608
611
|
/**
|
|
609
|
-
*
|
|
612
|
+
* Returns the week-by-week season calendar.
|
|
610
613
|
*/
|
|
611
614
|
export const getCalendar = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetCalendarData, ThrowOnError>) => {
|
|
612
615
|
return (options?.client ?? client).get<GetCalendarResponse, GetCalendarError, ThrowOnError>({
|
|
@@ -616,7 +619,7 @@ export const getCalendar = <ThrowOnError extends boolean = false>(options: Optio
|
|
|
616
619
|
};
|
|
617
620
|
|
|
618
621
|
/**
|
|
619
|
-
*
|
|
622
|
+
* Returns current scoreboard data.
|
|
620
623
|
*/
|
|
621
624
|
export const getScoreboard = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetScoreboardData, ThrowOnError>) => {
|
|
622
625
|
return (options?.client ?? client).get<GetScoreboardResponse, GetScoreboardError, ThrowOnError>({
|
|
@@ -626,7 +629,7 @@ export const getScoreboard = <ThrowOnError extends boolean = false>(options?: Op
|
|
|
626
629
|
};
|
|
627
630
|
|
|
628
631
|
/**
|
|
629
|
-
*
|
|
632
|
+
* Returns historical drive data.
|
|
630
633
|
*/
|
|
631
634
|
export const getDrives = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetDrivesData, ThrowOnError>) => {
|
|
632
635
|
return (options?.client ?? client).get<GetDrivesResponse, GetDrivesError, ThrowOnError>({
|
|
@@ -636,7 +639,7 @@ export const getDrives = <ThrowOnError extends boolean = false>(options: Options
|
|
|
636
639
|
};
|
|
637
640
|
|
|
638
641
|
/**
|
|
639
|
-
*
|
|
642
|
+
* Returns the NFL teams represented in draft data.
|
|
640
643
|
*/
|
|
641
644
|
export const getDraftTeams = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => {
|
|
642
645
|
return (options?.client ?? client).get<GetDraftTeamsResponse, GetDraftTeamsError, ThrowOnError>({
|
|
@@ -646,7 +649,7 @@ export const getDraftTeams = <ThrowOnError extends boolean = false>(options?: Op
|
|
|
646
649
|
};
|
|
647
650
|
|
|
648
651
|
/**
|
|
649
|
-
*
|
|
652
|
+
* Returns the player position categories used in NFL Draft data.
|
|
650
653
|
*/
|
|
651
654
|
export const getDraftPositions = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => {
|
|
652
655
|
return (options?.client ?? client).get<GetDraftPositionsResponse, GetDraftPositionsError, ThrowOnError>({
|
|
@@ -656,7 +659,7 @@ export const getDraftPositions = <ThrowOnError extends boolean = false>(options?
|
|
|
656
659
|
};
|
|
657
660
|
|
|
658
661
|
/**
|
|
659
|
-
*
|
|
662
|
+
* Returns historical NFL Draft picks.
|
|
660
663
|
*/
|
|
661
664
|
export const getDraftPicks = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetDraftPicksData, ThrowOnError>) => {
|
|
662
665
|
return (options?.client ?? client).get<GetDraftPicksResponse, GetDraftPicksError, ThrowOnError>({
|
|
@@ -666,7 +669,7 @@ export const getDraftPicks = <ThrowOnError extends boolean = false>(options?: Op
|
|
|
666
669
|
};
|
|
667
670
|
|
|
668
671
|
/**
|
|
669
|
-
*
|
|
672
|
+
* Returns historical head coach records.
|
|
670
673
|
*/
|
|
671
674
|
export const getCoaches = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetCoachesData, ThrowOnError>) => {
|
|
672
675
|
return (options?.client ?? client).get<GetCoachesResponse, GetCoachesError, ThrowOnError>({
|
|
@@ -676,7 +679,37 @@ export const getCoaches = <ThrowOnError extends boolean = false>(options?: Optio
|
|
|
676
679
|
};
|
|
677
680
|
|
|
678
681
|
/**
|
|
679
|
-
*
|
|
682
|
+
* Returns a coach profile with canonical identity and career totals.
|
|
683
|
+
*/
|
|
684
|
+
export const getCoachProfile = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetCoachProfileData, ThrowOnError>) => {
|
|
685
|
+
return (options?.client ?? client).get<GetCoachProfileResponse, GetCoachProfileError, ThrowOnError>({
|
|
686
|
+
...options,
|
|
687
|
+
url: '/coaches/profile'
|
|
688
|
+
});
|
|
689
|
+
};
|
|
690
|
+
|
|
691
|
+
/**
|
|
692
|
+
* Returns coach-season records with attributed results and team context.
|
|
693
|
+
*/
|
|
694
|
+
export const getCoachSeasons = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetCoachSeasonsData, ThrowOnError>) => {
|
|
695
|
+
return (options?.client ?? client).get<GetCoachSeasonsResponse, GetCoachSeasonsError, ThrowOnError>({
|
|
696
|
+
...options,
|
|
697
|
+
url: '/coaches/seasons'
|
|
698
|
+
});
|
|
699
|
+
};
|
|
700
|
+
|
|
701
|
+
/**
|
|
702
|
+
* Returns continuous head-coaching tenures and their attributed records.
|
|
703
|
+
*/
|
|
704
|
+
export const getCoachTenures = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetCoachTenuresData, ThrowOnError>) => {
|
|
705
|
+
return (options?.client ?? client).get<GetCoachTenuresResponse, GetCoachTenuresError, ThrowOnError>({
|
|
706
|
+
...options,
|
|
707
|
+
url: '/coaches/tenures'
|
|
708
|
+
});
|
|
709
|
+
};
|
|
710
|
+
|
|
711
|
+
/**
|
|
712
|
+
* Returns an advanced box score for a game.
|
|
680
713
|
*/
|
|
681
714
|
export const getAdvancedBoxScore = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetAdvancedBoxScoreData, ThrowOnError>) => {
|
|
682
715
|
return (options?.client ?? client).get<GetAdvancedBoxScoreResponse, GetAdvancedBoxScoreError, ThrowOnError>({
|