cfbd 5.21.0 → 5.23.0

package/dist/sdk.gen.js

@@ -12,12 +12,12 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-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.getCfpGames = exports.getCfpParticipants = exports.getCfpPlayoff = exports.getPlayStatTypes = exports.getPlayStats = exports.getPlayTypes = exports.getPlays = exports.getRankings = exports.getFpi = exports.getElo = exports.getExpandedSrs = exports.getSrs = exports.getConferenceSp = exports.getSp = exports.getAggregatedTeamRecruitingRatings = exports.getTeamRecruitingRankings = exports.getRecruits = exports.getGameHavocStats = exports.getAdvancedGameStats = exports.getAdvancedSeasonStats = exports.getCategories = exports.getTeamStats = exports.getPlayerGameSuccessRates = exports.getPlayerSeasonSuccessRates = 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;
-exports.getAdvancedBoxScore = exports.getCoachTenures = exports.getCoachSeasons = exports.getCoachProfile = exports.getCoaches = exports.getDraftPicks = exports.getDraftPositions = exports.getDraftTeams = exports.getDrives = exports.getScoreboard = exports.getCalendar = exports.getRecords = exports.getWeather = exports.getMedia = exports.getGamePlayerStats = exports.getGameTeamStats = exports.getGames = exports.getUsage = exports.getUserInfo = exports.getLines = exports.getLivePlays = exports.getFieldGoalExpectedPoints = void 0;
+exports.getWinProbability = exports.getPredictedPointsAddedByPlayerSeason = exports.getPredictedPointsAddedByPlayerGame = exports.getPredictedPointsAddedByGame = exports.getPredictedPointsAddedByTeam = exports.getPredictedPoints = exports.getTransferPortal = exports.getReturningProduction = exports.getPlayerSeasonOverview = exports.getPlayerUsage = exports.searchPlayers = exports.getCfpGames = exports.getCfpParticipants = exports.getCfpPlayoff = exports.getPlayStatTypes = exports.getPlayStats = exports.getPlayTypes = exports.getPlays = exports.getRankings = exports.getFpi = exports.getElo = exports.getExpandedSrs = exports.getSrs = exports.getConferenceSp = exports.getSp = exports.getCore = exports.getAggregatedTeamRecruitingRatings = exports.getTeamRecruitingRankings = exports.getRecruits = exports.getGameHavocStats = exports.getAdvancedGameStats = exports.getAdvancedSeasonStats = exports.getCategories = exports.getTeamStats = exports.getPlayerGameSuccessRates = exports.getPlayerSeasonSuccessRates = 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;
+exports.getAdvancedBoxScore = exports.getCoachTenures = exports.getCoachSeasons = exports.getCoachProfile = exports.getCoaches = exports.getDraftPicks = exports.getDraftPositions = exports.getDraftTeams = exports.getDrives = exports.getScoreboard = exports.getCalendar = exports.getRecords = exports.getWeather = exports.getMedia = exports.getGamePlayerStats = exports.getGameTeamStats = exports.getGames = exports.getUsage = exports.getUserInfo = exports.getLines = exports.getLivePlays = exports.getFieldGoalExpectedPoints = exports.getPregameWinProbabilities = void 0;
 var client_fetch_1 = require("@hey-api/client-fetch");
 exports.client = (0, client_fetch_1.createClient)((0, client_fetch_1.createConfig)({ baseUrl: 'https://api.collegefootballdata.com' }));
 /**
- * Retrieve opponent-adjusted team season statistics
+ * Returns opponent-adjusted team statistics by season.
  */
 var getAdjustedTeamSeasonStats = function (options) {
     var _a;
@@ -25,7 +25,7 @@ var getAdjustedTeamSeasonStats = function (options) {
 };
 exports.getAdjustedTeamSeasonStats = getAdjustedTeamSeasonStats;
 /**
- * Retrieve opponent-adjusted player passing statistics
+ * Returns opponent-adjusted player passing metrics.
  */
 var getAdjustedPlayerPassingStats = function (options) {
     var _a;
@@ -33,7 +33,7 @@ var getAdjustedPlayerPassingStats = function (options) {
 };
 exports.getAdjustedPlayerPassingStats = getAdjustedPlayerPassingStats;
 /**
- * Retrieve opponent-adjusted player rushing statistics
+ * Returns opponent-adjusted player rushing metrics.
  */
 var getAdjustedPlayerRushingStats = function (options) {
     var _a;
@@ -41,7 +41,7 @@ var getAdjustedPlayerRushingStats = function (options) {
 };
 exports.getAdjustedPlayerRushingStats = getAdjustedPlayerRushingStats;
 /**
- * Retrieve Points Added Above Replacement (PAAR) ratings for kickers
+ * Returns Points Added Above Replacement (PAAR) ratings for kickers.
  */
 var getKickerPaar = function (options) {
     var _a;
@@ -49,7 +49,7 @@ var getKickerPaar = function (options) {
 };
 exports.getKickerPaar = getKickerPaar;
 /**
- * Retrieves team information
+ * Returns team information and conference affiliations.
  */
 var getTeams = function (options) {
     var _a;
@@ -57,7 +57,7 @@ var getTeams = function (options) {
 };
 exports.getTeams = getTeams;
 /**
- * Retrieves information on teams playing in the highest division of CFB
+ * Returns Football Bowl Subdivision (FBS) teams for a season.
  */
 var getFbsTeams = function (options) {
     var _a;
@@ -65,7 +65,7 @@ var getFbsTeams = function (options) {
 };
 exports.getFbsTeams = getFbsTeams;
 /**
- * Retrieves historical matchup details for two given teams
+ * Returns historical matchup results between two teams.
  */
 var getMatchup = function (options) {
     var _a;
@@ -73,7 +73,7 @@ var getMatchup = function (options) {
 };
 exports.getMatchup = getMatchup;
 /**
- * Retrieves against-the-spread (ATS) summary by team
+ * Returns against-the-spread (ATS) records by team.
  */
 var getTeamsAts = function (options) {
     var _a;
@@ -81,7 +81,7 @@ var getTeamsAts = function (options) {
 };
 exports.getTeamsAts = getTeamsAts;
 /**
- * Retrieves historical roster data
+ * Returns historical roster data.
  */
 var getRoster = function (options) {
     var _a;
@@ -89,7 +89,7 @@ var getRoster = function (options) {
 };
 exports.getRoster = getRoster;
 /**
- * Retrieves list of conferences
+ * Returns the available conferences.
  */
 var getConferences = function (options) {
     var _a;
@@ -97,7 +97,7 @@ var getConferences = function (options) {
 };
 exports.getConferences = getConferences;
 /**
- * Retrieve 247 Team Talent Composite for a given year
+ * Returns 247Sports Team Talent Composite ratings for a season.
  */
 var getTalent = function (options) {
     var _a;
@@ -105,7 +105,7 @@ var getTalent = function (options) {
 };
 exports.getTalent = getTalent;
 /**
- * Retrieve list of venues
+ * Returns college football venues.
  */
 var getVenues = function (options) {
     var _a;
@@ -113,7 +113,7 @@ var getVenues = function (options) {
 };
 exports.getVenues = getVenues;
 /**
- * Retrieves aggregated player statistics for a given season
+ * Returns player statistics aggregated by season.
  */
 var getPlayerSeasonStats = function (options) {
     var _a;
@@ -121,7 +121,7 @@ var getPlayerSeasonStats = function (options) {
 };
 exports.getPlayerSeasonStats = getPlayerSeasonStats;
 /**
- * Retrieves player passing and rushing success rates by season
+ * Returns player passing and rushing success rates by season.
  */
 var getPlayerSeasonSuccessRates = function (options) {
     var _a;
@@ -129,7 +129,7 @@ var getPlayerSeasonSuccessRates = function (options) {
 };
 exports.getPlayerSeasonSuccessRates = getPlayerSeasonSuccessRates;
 /**
- * Retrieves player passing and rushing success rates by game
+ * Returns player passing and rushing success rates by game.
  */
 var getPlayerGameSuccessRates = function (options) {
     var _a;
@@ -137,7 +137,7 @@ var getPlayerGameSuccessRates = function (options) {
 };
 exports.getPlayerGameSuccessRates = getPlayerGameSuccessRates;
 /**
- * Retrieves aggregated team season statistics
+ * Returns team statistics aggregated by season.
  */
 var getTeamStats = function (options) {
     var _a;
@@ -145,7 +145,7 @@ var getTeamStats = function (options) {
 };
 exports.getTeamStats = getTeamStats;
 /**
- * Gets team statistical categories
+ * Returns the available team statistical categories.
  */
 var getCategories = function (options) {
     var _a;
@@ -153,7 +153,7 @@ var getCategories = function (options) {
 };
 exports.getCategories = getCategories;
 /**
- * Retrieves advanced season statistics for teams
+ * Returns advanced team statistics aggregated by season.
  */
 var getAdvancedSeasonStats = function (options) {
     var _a;
@@ -161,7 +161,7 @@ var getAdvancedSeasonStats = function (options) {
 };
 exports.getAdvancedSeasonStats = getAdvancedSeasonStats;
 /**
- * Retrieves advanced statistics aggregated by game
+ * Returns advanced team statistics aggregated by game.
  */
 var getAdvancedGameStats = function (options) {
     var _a;
@@ -169,7 +169,7 @@ var getAdvancedGameStats = function (options) {
 };
 exports.getAdvancedGameStats = getAdvancedGameStats;
 /**
- * Retrieves havoc statistics aggregated by game
+ * Returns team havoc statistics aggregated by game.
  */
 var getGameHavocStats = function (options) {
     var _a;
@@ -177,7 +177,7 @@ var getGameHavocStats = function (options) {
 };
 exports.getGameHavocStats = getGameHavocStats;
 /**
- * Retrieves player recruiting rankings
+ * Returns player recruiting rankings.
  */
 var getRecruits = function (options) {
     var _a;
@@ -185,7 +185,7 @@ var getRecruits = function (options) {
 };
 exports.getRecruits = getRecruits;
 /**
- * Retrieves team recruiting rankings
+ * Returns team recruiting rankings.
  */
 var getTeamRecruitingRankings = function (options) {
     var _a;
@@ -193,7 +193,7 @@ var getTeamRecruitingRankings = function (options) {
 };
 exports.getTeamRecruitingRankings = getTeamRecruitingRankings;
 /**
- * Retrieves aggregated recruiting statistics by team and position grouping
+ * Returns recruiting ratings aggregated by team and position group.
  */
 var getAggregatedTeamRecruitingRatings = function (options) {
     var _a;
@@ -201,7 +201,16 @@ var getAggregatedTeamRecruitingRatings = function (options) {
 };
 exports.getAggregatedTeamRecruitingRatings = getAggregatedTeamRecruitingRatings;
 /**
- * Retrieves SP+ ratings for a given year or school
+ * Returns Context & Opponent-Relative Efficiency (CORE) ratings.
+ * At least one of `year` or `team` is required.
+ */
+var getCore = function (options) {
+    var _a;
+    return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/ratings/core' }));
+};
+exports.getCore = getCore;
+/**
+ * Returns SP+ ratings by team and season.
  */
 var getSp = function (options) {
     var _a;
@@ -209,7 +218,7 @@ var getSp = function (options) {
 };
 exports.getSp = getSp;
 /**
- * Retrieves aggregated historical conference SP+ data
+ * Returns conference-level SP+ ratings by season.
  */
 var getConferenceSp = function (options) {
     var _a;
@@ -217,7 +226,7 @@ var getConferenceSp = function (options) {
 };
 exports.getConferenceSp = getConferenceSp;
 /**
- * Retrieves historical SRS for a year or team
+ * Returns Simple Rating System (SRS) ratings by team and season.
  */
 var getSrs = function (options) {
     var _a;
@@ -225,7 +234,7 @@ var getSrs = function (options) {
 };
 exports.getSrs = getSrs;
 /**
- * Retrieves expanded historical SRS (including FCS) for a year or team
+ * Returns expanded Simple Rating System (SRS) ratings, including FCS teams.
  */
 var getExpandedSrs = function (options) {
     var _a;
@@ -233,7 +242,7 @@ var getExpandedSrs = function (options) {
 };
 exports.getExpandedSrs = getExpandedSrs;
 /**
- * Retrieves historical Elo ratings
+ * Returns historical Elo ratings.
  */
 var getElo = function (options) {
     var _a;
@@ -241,7 +250,7 @@ var getElo = function (options) {
 };
 exports.getElo = getElo;
 /**
- * Retrieves historical Football Power Index (FPI) ratings
+ * Returns historical Football Power Index (FPI) ratings.
  */
 var getFpi = function (options) {
     var _a;
@@ -249,7 +258,7 @@ var getFpi = function (options) {
 };
 exports.getFpi = getFpi;
 /**
- * Retrieves historical poll data
+ * Returns historical poll rankings.
  */
 var getRankings = function (options) {
     var _a;
@@ -257,7 +266,7 @@ var getRankings = function (options) {
 };
 exports.getRankings = getRankings;
 /**
- * Retrieves historical play data
+ * Returns historical play-by-play data.
  */
 var getPlays = function (options) {
     var _a;
@@ -265,7 +274,7 @@ var getPlays = function (options) {
 };
 exports.getPlays = getPlays;
 /**
- * Retrieves available play types
+ * Returns the available play types.
  */
 var getPlayTypes = function (options) {
     var _a;
@@ -273,7 +282,7 @@ var getPlayTypes = function (options) {
 };
 exports.getPlayTypes = getPlayTypes;
 /**
- * Retrieve player-play associations (limit 2000)
+ * Returns player and play-stat associations, limited to 2,000 records.
  */
 var getPlayStats = function (options) {
     var _a;
@@ -281,7 +290,7 @@ var getPlayStats = function (options) {
 };
 exports.getPlayStats = getPlayStats;
 /**
- * Retrieves available play stat types
+ * Returns the available play stat types.
  */
 var getPlayStatTypes = function (options) {
     var _a;
@@ -289,7 +298,7 @@ var getPlayStatTypes = function (options) {
 };
 exports.getPlayStatTypes = getPlayStatTypes;
 /**
- * Retrieves the complete College Football Playoff bracket for a season
+ * Returns the complete College Football Playoff bracket for a season.
  */
 var getCfpPlayoff = function (options) {
     var _a;
@@ -297,7 +306,7 @@ var getCfpPlayoff = function (options) {
 };
 exports.getCfpPlayoff = getCfpPlayoff;
 /**
- * Retrieves College Football Playoff participants for a season
+ * Returns College Football Playoff participants for a season.
  */
 var getCfpParticipants = function (options) {
     var _a;
@@ -305,7 +314,7 @@ var getCfpParticipants = function (options) {
 };
 exports.getCfpParticipants = getCfpParticipants;
 /**
- * Retrieves College Football Playoff matchups for a season
+ * Returns College Football Playoff matchups for a season.
  */
 var getCfpGames = function (options) {
     var _a;
@@ -313,7 +322,7 @@ var getCfpGames = function (options) {
 };
 exports.getCfpGames = getCfpGames;
 /**
- * Search for players (lists top 100 results)
+ * Returns up to 100 players whose names match the search term.
  */
 var searchPlayers = function (options) {
     var _a;
@@ -321,7 +330,7 @@ var searchPlayers = function (options) {
 };
 exports.searchPlayers = searchPlayers;
 /**
- * Retrieves player usage data for a given season
+ * Returns player usage metrics for a season.
  */
 var getPlayerUsage = function (options) {
     var _a;
@@ -329,7 +338,8 @@ var getPlayerUsage = function (options) {
 };
 exports.getPlayerUsage = getPlayerUsage;
 /**
- * Retrieves a player season overview with box score, usage, and PPA data
+ * Returns a player season overview with box score, usage, and Predicted
+ * Points Added (PPA) data.
  */
 var getPlayerSeasonOverview = function (options) {
     var _a;
@@ -337,7 +347,7 @@ var getPlayerSeasonOverview = function (options) {
 };
 exports.getPlayerSeasonOverview = getPlayerSeasonOverview;
 /**
- * Retrieves returning production data. Either a year or team filter must be specified.
+ * Returns returning production metrics by team and season.
  */
 var getReturningProduction = function (options) {
     var _a;
@@ -345,7 +355,7 @@ var getReturningProduction = function (options) {
 };
 exports.getReturningProduction = getReturningProduction;
 /**
- * Retrieves transfer portal data for a given year
+ * Returns transfer portal entries for a season.
  */
 var getTransferPortal = function (options) {
     var _a;
@@ -353,7 +363,7 @@ var getTransferPortal = function (options) {
 };
 exports.getTransferPortal = getTransferPortal;
 /**
- * Query Predicted Points values by down and distance
+ * Returns predicted points values by down and distance.
  */
 var getPredictedPoints = function (options) {
     var _a;
@@ -361,7 +371,7 @@ var getPredictedPoints = function (options) {
 };
 exports.getPredictedPoints = getPredictedPoints;
 /**
- * Retrieves historical team PPA metrics by season
+ * Returns team Predicted Points Added (PPA) metrics by season.
  */
 var getPredictedPointsAddedByTeam = function (options) {
     var _a;
@@ -369,7 +379,7 @@ var getPredictedPointsAddedByTeam = function (options) {
 };
 exports.getPredictedPointsAddedByTeam = getPredictedPointsAddedByTeam;
 /**
- * Retrieves historical team PPA metrics by game
+ * Returns team Predicted Points Added (PPA) metrics by game.
  */
 var getPredictedPointsAddedByGame = function (options) {
     var _a;
@@ -377,7 +387,7 @@ var getPredictedPointsAddedByGame = function (options) {
 };
 exports.getPredictedPointsAddedByGame = getPredictedPointsAddedByGame;
 /**
- * Queries player PPA statistics by game
+ * Returns player Predicted Points Added (PPA) metrics by game.
  */
 var getPredictedPointsAddedByPlayerGame = function (options) {
     var _a;
@@ -385,7 +395,7 @@ var getPredictedPointsAddedByPlayerGame = function (options) {
 };
 exports.getPredictedPointsAddedByPlayerGame = getPredictedPointsAddedByPlayerGame;
 /**
- * Queries player PPA statistics by season
+ * Returns player Predicted Points Added (PPA) metrics by season.
  */
 var getPredictedPointsAddedByPlayerSeason = function (options) {
     var _a;
@@ -393,7 +403,7 @@ var getPredictedPointsAddedByPlayerSeason = function (options) {
 };
 exports.getPredictedPointsAddedByPlayerSeason = getPredictedPointsAddedByPlayerSeason;
 /**
- * Query play win probabilities by game
+ * Returns play-by-play win probabilities for a game.
  */
 var getWinProbability = function (options) {
     var _a;
@@ -401,7 +411,7 @@ var getWinProbability = function (options) {
 };
 exports.getWinProbability = getWinProbability;
 /**
- * Queries pregame win probabilities
+ * Returns pregame win probabilities.
  */
 var getPregameWinProbabilities = function (options) {
     var _a;
@@ -409,7 +419,7 @@ var getPregameWinProbabilities = function (options) {
 };
 exports.getPregameWinProbabilities = getPregameWinProbabilities;
 /**
- * Queries field goal expected points values
+ * Returns expected points values for field goal attempts.
  */
 var getFieldGoalExpectedPoints = function (options) {
     var _a;
@@ -417,7 +427,7 @@ var getFieldGoalExpectedPoints = function (options) {
 };
 exports.getFieldGoalExpectedPoints = getFieldGoalExpectedPoints;
 /**
- * Queries live play-by-play data and advanced stats
+ * Returns live play-by-play data and advanced metrics for a game.
  */
 var getLivePlays = function (options) {
     var _a;
@@ -425,7 +435,7 @@ var getLivePlays = function (options) {
 };
 exports.getLivePlays = getLivePlays;
 /**
- * Retrieves historical betting data
+ * Returns historical betting lines and results.
  */
 var getLines = function (options) {
     var _a;
@@ -433,7 +443,8 @@ var getLines = function (options) {
 };
 exports.getLines = getLines;
 /**
- * Retrieves information about the user, including their Patreon level and remaining API calls.
+ * Returns the authenticated user's Patreon level and remaining API calls.
+ * Returns `null` when the request is not authenticated.
  */
 var getUserInfo = function (options) {
     var _a;
@@ -441,7 +452,8 @@ var getUserInfo = function (options) {
 };
 exports.getUserInfo = getUserInfo;
 /**
- * Retrieves bounded API usage for the authenticated user's shared CFB/CBB call pool.
+ * Returns recent usage for the authenticated user's shared CFB and CBB call
+ * pool. Returns `null` when the request is not authenticated.
  */
 var getUsage = function (options) {
     var _a;
@@ -449,7 +461,7 @@ var getUsage = function (options) {
 };
 exports.getUsage = getUsage;
 /**
- * Retrieves historical game data
+ * Returns historical game data.
  */
 var getGames = function (options) {
     var _a;
@@ -457,7 +469,7 @@ var getGames = function (options) {
 };
 exports.getGames = getGames;
 /**
- * Retrieves team box score statistics
+ * Returns team box score statistics by game.
  */
 var getGameTeamStats = function (options) {
     var _a;
@@ -465,7 +477,7 @@ var getGameTeamStats = function (options) {
 };
 exports.getGameTeamStats = getGameTeamStats;
 /**
- * Retrieves player box score statistics
+ * Returns player box score statistics by game.
  */
 var getGamePlayerStats = function (options) {
     var _a;
@@ -473,7 +485,7 @@ var getGamePlayerStats = function (options) {
 };
 exports.getGamePlayerStats = getGamePlayerStats;
 /**
- * Retrieves media information for games
+ * Returns broadcast and media information for games.
  */
 var getMedia = function (options) {
     var _a;
@@ -481,7 +493,7 @@ var getMedia = function (options) {
 };
 exports.getMedia = getMedia;
 /**
- * Retrieve historical and future weather data (Patreon only)
+ * Returns historical and forecast weather data for games. Requires Patreon.
  */
 var getWeather = function (options) {
     var _a;
@@ -489,7 +501,7 @@ var getWeather = function (options) {
 };
 exports.getWeather = getWeather;
 /**
- * Retrieves historical team records
+ * Returns historical team records by season.
  */
 var getRecords = function (options) {
     var _a;
@@ -497,7 +509,7 @@ var getRecords = function (options) {
 };
 exports.getRecords = getRecords;
 /**
- * Retrieves calendar information
+ * Returns the week-by-week season calendar.
  */
 var getCalendar = function (options) {
     var _a;
@@ -505,7 +517,7 @@ var getCalendar = function (options) {
 };
 exports.getCalendar = getCalendar;
 /**
- * Retrieves live scoreboard data
+ * Returns current scoreboard data.
  */
 var getScoreboard = function (options) {
     var _a;
@@ -513,7 +525,7 @@ var getScoreboard = function (options) {
 };
 exports.getScoreboard = getScoreboard;
 /**
- * Retrieves historical drive data
+ * Returns historical drive data.
  */
 var getDrives = function (options) {
     var _a;
@@ -521,7 +533,7 @@ var getDrives = function (options) {
 };
 exports.getDrives = getDrives;
 /**
- * Retrieves list of NFL teams
+ * Returns the NFL teams represented in draft data.
  */
 var getDraftTeams = function (options) {
     var _a;
@@ -529,7 +541,7 @@ var getDraftTeams = function (options) {
 };
 exports.getDraftTeams = getDraftTeams;
 /**
- * Retrieves list of player position categories for the NFL Draft
+ * Returns the player position categories used in NFL Draft data.
  */
 var getDraftPositions = function (options) {
     var _a;
@@ -537,7 +549,7 @@ var getDraftPositions = function (options) {
 };
 exports.getDraftPositions = getDraftPositions;
 /**
- * Retrieve historical NFL draft data
+ * Returns historical NFL Draft picks.
  */
 var getDraftPicks = function (options) {
     var _a;
@@ -545,7 +557,7 @@ var getDraftPicks = function (options) {
 };
 exports.getDraftPicks = getDraftPicks;
 /**
- * Retrieves historical head coach information and records
+ * Returns historical head coach records.
  */
 var getCoaches = function (options) {
     var _a;
@@ -553,7 +565,7 @@ var getCoaches = function (options) {
 };
 exports.getCoaches = getCoaches;
 /**
- * Retrieves canonical coach identity and complete career totals
+ * Returns a coach profile with canonical identity and career totals.
  */
 var getCoachProfile = function (options) {
     var _a;
@@ -561,8 +573,7 @@ var getCoachProfile = function (options) {
 };
 exports.getCoachProfile = getCoachProfile;
 /**
- * Retrieves detailed coach-season records with attributed results and
- * whole-team season context
+ * Returns coach-season records with attributed results and team context.
  */
 var getCoachSeasons = function (options) {
     var _a;
@@ -570,7 +581,7 @@ var getCoachSeasons = function (options) {
 };
 exports.getCoachSeasons = getCoachSeasons;
 /**
- * Retrieves continuous head-coaching stints and attributed records
+ * Returns continuous head-coaching tenures and their attributed records.
  */
 var getCoachTenures = function (options) {
     var _a;
@@ -578,7 +589,7 @@ var getCoachTenures = function (options) {
 };
 exports.getCoachTenures = getCoachTenures;
 /**
- * Retrieves an advanced box score for a game
+ * Returns an advanced box score for a game.
  */
 var getAdvancedBoxScore = function (options) {
     var _a;