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/dist/sdk.gen.js CHANGED
@@ -13,11 +13,11 @@ var __assign = (this && this.__assign) || function () {
13
13
  };
14
14
  Object.defineProperty(exports, "__esModule", { value: true });
15
15
  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;
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 = exports.getGameTeamStats = exports.getGames = exports.getUsage = exports.getUserInfo = exports.getLines = exports.getLivePlays = exports.getFieldGoalExpectedPoints = void 0;
16
+ 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;
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
  /**
20
- * Retrieve opponent-adjusted team season statistics
20
+ * Returns opponent-adjusted team statistics by season.
21
21
  */
22
22
  var getAdjustedTeamSeasonStats = function (options) {
23
23
  var _a;
@@ -25,7 +25,7 @@ var getAdjustedTeamSeasonStats = function (options) {
25
25
  };
26
26
  exports.getAdjustedTeamSeasonStats = getAdjustedTeamSeasonStats;
27
27
  /**
28
- * Retrieve opponent-adjusted player passing statistics
28
+ * Returns opponent-adjusted player passing metrics.
29
29
  */
30
30
  var getAdjustedPlayerPassingStats = function (options) {
31
31
  var _a;
@@ -33,7 +33,7 @@ var getAdjustedPlayerPassingStats = function (options) {
33
33
  };
34
34
  exports.getAdjustedPlayerPassingStats = getAdjustedPlayerPassingStats;
35
35
  /**
36
- * Retrieve opponent-adjusted player rushing statistics
36
+ * Returns opponent-adjusted player rushing metrics.
37
37
  */
38
38
  var getAdjustedPlayerRushingStats = function (options) {
39
39
  var _a;
@@ -41,7 +41,7 @@ var getAdjustedPlayerRushingStats = function (options) {
41
41
  };
42
42
  exports.getAdjustedPlayerRushingStats = getAdjustedPlayerRushingStats;
43
43
  /**
44
- * Retrieve Points Added Above Replacement (PAAR) ratings for kickers
44
+ * Returns Points Added Above Replacement (PAAR) ratings for kickers.
45
45
  */
46
46
  var getKickerPaar = function (options) {
47
47
  var _a;
@@ -49,7 +49,7 @@ var getKickerPaar = function (options) {
49
49
  };
50
50
  exports.getKickerPaar = getKickerPaar;
51
51
  /**
52
- * Retrieves team information
52
+ * Returns team information and conference affiliations.
53
53
  */
54
54
  var getTeams = function (options) {
55
55
  var _a;
@@ -57,7 +57,7 @@ var getTeams = function (options) {
57
57
  };
58
58
  exports.getTeams = getTeams;
59
59
  /**
60
- * Retrieves information on teams playing in the highest division of CFB
60
+ * Returns Football Bowl Subdivision (FBS) teams for a season.
61
61
  */
62
62
  var getFbsTeams = function (options) {
63
63
  var _a;
@@ -65,7 +65,7 @@ var getFbsTeams = function (options) {
65
65
  };
66
66
  exports.getFbsTeams = getFbsTeams;
67
67
  /**
68
- * Retrieves historical matchup details for two given teams
68
+ * Returns historical matchup results between two teams.
69
69
  */
70
70
  var getMatchup = function (options) {
71
71
  var _a;
@@ -73,7 +73,7 @@ var getMatchup = function (options) {
73
73
  };
74
74
  exports.getMatchup = getMatchup;
75
75
  /**
76
- * Retrieves against-the-spread (ATS) summary by team
76
+ * Returns against-the-spread (ATS) records by team.
77
77
  */
78
78
  var getTeamsAts = function (options) {
79
79
  var _a;
@@ -81,7 +81,7 @@ var getTeamsAts = function (options) {
81
81
  };
82
82
  exports.getTeamsAts = getTeamsAts;
83
83
  /**
84
- * Retrieves historical roster data
84
+ * Returns historical roster data.
85
85
  */
86
86
  var getRoster = function (options) {
87
87
  var _a;
@@ -89,7 +89,7 @@ var getRoster = function (options) {
89
89
  };
90
90
  exports.getRoster = getRoster;
91
91
  /**
92
- * Retrieves list of conferences
92
+ * Returns the available conferences.
93
93
  */
94
94
  var getConferences = function (options) {
95
95
  var _a;
@@ -97,7 +97,7 @@ var getConferences = function (options) {
97
97
  };
98
98
  exports.getConferences = getConferences;
99
99
  /**
100
- * Retrieve 247 Team Talent Composite for a given year
100
+ * Returns 247Sports Team Talent Composite ratings for a season.
101
101
  */
102
102
  var getTalent = function (options) {
103
103
  var _a;
@@ -105,7 +105,7 @@ var getTalent = function (options) {
105
105
  };
106
106
  exports.getTalent = getTalent;
107
107
  /**
108
- * Retrieve list of venues
108
+ * Returns college football venues.
109
109
  */
110
110
  var getVenues = function (options) {
111
111
  var _a;
@@ -113,7 +113,7 @@ var getVenues = function (options) {
113
113
  };
114
114
  exports.getVenues = getVenues;
115
115
  /**
116
- * Retrieves aggregated player statistics for a given season
116
+ * Returns player statistics aggregated by season.
117
117
  */
118
118
  var getPlayerSeasonStats = function (options) {
119
119
  var _a;
@@ -121,7 +121,7 @@ var getPlayerSeasonStats = function (options) {
121
121
  };
122
122
  exports.getPlayerSeasonStats = getPlayerSeasonStats;
123
123
  /**
124
- * Retrieves player passing and rushing success rates by season
124
+ * Returns player passing and rushing success rates by season.
125
125
  */
126
126
  var getPlayerSeasonSuccessRates = function (options) {
127
127
  var _a;
@@ -129,7 +129,7 @@ var getPlayerSeasonSuccessRates = function (options) {
129
129
  };
130
130
  exports.getPlayerSeasonSuccessRates = getPlayerSeasonSuccessRates;
131
131
  /**
132
- * Retrieves player passing and rushing success rates by game
132
+ * Returns player passing and rushing success rates by game.
133
133
  */
134
134
  var getPlayerGameSuccessRates = function (options) {
135
135
  var _a;
@@ -137,7 +137,7 @@ var getPlayerGameSuccessRates = function (options) {
137
137
  };
138
138
  exports.getPlayerGameSuccessRates = getPlayerGameSuccessRates;
139
139
  /**
140
- * Retrieves aggregated team season statistics
140
+ * Returns team statistics aggregated by season.
141
141
  */
142
142
  var getTeamStats = function (options) {
143
143
  var _a;
@@ -145,7 +145,7 @@ var getTeamStats = function (options) {
145
145
  };
146
146
  exports.getTeamStats = getTeamStats;
147
147
  /**
148
- * Gets team statistical categories
148
+ * Returns the available team statistical categories.
149
149
  */
150
150
  var getCategories = function (options) {
151
151
  var _a;
@@ -153,7 +153,7 @@ var getCategories = function (options) {
153
153
  };
154
154
  exports.getCategories = getCategories;
155
155
  /**
156
- * Retrieves advanced season statistics for teams
156
+ * Returns advanced team statistics aggregated by season.
157
157
  */
158
158
  var getAdvancedSeasonStats = function (options) {
159
159
  var _a;
@@ -161,7 +161,7 @@ var getAdvancedSeasonStats = function (options) {
161
161
  };
162
162
  exports.getAdvancedSeasonStats = getAdvancedSeasonStats;
163
163
  /**
164
- * Retrieves advanced statistics aggregated by game
164
+ * Returns advanced team statistics aggregated by game.
165
165
  */
166
166
  var getAdvancedGameStats = function (options) {
167
167
  var _a;
@@ -169,7 +169,7 @@ var getAdvancedGameStats = function (options) {
169
169
  };
170
170
  exports.getAdvancedGameStats = getAdvancedGameStats;
171
171
  /**
172
- * Retrieves havoc statistics aggregated by game
172
+ * Returns team havoc statistics aggregated by game.
173
173
  */
174
174
  var getGameHavocStats = function (options) {
175
175
  var _a;
@@ -177,7 +177,7 @@ var getGameHavocStats = function (options) {
177
177
  };
178
178
  exports.getGameHavocStats = getGameHavocStats;
179
179
  /**
180
- * Retrieves player recruiting rankings
180
+ * Returns player recruiting rankings.
181
181
  */
182
182
  var getRecruits = function (options) {
183
183
  var _a;
@@ -185,7 +185,7 @@ var getRecruits = function (options) {
185
185
  };
186
186
  exports.getRecruits = getRecruits;
187
187
  /**
188
- * Retrieves team recruiting rankings
188
+ * Returns team recruiting rankings.
189
189
  */
190
190
  var getTeamRecruitingRankings = function (options) {
191
191
  var _a;
@@ -193,7 +193,7 @@ var getTeamRecruitingRankings = function (options) {
193
193
  };
194
194
  exports.getTeamRecruitingRankings = getTeamRecruitingRankings;
195
195
  /**
196
- * Retrieves aggregated recruiting statistics by team and position grouping
196
+ * Returns recruiting ratings aggregated by team and position group.
197
197
  */
198
198
  var getAggregatedTeamRecruitingRatings = function (options) {
199
199
  var _a;
@@ -201,7 +201,7 @@ var getAggregatedTeamRecruitingRatings = function (options) {
201
201
  };
202
202
  exports.getAggregatedTeamRecruitingRatings = getAggregatedTeamRecruitingRatings;
203
203
  /**
204
- * Retrieves SP+ ratings for a given year or school
204
+ * Returns SP+ ratings by team and season.
205
205
  */
206
206
  var getSp = function (options) {
207
207
  var _a;
@@ -209,7 +209,7 @@ var getSp = function (options) {
209
209
  };
210
210
  exports.getSp = getSp;
211
211
  /**
212
- * Retrieves aggregated historical conference SP+ data
212
+ * Returns conference-level SP+ ratings by season.
213
213
  */
214
214
  var getConferenceSp = function (options) {
215
215
  var _a;
@@ -217,7 +217,7 @@ var getConferenceSp = function (options) {
217
217
  };
218
218
  exports.getConferenceSp = getConferenceSp;
219
219
  /**
220
- * Retrieves historical SRS for a year or team
220
+ * Returns Simple Rating System (SRS) ratings by team and season.
221
221
  */
222
222
  var getSrs = function (options) {
223
223
  var _a;
@@ -225,7 +225,7 @@ var getSrs = function (options) {
225
225
  };
226
226
  exports.getSrs = getSrs;
227
227
  /**
228
- * Retrieves expanded historical SRS (including FCS) for a year or team
228
+ * Returns expanded Simple Rating System (SRS) ratings, including FCS teams.
229
229
  */
230
230
  var getExpandedSrs = function (options) {
231
231
  var _a;
@@ -233,7 +233,7 @@ var getExpandedSrs = function (options) {
233
233
  };
234
234
  exports.getExpandedSrs = getExpandedSrs;
235
235
  /**
236
- * Retrieves historical Elo ratings
236
+ * Returns historical Elo ratings.
237
237
  */
238
238
  var getElo = function (options) {
239
239
  var _a;
@@ -241,7 +241,7 @@ var getElo = function (options) {
241
241
  };
242
242
  exports.getElo = getElo;
243
243
  /**
244
- * Retrieves historical Football Power Index (FPI) ratings
244
+ * Returns historical Football Power Index (FPI) ratings.
245
245
  */
246
246
  var getFpi = function (options) {
247
247
  var _a;
@@ -249,7 +249,7 @@ var getFpi = function (options) {
249
249
  };
250
250
  exports.getFpi = getFpi;
251
251
  /**
252
- * Retrieves historical poll data
252
+ * Returns historical poll rankings.
253
253
  */
254
254
  var getRankings = function (options) {
255
255
  var _a;
@@ -257,7 +257,7 @@ var getRankings = function (options) {
257
257
  };
258
258
  exports.getRankings = getRankings;
259
259
  /**
260
- * Retrieves historical play data
260
+ * Returns historical play-by-play data.
261
261
  */
262
262
  var getPlays = function (options) {
263
263
  var _a;
@@ -265,7 +265,7 @@ var getPlays = function (options) {
265
265
  };
266
266
  exports.getPlays = getPlays;
267
267
  /**
268
- * Retrieves available play types
268
+ * Returns the available play types.
269
269
  */
270
270
  var getPlayTypes = function (options) {
271
271
  var _a;
@@ -273,7 +273,7 @@ var getPlayTypes = function (options) {
273
273
  };
274
274
  exports.getPlayTypes = getPlayTypes;
275
275
  /**
276
- * Retrieve player-play associations (limit 2000)
276
+ * Returns player and play-stat associations, limited to 2,000 records.
277
277
  */
278
278
  var getPlayStats = function (options) {
279
279
  var _a;
@@ -281,7 +281,7 @@ var getPlayStats = function (options) {
281
281
  };
282
282
  exports.getPlayStats = getPlayStats;
283
283
  /**
284
- * Retrieves available play stat types
284
+ * Returns the available play stat types.
285
285
  */
286
286
  var getPlayStatTypes = function (options) {
287
287
  var _a;
@@ -289,7 +289,7 @@ var getPlayStatTypes = function (options) {
289
289
  };
290
290
  exports.getPlayStatTypes = getPlayStatTypes;
291
291
  /**
292
- * Retrieves the complete College Football Playoff bracket for a season
292
+ * Returns the complete College Football Playoff bracket for a season.
293
293
  */
294
294
  var getCfpPlayoff = function (options) {
295
295
  var _a;
@@ -297,7 +297,7 @@ var getCfpPlayoff = function (options) {
297
297
  };
298
298
  exports.getCfpPlayoff = getCfpPlayoff;
299
299
  /**
300
- * Retrieves College Football Playoff participants for a season
300
+ * Returns College Football Playoff participants for a season.
301
301
  */
302
302
  var getCfpParticipants = function (options) {
303
303
  var _a;
@@ -305,7 +305,7 @@ var getCfpParticipants = function (options) {
305
305
  };
306
306
  exports.getCfpParticipants = getCfpParticipants;
307
307
  /**
308
- * Retrieves College Football Playoff matchups for a season
308
+ * Returns College Football Playoff matchups for a season.
309
309
  */
310
310
  var getCfpGames = function (options) {
311
311
  var _a;
@@ -313,7 +313,7 @@ var getCfpGames = function (options) {
313
313
  };
314
314
  exports.getCfpGames = getCfpGames;
315
315
  /**
316
- * Search for players (lists top 100 results)
316
+ * Returns up to 100 players whose names match the search term.
317
317
  */
318
318
  var searchPlayers = function (options) {
319
319
  var _a;
@@ -321,7 +321,7 @@ var searchPlayers = function (options) {
321
321
  };
322
322
  exports.searchPlayers = searchPlayers;
323
323
  /**
324
- * Retrieves player usage data for a given season
324
+ * Returns player usage metrics for a season.
325
325
  */
326
326
  var getPlayerUsage = function (options) {
327
327
  var _a;
@@ -329,7 +329,8 @@ var getPlayerUsage = function (options) {
329
329
  };
330
330
  exports.getPlayerUsage = getPlayerUsage;
331
331
  /**
332
- * Retrieves a player season overview with box score, usage, and PPA data
332
+ * Returns a player season overview with box score, usage, and Predicted
333
+ * Points Added (PPA) data.
333
334
  */
334
335
  var getPlayerSeasonOverview = function (options) {
335
336
  var _a;
@@ -337,7 +338,7 @@ var getPlayerSeasonOverview = function (options) {
337
338
  };
338
339
  exports.getPlayerSeasonOverview = getPlayerSeasonOverview;
339
340
  /**
340
- * Retrieves returning production data. Either a year or team filter must be specified.
341
+ * Returns returning production metrics by team and season.
341
342
  */
342
343
  var getReturningProduction = function (options) {
343
344
  var _a;
@@ -345,7 +346,7 @@ var getReturningProduction = function (options) {
345
346
  };
346
347
  exports.getReturningProduction = getReturningProduction;
347
348
  /**
348
- * Retrieves transfer portal data for a given year
349
+ * Returns transfer portal entries for a season.
349
350
  */
350
351
  var getTransferPortal = function (options) {
351
352
  var _a;
@@ -353,7 +354,7 @@ var getTransferPortal = function (options) {
353
354
  };
354
355
  exports.getTransferPortal = getTransferPortal;
355
356
  /**
356
- * Query Predicted Points values by down and distance
357
+ * Returns predicted points values by down and distance.
357
358
  */
358
359
  var getPredictedPoints = function (options) {
359
360
  var _a;
@@ -361,7 +362,7 @@ var getPredictedPoints = function (options) {
361
362
  };
362
363
  exports.getPredictedPoints = getPredictedPoints;
363
364
  /**
364
- * Retrieves historical team PPA metrics by season
365
+ * Returns team Predicted Points Added (PPA) metrics by season.
365
366
  */
366
367
  var getPredictedPointsAddedByTeam = function (options) {
367
368
  var _a;
@@ -369,7 +370,7 @@ var getPredictedPointsAddedByTeam = function (options) {
369
370
  };
370
371
  exports.getPredictedPointsAddedByTeam = getPredictedPointsAddedByTeam;
371
372
  /**
372
- * Retrieves historical team PPA metrics by game
373
+ * Returns team Predicted Points Added (PPA) metrics by game.
373
374
  */
374
375
  var getPredictedPointsAddedByGame = function (options) {
375
376
  var _a;
@@ -377,7 +378,7 @@ var getPredictedPointsAddedByGame = function (options) {
377
378
  };
378
379
  exports.getPredictedPointsAddedByGame = getPredictedPointsAddedByGame;
379
380
  /**
380
- * Queries player PPA statistics by game
381
+ * Returns player Predicted Points Added (PPA) metrics by game.
381
382
  */
382
383
  var getPredictedPointsAddedByPlayerGame = function (options) {
383
384
  var _a;
@@ -385,7 +386,7 @@ var getPredictedPointsAddedByPlayerGame = function (options) {
385
386
  };
386
387
  exports.getPredictedPointsAddedByPlayerGame = getPredictedPointsAddedByPlayerGame;
387
388
  /**
388
- * Queries player PPA statistics by season
389
+ * Returns player Predicted Points Added (PPA) metrics by season.
389
390
  */
390
391
  var getPredictedPointsAddedByPlayerSeason = function (options) {
391
392
  var _a;
@@ -393,7 +394,7 @@ var getPredictedPointsAddedByPlayerSeason = function (options) {
393
394
  };
394
395
  exports.getPredictedPointsAddedByPlayerSeason = getPredictedPointsAddedByPlayerSeason;
395
396
  /**
396
- * Query play win probabilities by game
397
+ * Returns play-by-play win probabilities for a game.
397
398
  */
398
399
  var getWinProbability = function (options) {
399
400
  var _a;
@@ -401,7 +402,7 @@ var getWinProbability = function (options) {
401
402
  };
402
403
  exports.getWinProbability = getWinProbability;
403
404
  /**
404
- * Queries pregame win probabilities
405
+ * Returns pregame win probabilities.
405
406
  */
406
407
  var getPregameWinProbabilities = function (options) {
407
408
  var _a;
@@ -409,7 +410,7 @@ var getPregameWinProbabilities = function (options) {
409
410
  };
410
411
  exports.getPregameWinProbabilities = getPregameWinProbabilities;
411
412
  /**
412
- * Queries field goal expected points values
413
+ * Returns expected points values for field goal attempts.
413
414
  */
414
415
  var getFieldGoalExpectedPoints = function (options) {
415
416
  var _a;
@@ -417,7 +418,7 @@ var getFieldGoalExpectedPoints = function (options) {
417
418
  };
418
419
  exports.getFieldGoalExpectedPoints = getFieldGoalExpectedPoints;
419
420
  /**
420
- * Queries live play-by-play data and advanced stats
421
+ * Returns live play-by-play data and advanced metrics for a game.
421
422
  */
422
423
  var getLivePlays = function (options) {
423
424
  var _a;
@@ -425,7 +426,7 @@ var getLivePlays = function (options) {
425
426
  };
426
427
  exports.getLivePlays = getLivePlays;
427
428
  /**
428
- * Retrieves historical betting data
429
+ * Returns historical betting lines and results.
429
430
  */
430
431
  var getLines = function (options) {
431
432
  var _a;
@@ -433,7 +434,8 @@ var getLines = function (options) {
433
434
  };
434
435
  exports.getLines = getLines;
435
436
  /**
436
- * Retrieves information about the user, including their Patreon level and remaining API calls.
437
+ * Returns the authenticated user's Patreon level and remaining API calls.
438
+ * Returns `null` when the request is not authenticated.
437
439
  */
438
440
  var getUserInfo = function (options) {
439
441
  var _a;
@@ -441,7 +443,8 @@ var getUserInfo = function (options) {
441
443
  };
442
444
  exports.getUserInfo = getUserInfo;
443
445
  /**
444
- * Retrieves bounded API usage for the authenticated user's shared CFB/CBB call pool.
446
+ * Returns recent usage for the authenticated user's shared CFB and CBB call
447
+ * pool. Returns `null` when the request is not authenticated.
445
448
  */
446
449
  var getUsage = function (options) {
447
450
  var _a;
@@ -449,7 +452,7 @@ var getUsage = function (options) {
449
452
  };
450
453
  exports.getUsage = getUsage;
451
454
  /**
452
- * Retrieves historical game data
455
+ * Returns historical game data.
453
456
  */
454
457
  var getGames = function (options) {
455
458
  var _a;
@@ -457,7 +460,7 @@ var getGames = function (options) {
457
460
  };
458
461
  exports.getGames = getGames;
459
462
  /**
460
- * Retrieves team box score statistics
463
+ * Returns team box score statistics by game.
461
464
  */
462
465
  var getGameTeamStats = function (options) {
463
466
  var _a;
@@ -465,7 +468,7 @@ var getGameTeamStats = function (options) {
465
468
  };
466
469
  exports.getGameTeamStats = getGameTeamStats;
467
470
  /**
468
- * Retrieves player box score statistics
471
+ * Returns player box score statistics by game.
469
472
  */
470
473
  var getGamePlayerStats = function (options) {
471
474
  var _a;
@@ -473,7 +476,7 @@ var getGamePlayerStats = function (options) {
473
476
  };
474
477
  exports.getGamePlayerStats = getGamePlayerStats;
475
478
  /**
476
- * Retrieves media information for games
479
+ * Returns broadcast and media information for games.
477
480
  */
478
481
  var getMedia = function (options) {
479
482
  var _a;
@@ -481,7 +484,7 @@ var getMedia = function (options) {
481
484
  };
482
485
  exports.getMedia = getMedia;
483
486
  /**
484
- * Retrieve historical and future weather data (Patreon only)
487
+ * Returns historical and forecast weather data for games. Requires Patreon.
485
488
  */
486
489
  var getWeather = function (options) {
487
490
  var _a;
@@ -489,7 +492,7 @@ var getWeather = function (options) {
489
492
  };
490
493
  exports.getWeather = getWeather;
491
494
  /**
492
- * Retrieves historical team records
495
+ * Returns historical team records by season.
493
496
  */
494
497
  var getRecords = function (options) {
495
498
  var _a;
@@ -497,7 +500,7 @@ var getRecords = function (options) {
497
500
  };
498
501
  exports.getRecords = getRecords;
499
502
  /**
500
- * Retrieves calendar information
503
+ * Returns the week-by-week season calendar.
501
504
  */
502
505
  var getCalendar = function (options) {
503
506
  var _a;
@@ -505,7 +508,7 @@ var getCalendar = function (options) {
505
508
  };
506
509
  exports.getCalendar = getCalendar;
507
510
  /**
508
- * Retrieves live scoreboard data
511
+ * Returns current scoreboard data.
509
512
  */
510
513
  var getScoreboard = function (options) {
511
514
  var _a;
@@ -513,7 +516,7 @@ var getScoreboard = function (options) {
513
516
  };
514
517
  exports.getScoreboard = getScoreboard;
515
518
  /**
516
- * Retrieves historical drive data
519
+ * Returns historical drive data.
517
520
  */
518
521
  var getDrives = function (options) {
519
522
  var _a;
@@ -521,7 +524,7 @@ var getDrives = function (options) {
521
524
  };
522
525
  exports.getDrives = getDrives;
523
526
  /**
524
- * Retrieves list of NFL teams
527
+ * Returns the NFL teams represented in draft data.
525
528
  */
526
529
  var getDraftTeams = function (options) {
527
530
  var _a;
@@ -529,7 +532,7 @@ var getDraftTeams = function (options) {
529
532
  };
530
533
  exports.getDraftTeams = getDraftTeams;
531
534
  /**
532
- * Retrieves list of player position categories for the NFL Draft
535
+ * Returns the player position categories used in NFL Draft data.
533
536
  */
534
537
  var getDraftPositions = function (options) {
535
538
  var _a;
@@ -537,7 +540,7 @@ var getDraftPositions = function (options) {
537
540
  };
538
541
  exports.getDraftPositions = getDraftPositions;
539
542
  /**
540
- * Retrieve historical NFL draft data
543
+ * Returns historical NFL Draft picks.
541
544
  */
542
545
  var getDraftPicks = function (options) {
543
546
  var _a;
@@ -545,7 +548,7 @@ var getDraftPicks = function (options) {
545
548
  };
546
549
  exports.getDraftPicks = getDraftPicks;
547
550
  /**
548
- * Retrieves historical head coach information and records
551
+ * Returns historical head coach records.
549
552
  */
550
553
  var getCoaches = function (options) {
551
554
  var _a;
@@ -553,7 +556,31 @@ var getCoaches = function (options) {
553
556
  };
554
557
  exports.getCoaches = getCoaches;
555
558
  /**
556
- * Retrieves an advanced box score for a game
559
+ * Returns a coach profile with canonical identity and career totals.
560
+ */
561
+ var getCoachProfile = function (options) {
562
+ var _a;
563
+ return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/coaches/profile' }));
564
+ };
565
+ exports.getCoachProfile = getCoachProfile;
566
+ /**
567
+ * Returns coach-season records with attributed results and team context.
568
+ */
569
+ var getCoachSeasons = function (options) {
570
+ var _a;
571
+ return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/coaches/seasons' }));
572
+ };
573
+ exports.getCoachSeasons = getCoachSeasons;
574
+ /**
575
+ * Returns continuous head-coaching tenures and their attributed records.
576
+ */
577
+ var getCoachTenures = function (options) {
578
+ var _a;
579
+ return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/coaches/tenures' }));
580
+ };
581
+ exports.getCoachTenures = getCoachTenures;
582
+ /**
583
+ * Returns an advanced box score for a game.
557
584
  */
558
585
  var getAdvancedBoxScore = function (options) {
559
586
  var _a;