feat(info): new user info endpoint

Author: github-actions[bot]

package.json

@@ -1,6 +1,6 @@
 {
   "name": "cfbd",
-  "version": "5.6.24",
+  "version": "5.7.0",
   "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.",
   "repository": {
     "type": "git",

src/sdk.gen.ts

@@ -1,7 +1,7 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
 import type { Options as ClientOptions, TDataShape, Client } from './client';
-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';
+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';
 import { client as _heyApiClient } from './client.gen';
 
 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
     });
 };
 
+/**
+ * Retrieves information about the user, including their Patreon level and remaining API calls.
+ */
+export const getUserInfo = <ThrowOnError extends boolean = false>(options?: Options<GetUserInfoData, ThrowOnError>) => {
+    return (options?.client ?? _heyApiClient).get<GetUserInfoResponses, unknown, ThrowOnError>({
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/info',
+        ...options
+    });
+};
+
 /**
  * Retrieves historical game data
  */

src/types.gen.ts

@@ -951,6 +951,11 @@ export type BettingGame = {
     lines: Array<GameLine>;
 };
 
+export type UserInfo = {
+    patronLevel: number;
+    remainingCalls: number;
+};
+
 export type Game = {
     id: number;
     season: number;
@@ -2714,6 +2719,22 @@ export type GetLinesResponses = {
 
 export type GetLinesResponse = GetLinesResponses[keyof GetLinesResponses];
 
+export type GetUserInfoData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/info';
+};
+
+export type GetUserInfoResponses = {
+    /**
+     * UserInfo object containing patron level and remaining calls, or null if not authenticated.
+     */
+    200: UserInfo | null;
+};
+
+export type GetUserInfoResponse = GetUserInfoResponses[keyof GetUserInfoResponses];
+
 export type GetGamesData = {
     body?: never;
     path?: never;