gamebench_api_client.api.response package

Submodules

gamebench_api_client.api.response.response_mediator module

class gamebench_api_client.api.response.response_mediator.AuthenticationMediator(**request_parameters)

Bases: gamebench_api_client.api.response.response_mediator.ResponseMediator

Concrete Mediator for Authentication requests to use.

Parameters:request_parameters –

__init__(**request_parameters)

Initialize self. See help(type(self)) for accurate signature.

get_results()

Retrieves the Authentication token for a user.

Return response_json:  Auth Token as a JSON.

class gamebench_api_client.api.response.response_mediator.GenericMediator(**request_parameters)

Bases: gamebench_api_client.api.response.response_mediator.ResponseMediator

Concrete Mediator for generic objects to use.

__init__(**request_parameters)

Initialize self. See help(type(self)) for accurate signature.

get_results()

Sets JSON data into a Pandas DataFrame.

Returns:DataFrame of the JSON data from a response.

class gamebench_api_client.api.response.response_mediator.ResponseMediator(**request_parameters)

Bases: abc.ABC

Abstract Mediator.

Parameters:request_parameters – Dictionary from the user containing information for the request.

__init__(**request_parameters)

Initialize self. See help(type(self)) for accurate signature.

get_results()

Abstract method to get the JSON from the retriever.

For the Time Series, Generic, and Session Detail mediators this information will be returned in a Pandas DataFrame. The Authentication simply returns the Auth Token.

class gamebench_api_client.api.response.response_mediator.SessionDetailMediator(**request_parameters)

Bases: gamebench_api_client.api.response.response_mediator.ResponseMediator

Concrete Mediator for session detail objects to use.

__init__(**request_parameters)

Initialize self. See help(type(self)) for accurate signature.

get_results()

Sets JSON data into a Pandas DataFrame.

Returns:DataFrame of the JSON data from a response.

class gamebench_api_client.api.response.response_mediator.TimeSeriesMediator(**request_parameters)

Bases: gamebench_api_client.api.response.response_mediator.ResponseMediator

Concrete Mediator for Time Series objects to use.

__init__(**request_parameters)

Initialize self. See help(type(self)) for accurate signature.

get_results()

Sets JSON data into a Pandas DataFrame.

Returns:DataFrame of the JSON data from a response.

gamebench_api_client.api.response.response_retriever module

class gamebench_api_client.api.response.response_retriever.AbstractRetriever(**request_parameters)

Bases: abc.ABC

Abstract retriever class for contacting the RequestDirector and RequestAdapter.

When instantiated a network call will be made through the Request Adapter.

Parameters:request_parameters – Dictionary from the user containing information for the request.

__init__(**request_parameters)

Initialize self. See help(type(self)) for accurate signature.

get_response_json()

Abstract method to return the JSON of the response object.

Returns:The JSON data for a response.

class gamebench_api_client.api.response.response_retriever.AuthResponseRetriever(**request_parameters)

Bases: gamebench_api_client.api.response.response_retriever.AbstractRetriever

Facade for getting Auth token from the Request.

Parameters:request_parameters – Dictionary containing information needed for an authentication request. Example: {‘username’: ‘John@gmail.com’, ‘password’: ‘1234’}

__init__(**request_parameters)

Initialize self. See help(type(self)) for accurate signature.

get_response_json()

Return the JSON of the response object.

Returns:The JSON data for a response.

class gamebench_api_client.api.response.response_retriever.ResponseRetriever(**request_parameters)

Bases: gamebench_api_client.api.response.response_retriever.AbstractRetriever

Facade to retrieve data for non-auth requests.

__init__(**request_parameters)

Initialize self. See help(type(self)) for accurate signature.

get_response_json()

Return the JSON of the response object.

Returns:The JSON data for a response.

Module contents