api.rst

.. currentmodule:: pyrez

API Reference

The following section outlines the API of Pyrez.

PaladinsAPI

.. autoclass:: pyrez.api.PaladinsAPI
    :members:
    :inherited-members:

RealmRoyaleAPI

.. autoclass:: pyrez.api.RealmRoyaleAPI
    :members:
    :inherited-members:

SmiteAPI

.. autoclass:: pyrez.api.SmiteAPI
    :members:
    :inherited-members:

StatusPageAPI

.. autoclass:: pyrez.api.StatusPageAPI
    :members:
    :inherited-members:

Enums (pyrez.enumerations)

There are several enums used within Pyrez to make it easier for you to configure the library for use how you like.

.. autoclass:: pyrez.enumerations.Enum
    :members:
    :undoc-members:
    :private-members:

.. autoclass:: pyrez.enumerations.Champions
    :members:
    :undoc-members:
    :private-members:

.. automodule:: pyrez.enumerations.Classes
    :members:
    :undoc-members:
    :private-members:

.. autoclass:: pyrez.enumerations.Endpoint
    :members:
    :undoc-members:
    :private-members:

.. autoclass:: pyrez.enumerations.Format
    :members:
    :undoc-members:
    :private-members:

.. autoclass:: pyrez.enumerations.Gods
    :members:
    :undoc-members:
    :private-members:

.. autoclass:: pyrez.enumerations.Language
    :members:
    :undoc-members:
    :private-members:

.. autoclass:: pyrez.enumerations.PortalId
    :members:
    :undoc-members:
    :private-members:

.. autoclass:: pyrez.enumerations.Region
    :members:
    :undoc-members:
    :private-members:

.. autoclass:: pyrez.enumerations.QueuePaladins
    :members:
    :undoc-members:
    :private-members:

.. autoclass:: pyrez.enumerations.QueueRealmRoyale
    :members:
    :undoc-members:
    :private-members:

.. autoclass:: pyrez.enumerations.QueueSmite
    :members:
    :undoc-members:
    :private-members:

.. autoclass:: pyrez.enumerations.Status
    :members:
    :undoc-members:
    :private-members:

.. autoclass:: pyrez.enumerations.Tier
    :members:
    :undoc-members:
    :private-members:

Exceptions (pyrez.exceptions)

The following exceptions are thrown by the library.

.. automodule:: pyrez.exceptions
    :members:
    :undoc-members: