cfbd 5.31.0 → 5.31.2

package/dist/sdk.gen.d.ts

@@ -304,12 +304,12 @@ export declare const getUsage: <ThrowOnError extends boolean = false>(options?:
  */
 export declare const getGameSchedule: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetGameScheduleData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").GameSchedule, import("./types.gen").GamePreviewError, ThrowOnError>;
 /**
- * Returns pregame team comparisons and key players. Started games return metadata only.
+ * Returns pregame team comparisons and key players. Analysis remains available until the game is completed.
  * Team statistics may use the previous season; players and context stay in the game season.
  */
 export declare const getGamePreview: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetGamePreviewData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").GamePreview, import("./types.gen").GamePreviewError, ThrowOnError>;
 /**
- * Returns stored adjusted team and player metrics. Requires Patreon Tier 1.
+ * Returns stored adjusted team and player metrics until game completion. Requires Patreon Tier 1.
  * Team metrics may use the previous season; players remain current-season.
  */
 export declare const getAdjustedGamePreview: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetAdjustedGamePreviewData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").AdjustedGamePreview, import("./types.gen").GamePreviewError, ThrowOnError>;

package/dist/sdk.gen.js

@@ -595,7 +595,7 @@ var getGameSchedule = function (options) {
 };
 exports.getGameSchedule = getGameSchedule;
 /**
- * Returns pregame team comparisons and key players. Started games return metadata only.
+ * Returns pregame team comparisons and key players. Analysis remains available until the game is completed.
  * Team statistics may use the previous season; players and context stay in the game season.
  */
 var getGamePreview = function (options) {
@@ -604,7 +604,7 @@ var getGamePreview = function (options) {
 };
 exports.getGamePreview = getGamePreview;
 /**
- * Returns stored adjusted team and player metrics. Requires Patreon Tier 1.
+ * Returns stored adjusted team and player metrics until game completion. Requires Patreon Tier 1.
  * Team metrics may use the previous season; players remain current-season.
  */
 var getAdjustedGamePreview = function (options) {

package/dist/types.gen.d.ts

@@ -562,6 +562,7 @@ export type DetailedCoachSeason = {
     cfp: CoachCfpContext;
     draftFollowingSeason: ((CoachDraftContext) | null);
 };
+export type Division = 'fbs' | 'fcs' | 'ii' | 'ii/iii' | 'iii';
 export type DivisionClassification = 'fbs' | 'fcs' | 'ii' | 'ii/iii' | 'iii';
 export type DraftPick = {
     collegeAthleteId: (number) | null;
@@ -2096,6 +2097,7 @@ export type PreviewTeamIdentity = {
     points: (number) | null;
 };
 export type PreviewTeamStatistics = {
+    statRankings?: ((TeamSeasonStatRankings) | null);
     season: number;
     isPreviousSeason: boolean;
     advanced: TeamSeasonAdvancedStats;
@@ -2125,6 +2127,31 @@ export type RecentResult = {
     result: 'win' | 'loss' | 'tie' | 'unknown';
 };
 export type result = 'win' | 'loss' | 'tie' | 'unknown';
+/**
+ * Construct a type with a set of properties K of type T
+ */
+export type Record_StatMetricKey_TeamStatRank_or_null_ = {
+    ppa: TeamStatRank;
+    successRate: TeamStatRank;
+    explosiveness: TeamStatRank;
+    'standardDowns.successRate': TeamStatRank;
+    'passingDowns.successRate': TeamStatRank;
+    'passingPlays.ppa': TeamStatRank;
+    'rushingPlays.ppa': TeamStatRank;
+    'passingPlays.explosiveness': TeamStatRank;
+    'rushingPlays.explosiveness': TeamStatRank;
+    lineYards: TeamStatRank;
+    secondLevelYards: TeamStatRank;
+    openFieldYards: TeamStatRank;
+    stuffRate: TeamStatRank;
+    powerSuccess: TeamStatRank;
+    'havoc.total': TeamStatRank;
+    'havoc.frontSeven': TeamStatRank;
+    'havoc.db': TeamStatRank;
+    pointsPerOpportunity: TeamStatRank;
+    'fieldPosition.averageStart': TeamStatRank;
+    'fieldPosition.averagePredictedPoints': TeamStatRank;
+};
 export type Recruit = {
     id: string;
     athleteId: (string) | null;
@@ -2689,6 +2716,7 @@ export type TeamSeasonAdvancedStats = {
         lineYards: number;
         stuffRate: number;
         powerSuccess: (number) | null;
+        powerRushAttempts?: number;
         explosiveness: (number) | null;
         successRate: number;
         totalPPA: number;
@@ -2743,6 +2771,7 @@ export type TeamSeasonAdvancedStats = {
         lineYards: number;
         stuffRate: number;
         powerSuccess: (number) | null;
+        powerRushAttempts?: number;
         explosiveness: (number) | null;
         successRate: number;
         totalPPA: number;
@@ -2759,6 +2788,7 @@ export type TeamSeasonOverview = {
     };
     passing: ((TeamPassingSeason) | null);
     rushing: ((TeamRushingSeason) | null);
+    statRankings?: ((TeamSeasonStatRankings) | null);
     /**
      * Completed games for the requested season, including postseason.
      */
@@ -2884,6 +2914,17 @@ export type TeamSeasonRankedRating = {
      */
     rank: (number) | null;
 };
+export type TeamSeasonStatRankings = {
+    teamId: number;
+    season: number;
+    division: Division;
+    divisionTeamCount: number;
+    calculatedAt: string;
+    expiresAt: string;
+    sourceUpdatedAt: string;
+    offense: Record_StatMetricKey_TeamStatRank_or_null_;
+    defense: Record_StatMetricKey_TeamStatRank_or_null_;
+};
 export type TeamSP = {
     year: number;
     team: string;
@@ -2938,6 +2979,12 @@ export type TeamStat = {
     statName: string;
     statValue: (string | number);
 };
+export type TeamStatRank = {
+    rank: number;
+    population: number;
+    tied: boolean;
+    percentile: number;
+};
 export type TeamSuccessRates = {
     team: string;
     overall: StatsByQuarter;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cfbd",
-  "version": "5.31.0",
+  "version": "5.31.2",
   "description": "This API is in limited Beta for Patreon subscribers. It may have bugs and is subject to changes. API keys can be acquired from the CollegeFootballData.com website.",
   "repository": {
     "type": "git",

package/src/sdk.gen.ts

@@ -722,7 +722,7 @@ export const getGameSchedule = <ThrowOnError extends boolean = false>(options?:
 };
 
 /**
- * Returns pregame team comparisons and key players. Started games return metadata only.
+ * Returns pregame team comparisons and key players. Analysis remains available until the game is completed.
  * Team statistics may use the previous season; players and context stay in the game season.
  */
 export const getGamePreview = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetGamePreviewData, ThrowOnError>) => {
@@ -733,7 +733,7 @@ export const getGamePreview = <ThrowOnError extends boolean = false>(options: Op
 };
 
 /**
- * Returns stored adjusted team and player metrics. Requires Patreon Tier 1.
+ * Returns stored adjusted team and player metrics until game completion. Requires Patreon Tier 1.
  * Team metrics may use the previous season; players remain current-season.
  */
 export const getAdjustedGamePreview = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetAdjustedGamePreviewData, ThrowOnError>) => {

package/src/types.gen.ts

@@ -603,6 +603,8 @@ export type DetailedCoachSeason = {
     draftFollowingSeason: ((CoachDraftContext) | null);
 };
 
+export type Division = 'fbs' | 'fcs' | 'ii' | 'ii/iii' | 'iii';
+
 export type DivisionClassification = 'fbs' | 'fcs' | 'ii' | 'ii/iii' | 'iii';
 
 export type DraftPick = {
@@ -2262,6 +2264,7 @@ export type PreviewTeamIdentity = {
 };
 
 export type PreviewTeamStatistics = {
+    statRankings?: ((TeamSeasonStatRankings) | null);
     season: number;
     isPreviousSeason: boolean;
     advanced: TeamSeasonAdvancedStats;
@@ -2296,6 +2299,32 @@ export type RecentResult = {
 
 export type result = 'win' | 'loss' | 'tie' | 'unknown';
 
+/**
+ * Construct a type with a set of properties K of type T
+ */
+export type Record_StatMetricKey_TeamStatRank_or_null_ = {
+    ppa: TeamStatRank;
+    successRate: TeamStatRank;
+    explosiveness: TeamStatRank;
+    'standardDowns.successRate': TeamStatRank;
+    'passingDowns.successRate': TeamStatRank;
+    'passingPlays.ppa': TeamStatRank;
+    'rushingPlays.ppa': TeamStatRank;
+    'passingPlays.explosiveness': TeamStatRank;
+    'rushingPlays.explosiveness': TeamStatRank;
+    lineYards: TeamStatRank;
+    secondLevelYards: TeamStatRank;
+    openFieldYards: TeamStatRank;
+    stuffRate: TeamStatRank;
+    powerSuccess: TeamStatRank;
+    'havoc.total': TeamStatRank;
+    'havoc.frontSeven': TeamStatRank;
+    'havoc.db': TeamStatRank;
+    pointsPerOpportunity: TeamStatRank;
+    'fieldPosition.averageStart': TeamStatRank;
+    'fieldPosition.averagePredictedPoints': TeamStatRank;
+};
+
 export type Recruit = {
     id: string;
     athleteId: (string) | null;
@@ -2904,6 +2933,7 @@ export type TeamSeasonAdvancedStats = {
         lineYards: number;
         stuffRate: number;
         powerSuccess: (number) | null;
+        powerRushAttempts?: number;
         explosiveness: (number) | null;
         successRate: number;
         totalPPA: number;
@@ -2958,6 +2988,7 @@ export type TeamSeasonAdvancedStats = {
         lineYards: number;
         stuffRate: number;
         powerSuccess: (number) | null;
+        powerRushAttempts?: number;
         explosiveness: (number) | null;
         successRate: number;
         totalPPA: number;
@@ -2975,6 +3006,7 @@ export type TeamSeasonOverview = {
     };
     passing: ((TeamPassingSeason) | null);
     rushing: ((TeamRushingSeason) | null);
+    statRankings?: ((TeamSeasonStatRankings) | null);
     /**
      * Completed games for the requested season, including postseason.
      */
@@ -3107,6 +3139,18 @@ export type TeamSeasonRankedRating = {
     rank: (number) | null;
 };
 
+export type TeamSeasonStatRankings = {
+    teamId: number;
+    season: number;
+    division: Division;
+    divisionTeamCount: number;
+    calculatedAt: string;
+    expiresAt: string;
+    sourceUpdatedAt: string;
+    offense: Record_StatMetricKey_TeamStatRank_or_null_;
+    defense: Record_StatMetricKey_TeamStatRank_or_null_;
+};
+
 export type TeamSP = {
     year: number;
     team: string;
@@ -3164,6 +3208,13 @@ export type TeamStat = {
     statValue: (string | number);
 };
 
+export type TeamStatRank = {
+    rank: number;
+    population: number;
+    tied: boolean;
+    percentile: number;
+};
+
 export type TeamSuccessRates = {
     team: string;
     overall: StatsByQuarter;