added fpi ratings

CFBD · Sep 9, 2023 · 0ffc67e · 0ffc67e
1 parent dab85c5
commit 0ffc67e
Show file tree

Hide file tree

Showing 256 changed files with 1,148 additions and 377 deletions.
diff --git a/README.md b/README.md
@@ -4,8 +4,8 @@ cfb - JavaScript client for cfb.js
 This is an API for accessing all sorts of college football data.  Please note that API keys should be supplied with \"Bearer \" prepended (e.g. \"Bearer your_key\"). API keys can be acquired from the CollegeFootballData.com website.
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
-- API version: 4.4.15
-- Package version: 4.4.15
+- API version: 4.5.0
+- Package version: 4.5.0
 - Build package: io.swagger.codegen.languages.JavascriptClientCodegen
 
 ## Installation
@@ -130,6 +130,7 @@ Class | Method | HTTP request | Description
 *cfb.RankingsApi* | [**getRankings**](docs/RankingsApi.md#getRankings) | **GET** /rankings | Historical polls and rankings
 *cfb.RatingsApi* | [**getConferenceSPRatings**](docs/RatingsApi.md#getConferenceSPRatings) | **GET** /ratings/sp/conferences | Historical SP+ ratings by conference
 *cfb.RatingsApi* | [**getEloRatings**](docs/RatingsApi.md#getEloRatings) | **GET** /ratings/elo | Historical Elo ratings
+*cfb.RatingsApi* | [**getFPIRatings**](docs/RatingsApi.md#getFPIRatings) | **GET** /ratings/fpi | Historical FPI ratings
 *cfb.RatingsApi* | [**getSPRatings**](docs/RatingsApi.md#getSPRatings) | **GET** /ratings/sp | Historical SP+ ratings
 *cfb.RatingsApi* | [**getSRSRatings**](docs/RatingsApi.md#getSRSRatings) | **GET** /ratings/srs | Historical SRS ratings
 *cfb.RecruitingApi* | [**getRecruitingGroups**](docs/RecruitingApi.md#getRecruitingGroups) | **GET** /recruiting/groups | Recruit position group ratings
@@ -231,6 +232,9 @@ Class | Method | HTTP request | Description
  - [cfb.ScoreboardGameWeather](docs/ScoreboardGameWeather.md)
  - [cfb.Team](docs/Team.md)
  - [cfb.TeamEloRating](docs/TeamEloRating.md)
+ - [cfb.TeamFPIRating](docs/TeamFPIRating.md)
+ - [cfb.TeamFPIRatingEfficiencies](docs/TeamFPIRatingEfficiencies.md)
+ - [cfb.TeamFPIRatingResumeRanks](docs/TeamFPIRatingResumeRanks.md)
  - [cfb.TeamGame](docs/TeamGame.md)
  - [cfb.TeamGameStats](docs/TeamGameStats.md)
  - [cfb.TeamGameTeams](docs/TeamGameTeams.md)

diff --git a/docs/RatingsApi.md b/docs/RatingsApi.md
@@ -6,6 +6,7 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**getConferenceSPRatings**](RatingsApi.md#getConferenceSPRatings) | **GET** /ratings/sp/conferences | Historical SP+ ratings by conference
 [**getEloRatings**](RatingsApi.md#getEloRatings) | **GET** /ratings/elo | Historical Elo ratings
+[**getFPIRatings**](RatingsApi.md#getFPIRatings) | **GET** /ratings/fpi | Historical FPI ratings
 [**getSPRatings**](RatingsApi.md#getSPRatings) | **GET** /ratings/sp | Historical SP+ ratings
 [**getSRSRatings**](RatingsApi.md#getSRSRatings) | **GET** /ratings/srs | Historical SRS ratings
 
@@ -117,6 +118,61 @@ Name | Type | Description  | Notes
 
 [ApiKeyAuth](../README.md#ApiKeyAuth)
 
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+<a name="getFPIRatings"></a>
+# **getFPIRatings**
+> [TeamFPIRating] getFPIRatings(opts)
+
+Historical FPI ratings
+
+FPI rating data
+
+### Example
+```javascript
+var cfb = require('cfb.js');
+var defaultClient = cfb.ApiClient.instance;
+
+// Configure API key authorization: ApiKeyAuth
+var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
+ApiKeyAuth.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//ApiKeyAuth.apiKeyPrefix = 'Token';
+
+var apiInstance = new cfb.RatingsApi();
+
+var opts = { 
+  'year': 56, // Number | Season filter
+  'team': "team_example", // String | Team filter
+  'conference': "conference_example" // String | Conference filter
+};
+apiInstance.getFPIRatings(opts).then(function(data) {
+  console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **year** | **Number**| Season filter | [optional] 
+ **team** | **String**| Team filter | [optional] 
+ **conference** | **String**| Conference filter | [optional] 
+
+### Return type
+
+[**[TeamFPIRating]**](TeamFPIRating.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
 ### HTTP request headers
 
  - **Content-Type**: Not defined

diff --git a/docs/TeamFPIRating.md b/docs/TeamFPIRating.md
@@ -0,0 +1,13 @@
+# cfb.TeamFPIRating
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**year** | **Number** |  | [optional] 
+**team** | **String** |  | [optional] 
+**conference** | **String** |  | [optional] 
+**fpi** | **Number** |  | [optional] 
+**resumeRanks** | [**TeamFPIRatingResumeRanks**](TeamFPIRatingResumeRanks.md) |  | [optional] 
+**efficiencies** | [**TeamFPIRatingEfficiencies**](TeamFPIRatingEfficiencies.md) |  | [optional] 
+
+
diff --git a/docs/TeamFPIRatingEfficiencies.md b/docs/TeamFPIRatingEfficiencies.md
@@ -0,0 +1,11 @@
+# cfb.TeamFPIRatingEfficiencies
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**overall** | **Number** |  | [optional] 
+**offense** | **Number** |  | [optional] 
+**defense** | **Number** |  | [optional] 
+**specialTeams** | **Number** |  | [optional] 
+
+
diff --git a/docs/TeamFPIRatingResumeRanks.md b/docs/TeamFPIRatingResumeRanks.md
@@ -0,0 +1,13 @@
+# cfb.TeamFPIRatingResumeRanks
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**strengthOfRecord** | **Number** |  | [optional] 
+**fpi** | **Number** |  | [optional] 
+**averageWinProbability** | **Number** |  | [optional] 
+**strengthOfSchedule** | **Number** |  | [optional] 
+**remainingStrengthOfSchedule** | **Number** |  | [optional] 
+**gameControl** | **Number** |  | [optional] 
+
+
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "cfb.js",
-  "version": "4.4.15",
+  "version": "4.5.0",
   "description": "This_is_an_API_for_accessing_all_sorts_of_college_football_data___Please_note_that_API_keys_should_be_supplied_with_Bearer__prepended__e_g__Bearer_your_key__API_keys_can_be_acquired_from_the_CollegeFootballData_com_website_",
   "license": "MIT",
   "main": "src/index.js",

diff --git a/src/ApiClient.js b/src/ApiClient.js
@@ -2,7 +2,7 @@
  * College Football Data API
  * This is an API for accessing all sorts of college football data.  Please note that API keys should be supplied with \"Bearer \" prepended (e.g. \"Bearer your_key\"). API keys can be acquired from the CollegeFootballData.com website.
  *
- * OpenAPI spec version: 4.4.15
+ * OpenAPI spec version: 4.5.0
  * Contact: admin@collegefootballdata.com
  *
  * NOTE: This class is auto generated by the swagger code generator program.
@@ -33,7 +33,7 @@
 
   /**
    * @module ApiClient
-   * @version 4.4.15
+   * @version 4.5.0
    */
 
   /**

diff --git a/src/api/BettingApi.js b/src/api/BettingApi.js
@@ -2,7 +2,7 @@
  * College Football Data API
  * This is an API for accessing all sorts of college football data.  Please note that API keys should be supplied with \"Bearer \" prepended (e.g. \"Bearer your_key\"). API keys can be acquired from the CollegeFootballData.com website.
  *
- * OpenAPI spec version: 4.4.15
+ * OpenAPI spec version: 4.5.0
  * Contact: admin@collegefootballdata.com
  *
  * NOTE: This class is auto generated by the swagger code generator program.
@@ -34,7 +34,7 @@
   /**
    * Betting service.
    * @module api/BettingApi
-   * @version 4.4.15
+   * @version 4.5.0
    */
 
   /**

diff --git a/src/api/CoachesApi.js b/src/api/CoachesApi.js
@@ -2,7 +2,7 @@
  * College Football Data API
  * This is an API for accessing all sorts of college football data.  Please note that API keys should be supplied with \"Bearer \" prepended (e.g. \"Bearer your_key\"). API keys can be acquired from the CollegeFootballData.com website.
  *
- * OpenAPI spec version: 4.4.15
+ * OpenAPI spec version: 4.5.0
  * Contact: admin@collegefootballdata.com
  *
  * NOTE: This class is auto generated by the swagger code generator program.
@@ -34,7 +34,7 @@
   /**
    * Coaches service.
    * @module api/CoachesApi
-   * @version 4.4.15
+   * @version 4.5.0
    */
 
   /**

diff --git a/src/api/ConferencesApi.js b/src/api/ConferencesApi.js
@@ -2,7 +2,7 @@
  * College Football Data API
  * This is an API for accessing all sorts of college football data.  Please note that API keys should be supplied with \"Bearer \" prepended (e.g. \"Bearer your_key\"). API keys can be acquired from the CollegeFootballData.com website.
  *
- * OpenAPI spec version: 4.4.15
+ * OpenAPI spec version: 4.5.0
  * Contact: admin@collegefootballdata.com
  *
  * NOTE: This class is auto generated by the swagger code generator program.
@@ -34,7 +34,7 @@
   /**
    * Conferences service.
    * @module api/ConferencesApi
-   * @version 4.4.15
+   * @version 4.5.0
    */
 
   /**

diff --git a/src/api/DraftApi.js b/src/api/DraftApi.js
@@ -2,7 +2,7 @@
  * College Football Data API
  * This is an API for accessing all sorts of college football data.  Please note that API keys should be supplied with \"Bearer \" prepended (e.g. \"Bearer your_key\"). API keys can be acquired from the CollegeFootballData.com website.
  *
- * OpenAPI spec version: 4.4.15
+ * OpenAPI spec version: 4.5.0
  * Contact: admin@collegefootballdata.com
  *
  * NOTE: This class is auto generated by the swagger code generator program.
@@ -34,7 +34,7 @@
   /**
    * Draft service.
    * @module api/DraftApi
-   * @version 4.4.15
+   * @version 4.5.0
    */
 
   /**

diff --git a/src/api/DrivesApi.js b/src/api/DrivesApi.js
@@ -2,7 +2,7 @@
  * College Football Data API
  * This is an API for accessing all sorts of college football data.  Please note that API keys should be supplied with \"Bearer \" prepended (e.g. \"Bearer your_key\"). API keys can be acquired from the CollegeFootballData.com website.
  *
- * OpenAPI spec version: 4.4.15
+ * OpenAPI spec version: 4.5.0
  * Contact: admin@collegefootballdata.com
  *
  * NOTE: This class is auto generated by the swagger code generator program.
@@ -34,7 +34,7 @@
   /**
    * Drives service.
    * @module api/DrivesApi
-   * @version 4.4.15
+   * @version 4.5.0
    */
 
   /**

diff --git a/src/api/GamesApi.js b/src/api/GamesApi.js
@@ -2,7 +2,7 @@
  * College Football Data API
  * This is an API for accessing all sorts of college football data.  Please note that API keys should be supplied with \"Bearer \" prepended (e.g. \"Bearer your_key\"). API keys can be acquired from the CollegeFootballData.com website.
  *
- * OpenAPI spec version: 4.4.15
+ * OpenAPI spec version: 4.5.0
  * Contact: admin@collegefootballdata.com
  *
  * NOTE: This class is auto generated by the swagger code generator program.
@@ -34,7 +34,7 @@
   /**
    * Games service.
    * @module api/GamesApi
-   * @version 4.4.15
+   * @version 4.5.0
    */
 
   /**

diff --git a/src/api/MetricsApi.js b/src/api/MetricsApi.js
@@ -2,7 +2,7 @@
  * College Football Data API
  * This is an API for accessing all sorts of college football data.  Please note that API keys should be supplied with \"Bearer \" prepended (e.g. \"Bearer your_key\"). API keys can be acquired from the CollegeFootballData.com website.
  *
- * OpenAPI spec version: 4.4.15
+ * OpenAPI spec version: 4.5.0
  * Contact: admin@collegefootballdata.com
  *
  * NOTE: This class is auto generated by the swagger code generator program.
@@ -34,7 +34,7 @@
   /**
    * Metrics service.
    * @module api/MetricsApi
-   * @version 4.4.15
+   * @version 4.5.0
    */
 
   /**

diff --git a/src/api/PlayersApi.js b/src/api/PlayersApi.js
@@ -2,7 +2,7 @@
  * College Football Data API
  * This is an API for accessing all sorts of college football data.  Please note that API keys should be supplied with \"Bearer \" prepended (e.g. \"Bearer your_key\"). API keys can be acquired from the CollegeFootballData.com website.
  *
- * OpenAPI spec version: 4.4.15
+ * OpenAPI spec version: 4.5.0
  * Contact: admin@collegefootballdata.com
  *
  * NOTE: This class is auto generated by the swagger code generator program.
@@ -34,7 +34,7 @@
   /**
    * Players service.
    * @module api/PlayersApi
-   * @version 4.4.15
+   * @version 4.5.0
    */
 
   /**

diff --git a/src/api/PlaysApi.js b/src/api/PlaysApi.js
@@ -2,7 +2,7 @@
  * College Football Data API
  * This is an API for accessing all sorts of college football data.  Please note that API keys should be supplied with \"Bearer \" prepended (e.g. \"Bearer your_key\"). API keys can be acquired from the CollegeFootballData.com website.
  *
- * OpenAPI spec version: 4.4.15
+ * OpenAPI spec version: 4.5.0
  * Contact: admin@collegefootballdata.com
  *
  * NOTE: This class is auto generated by the swagger code generator program.
@@ -34,7 +34,7 @@
   /**
    * Plays service.
    * @module api/PlaysApi
-   * @version 4.4.15
+   * @version 4.5.0
    */
 
   /**

diff --git a/src/api/RankingsApi.js b/src/api/RankingsApi.js
@@ -2,7 +2,7 @@
  * College Football Data API
  * This is an API for accessing all sorts of college football data.  Please note that API keys should be supplied with \"Bearer \" prepended (e.g. \"Bearer your_key\"). API keys can be acquired from the CollegeFootballData.com website.
  *
- * OpenAPI spec version: 4.4.15
+ * OpenAPI spec version: 4.5.0
  * Contact: admin@collegefootballdata.com
  *
  * NOTE: This class is auto generated by the swagger code generator program.
@@ -34,7 +34,7 @@
   /**
    * Rankings service.
    * @module api/RankingsApi
-   * @version 4.4.15
+   * @version 4.5.0
    */
 
   /**