kickerde_api_client.api
=======================

.. py:module:: kickerde_api_client.api

.. autoapi-nested-parse::

   The primary module in kickerde_api_client.



Attributes
----------

.. autoapisummary::

   kickerde_api_client.api.logger


Classes
-------

.. autoapisummary::

   kickerde_api_client.api.Api


Module Contents
---------------

.. py:data:: logger

.. py:class:: Api(http_client = None, provider = None)

   The primary API client and entry point for all requests.


   .. py:method:: leagues()
      :async:


      Returns all leagues and tournaments known to the system.

      :return:
          a dictionary of :py:class:`~.model.League` objects, indexed
          by league ID.



   .. py:method:: seasons(league)
      :async:


      Returns all known seasons for the given league or tournament.

      :param league:
          the ID of the league or tournament.
          Alternatively, a :py:class:`~.model.League` object.

      :return:
          a dictionary of :py:class:`~.model.Season` objects, indexed
          by season ID.



   .. py:method:: league_season(league, season)
      :async:


      Returns an informational structure for the given league and
      season. Aside from league properties, the structure contains
      dictionaries that provide info on teams and match days (aka
      gamedays).

      :param league:
          the ID of the league or tournament.
          Alternatively, a :py:class:`~.model.League` object.

      :param season:
          the ID of the season.
          Alternatively, a :py:class:`~.model.Season` object.

      :return: a :py:class:`~.model.LeagueSeason` object.



   .. py:method:: my_team_sync(team)
      :async:


      Returns an informational structure for live and upcoming
      matches played by the given team.

      :param team:
          the ID of the team.
          Alternatively, a :py:class:`~.model.Team` object.

      :return: a :py:class:`~.model.MyTeamSync` object.



   .. py:method:: dump_leagues()
      :async:


      Dumps all leagues to stdout in JSON format.



   .. py:method:: dump_seasons(league)
      :async:


      Dumps all seasons to stdout in JSON format.

      :param league:
          the ID of the league or tournament.
          Alternatively, a :py:class:`~.model.League` object.



   .. py:method:: dump_league_season(league, season)
      :async:


      Dumps a :py:class:`~.model.LeagueSeason` object to stdout
      in JSON format.

      :param league:
          the ID of the league or tournament.
          Alternatively, a :py:class:`~.model.League` object.

      :param season:
          the ID of the season.
          Alternatively, a :py:class:`~.model.Season` object.



   .. py:method:: dump_my_team_sync(team)
      :async:


      Dumps a :py:class:`~.model.MyTeamSync` object to stdout in
      JSON format.

      :param team:
          the ID of the team.
          Alternatively, a :py:class:`~.model.Team` object.