feat: adjusted efficiency ratings

Author: github-actions[bot]

.openapi-generator/FILES

@@ -19,6 +19,7 @@ cbbd/api_response.py
 cbbd/configuration.py
 cbbd/exceptions.py
 cbbd/models/__init__.py
+cbbd/models/adjusted_efficiency_info.py
 cbbd/models/conference_history.py
 cbbd/models/conference_history_teams_inner.py
 cbbd/models/conference_info.py
@@ -55,6 +56,7 @@ cbbd/models/team_season_unit_stats_turnovers.py
 cbbd/models/venue_info.py
 cbbd/py.typed
 cbbd/rest.py
+docs/AdjustedEfficiencyInfo.md
 docs/ConferenceHistory.md
 docs/ConferenceHistoryTeamsInner.md
 docs/ConferenceInfo.md
@@ -104,6 +106,7 @@ setup.cfg
 setup.py
 test-requirements.txt
 test/__init__.py
+test/test_adjusted_efficiency_info.py
 test/test_conference_history.py
 test/test_conference_history_teams_inner.py
 test/test_conference_info.py

README.md

@@ -3,8 +3,8 @@ This API is in limited Beta for Patreon subscribers. It may have bugs and is sub
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 1.4.0
-- Package version: 1.4.0
+- API version: 1.5.0
+- Package version: 1.5.0
 - Generator version: 7.11.0
 - Build package: org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen
 
@@ -16,9 +16,9 @@ Python 3.7+
 ### pip install
 
 ```sh
-pip install cbbd@1.4.0
+pip install cbbd@1.5.0
 ```
-(you may need to run `pip` with root permission: `sudo pip install cbbd@1.4.0`)
+(you may need to run `pip` with root permission: `sudo pip install cbbd@1.5.0`)
 
 Then import the package:
 ```python
@@ -87,6 +87,7 @@ Class | Method | HTTP request | Description
 *PlaysApi* | [**get_plays_by_date**](docs/PlaysApi.md#get_plays_by_date) | **GET** /plays/date | 
 *PlaysApi* | [**get_plays_by_player_id**](docs/PlaysApi.md#get_plays_by_player_id) | **GET** /plays/player/{playerId} | 
 *PlaysApi* | [**get_plays_by_team**](docs/PlaysApi.md#get_plays_by_team) | **GET** /plays/team | 
+*RatingsApi* | [**get_adjusted_efficiency**](docs/RatingsApi.md#get_adjusted_efficiency) | **GET** /ratings/adjusted | 
 *RatingsApi* | [**get_srs**](docs/RatingsApi.md#get_srs) | **GET** /ratings/srs | 
 *StatsApi* | [**get_player_season_stats**](docs/StatsApi.md#get_player_season_stats) | **GET** /stats/player/season | 
 *StatsApi* | [**get_team_season_stats**](docs/StatsApi.md#get_team_season_stats) | **GET** /stats/team/season | 
@@ -97,6 +98,7 @@ Class | Method | HTTP request | Description
 
 ## Documentation For Models
 
+ - [AdjustedEfficiencyInfo](docs/AdjustedEfficiencyInfo.md)
  - [ConferenceHistory](docs/ConferenceHistory.md)
  - [ConferenceHistoryTeamsInner](docs/ConferenceHistoryTeamsInner.md)
  - [ConferenceInfo](docs/ConferenceInfo.md)

cbbd/__init__.py

@@ -7,15 +7,15 @@
 
     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.
 
-    The version of the OpenAPI document: 1.4.0
+    The version of the OpenAPI document: 1.5.0
     Contact: admin@collegefootballdata.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
 """  # noqa: E501
 
 
-__version__ = "1.4.0"
+__version__ = "1.5.0"
 
 # import apis into sdk package
 from cbbd.api.conferences_api import ConferencesApi
@@ -39,6 +39,7 @@
 from cbbd.exceptions import ApiException
 
 # import models into sdk package
+from cbbd.models.adjusted_efficiency_info import AdjustedEfficiencyInfo
 from cbbd.models.conference_history import ConferenceHistory
 from cbbd.models.conference_history_teams_inner import ConferenceHistoryTeamsInner
 from cbbd.models.conference_info import ConferenceInfo

cbbd/api/conferences_api.py

@@ -5,7 +5,7 @@
 
     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.
 
-    The version of the OpenAPI document: 1.4.0
+    The version of the OpenAPI document: 1.5.0
     Contact: admin@collegefootballdata.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

cbbd/api/games_api.py

@@ -5,7 +5,7 @@
 
     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.
 
-    The version of the OpenAPI document: 1.4.0
+    The version of the OpenAPI document: 1.5.0
     Contact: admin@collegefootballdata.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

cbbd/api/lines_api.py

@@ -5,7 +5,7 @@
 
     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.
 
-    The version of the OpenAPI document: 1.4.0
+    The version of the OpenAPI document: 1.5.0
     Contact: admin@collegefootballdata.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

cbbd/api/plays_api.py

@@ -5,7 +5,7 @@
 
     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.
 
-    The version of the OpenAPI document: 1.4.0
+    The version of the OpenAPI document: 1.5.0
     Contact: admin@collegefootballdata.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

cbbd/api/ratings_api.py

@@ -5,7 +5,7 @@
 
     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.
 
-    The version of the OpenAPI document: 1.4.0
+    The version of the OpenAPI document: 1.5.0
     Contact: admin@collegefootballdata.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -24,6 +24,7 @@
 
 from typing import List, Optional
 
+from cbbd.models.adjusted_efficiency_info import AdjustedEfficiencyInfo
 from cbbd.models.srs_info import SrsInfo
 
 from cbbd.api_client import ApiClient
@@ -46,6 +47,162 @@ def __init__(self, api_client=None) -> None:
             api_client = ApiClient.get_default()
         self.api_client = api_client
 
+    @validate_arguments
+    def get_adjusted_efficiency(self, season : Annotated[Optional[StrictInt], Field(description="Optional season filter")] = None, team : Annotated[Optional[StrictStr], Field(description="Optional team filter")] = None, conference : Annotated[Optional[StrictStr], Field(description="Optional conference abbreviation filter")] = None, **kwargs) -> List[AdjustedEfficiencyInfo]:  # noqa: E501
+        """get_adjusted_efficiency  # noqa: E501
+
+        Retrieves adjusted efficiency ratings for the provided season, team, or conference.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.get_adjusted_efficiency(season, team, conference, async_req=True)
+        >>> result = thread.get()
+
+        :param season: Optional season filter
+        :type season: int
+        :param team: Optional team filter
+        :type team: str
+        :param conference: Optional conference abbreviation filter
+        :type conference: str
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _request_timeout: timeout setting for this request.
+               If one number provided, it will be total request
+               timeout. It can also be a pair (tuple) of
+               (connection, read) timeouts.
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: List[AdjustedEfficiencyInfo]
+        """
+        kwargs['_return_http_data_only'] = True
+        if '_preload_content' in kwargs:
+            message = "Error! Please call the get_adjusted_efficiency_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data"  # noqa: E501
+            raise ValueError(message)
+        return self.get_adjusted_efficiency_with_http_info(season, team, conference, **kwargs)  # noqa: E501
+
+    @validate_arguments
+    def get_adjusted_efficiency_with_http_info(self, season : Annotated[Optional[StrictInt], Field(description="Optional season filter")] = None, team : Annotated[Optional[StrictStr], Field(description="Optional team filter")] = None, conference : Annotated[Optional[StrictStr], Field(description="Optional conference abbreviation filter")] = None, **kwargs) -> ApiResponse:  # noqa: E501
+        """get_adjusted_efficiency  # noqa: E501
+
+        Retrieves adjusted efficiency ratings for the provided season, team, or conference.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.get_adjusted_efficiency_with_http_info(season, team, conference, async_req=True)
+        >>> result = thread.get()
+
+        :param season: Optional season filter
+        :type season: int
+        :param team: Optional team filter
+        :type team: str
+        :param conference: Optional conference abbreviation filter
+        :type conference: str
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _preload_content: if False, the ApiResponse.data will
+                                 be set to none and raw_data will store the
+                                 HTTP response body without reading/decoding.
+                                 Default is True.
+        :type _preload_content: bool, optional
+        :param _return_http_data_only: response data instead of ApiResponse
+                                       object with status code, headers, etc
+        :type _return_http_data_only: bool, optional
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the authentication
+                              in the spec for a single request.
+        :type _request_auth: dict, optional
+        :type _content_type: string, optional: force content-type for the request
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: tuple(List[AdjustedEfficiencyInfo], status_code(int), headers(HTTPHeaderDict))
+        """
+
+        _params = locals()
+
+        _all_params = [
+            'season',
+            'team',
+            'conference'
+        ]
+        _all_params.extend(
+            [
+                'async_req',
+                '_return_http_data_only',
+                '_preload_content',
+                '_request_timeout',
+                '_request_auth',
+                '_content_type',
+                '_headers'
+            ]
+        )
+
+        # validate the arguments
+        for _key, _val in _params['kwargs'].items():
+            if _key not in _all_params:
+                raise ApiTypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method get_adjusted_efficiency" % _key
+                )
+            _params[_key] = _val
+        del _params['kwargs']
+
+        _collection_formats = {}
+
+        # process the path parameters
+        _path_params = {}
+
+        # process the query parameters
+        _query_params = []
+        if _params.get('season') is not None:  # noqa: E501
+            _query_params.append(('season', _params['season']))
+
+        if _params.get('team') is not None:  # noqa: E501
+            _query_params.append(('team', _params['team']))
+
+        if _params.get('conference') is not None:  # noqa: E501
+            _query_params.append(('conference', _params['conference']))
+
+        # process the header parameters
+        _header_params = dict(_params.get('_headers', {}))
+        # process the form parameters
+        _form_params = []
+        _files = {}
+        # process the body parameter
+        _body_params = None
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # authentication setting
+        _auth_settings = ['apiKey']  # noqa: E501
+
+        _response_types_map = {
+            '200': "List[AdjustedEfficiencyInfo]",
+        }
+
+        return self.api_client.call_api(
+            '/ratings/adjusted', 'GET',
+            _path_params,
+            _query_params,
+            _header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            response_types_map=_response_types_map,
+            auth_settings=_auth_settings,
+            async_req=_params.get('async_req'),
+            _return_http_data_only=_params.get('_return_http_data_only'),  # noqa: E501
+            _preload_content=_params.get('_preload_content', True),
+            _request_timeout=_params.get('_request_timeout'),
+            collection_formats=_collection_formats,
+            _request_auth=_params.get('_request_auth'))
+
     @validate_arguments
     def get_srs(self, season : Annotated[Optional[StrictInt], Field(description="Optional season filter")] = None, team : Annotated[Optional[StrictStr], Field(description="Optional team filter")] = None, conference : Annotated[Optional[StrictStr], Field(description="Optional conference abbreviation filter")] = None, **kwargs) -> List[SrsInfo]:  # noqa: E501
         """get_srs  # noqa: E501

cbbd/api/stats_api.py

@@ -5,7 +5,7 @@
 
     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.
 
-    The version of the OpenAPI document: 1.4.0
+    The version of the OpenAPI document: 1.5.0
     Contact: admin@collegefootballdata.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

cbbd/api/teams_api.py

@@ -5,7 +5,7 @@
 
     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.
 
-    The version of the OpenAPI document: 1.4.0
+    The version of the OpenAPI document: 1.5.0
     Contact: admin@collegefootballdata.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)