kickerde_api_client.model.league
================================

.. py:module:: kickerde_api_client.model.league

.. autoapi-nested-parse::

   Upstream model for leagues, tournaments, and seasons.



Attributes
----------

.. autoapisummary::

   kickerde_api_client.model.league.ConferenceId
   kickerde_api_client.model.league.DivisionId
   kickerde_api_client.model.league.GamedayId
   kickerde_api_client.model.league.GroupId
   kickerde_api_client.model.league.LeagueTableId
   kickerde_api_client.model.league.SeasonId


Classes
-------

.. autoapisummary::

   kickerde_api_client.model.league.TableCalculatorType
   kickerde_api_client.model.league.League
   kickerde_api_client.model.league.Season
   kickerde_api_client.model.league.Gameday
   kickerde_api_client.model.league.LeagueSeason
   kickerde_api_client.model.league.LeagueTableEntry
   kickerde_api_client.model.league.LeagueTable


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

.. py:data:: ConferenceId
   :type:  TypeAlias
   :value: int


   Upstream ID with unknown semantics.


.. py:data:: DivisionId
   :type:  TypeAlias
   :value: int


   Upstream ID with unknown semantics.


.. py:data:: GamedayId
   :type:  TypeAlias
   :value: int


   Upstream ID for a match day within a league or tournament.


.. py:data:: GroupId
   :type:  TypeAlias
   :value: int


   Upstream ID with unknown semantics.


.. py:data:: LeagueTableId
   :type:  TypeAlias
   :value: int


   Upstream ID for a (partial or complete) league table.


.. py:data:: SeasonId
   :type:  TypeAlias
   :value: str


   Upstream ID for a season of a league or tournament.


.. py:class:: TableCalculatorType

   Bases: :py:obj:`enum.IntEnum`


   Upstream ID to identify the type of table calculator to be
   used for a given league.


   .. py:attribute:: LEAGUE
      :value: 1


      League-style table calculation



   .. py:attribute:: TOURNAMENT
      :value: 2


      Tournament-style table calculation



.. py:class:: League

   Bases: :py:obj:`TypedDict`


   Upstream model for a league or tournament.


   .. py:attribute:: id
      :type:  kickerde_api_client.model.league_id.LeagueId


   .. py:attribute:: shortName
      :type:  str


   .. py:attribute:: longName
      :type:  str


   .. py:attribute:: currentSeasonId
      :type:  SeasonId


   .. py:attribute:: currentRoundId
      :type:  int


   .. py:attribute:: currentRoundName
      :type:  NotRequired[str]


   .. py:attribute:: iconSmall
      :type:  NotRequired[str]


   .. py:attribute:: iconBig
      :type:  NotRequired[str]


   .. py:attribute:: displayKey
      :type:  int


   .. py:attribute:: displayKey2
      :type:  int


   .. py:attribute:: table
      :type:  NotRequired[int]


   .. py:attribute:: stateId
      :type:  NotRequired[kickerde_api_client.model.core.StateId]


   .. py:attribute:: countryId
      :type:  kickerde_api_client.model.core.CountryId


   .. py:attribute:: associationId
      :type:  NotRequired[kickerde_api_client.model.association.Association]


   .. py:attribute:: sportId
      :type:  kickerde_api_client.model.core.SportId


   .. py:attribute:: teamOrigin
      :type:  NotRequired[bool]


   .. py:attribute:: imId
      :type:  int


   .. py:attribute:: urlName
      :type:  str


   .. py:attribute:: uShortName
      :type:  str


   .. py:attribute:: friendlyName
      :type:  NotRequired[str]


   .. py:attribute:: ressortId
      :type:  NotRequired[kickerde_api_client.model.core.RessortId]


   .. py:attribute:: ressortIdHome
      :type:  NotRequired[kickerde_api_client.model.core.RessortIdHome]


   .. py:attribute:: trackRessortId
      :type:  NotRequired[kickerde_api_client.model.core.TrackRessortId]


   .. py:attribute:: trackRessortName
      :type:  NotRequired[str]


   .. py:attribute:: priority
      :type:  NotRequired[int]


   .. py:attribute:: tblcalc
      :type:  NotRequired[TableCalculatorType]


   .. py:attribute:: tickerQuoteAd
      :type:  NotRequired[bool]


   .. py:attribute:: gamedayQuoteAd
      :type:  NotRequired[bool]


   .. py:attribute:: gamedayButtonTitle
      :type:  NotRequired[str]


   .. py:attribute:: socialmedia
      :type:  NotRequired[bool]


   .. py:attribute:: goalgetters
      :type:  NotRequired[bool]


   .. py:attribute:: history
      :type:  NotRequired[bool]


   .. py:attribute:: hasTransfers
      :type:  NotRequired[bool]


   .. py:attribute:: adKeywords
      :type:  NotRequired[str]


.. py:class:: Season

   Bases: :py:obj:`TypedDict`


   Upstream model for the season of a league or tournament.


   .. py:attribute:: id
      :type:  SeasonId


   .. py:attribute:: currentRoundId
      :type:  int


   .. py:attribute:: displayKey
      :type:  int


   .. py:attribute:: displayKey2
      :type:  int


   .. py:attribute:: table
      :type:  NotRequired[int]


   .. py:attribute:: winnerId
      :type:  kickerde_api_client.model.team.TeamId | Literal[0]


   .. py:attribute:: winnerLongName
      :type:  NotRequired[str]


   .. py:attribute:: points
      :type:  NotRequired[str]


   .. py:attribute:: goals
      :type:  NotRequired[str]


.. py:class:: Gameday

   Bases: :py:obj:`TypedDict`


   Upstream model for a match day.


   .. py:attribute:: id
      :type:  GamedayId


   .. py:attribute:: title
      :type:  str


   .. py:attribute:: dateFrom
      :type:  NotRequired[datetype.NaiveDateTime]


   .. py:attribute:: dateTo
      :type:  NotRequired[datetype.NaiveDateTime]


   .. py:attribute:: hideForTable
      :type:  NotRequired[bool]


.. py:class:: LeagueSeason

   Bases: :py:obj:`TypedDict`


   Upstream model for a hierarchical view on a league in a season.
   Contains teams and match days (dubbed  :py:attr:`.gamedays`) as
   submappings.

   Submappings are indexed by team ID or gameday ID, respectively.


   .. py:attribute:: id
      :type:  kickerde_api_client.model.league_id.LeagueId


   .. py:attribute:: shortName
      :type:  str


   .. py:attribute:: longName
      :type:  str


   .. py:attribute:: country
      :type:  NotRequired[kickerde_api_client.model.core.Country]


   .. py:attribute:: teamType
      :type:  str


   .. py:attribute:: teams
      :type:  collections.abc.Mapping[kickerde_api_client.model.team.TeamId, kickerde_api_client.model.team.Team]


   .. py:attribute:: gamedays
      :type:  collections.abc.Mapping[GamedayId, Gameday]


   .. py:attribute:: iconSmall
      :type:  str


   .. py:attribute:: iconBig
      :type:  str


   .. py:attribute:: currentSeasonId
      :type:  SeasonId


   .. py:attribute:: currentRoundId
      :type:  int


   .. py:attribute:: displayKey
      :type:  int


   .. py:attribute:: displayKey2
      :type:  int


   .. py:attribute:: table
      :type:  NotRequired[int]


   .. py:attribute:: ressortId
      :type:  NotRequired[kickerde_api_client.model.core.RessortId]


   .. py:attribute:: ressortIdHome
      :type:  NotRequired[kickerde_api_client.model.core.RessortId]


   .. py:attribute:: tblcalc
      :type:  NotRequired[TableCalculatorType]


   .. py:attribute:: socialmedia
      :type:  NotRequired[bool]


   .. py:attribute:: syncMeinKicker
      :type:  NotRequired[bool]


   .. py:attribute:: goalgetters
      :type:  bool


.. py:class:: LeagueTableEntry

   Bases: :py:obj:`TypedDict`


   Upstream model for an entry in a league table.


   .. py:attribute:: id
      :type:  kickerde_api_client.model.team.TeamId


   .. py:attribute:: rank
      :type:  int

      The numeric rank of the table entry.

      Note that in the context of the league table that contains this
      entry, the values of `rank` may be non-unique (due to ties) and
      sparse (also due to ties, or because the league table might
      represent a focused subwindow of an actual league table).



   .. py:attribute:: shortName
      :type:  str


   .. py:attribute:: longName
      :type:  str


   .. py:attribute:: sortName
      :type:  str


   .. py:attribute:: defaultLeagueId
      :type:  kickerde_api_client.model.league_id.LeagueId


   .. py:attribute:: games
      :type:  int


   .. py:attribute:: goalsFor
      :type:  int


   .. py:attribute:: goalsAgainst
      :type:  int


   .. py:attribute:: wins
      :type:  int


   .. py:attribute:: ties
      :type:  int


   .. py:attribute:: lost
      :type:  int


   .. py:attribute:: points
      :type:  int


   .. py:attribute:: direction
      :type:  Literal['up', 'down'] | None


   .. py:attribute:: winsOvertime
      :type:  int


   .. py:attribute:: winsPenalty
      :type:  int


   .. py:attribute:: lostOvertime
      :type:  int


   .. py:attribute:: lostPenalty
      :type:  int


   .. py:attribute:: groupId
      :type:  GroupId | None


   .. py:attribute:: groupName
      :type:  str | None


   .. py:attribute:: divisionId
      :type:  DivisionId | None


   .. py:attribute:: divisionName
      :type:  str | None


   .. py:attribute:: conferenceId
      :type:  ConferenceId | None


   .. py:attribute:: conferenceName
      :type:  str | None


   .. py:attribute:: iconSmall
      :type:  str


   .. py:attribute:: iconBig
      :type:  str


.. py:class:: LeagueTable

   Bases: :py:obj:`TypedDict`


   Upstream model for a league table.


   .. py:attribute:: id
      :type:  LeagueTableId


   .. py:attribute:: leagueId
      :type:  kickerde_api_client.model.league_id.LeagueId


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: seasonId
      :type:  SeasonId


   .. py:attribute:: roundId
      :type:  int


   .. py:attribute:: entries
      :type:  dict[kickerde_api_client.model.team.TeamId, LeagueTableEntry]

      Dictionary containing :py:class:`.LeagueTableEntry` objects,
      ordered by :py:attr:`~.LeagueTableEntry.rank` but indexed by
      team ID.

      See :py:attr:`.LeagueTableEntry.rank` for details on why this
      dictionary is indexed by team rather than by rank.