.. currentmodule:: stoat

Invites
=======

The following section documents everything related to invites.

Models
------

BaseInvite
~~~~~~~~~~

.. attributetable:: BaseInvite

.. autoclass:: BaseInvite
    :members:
    :inherited-members:

ServerPublicInvite
~~~~~~~~~~~~~~~~~~

.. attributetable:: ServerPublicInvite

.. autoclass:: ServerPublicInvite
    :members:
    :inherited-members:

GroupPublicInvite
~~~~~~~~~~~~~~~~~

.. attributetable:: GroupPublicInvite

.. autoclass:: GroupPublicInvite
    :members:
    :inherited-members:

UnknownPublicInvite
~~~~~~~~~~~~~~~~~~~

.. attributetable:: UnknownPublicInvite

.. autoclass:: UnknownPublicInvite
    :members:
    :inherited-members:

PublicInvite
~~~~~~~~~~~~

.. class:: PublicInvite
    
    An union of all public invites.

    The following classes are included in this union:

    - :class:`.ServerPublicInvite`
    - :class:`.GroupPublicInvite`
    - :class:`.UnknownPublicInvite`

PrivateBaseInvite
~~~~~~~~~~~~~~~~~

.. attributetable:: PrivateBaseInvite

.. autoclass:: PrivateBaseInvite
    :members:
    :inherited-members:

GroupInvite
~~~~~~~~~~~

.. attributetable:: GroupInvite

.. autoclass:: GroupInvite
    :members:
    :inherited-members:

ServerInvite
~~~~~~~~~~~~

.. attributetable:: ServerInvite

.. autoclass:: ServerInvite
    :members:
    :inherited-members:

Invite
~~~~~~

.. attributetable:: Invite

.. autoclass:: Invite
    :members:
    :inherited-members: