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.
@@ -302,6 +302,7 @@ export type CalendarWeek = {
302
302
  */
303
303
  lastGameStart: string;
304
304
  };
305
+ export type CfpCoachSeasonOutcome = 'active' | 'eliminated' | 'champion';
305
306
  export type CfpPlayoff = {
306
307
  season: number;
307
308
  competition: PlayoffCompetition_Cfp;
@@ -317,18 +318,114 @@ export type CfpPlayoffNotFound = {
317
318
  };
318
319
  export type message = 'CFP playoff not found';
319
320
  export type Coach = {
321
+ id: number;
320
322
  firstName: string;
321
323
  lastName: string;
324
+ /**
325
+ * @deprecated
326
+ */
322
327
  hireDate: (string) | null;
323
328
  seasons: Array<CoachSeason>;
324
329
  };
330
+ export type CoachAlmaMater = {
331
+ id: number;
332
+ school: string;
333
+ };
334
+ export type CoachCareer = {
335
+ games: number;
336
+ wins: number;
337
+ losses: number;
338
+ ties: number;
339
+ winPercentage: (number) | null;
340
+ seasons: number;
341
+ teams: number;
342
+ firstYear: number;
343
+ lastYear: number;
344
+ };
345
+ export type CoachCfpContext = {
346
+ appeared: boolean;
347
+ seed: (number) | null;
348
+ outcome: ((CfpCoachSeasonOutcome) | null);
349
+ };
350
+ export type CoachDraftContext = {
351
+ year: number;
352
+ totalPicks: number;
353
+ firstRoundPicks: number;
354
+ };
355
+ export type CoachNotFound = {
356
+ message: 'Coach not found';
357
+ };
358
+ export type message2 = 'Coach not found';
359
+ export type CoachPollResume = {
360
+ preseasonRank: (number) | null;
361
+ postseasonRank: (number) | null;
362
+ bestRank: (number) | null;
363
+ weeksRanked: number;
364
+ weeksTopTen: number;
365
+ };
366
+ export type CoachProfile = {
367
+ id: number;
368
+ firstName: string;
369
+ lastName: string;
370
+ displayName: (string) | null;
371
+ currentTeam: ((CoachSeasonTeamReference) | null);
372
+ career: CoachCareer;
373
+ birthDate: (string) | null;
374
+ almaMater: ((CoachAlmaMater) | null);
375
+ graduationYear: (number) | null;
376
+ wikidataId: (string) | null;
377
+ hallOfFameYear: (number) | null;
378
+ };
379
+ export type CoachRatingContext = {
380
+ spSpecialTeams: (number) | null;
381
+ strengthOfSchedule: (number) | null;
382
+ secondOrderWins: (number) | null;
383
+ fpi: (number) | null;
384
+ yearOverYear: {
385
+ spOverall: (number) | null;
386
+ srs: (number) | null;
387
+ wins: (number) | null;
388
+ };
389
+ };
390
+ export type CoachRecord = {
391
+ games: number;
392
+ wins: number;
393
+ losses: number;
394
+ ties: number;
395
+ winPercentage: (number) | null;
396
+ };
397
+ export type CoachRecordSplits = {
398
+ conference: CoachRecord;
399
+ postseason: CoachRecord;
400
+ home: CoachRecord;
401
+ away: CoachRecord;
402
+ neutral: CoachRecord;
403
+ };
404
+ export type CoachRecruitingContext = {
405
+ rank: (number) | null;
406
+ points: (number) | null;
407
+ talent: (number) | null;
408
+ };
409
+ export type CoachReference = {
410
+ id: number;
411
+ firstName: string;
412
+ lastName: string;
413
+ };
414
+ export type CoachScoring = {
415
+ pointsFor: number;
416
+ pointsAgainst: number;
417
+ averagePointDifferential: (number) | null;
418
+ };
325
419
  export type CoachSeason = {
420
+ teamId: number;
326
421
  school: string;
422
+ conference: (string) | null;
327
423
  year: number;
328
424
  games: number;
329
425
  wins: number;
330
426
  losses: number;
331
427
  ties: number;
428
+ winPercentage: (number) | null;
332
429
  preseasonRank: (number) | null;
333
430
  postseasonRank: (number) | null;
334
431
  srs: (number) | null;
@@ -336,6 +433,30 @@ export type CoachSeason = {
336
433
  spOffense: (number) | null;
337
434
  spDefense: (number) | null;
338
435
  };
436
+ export type CoachSeasonTeamReference = {
437
+ id: number;
438
+ school: string;
439
+ conference: (string) | null;
440
+ };
441
+ export type CoachTeamReference = {
442
+ id: number;
443
+ school: string;
444
+ };
445
+ export type CoachTenure = {
446
+ id: number;
447
+ coach: CoachReference;
448
+ team: CoachTeamReference;
449
+ hireDate: (string) | null;
450
+ startYear: number;
451
+ endYear: (number) | null;
452
+ effectiveStart: (string) | null;
453
+ effectiveEnd: (string) | null;
454
+ isInterim: boolean;
455
+ active: boolean;
456
+ seasons: number;
457
+ record: CoachRecord;
458
+ attributionComplete: boolean;
459
+ };
339
460
  export type Conference = {
340
461
  id: number;
341
462
  name: string;
@@ -378,6 +499,30 @@ export type ConferenceSP = {
378
499
  rating: (number) | null;
379
500
  };
380
501
  };
502
+ export type DetailedCoachSeason = {
503
+ games: number;
504
+ wins: number;
505
+ losses: number;
506
+ ties: number;
507
+ winPercentage: (number) | null;
508
+ coach: CoachReference;
509
+ team: CoachSeasonTeamReference;
510
+ year: number;
511
+ preseasonRank: (number) | null;
512
+ postseasonRank: (number) | null;
513
+ srs: (number) | null;
514
+ spOverall: (number) | null;
515
+ spOffense: (number) | null;
516
+ spDefense: (number) | null;
517
+ teamMetrics: CoachRatingContext;
518
+ recruiting: CoachRecruitingContext;
519
+ pollResume: ((CoachPollResume) | null);
520
+ attributionComplete: boolean;
521
+ recordSplits: ((CoachRecordSplits) | null);
522
+ scoring: ((CoachScoring) | null);
523
+ cfp: CoachCfpContext;
524
+ draftFollowingSeason: ((CoachDraftContext) | null);
525
+ };
381
526
  export type DivisionClassification = 'fbs' | 'fcs' | 'ii' | 'iii';
382
527
  export type DraftPick = {
383
528
  collegeAthleteId: (number) | null;
@@ -1596,15 +1741,15 @@ export type Venue = {
1596
1741
  export type GetAdjustedTeamSeasonStatsData = {
1597
1742
  query?: {
1598
1743
  /**
1599
- * Optional conference filter
1744
+ * Conference name or abbreviation.
1600
1745
  */
1601
1746
  conference?: string;
1602
1747
  /**
1603
- * Optional team filter
1748
+ * Team name.
1604
1749
  */
1605
1750
  team?: string;
1606
1751
  /**
1607
- * Optional year filter
1752
+ * Season year.
1608
1753
  */
1609
1754
  year?: number;
1610
1755
  };
@@ -1614,19 +1759,19 @@ export type GetAdjustedTeamSeasonStatsError = unknown;
1614
1759
  export type GetAdjustedPlayerPassingStatsData = {
1615
1760
  query?: {
1616
1761
  /**
1617
- * Optional conference abbreviation filter
1762
+ * Conference abbreviation.
1618
1763
  */
1619
1764
  conference?: string;
1620
1765
  /**
1621
- * Optional position abbreviation filter
1766
+ * Player position abbreviation.
1622
1767
  */
1623
1768
  position?: string;
1624
1769
  /**
1625
- * Optional team filter
1770
+ * Team name.
1626
1771
  */
1627
1772
  team?: string;
1628
1773
  /**
1629
- * Optional year filter
1774
+ * Season year.
1630
1775
  */
1631
1776
  year?: number;
1632
1777
  };
@@ -1636,19 +1781,19 @@ export type GetAdjustedPlayerPassingStatsError = unknown;
1636
1781
  export type GetAdjustedPlayerRushingStatsData = {
1637
1782
  query?: {
1638
1783
  /**
1639
- * Optional conference abbreviation filter
1784
+ * Conference abbreviation.
1640
1785
  */
1641
1786
  conference?: string;
1642
1787
  /**
1643
- * Optional position abbreviation filter
1788
+ * Player position abbreviation.
1644
1789
  */
1645
1790
  position?: string;
1646
1791
  /**
1647
- * Optional team filter
1792
+ * Team name.
1648
1793
  */
1649
1794
  team?: string;
1650
1795
  /**
1651
- * Optional year filter
1796
+ * Season year.
1652
1797
  */
1653
1798
  year?: number;
1654
1799
  };
@@ -1658,15 +1803,15 @@ export type GetAdjustedPlayerRushingStatsError = unknown;
1658
1803
  export type GetKickerPaarData = {
1659
1804
  query?: {
1660
1805
  /**
1661
- * Optional conference abbreviation filter
1806
+ * Conference abbreviation.
1662
1807
  */
1663
1808
  conference?: string;
1664
1809
  /**
1665
- * Optional team filter
1810
+ * Team name.
1666
1811
  */
1667
1812
  team?: string;
1668
1813
  /**
1669
- * Optional year filter
1814
+ * Season year.
1670
1815
  */
1671
1816
  year?: number;
1672
1817
  };
@@ -1676,11 +1821,11 @@ export type GetKickerPaarError = unknown;
1676
1821
  export type GetTeamsData = {
1677
1822
  query?: {
1678
1823
  /**
1679
- * Optional conference abbreviation filter
1824
+ * Conference abbreviation.
1680
1825
  */
1681
1826
  conference?: string;
1682
1827
  /**
1683
- * Optional year filter to get historical conference affiliations
1828
+ * Season year for historical conference affiliations.
1684
1829
  */
1685
1830
  year?: number;
1686
1831
  };
@@ -1690,7 +1835,7 @@ export type GetTeamsError = unknown;
1690
1835
  export type GetFbsTeamsData = {
1691
1836
  query?: {
1692
1837
  /**
1693
- * Year or season
1838
+ * Season year.
1694
1839
  */
1695
1840
  year?: number;
1696
1841
  };
@@ -1700,19 +1845,19 @@ export type GetFbsTeamsError = unknown;
1700
1845
  export type GetMatchupData = {
1701
1846
  query: {
1702
1847
  /**
1703
- * Optional ending year
1848
+ * Latest season year to include.
1704
1849
  */
1705
1850
  maxYear?: number;
1706
1851
  /**
1707
- * Optional starting year
1852
+ * Earliest season year to include.
1708
1853
  */
1709
1854
  minYear?: number;
1710
1855
  /**
1711
- * First team to compare
1856
+ * First team name.
1712
1857
  */
1713
1858
  team1: string;
1714
1859
  /**
1715
- * Second team to compare
1860
+ * Second team name.
1716
1861
  */
1717
1862
  team2: string;
1718
1863
  };
@@ -1722,15 +1867,15 @@ export type GetMatchupError = unknown;
1722
1867
  export type GetTeamsAtsData = {
1723
1868
  query: {
1724
1869
  /**
1725
- * Optional conference filter
1870
+ * Conference name or abbreviation.
1726
1871
  */
1727
1872
  conference?: string;
1728
1873
  /**
1729
- * Optional team filter
1874
+ * Team name.
1730
1875
  */
1731
1876
  team?: string;
1732
1877
  /**
1733
- * Required year filter
1878
+ * Season year.
1734
1879
  */
1735
1880
  year: number;
1736
1881
  };
@@ -1740,15 +1885,15 @@ export type GetTeamsAtsError = unknown;
1740
1885
  export type GetRosterData = {
1741
1886
  query?: {
1742
1887
  /**
1743
- * Optional filter to only include players from FBS or FCS teams
1888
+ * Division classification: `fbs` or `fcs`.
1744
1889
  */
1745
1890
  classification?: DivisionClassification;
1746
1891
  /**
1747
- * Optional team filter
1892
+ * Team name.
1748
1893
  */
1749
1894
  team?: string;
1750
1895
  /**
1751
- * Optional year filter, defaults to 2025
1896
+ * Season year. Defaults to 2025.
1752
1897
  */
1753
1898
  year?: number;
1754
1899
  };
@@ -1760,7 +1905,7 @@ export type GetConferencesError = unknown;
1760
1905
  export type GetTalentData = {
1761
1906
  query: {
1762
1907
  /**
1763
- * Year filter
1908
+ * Season year.
1764
1909
  */
1765
1910
  year: number;
1766
1911
  };
@@ -1772,31 +1917,31 @@ export type GetVenuesError = unknown;
1772
1917
  export type GetPlayerSeasonStatsData = {
1773
1918
  query: {
1774
1919
  /**
1775
- * Optional category filter
1920
+ * Statistical category.
1776
1921
  */
1777
1922
  category?: string;
1778
1923
  /**
1779
- * Optional conference filter
1924
+ * Conference name or abbreviation.
1780
1925
  */
1781
1926
  conference?: string;
1782
1927
  /**
1783
- * Optional ending week range
1928
+ * Latest week to include.
1784
1929
  */
1785
1930
  endWeek?: number;
1786
1931
  /**
1787
- * Optional season type filter
1932
+ * Season type.
1788
1933
  */
1789
1934
  seasonType?: SeasonType;
1790
1935
  /**
1791
- * Optional starting week range
1936
+ * Earliest week to include.
1792
1937
  */
1793
1938
  startWeek?: number;
1794
1939
  /**
1795
- * Optional team filter
1940
+ * Team name.
1796
1941
  */
1797
1942
  team?: string;
1798
1943
  /**
1799
- * Required year filter
1944
+ * Season year.
1800
1945
  */
1801
1946
  year: number;
1802
1947
  };
@@ -1806,39 +1951,39 @@ export type GetPlayerSeasonStatsError = unknown;
1806
1951
  export type GetPlayerSeasonSuccessRatesData = {
1807
1952
  query?: {
1808
1953
  /**
1809
- * Optional conference abbreviation filter
1954
+ * Conference abbreviation.
1810
1955
  */
1811
1956
  conference?: string;
1812
1957
  /**
1813
- * Optional ending week range
1958
+ * Latest week to include.
1814
1959
  */
1815
1960
  endWeek?: number;
1816
1961
  /**
1817
- * Optional flag to exclude garbage time plays
1962
+ * Excludes garbage-time plays when `true`.
1818
1963
  */
1819
1964
  excludeGarbageTime?: boolean;
1820
1965
  /**
1821
- * Player ID filter, required if year not specified
1966
+ * Player ID. Required unless `year` is specified.
1822
1967
  */
1823
1968
  playerId?: number;
1824
1969
  /**
1825
- * Optional season type filter
1970
+ * Season type.
1826
1971
  */
1827
1972
  seasonType?: SeasonType;
1828
1973
  /**
1829
- * Optional starting week range
1974
+ * Earliest week to include.
1830
1975
  */
1831
1976
  startWeek?: number;
1832
1977
  /**
1833
- * Optional team filter
1978
+ * Team name.
1834
1979
  */
1835
1980
  team?: string;
1836
1981
  /**
1837
- * Optional minimum credited passing plus rushing plays
1982
+ * Minimum credited passing and rushing plays.
1838
1983
  */
1839
1984
  threshold?: number;
1840
1985
  /**
1841
- * Year filter, required if playerId not specified
1986
+ * Season year. Required unless `playerId` is specified.
1842
1987
  */
1843
1988
  year?: number;
1844
1989
  };
@@ -1848,35 +1993,35 @@ export type GetPlayerSeasonSuccessRatesError = unknown;
1848
1993
  export type GetPlayerGameSuccessRatesData = {
1849
1994
  query: {
1850
1995
  /**
1851
- * Optional conference abbreviation filter
1996
+ * Conference abbreviation.
1852
1997
  */
1853
1998
  conference?: string;
1854
1999
  /**
1855
- * Optional flag to exclude garbage time plays
2000
+ * Excludes garbage-time plays when `true`.
1856
2001
  */
1857
2002
  excludeGarbageTime?: boolean;
1858
2003
  /**
1859
- * Optional player ID filter
2004
+ * Player ID.
1860
2005
  */
1861
2006
  playerId?: number;
1862
2007
  /**
1863
- * Optional season type filter
2008
+ * Season type.
1864
2009
  */
1865
2010
  seasonType?: SeasonType;
1866
2011
  /**
1867
- * Optional team filter
2012
+ * Team name.
1868
2013
  */
1869
2014
  team?: string;
1870
2015
  /**
1871
- * Optional minimum credited passing plus rushing plays
2016
+ * Minimum credited passing and rushing plays.
1872
2017
  */
1873
2018
  threshold?: number;
1874
2019
  /**
1875
- * Week filter, required if team and playerId not specified
2020
+ * Week number. Required unless `team` or `playerId` is specified.
1876
2021
  */
1877
2022
  week?: number;
1878
2023
  /**
1879
- * Required year filter
2024
+ * Season year.
1880
2025
  */
1881
2026
  year: number;
1882
2027
  };
@@ -1886,27 +2031,27 @@ export type GetPlayerGameSuccessRatesError = unknown;
1886
2031
  export type GetTeamStatsData = {
1887
2032
  query?: {
1888
2033
  /**
1889
- * Optional division classification filter, defaults to fbs
2034
+ * Division classification. Defaults to `fbs`.
1890
2035
  */
1891
2036
  classification?: DivisionClassification;
1892
2037
  /**
1893
- * Optional conference filter
2038
+ * Conference name or abbreviation.
1894
2039
  */
1895
2040
  conference?: string;
1896
2041
  /**
1897
- * Optional week end range filter
2042
+ * Latest week to include.
1898
2043
  */
1899
2044
  endWeek?: number;
1900
2045
  /**
1901
- * Optional week start range filter
2046
+ * Earliest week to include.
1902
2047
  */
1903
2048
  startWeek?: number;
1904
2049
  /**
1905
- * Team filter, required if year not specified
2050
+ * Team name. Required unless `year` is specified.
1906
2051
  */
1907
2052
  team?: string;
1908
2053
  /**
1909
- * Year filter, required if team not specified
2054
+ * Season year. Required unless `team` is specified.
1910
2055
  */
1911
2056
  year?: number;
1912
2057
  };
@@ -1918,27 +2063,28 @@ export type GetCategoriesError = unknown;
1918
2063
  export type GetAdvancedSeasonStatsData = {
1919
2064
  query?: {
1920
2065
  /**
1921
- * Optional division classification filter, defaults to fbs
2066
+ * Division classification. Defaults to `fbs`.
1922
2067
  */
1923
2068
  classification?: DivisionClassification;
1924
2069
  /**
1925
- * Optional end week range filter
2070
+ * Latest week to include.
1926
2071
  */
1927
2072
  endWeek?: number;
1928
2073
  /**
1929
- * Garbage time exclusion filter, defaults to false
2074
+ * Excludes garbage-time plays when `true`. Defaults
2075
+ * to `false`.
1930
2076
  */
1931
2077
  excludeGarbageTime?: boolean;
1932
2078
  /**
1933
- * Optional start week range filter
2079
+ * Earliest week to include.
1934
2080
  */
1935
2081
  startWeek?: number;
1936
2082
  /**
1937
- * Team filter, required if year not specified
2083
+ * Team name. Required unless `year` is specified.
1938
2084
  */
1939
2085
  team?: string;
1940
2086
  /**
1941
- * Year filter, required if team not specified
2087
+ * Season year. Required unless `team` is specified.
1942
2088
  */
1943
2089
  year?: number;
1944
2090
  };
@@ -1948,27 +2094,28 @@ export type GetAdvancedSeasonStatsError = unknown;
1948
2094
  export type GetAdvancedGameStatsData = {
1949
2095
  query?: {
1950
2096
  /**
1951
- * Garbage time exclusion filter, defaults to false
2097
+ * Excludes garbage-time plays when `true`. Defaults
2098
+ * to `false`.
1952
2099
  */
1953
2100
  excludeGarbageTime?: boolean;
1954
2101
  /**
1955
- * Optional opponent filter
2102
+ * Opponent team name.
1956
2103
  */
1957
2104
  opponent?: string;
1958
2105
  /**
1959
- * Optional season type filter
2106
+ * Season type.
1960
2107
  */
1961
2108
  seasonType?: SeasonType;
1962
2109
  /**
1963
- * Team filter, required if year not specified
2110
+ * Team name. Required unless `year` is specified.
1964
2111
  */
1965
2112
  team?: string;
1966
2113
  /**
1967
- * Optional week filter
2114
+ * Week number.
1968
2115
  */
1969
2116
  week?: number;
1970
2117
  /**
1971
- * Year filter, required if team not specified
2118
+ * Season year. Required unless `team` is specified.
1972
2119
  */
1973
2120
  year?: number;
1974
2121
  };
@@ -1978,23 +2125,23 @@ export type GetAdvancedGameStatsError = unknown;
1978
2125
  export type GetGameHavocStatsData = {
1979
2126
  query?: {
1980
2127
  /**
1981
- * Optional opponent filter
2128
+ * Opponent team name.
1982
2129
  */
1983
2130
  opponent?: string;
1984
2131
  /**
1985
- * Optional season type filter
2132
+ * Season type.
1986
2133
  */
1987
2134
  seasonType?: SeasonType;
1988
2135
  /**
1989
- * Team filter, required if year not specified
2136
+ * Team name. Required unless `year` is specified.
1990
2137
  */
1991
2138
  team?: string;
1992
2139
  /**
1993
- * Optional week filter
2140
+ * Week number.
1994
2141
  */
1995
2142
  week?: number;
1996
2143
  /**
1997
- * Year filter, required if team not specified
2144
+ * Season year. Required unless `team` is specified.
1998
2145
  */
1999
2146
  year?: number;
2000
2147
  };
@@ -2004,23 +2151,23 @@ export type GetGameHavocStatsError = unknown;
2004
2151
  export type GetRecruitsData = {
2005
2152
  query?: {
2006
2153
  /**
2007
- * Optional recruit type classification filter, defaults to HighSchool
2154
+ * Recruit classification. Defaults to `HighSchool`.
2008
2155
  */
2009
2156
  classification?: RecruitClassification;
2010
2157
  /**
2011
- * Optional position categorization filter
2158
+ * Position category.
2012
2159
  */
2013
2160
  position?: string;
2014
2161
  /**
2015
- * Optional state/province filter
2162
+ * State or province abbreviation.
2016
2163
  */
2017
2164
  state?: string;
2018
2165
  /**
2019
- * Team filter, required when no team specified
2166
+ * Team name. Required unless `year` is specified.
2020
2167
  */
2021
2168
  team?: string;
2022
2169
  /**
2023
- * Year filter, required when no team specified
2170
+ * Recruiting class year. Required unless `team` is specified.
2024
2171
  */
2025
2172
  year?: number;
2026
2173
  };
@@ -2030,11 +2177,11 @@ export type GetRecruitsError = unknown;
2030
2177
  export type GetTeamRecruitingRankingsData = {
2031
2178
  query?: {
2032
2179
  /**
2033
- * Optional team filter
2180
+ * Team name.
2034
2181
  */
2035
2182
  team?: string;
2036
2183
  /**
2037
- * Optional year filter
2184
+ * Recruiting class year.
2038
2185
  */
2039
2186
  year?: number;
2040
2187
  };
@@ -2044,23 +2191,23 @@ export type GetTeamRecruitingRankingsError = unknown;
2044
2191
  export type GetAggregatedTeamRecruitingRatingsData = {
2045
2192
  query?: {
2046
2193
  /**
2047
- * Optional conference filter
2194
+ * Conference name or abbreviation.
2048
2195
  */
2049
2196
  conference?: string;
2050
2197
  /**
2051
- * Optional end year range, defaults to current year
2198
+ * Latest recruiting class year. Defaults to the current year.
2052
2199
  */
2053
2200
  endYear?: number;
2054
2201
  /**
2055
- * Optional recruit type filter, defaults to HighSchool
2202
+ * Recruit classification. Defaults to `HighSchool`.
2056
2203
  */
2057
2204
  recruitType?: RecruitClassification;
2058
2205
  /**
2059
- * Optional start year range, defaults to 2000
2206
+ * Earliest recruiting class year. Defaults to 2000.
2060
2207
  */
2061
2208
  startYear?: number;
2062
2209
  /**
2063
- * Optional team filter
2210
+ * Team name.
2064
2211
  */
2065
2212
  team?: string;
2066
2213
  };
@@ -2070,11 +2217,11 @@ export type GetAggregatedTeamRecruitingRatingsError = unknown;
2070
2217
  export type GetSpData = {
2071
2218
  query?: {
2072
2219
  /**
2073
- * Team filter, required if year not specified
2220
+ * Team name. Required unless `year` is specified.
2074
2221
  */
2075
2222
  team?: string;
2076
2223
  /**
2077
- * Year filter, required if team not specified
2224
+ * Season year. Required unless `team` is specified.
2078
2225
  */
2079
2226
  year?: number;
2080
2227
  };
@@ -2084,15 +2231,15 @@ export type GetSpError = unknown;
2084
2231
  export type GetConferenceSpData = {
2085
2232
  query?: {
2086
2233
  /**
2087
- * Optional division classification filter, defaults to fbs
2234
+ * Division classification. Defaults to `fbs`.
2088
2235
  */
2089
2236
  classification?: DivisionClassification;
2090
2237
  /**
2091
- * Optional conference filter
2238
+ * Conference name or abbreviation.
2092
2239
  */
2093
2240
  conference?: string;
2094
2241
  /**
2095
- * Optional year filter
2242
+ * Season year.
2096
2243
  */
2097
2244
  year?: number;
2098
2245
  };
@@ -2102,15 +2249,15 @@ export type GetConferenceSpError = unknown;
2102
2249
  export type GetSrsData = {
2103
2250
  query?: {
2104
2251
  /**
2105
- * Optional conference filter
2252
+ * Conference name or abbreviation.
2106
2253
  */
2107
2254
  conference?: string;
2108
2255
  /**
2109
- * Team filter, required if year not specified
2256
+ * Team name. Required unless `year` is specified.
2110
2257
  */
2111
2258
  team?: string;
2112
2259
  /**
2113
- * Year filter, required if team not specified
2260
+ * Season year. Required unless `team` is specified.
2114
2261
  */
2115
2262
  year?: number;
2116
2263
  };
@@ -2120,19 +2267,19 @@ export type GetSrsError = unknown;
2120
2267
  export type GetExpandedSrsData = {
2121
2268
  query?: {
2122
2269
  /**
2123
- * Optional division classification filter (fbs or fcs)
2270
+ * Division classification: `fbs` or `fcs`.
2124
2271
  */
2125
2272
  classification?: DivisionClassification;
2126
2273
  /**
2127
- * Optional conference filter
2274
+ * Conference name or abbreviation.
2128
2275
  */
2129
2276
  conference?: string;
2130
2277
  /**
2131
- * Team filter, required if year not specified
2278
+ * Team name. Required unless `year` is specified.
2132
2279
  */
2133
2280
  team?: string;
2134
2281
  /**
2135
- * Year filter, required if team not specified
2282
+ * Season year. Required unless `team` is specified.
2136
2283
  */
2137
2284
  year?: number;
2138
2285
  };
@@ -2142,23 +2289,24 @@ export type GetExpandedSrsError = unknown;
2142
2289
  export type GetEloData = {
2143
2290
  query?: {
2144
2291
  /**
2145
- * Optional conference filter
2292
+ * Conference name or abbreviation.
2146
2293
  */
2147
2294
  conference?: string;
2148
2295
  /**
2149
- * Optional season type filter
2296
+ * Season type.
2150
2297
  */
2151
2298
  seasonType?: SeasonType;
2152
2299
  /**
2153
- * Optional team filter
2300
+ * Team name.
2154
2301
  */
2155
2302
  team?: string;
2156
2303
  /**
2157
- * Optional week filter, defaults to last available week in the season
2304
+ * Week number. Defaults to the latest available week in the
2305
+ * season.
2158
2306
  */
2159
2307
  week?: number;
2160
2308
  /**
2161
- * Optional year filter
2309
+ * Season year.
2162
2310
  */
2163
2311
  year?: number;
2164
2312
  };
@@ -2168,15 +2316,15 @@ export type GetEloError = unknown;
2168
2316
  export type GetFpiData = {
2169
2317
  query?: {
2170
2318
  /**
2171
- * Optional conference filter
2319
+ * Conference name or abbreviation.
2172
2320
  */
2173
2321
  conference?: string;
2174
2322
  /**
2175
- * team filter, required if year not specified
2323
+ * Team name. Required unless `year` is specified.
2176
2324
  */
2177
2325
  team?: string;
2178
2326
  /**
2179
- * year filter, required if team not specified
2327
+ * Season year. Required unless `team` is specified.
2180
2328
  */
2181
2329
  year?: number;
2182
2330
  };
@@ -2186,27 +2334,30 @@ export type GetFpiError = unknown;
2186
2334
  export type GetRankingsData = {
2187
2335
  query: {
2188
2336
  /**
2189
- * Return the marked final CFP snapshot
2337
+ * Returns the CFP snapshot marked as final when `true`. Requires
2338
+ * `poll=cfp` and cannot be combined with `latest`.
2190
2339
  */
2191
2340
  final?: boolean;
2192
2341
  /**
2193
- * Return the latest CFP snapshot, preferring the marked final
2342
+ * Returns the latest CFP snapshot when `true`, preferring the
2343
+ * snapshot marked as final. Requires `poll=cfp` and cannot be combined with
2344
+ * `final`.
2194
2345
  */
2195
2346
  latest?: boolean;
2196
2347
  /**
2197
- * Optional poll filter
2348
+ * Poll name.
2198
2349
  */
2199
2350
  poll?: RankingPoll;
2200
2351
  /**
2201
- * Optional season type filter
2352
+ * Season type.
2202
2353
  */
2203
2354
  seasonType?: SeasonType;
2204
2355
  /**
2205
- * Optional week filter
2356
+ * Poll week.
2206
2357
  */
2207
2358
  week?: number;
2208
2359
  /**
2209
- * Required year filter
2360
+ * Season year.
2210
2361
  */
2211
2362
  year: number;
2212
2363
  };
@@ -2218,47 +2369,47 @@ export type GetRankingsError = ({
2218
2369
  export type GetPlaysData = {
2219
2370
  query: {
2220
2371
  /**
2221
- * Optional division classification filter
2372
+ * Division classification of either team.
2222
2373
  */
2223
2374
  classification?: DivisionClassification;
2224
2375
  /**
2225
- * Optional conference filter
2376
+ * Conference of either team.
2226
2377
  */
2227
2378
  conference?: string;
2228
2379
  /**
2229
- * Optional defensive team filter
2380
+ * Defensive team name.
2230
2381
  */
2231
2382
  defense?: string;
2232
2383
  /**
2233
- * Optional defensive conference filter
2384
+ * Defensive team conference.
2234
2385
  */
2235
2386
  defenseConference?: string;
2236
2387
  /**
2237
- * Optional offensive team filter
2388
+ * Offensive team name.
2238
2389
  */
2239
2390
  offense?: string;
2240
2391
  /**
2241
- * Optional offensive conference filter
2392
+ * Offensive team conference.
2242
2393
  */
2243
2394
  offenseConference?: string;
2244
2395
  /**
2245
- * Optoinal play type abbreviation filter
2396
+ * Play type abbreviation.
2246
2397
  */
2247
2398
  playType?: string;
2248
2399
  /**
2249
- * Optional season type filter
2400
+ * Season type.
2250
2401
  */
2251
2402
  seasonType?: SeasonType;
2252
2403
  /**
2253
- * Optional team filter
2404
+ * Team name on either side of the play.
2254
2405
  */
2255
2406
  team?: string;
2256
2407
  /**
2257
- * Required week filter
2408
+ * Week number.
2258
2409
  */
2259
2410
  week: number;
2260
2411
  /**
2261
- * Required year filter
2412
+ * Season year.
2262
2413
  */
2263
2414
  year: number;
2264
2415
  };
@@ -2270,35 +2421,35 @@ export type GetPlayTypesError = unknown;
2270
2421
  export type GetPlayStatsData = {
2271
2422
  query?: {
2272
2423
  /**
2273
- * Optional athleteId filter
2424
+ * Athlete ID.
2274
2425
  */
2275
2426
  athleteId?: number;
2276
2427
  /**
2277
- * Optional conference filter
2428
+ * Conference name or abbreviation.
2278
2429
  */
2279
2430
  conference?: string;
2280
2431
  /**
2281
- * Optional gameId filter
2432
+ * Game ID.
2282
2433
  */
2283
2434
  gameId?: number;
2284
2435
  /**
2285
- * Optional season type filter
2436
+ * Season type.
2286
2437
  */
2287
2438
  seasonType?: SeasonType;
2288
2439
  /**
2289
- * Optional statTypeId filter
2440
+ * Play stat type ID.
2290
2441
  */
2291
2442
  statTypeId?: number;
2292
2443
  /**
2293
- * Optional team filter
2444
+ * Team name.
2294
2445
  */
2295
2446
  team?: string;
2296
2447
  /**
2297
- * Optional week filter
2448
+ * Week number.
2298
2449
  */
2299
2450
  week?: number;
2300
2451
  /**
2301
- * Optional year filter
2452
+ * Season year.
2302
2453
  */
2303
2454
  year?: number;
2304
2455
  };
@@ -2310,7 +2461,7 @@ export type GetPlayStatTypesError = unknown;
2310
2461
  export type GetCfpPlayoffData = {
2311
2462
  query: {
2312
2463
  /**
2313
- * Required year filter
2464
+ * Season year.
2314
2465
  */
2315
2466
  year: number;
2316
2467
  };
@@ -2322,7 +2473,7 @@ export type GetCfpPlayoffError = ({
2322
2473
  export type GetCfpParticipantsData = {
2323
2474
  query: {
2324
2475
  /**
2325
- * Required year filter
2476
+ * Season year.
2326
2477
  */
2327
2478
  year: number;
2328
2479
  };
@@ -2334,11 +2485,11 @@ export type GetCfpParticipantsError = ({
2334
2485
  export type GetCfpGamesData = {
2335
2486
  query: {
2336
2487
  /**
2337
- * Optional playoff round filter
2488
+ * Playoff round.
2338
2489
  */
2339
2490
  round?: PlayoffRound;
2340
2491
  /**
2341
- * Required year filter
2492
+ * Season year.
2342
2493
  */
2343
2494
  year: number;
2344
2495
  };
@@ -2350,19 +2501,19 @@ export type GetCfpGamesError = ({
2350
2501
  export type SearchPlayersData = {
2351
2502
  query: {
2352
2503
  /**
2353
- * Optional position abbreviation filter
2504
+ * Player position abbreviation.
2354
2505
  */
2355
2506
  position?: string;
2356
2507
  /**
2357
- * Search term for matching player name
2508
+ * Full or partial player name.
2358
2509
  */
2359
2510
  searchTerm: string;
2360
2511
  /**
2361
- * Optional team filter
2512
+ * Team name.
2362
2513
  */
2363
2514
  team?: string;
2364
2515
  /**
2365
- * Optional year filter
2516
+ * Season year.
2366
2517
  */
2367
2518
  year?: number;
2368
2519
  };
@@ -2372,27 +2523,28 @@ export type SearchPlayersError = unknown;
2372
2523
  export type GetPlayerUsageData = {
2373
2524
  query: {
2374
2525
  /**
2375
- * Optional conference abbreviation filter
2526
+ * Conference abbreviation.
2376
2527
  */
2377
2528
  conference?: string;
2378
2529
  /**
2379
- * Optional exclude garbage time flag, defaults to false
2530
+ * Excludes garbage-time plays when `true`. Defaults
2531
+ * to `false`.
2380
2532
  */
2381
2533
  excludeGarbageTime?: boolean;
2382
2534
  /**
2383
- * Optional player id filter
2535
+ * Player ID.
2384
2536
  */
2385
2537
  playerId?: number;
2386
2538
  /**
2387
- * Optional position abbreivation filter
2539
+ * Player position abbreviation.
2388
2540
  */
2389
2541
  position?: string;
2390
2542
  /**
2391
- * Optional team filter
2543
+ * Team name.
2392
2544
  */
2393
2545
  team?: string;
2394
2546
  /**
2395
- * Required year filter
2547
+ * Season year.
2396
2548
  */
2397
2549
  year: number;
2398
2550
  };
@@ -2402,11 +2554,11 @@ export type GetPlayerUsageError = unknown;
2402
2554
  export type GetPlayerSeasonOverviewData = {
2403
2555
  query: {
2404
2556
  /**
2405
- * Required player id filter
2557
+ * Player ID.
2406
2558
  */
2407
2559
  playerId: number;
2408
2560
  /**
2409
- * Required year filter
2561
+ * Season year.
2410
2562
  */
2411
2563
  year: number;
2412
2564
  };
@@ -2416,15 +2568,15 @@ export type GetPlayerSeasonOverviewError = unknown;
2416
2568
  export type GetReturningProductionData = {
2417
2569
  query?: {
2418
2570
  /**
2419
- * Optional conference filter
2571
+ * Conference name or abbreviation.
2420
2572
  */
2421
2573
  conference?: string;
2422
2574
  /**
2423
- * Team filter, required if year not specified
2575
+ * Team name. Required unless `year` is specified.
2424
2576
  */
2425
2577
  team?: string;
2426
2578
  /**
2427
- * Year filter, required if team not specified
2579
+ * Season year. Required unless `team` is specified.
2428
2580
  */
2429
2581
  year?: number;
2430
2582
  };
@@ -2434,7 +2586,7 @@ export type GetReturningProductionError = unknown;
2434
2586
  export type GetTransferPortalData = {
2435
2587
  query: {
2436
2588
  /**
2437
- * Required year filter
2589
+ * Season year.
2438
2590
  */
2439
2591
  year: number;
2440
2592
  };
@@ -2444,11 +2596,11 @@ export type GetTransferPortalError = unknown;
2444
2596
  export type GetPredictedPointsData = {
2445
2597
  query: {
2446
2598
  /**
2447
- * Distance value
2599
+ * Distance to gain, in yards.
2448
2600
  */
2449
2601
  distance: number;
2450
2602
  /**
2451
- * Down value
2603
+ * Down number.
2452
2604
  */
2453
2605
  down: number;
2454
2606
  };
@@ -2458,23 +2610,23 @@ export type GetPredictedPointsError = unknown;
2458
2610
  export type GetPredictedPointsAddedByTeamData = {
2459
2611
  query?: {
2460
2612
  /**
2461
- * Optional division classification filter, defaults to fbs
2613
+ * Division classification. Defaults to `fbs`.
2462
2614
  */
2463
2615
  classification?: DivisionClassification;
2464
2616
  /**
2465
- * Conference abbreviation filter
2617
+ * Conference abbreviation.
2466
2618
  */
2467
2619
  conference?: string;
2468
2620
  /**
2469
- * Exclude garbage time plays
2621
+ * Excludes garbage-time plays when `true`.
2470
2622
  */
2471
2623
  excludeGarbageTime?: boolean;
2472
2624
  /**
2473
- * Team filter, required if year not specified
2625
+ * Team name. Required unless `year` is specified.
2474
2626
  */
2475
2627
  team?: string;
2476
2628
  /**
2477
- * Year filter, required if team not specified
2629
+ * Season year. Required unless `team` is specified.
2478
2630
  */
2479
2631
  year?: number;
2480
2632
  };
@@ -2484,31 +2636,31 @@ export type GetPredictedPointsAddedByTeamError = unknown;
2484
2636
  export type GetPredictedPointsAddedByGameData = {
2485
2637
  query: {
2486
2638
  /**
2487
- * Optional division classification filter, defaults to fbs
2639
+ * Division classification. Defaults to `fbs`.
2488
2640
  */
2489
2641
  classification?: DivisionClassification;
2490
2642
  /**
2491
- * Optional conference abbreviation filter
2643
+ * Conference abbreviation.
2492
2644
  */
2493
2645
  conference?: string;
2494
2646
  /**
2495
- * Optional flag to exclude garbage time plays
2647
+ * Excludes garbage-time plays when `true`.
2496
2648
  */
2497
2649
  excludeGarbageTime?: boolean;
2498
2650
  /**
2499
- * Optional season type filter
2651
+ * Season type.
2500
2652
  */
2501
2653
  seasonType?: SeasonType;
2502
2654
  /**
2503
- * Optional team filter
2655
+ * Team name.
2504
2656
  */
2505
2657
  team?: string;
2506
2658
  /**
2507
- * Optional week filter
2659
+ * Week number.
2508
2660
  */
2509
2661
  week?: number;
2510
2662
  /**
2511
- * Required year filter
2663
+ * Season year.
2512
2664
  */
2513
2665
  year: number;
2514
2666
  };
@@ -2518,35 +2670,35 @@ export type GetPredictedPointsAddedByGameError = unknown;
2518
2670
  export type GetPredictedPointsAddedByPlayerGameData = {
2519
2671
  query: {
2520
2672
  /**
2521
- * Optional flag to exclude garbage time plays
2673
+ * Excludes garbage-time plays when `true`.
2522
2674
  */
2523
2675
  excludeGarbageTime?: boolean;
2524
2676
  /**
2525
- * Optional player ID filter
2677
+ * Player ID.
2526
2678
  */
2527
2679
  playerId?: string;
2528
2680
  /**
2529
- * Optional player position abbreviation filter
2681
+ * Player position abbreviation.
2530
2682
  */
2531
2683
  position?: string;
2532
2684
  /**
2533
- * Optional season type filter
2685
+ * Season type.
2534
2686
  */
2535
2687
  seasonType?: SeasonType;
2536
2688
  /**
2537
- * Team filter, required if week not specified
2689
+ * Team name. Required unless `week` is specified.
2538
2690
  */
2539
2691
  team?: string;
2540
2692
  /**
2541
- * Threshold value for minimum number of plays
2693
+ * Minimum number of plays.
2542
2694
  */
2543
2695
  threshold?: number;
2544
2696
  /**
2545
- * Week filter, required if team not specified
2697
+ * Week number. Required unless `team` is specified.
2546
2698
  */
2547
2699
  week?: number;
2548
2700
  /**
2549
- * Required year filter
2701
+ * Season year.
2550
2702
  */
2551
2703
  year: number;
2552
2704
  };
@@ -2556,31 +2708,31 @@ export type GetPredictedPointsAddedByPlayerGameError = unknown;
2556
2708
  export type GetPredictedPointsAddedByPlayerSeasonData = {
2557
2709
  query?: {
2558
2710
  /**
2559
- * Optional conference abbreviation filter
2711
+ * Conference abbreviation.
2560
2712
  */
2561
2713
  conference?: string;
2562
2714
  /**
2563
- * Optional flag to exclude garbage time plays
2715
+ * Excludes garbage-time plays when `true`.
2564
2716
  */
2565
2717
  excludeGarbageTime?: boolean;
2566
2718
  /**
2567
- * Player ID filter, required if year not specified
2719
+ * Player ID. Required unless `year` is specified.
2568
2720
  */
2569
2721
  playerId?: string;
2570
2722
  /**
2571
- * Optional position abbreviation filter
2723
+ * Player position abbreviation.
2572
2724
  */
2573
2725
  position?: string;
2574
2726
  /**
2575
- * Optional team filter
2727
+ * Team name.
2576
2728
  */
2577
2729
  team?: string;
2578
2730
  /**
2579
- * Threshold value for minimum number of plays
2731
+ * Minimum number of plays.
2580
2732
  */
2581
2733
  threshold?: number;
2582
2734
  /**
2583
- * Year filter, required if playerId not specified
2735
+ * Season year. Required unless `playerId` is specified.
2584
2736
  */
2585
2737
  year?: number;
2586
2738
  };
@@ -2590,7 +2742,7 @@ export type GetPredictedPointsAddedByPlayerSeasonError = unknown;
2590
2742
  export type GetWinProbabilityData = {
2591
2743
  query: {
2592
2744
  /**
2593
- * Required game ID filter
2745
+ * Game ID.
2594
2746
  */
2595
2747
  gameId: number;
2596
2748
  };
@@ -2600,19 +2752,19 @@ export type GetWinProbabilityError = unknown;
2600
2752
  export type GetPregameWinProbabilitiesData = {
2601
2753
  query?: {
2602
2754
  /**
2603
- * Optional season type filter
2755
+ * Season type.
2604
2756
  */
2605
2757
  seasonType?: SeasonType;
2606
2758
  /**
2607
- * Optional team filter
2759
+ * Team name.
2608
2760
  */
2609
2761
  team?: string;
2610
2762
  /**
2611
- * Optional week filter
2763
+ * Week number.
2612
2764
  */
2613
2765
  week?: number;
2614
2766
  /**
2615
- * Optional year filter
2767
+ * Season year.
2616
2768
  */
2617
2769
  year?: number;
2618
2770
  };
@@ -2624,7 +2776,7 @@ export type GetFieldGoalExpectedPointsError = unknown;
2624
2776
  export type GetLivePlaysData = {
2625
2777
  query: {
2626
2778
  /**
2627
- * Game Id filter
2779
+ * Game ID.
2628
2780
  */
2629
2781
  gameId: number;
2630
2782
  };
@@ -2634,39 +2786,39 @@ export type GetLivePlaysError = unknown;
2634
2786
  export type GetLinesData = {
2635
2787
  query?: {
2636
2788
  /**
2637
- * Optional away team filter
2789
+ * Away team name.
2638
2790
  */
2639
2791
  away?: string;
2640
2792
  /**
2641
- * Optional conference filter
2793
+ * Conference of either team.
2642
2794
  */
2643
2795
  conference?: string;
2644
2796
  /**
2645
- * Optional gameId filter
2797
+ * Game ID.
2646
2798
  */
2647
2799
  gameId?: number;
2648
2800
  /**
2649
- * Optional home team filter
2801
+ * Home team name.
2650
2802
  */
2651
2803
  home?: string;
2652
2804
  /**
2653
- * Optional provider name filter
2805
+ * Betting line provider.
2654
2806
  */
2655
2807
  provider?: string;
2656
2808
  /**
2657
- * Optional season type filter
2809
+ * Season type.
2658
2810
  */
2659
2811
  seasonType?: SeasonType;
2660
2812
  /**
2661
- * Optional team filter
2813
+ * Team name on either side of the game.
2662
2814
  */
2663
2815
  team?: string;
2664
2816
  /**
2665
- * Optional week filter
2817
+ * Week number.
2666
2818
  */
2667
2819
  week?: number;
2668
2820
  /**
2669
- * Year filter, required if game id not specified
2821
+ * Season year. Required unless `gameId` is specified.
2670
2822
  */
2671
2823
  year?: number;
2672
2824
  };
@@ -2678,15 +2830,16 @@ export type GetUserInfoError = unknown;
2678
2830
  export type GetUsageData = {
2679
2831
  query?: {
2680
2832
  /**
2681
- * Optional API filter: all, cfb, or cbb
2833
+ * API to include: `all`, `cfb`, or `cbb`.
2682
2834
  */
2683
2835
  api?: UserUsageApi;
2684
2836
  /**
2685
- * Number of trailing days to include, defaults to 7 and is capped at 31
2837
+ * Trailing days to include. Defaults to 7; maximum 31.
2686
2838
  */
2687
2839
  days?: number;
2688
2840
  /**
2689
- * Number of endpoint and recent request rows to return, defaults to 10 and is capped at 50
2841
+ * Maximum endpoint and request rows to return. Defaults to 10;
2842
+ * maximum 50.
2690
2843
  */
2691
2844
  limit?: number;
2692
2845
  };
@@ -2696,47 +2849,47 @@ export type GetUsageError = unknown;
2696
2849
  export type GetGamesData = {
2697
2850
  query?: {
2698
2851
  /**
2699
- * Optional away team filter
2852
+ * Away team name.
2700
2853
  */
2701
2854
  away?: string;
2702
2855
  /**
2703
- * Optional division classification filter
2856
+ * Division classification.
2704
2857
  */
2705
2858
  classification?: DivisionClassification;
2706
2859
  /**
2707
- * Optional playoff competition filter
2860
+ * Playoff competition.
2708
2861
  */
2709
2862
  competition?: PlayoffCompetition;
2710
2863
  /**
2711
- * Optional conference filter
2864
+ * Conference of either team.
2712
2865
  */
2713
2866
  conference?: string;
2714
2867
  /**
2715
- * Optional home team filter
2868
+ * Home team name.
2716
2869
  */
2717
2870
  home?: string;
2718
2871
  /**
2719
- * Game id filter to retrieve a single game
2872
+ * Game ID. When specified, returns data for that game.
2720
2873
  */
2721
2874
  id?: number;
2722
2875
  /**
2723
- * Optional playoff round filter; requires competition
2876
+ * Playoff round. Requires `competition`.
2724
2877
  */
2725
2878
  round?: PlayoffRound;
2726
2879
  /**
2727
- * Optional season type filter
2880
+ * Season type.
2728
2881
  */
2729
2882
  seasonType?: SeasonType;
2730
2883
  /**
2731
- * Optional team filter
2884
+ * Team name on either side of the game.
2732
2885
  */
2733
2886
  team?: string;
2734
2887
  /**
2735
- * Optional week filter
2888
+ * Week number.
2736
2889
  */
2737
2890
  week?: number;
2738
2891
  /**
2739
- * Required year filter (except when id is specified)
2892
+ * Season year. Required unless `id` is specified.
2740
2893
  */
2741
2894
  year?: number;
2742
2895
  };
@@ -2748,31 +2901,34 @@ export type GetGamesError = ({
2748
2901
  export type GetGameTeamStatsData = {
2749
2902
  query?: {
2750
2903
  /**
2751
- * Optional division classification filter
2904
+ * Division classification.
2752
2905
  */
2753
2906
  classification?: DivisionClassification;
2754
2907
  /**
2755
- * Optional conference filter, required if week and team not specified
2908
+ * Conference name or abbreviation. One of `week`, `team`,
2909
+ * or `conference` is required when filtering by year.
2756
2910
  */
2757
2911
  conference?: string;
2758
2912
  /**
2759
- * Optional id filter to retrieve a single game
2913
+ * Game ID. When specified, returns statistics for that game.
2760
2914
  */
2761
2915
  id?: number;
2762
2916
  /**
2763
- * Optional season type filter
2917
+ * Season type.
2764
2918
  */
2765
2919
  seasonType?: SeasonType;
2766
2920
  /**
2767
- * Optional team filter, required if week and conference not specified
2921
+ * Team name. One of `week`, `team`, or `conference` is required
2922
+ * when filtering by year.
2768
2923
  */
2769
2924
  team?: string;
2770
2925
  /**
2771
- * Optional week filter, required if team and conference not specified
2926
+ * Week number. One of `week`, `team`, or `conference` is required
2927
+ * when filtering by year.
2772
2928
  */
2773
2929
  week?: number;
2774
2930
  /**
2775
- * Required year filter (along with one of week, team, or conference), unless id is specified
2931
+ * Season year. Required unless `id` is specified.
2776
2932
  */
2777
2933
  year?: number;
2778
2934
  };
@@ -2782,35 +2938,38 @@ export type GetGameTeamStatsError = unknown;
2782
2938
  export type GetGamePlayerStatsData = {
2783
2939
  query?: {
2784
2940
  /**
2785
- * Optional player statistical category filter
2941
+ * Player statistical category.
2786
2942
  */
2787
2943
  category?: string;
2788
2944
  /**
2789
- * Optional division classification filter
2945
+ * Division classification.
2790
2946
  */
2791
2947
  classification?: DivisionClassification;
2792
2948
  /**
2793
- * Optional conference filter, required if week and team not specified
2949
+ * Conference name or abbreviation. One of `week`, `team`,
2950
+ * or `conference` is required when filtering by year.
2794
2951
  */
2795
2952
  conference?: string;
2796
2953
  /**
2797
- * Optional id filter to retrieve a single game
2954
+ * Game ID. When specified, returns statistics for that game.
2798
2955
  */
2799
2956
  id?: number;
2800
2957
  /**
2801
- * Optional season type filter
2958
+ * Season type.
2802
2959
  */
2803
2960
  seasonType?: SeasonType;
2804
2961
  /**
2805
- * Optional team filter, required if week and conference not specified
2962
+ * Team name. One of `week`, `team`, or `conference` is required
2963
+ * when filtering by year.
2806
2964
  */
2807
2965
  team?: string;
2808
2966
  /**
2809
- * Optional week filter, required if team and conference not specified
2967
+ * Week number. One of `week`, `team`, or `conference` is required
2968
+ * when filtering by year.
2810
2969
  */
2811
2970
  week?: number;
2812
2971
  /**
2813
- * Required year filter (along with one of week, team, or conference), unless id is specified
2972
+ * Season year. Required unless `id` is specified.
2814
2973
  */
2815
2974
  year?: number;
2816
2975
  };
@@ -2820,31 +2979,31 @@ export type GetGamePlayerStatsError = unknown;
2820
2979
  export type GetMediaData = {
2821
2980
  query: {
2822
2981
  /**
2823
- * Optional division classification filter
2982
+ * Division classification.
2824
2983
  */
2825
2984
  classification?: DivisionClassification;
2826
2985
  /**
2827
- * Optional conference filter
2986
+ * Conference name or abbreviation.
2828
2987
  */
2829
2988
  conference?: string;
2830
2989
  /**
2831
- * Optional media type filter
2990
+ * Media type.
2832
2991
  */
2833
2992
  mediaType?: MediaType;
2834
2993
  /**
2835
- * Optional season type filter
2994
+ * Season type.
2836
2995
  */
2837
2996
  seasonType?: SeasonType;
2838
2997
  /**
2839
- * Optional team filter
2998
+ * Team name.
2840
2999
  */
2841
3000
  team?: string;
2842
3001
  /**
2843
- * Optional week filter
3002
+ * Week number.
2844
3003
  */
2845
3004
  week?: number;
2846
3005
  /**
2847
- * Required year filter
3006
+ * Season year.
2848
3007
  */
2849
3008
  year: number;
2850
3009
  };
@@ -2854,31 +3013,31 @@ export type GetMediaError = unknown;
2854
3013
  export type GetWeatherData = {
2855
3014
  query?: {
2856
3015
  /**
2857
- * Optional division classification filter
3016
+ * Division classification.
2858
3017
  */
2859
3018
  classification?: DivisionClassification;
2860
3019
  /**
2861
- * Optional conference filter
3020
+ * Conference name or abbreviation.
2862
3021
  */
2863
3022
  conference?: string;
2864
3023
  /**
2865
- * Filter for retrieving a single game
3024
+ * Game ID. When specified, returns weather for that game.
2866
3025
  */
2867
3026
  gameId?: number;
2868
3027
  /**
2869
- * Optional season type filter
3028
+ * Season type.
2870
3029
  */
2871
3030
  seasonType?: SeasonType;
2872
3031
  /**
2873
- * Optional team filter
3032
+ * Team name.
2874
3033
  */
2875
3034
  team?: string;
2876
3035
  /**
2877
- * Optional week filter
3036
+ * Week number.
2878
3037
  */
2879
3038
  week?: number;
2880
3039
  /**
2881
- * Year filter, required if game id not specified
3040
+ * Season year. Required unless `gameId` is specified.
2882
3041
  */
2883
3042
  year?: number;
2884
3043
  };
@@ -2888,15 +3047,15 @@ export type GetWeatherError = unknown;
2888
3047
  export type GetRecordsData = {
2889
3048
  query?: {
2890
3049
  /**
2891
- * Optional conference filter
3050
+ * Conference name or abbreviation.
2892
3051
  */
2893
3052
  conference?: string;
2894
3053
  /**
2895
- * Team filter, required if year not specified
3054
+ * Team name. Required unless `year` is specified.
2896
3055
  */
2897
3056
  team?: string;
2898
3057
  /**
2899
- * Year filter, required if team not specified
3058
+ * Season year. Required unless `team` is specified.
2900
3059
  */
2901
3060
  year?: number;
2902
3061
  };
@@ -2906,7 +3065,7 @@ export type GetRecordsError = unknown;
2906
3065
  export type GetCalendarData = {
2907
3066
  query: {
2908
3067
  /**
2909
- * Required year filter
3068
+ * Season year.
2910
3069
  */
2911
3070
  year: number;
2912
3071
  };
@@ -2916,11 +3075,11 @@ export type GetCalendarError = unknown;
2916
3075
  export type GetScoreboardData = {
2917
3076
  query?: {
2918
3077
  /**
2919
- * Optional division classification filter, defaults to fbs
3078
+ * Division classification. Defaults to `fbs`.
2920
3079
  */
2921
3080
  classification?: DivisionClassification;
2922
3081
  /**
2923
- * Optional conference filter
3082
+ * Conference name or abbreviation.
2924
3083
  */
2925
3084
  conference?: string;
2926
3085
  };
@@ -2930,43 +3089,43 @@ export type GetScoreboardError = unknown;
2930
3089
  export type GetDrivesData = {
2931
3090
  query: {
2932
3091
  /**
2933
- * Optional division classification filter
3092
+ * Division classification of either team.
2934
3093
  */
2935
3094
  classification?: DivisionClassification;
2936
3095
  /**
2937
- * Optional conference filter
3096
+ * Conference of either team.
2938
3097
  */
2939
3098
  conference?: string;
2940
3099
  /**
2941
- * Optional defensive team filter
3100
+ * Defensive team name.
2942
3101
  */
2943
3102
  defense?: string;
2944
3103
  /**
2945
- * Optional defensive team conference filter
3104
+ * Defensive team conference.
2946
3105
  */
2947
3106
  defenseConference?: string;
2948
3107
  /**
2949
- * Optional offensive team filter
3108
+ * Offensive team name.
2950
3109
  */
2951
3110
  offense?: string;
2952
3111
  /**
2953
- * Optional offensive team conference filter
3112
+ * Offensive team conference.
2954
3113
  */
2955
3114
  offenseConference?: string;
2956
3115
  /**
2957
- * Optional season type filter
3116
+ * Season type.
2958
3117
  */
2959
3118
  seasonType?: SeasonType;
2960
3119
  /**
2961
- * Optional team filter
3120
+ * Team name on either side of the drive.
2962
3121
  */
2963
3122
  team?: string;
2964
3123
  /**
2965
- * Optional week filter
3124
+ * Week number.
2966
3125
  */
2967
3126
  week?: number;
2968
3127
  /**
2969
- * Required year filter
3128
+ * Season year.
2970
3129
  */
2971
3130
  year: number;
2972
3131
  };
@@ -2980,23 +3139,23 @@ export type GetDraftPositionsError = unknown;
2980
3139
  export type GetDraftPicksData = {
2981
3140
  query?: {
2982
3141
  /**
2983
- * Optional college conference filter
3142
+ * College conference name or abbreviation.
2984
3143
  */
2985
3144
  conference?: string;
2986
3145
  /**
2987
- * Optional position classification filter
3146
+ * Position category.
2988
3147
  */
2989
3148
  position?: string;
2990
3149
  /**
2991
- * Optional college team filter
3150
+ * College team name.
2992
3151
  */
2993
3152
  school?: string;
2994
3153
  /**
2995
- * Optional NFL team filter
3154
+ * NFL team name.
2996
3155
  */
2997
3156
  team?: string;
2998
3157
  /**
2999
- * Optional year filter
3158
+ * Draft year.
3000
3159
  */
3001
3160
  year?: number;
3002
3161
  };
@@ -3006,37 +3165,101 @@ export type GetDraftPicksError = unknown;
3006
3165
  export type GetCoachesData = {
3007
3166
  query?: {
3008
3167
  /**
3009
- * Optional first name filter
3168
+ * Coach first name.
3010
3169
  */
3011
3170
  firstName?: string;
3012
3171
  /**
3013
- * Optional last name filter
3172
+ * Coach last name.
3014
3173
  */
3015
3174
  lastName?: string;
3016
3175
  /**
3017
- * Optional end year range filter
3176
+ * Latest season year to include.
3018
3177
  */
3019
3178
  maxYear?: number;
3020
3179
  /**
3021
- * Optional start year range filter
3180
+ * Earliest season year to include.
3022
3181
  */
3023
3182
  minYear?: number;
3024
3183
  /**
3025
- * Optional team filter
3184
+ * Team name.
3026
3185
  */
3027
3186
  team?: string;
3028
3187
  /**
3029
- * Optional year filter
3188
+ * Season year.
3030
3189
  */
3031
3190
  year?: number;
3032
3191
  };
3033
3192
  };
3034
3193
  export type GetCoachesResponse = (Array<Coach>);
3035
3194
  export type GetCoachesError = unknown;
3195
+ export type GetCoachProfileData = {
3196
+ query: {
3197
+ /**
3198
+ * Coach ID.
3199
+ */
3200
+ coachId: number;
3201
+ };
3202
+ };
3203
+ export type GetCoachProfileResponse = (CoachProfile);
3204
+ export type GetCoachProfileError = ({
3205
+ message: string;
3206
+ } | CoachNotFound);
3207
+ export type GetCoachSeasonsData = {
3208
+ query?: {
3209
+ /**
3210
+ * Coach ID.
3211
+ */
3212
+ coachId?: number;
3213
+ /**
3214
+ * Latest season year to include.
3215
+ */
3216
+ maxYear?: number;
3217
+ /**
3218
+ * Earliest season year to include.
3219
+ */
3220
+ minYear?: number;
3221
+ /**
3222
+ * Team name.
3223
+ */
3224
+ team?: string;
3225
+ /**
3226
+ * Exact season year.
3227
+ */
3228
+ year?: number;
3229
+ };
3230
+ };
3231
+ export type GetCoachSeasonsResponse = (Array<DetailedCoachSeason>);
3232
+ export type GetCoachSeasonsError = ({
3233
+ message: string;
3234
+ });
3235
+ export type GetCoachTenuresData = {
3236
+ query?: {
3237
+ /**
3238
+ * Filters by active status when specified.
3239
+ */
3240
+ active?: boolean;
3241
+ /**
3242
+ * Coach ID.
3243
+ */
3244
+ coachId?: number;
3245
+ /**
3246
+ * Team name.
3247
+ */
3248
+ team?: string;
3249
+ /**
3250
+ * Season year contained within the tenure.
3251
+ */
3252
+ year?: number;
3253
+ };
3254
+ };
3255
+ export type GetCoachTenuresResponse = (Array<CoachTenure>);
3256
+ export type GetCoachTenuresError = ({
3257
+ message: string;
3258
+ });
3036
3259
  export type GetAdvancedBoxScoreData = {
3037
3260
  query: {
3038
3261
  /**
3039
- * Required game id filter
3262
+ * Game ID.
3040
3263
  */
3041
3264
  id: number;
3042
3265
  };