Skip to content

Commit 2d8f53c

Browse files
feat(info): new user info endpoint
1 parent 47f7c05 commit 2d8f53c

File tree

3 files changed

+39
-2
lines changed

3 files changed

+39
-2
lines changed

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "cfbd",
3-
"version": "5.6.24",
3+
"version": "5.7.0",
44
"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.",
55
"repository": {
66
"type": "git",

src/sdk.gen.ts

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// This file is auto-generated by @hey-api/openapi-ts
22

33
import type { Options as ClientOptions, TDataShape, Client } from './client';
4-
import type { GetAdjustedTeamSeasonStatsData, GetAdjustedTeamSeasonStatsResponses, GetAdjustedPlayerPassingStatsData, GetAdjustedPlayerPassingStatsResponses, GetAdjustedPlayerRushingStatsData, GetAdjustedPlayerRushingStatsResponses, GetKickerPaarData, GetKickerPaarResponses, GetTeamsData, GetTeamsResponses, GetFbsTeamsData, GetFbsTeamsResponses, GetMatchupData, GetMatchupResponses, GetRosterData, GetRosterResponses, GetConferencesData, GetConferencesResponses, GetTalentData, GetTalentResponses, GetVenuesData, GetVenuesResponses, GetPlayerSeasonStatsData, GetPlayerSeasonStatsResponses, GetTeamStatsData, GetTeamStatsResponses, GetCategoriesData, GetCategoriesResponses, GetAdvancedSeasonStatsData, GetAdvancedSeasonStatsResponses, GetAdvancedGameStatsData, GetAdvancedGameStatsResponses, GetRecruitsData, GetRecruitsResponses, GetTeamRecruitingRankingsData, GetTeamRecruitingRankingsResponses, GetAggregatedTeamRecruitingRatingsData, GetAggregatedTeamRecruitingRatingsResponses, GetSpData, GetSpResponses, GetConferenceSpData, GetConferenceSpResponses, GetSrsData, GetSrsResponses, GetEloData, GetEloResponses, GetFpiData, GetFpiResponses, GetRankingsData, GetRankingsResponses, GetPlaysData, GetPlaysResponses, GetPlayTypesData, GetPlayTypesResponses, GetPlayStatsData, GetPlayStatsResponses, GetPlayStatTypesData, GetPlayStatTypesResponses, SearchPlayersData, SearchPlayersResponses, GetPlayerUsageData, GetPlayerUsageResponses, GetReturningProductionData, GetReturningProductionResponses, GetTransferPortalData, GetTransferPortalResponses, GetPredictedPointsData, GetPredictedPointsResponses, GetPredictedPointsAddedByTeamData, GetPredictedPointsAddedByTeamResponses, GetPredictedPointsAddedByGameData, GetPredictedPointsAddedByGameResponses, GetPredictedPointsAddedByPlayerGameData, GetPredictedPointsAddedByPlayerGameResponses, GetPredictedPointsAddedByPlayerSeasonData, GetPredictedPointsAddedByPlayerSeasonResponses, GetWinProbabilityData, GetWinProbabilityResponses, GetPregameWinProbabilitiesData, GetPregameWinProbabilitiesResponses, GetFieldGoalExpectedPointsData, GetFieldGoalExpectedPointsResponses, GetLivePlaysData, GetLivePlaysResponses, GetLinesData, GetLinesResponses, GetGamesData, GetGamesResponses, GetGameTeamStatsData, GetGameTeamStatsResponses, GetGamePlayerStatsData, GetGamePlayerStatsResponses, GetMediaData, GetMediaResponses, GetWeatherData, GetWeatherResponses, GetRecordsData, GetRecordsResponses, GetCalendarData, GetCalendarResponses, GetScoreboardData, GetScoreboardResponses, GetDrivesData, GetDrivesResponses, GetDraftTeamsData, GetDraftTeamsResponses, GetDraftPositionsData, GetDraftPositionsResponses, GetDraftPicksData, GetDraftPicksResponses, GetCoachesData, GetCoachesResponses, GetAdvancedBoxScoreData, GetAdvancedBoxScoreResponses } from './types.gen';
4+
import type { GetAdjustedTeamSeasonStatsData, GetAdjustedTeamSeasonStatsResponses, GetAdjustedPlayerPassingStatsData, GetAdjustedPlayerPassingStatsResponses, GetAdjustedPlayerRushingStatsData, GetAdjustedPlayerRushingStatsResponses, GetKickerPaarData, GetKickerPaarResponses, GetTeamsData, GetTeamsResponses, GetFbsTeamsData, GetFbsTeamsResponses, GetMatchupData, GetMatchupResponses, GetRosterData, GetRosterResponses, GetConferencesData, GetConferencesResponses, GetTalentData, GetTalentResponses, GetVenuesData, GetVenuesResponses, GetPlayerSeasonStatsData, GetPlayerSeasonStatsResponses, GetTeamStatsData, GetTeamStatsResponses, GetCategoriesData, GetCategoriesResponses, GetAdvancedSeasonStatsData, GetAdvancedSeasonStatsResponses, GetAdvancedGameStatsData, GetAdvancedGameStatsResponses, GetRecruitsData, GetRecruitsResponses, GetTeamRecruitingRankingsData, GetTeamRecruitingRankingsResponses, GetAggregatedTeamRecruitingRatingsData, GetAggregatedTeamRecruitingRatingsResponses, GetSpData, GetSpResponses, GetConferenceSpData, GetConferenceSpResponses, GetSrsData, GetSrsResponses, GetEloData, GetEloResponses, GetFpiData, GetFpiResponses, GetRankingsData, GetRankingsResponses, GetPlaysData, GetPlaysResponses, GetPlayTypesData, GetPlayTypesResponses, GetPlayStatsData, GetPlayStatsResponses, GetPlayStatTypesData, GetPlayStatTypesResponses, SearchPlayersData, SearchPlayersResponses, GetPlayerUsageData, GetPlayerUsageResponses, GetReturningProductionData, GetReturningProductionResponses, GetTransferPortalData, GetTransferPortalResponses, GetPredictedPointsData, GetPredictedPointsResponses, GetPredictedPointsAddedByTeamData, GetPredictedPointsAddedByTeamResponses, GetPredictedPointsAddedByGameData, GetPredictedPointsAddedByGameResponses, GetPredictedPointsAddedByPlayerGameData, GetPredictedPointsAddedByPlayerGameResponses, GetPredictedPointsAddedByPlayerSeasonData, GetPredictedPointsAddedByPlayerSeasonResponses, GetWinProbabilityData, GetWinProbabilityResponses, GetPregameWinProbabilitiesData, GetPregameWinProbabilitiesResponses, GetFieldGoalExpectedPointsData, GetFieldGoalExpectedPointsResponses, GetLivePlaysData, GetLivePlaysResponses, GetLinesData, GetLinesResponses, GetUserInfoData, GetUserInfoResponses, GetGamesData, GetGamesResponses, GetGameTeamStatsData, GetGameTeamStatsResponses, GetGamePlayerStatsData, GetGamePlayerStatsResponses, GetMediaData, GetMediaResponses, GetWeatherData, GetWeatherResponses, GetRecordsData, GetRecordsResponses, GetCalendarData, GetCalendarResponses, GetScoreboardData, GetScoreboardResponses, GetDrivesData, GetDrivesResponses, GetDraftTeamsData, GetDraftTeamsResponses, GetDraftPositionsData, GetDraftPositionsResponses, GetDraftPicksData, GetDraftPicksResponses, GetCoachesData, GetCoachesResponses, GetAdvancedBoxScoreData, GetAdvancedBoxScoreResponses } from './types.gen';
55
import { client as _heyApiClient } from './client.gen';
66

77
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
@@ -706,6 +706,22 @@ export const getLines = <ThrowOnError extends boolean = false>(options?: Options
706706
});
707707
};
708708

709+
/**
710+
* Retrieves information about the user, including their Patreon level and remaining API calls.
711+
*/
712+
export const getUserInfo = <ThrowOnError extends boolean = false>(options?: Options<GetUserInfoData, ThrowOnError>) => {
713+
return (options?.client ?? _heyApiClient).get<GetUserInfoResponses, unknown, ThrowOnError>({
714+
security: [
715+
{
716+
scheme: 'bearer',
717+
type: 'http'
718+
}
719+
],
720+
url: '/info',
721+
...options
722+
});
723+
};
724+
709725
/**
710726
* Retrieves historical game data
711727
*/

src/types.gen.ts

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -951,6 +951,11 @@ export type BettingGame = {
951951
lines: Array<GameLine>;
952952
};
953953

954+
export type UserInfo = {
955+
patronLevel: number;
956+
remainingCalls: number;
957+
};
958+
954959
export type Game = {
955960
id: number;
956961
season: number;
@@ -2714,6 +2719,22 @@ export type GetLinesResponses = {
27142719

27152720
export type GetLinesResponse = GetLinesResponses[keyof GetLinesResponses];
27162721

2722+
export type GetUserInfoData = {
2723+
body?: never;
2724+
path?: never;
2725+
query?: never;
2726+
url: '/info';
2727+
};
2728+
2729+
export type GetUserInfoResponses = {
2730+
/**
2731+
* UserInfo object containing patron level and remaining calls, or null if not authenticated.
2732+
*/
2733+
200: UserInfo | null;
2734+
};
2735+
2736+
export type GetUserInfoResponse = GetUserInfoResponses[keyof GetUserInfoResponses];
2737+
27172738
export type GetGamesData = {
27182739
body?: never;
27192740
path?: never;

0 commit comments

Comments
 (0)