.. currentmodule:: stoat

Users
=====

The following section documents everything related to users. Users are generally considered base entity on Stoat.

Models
------

UserStatus
~~~~~~~~~~

.. attributetable:: UserStatus

.. autoclass:: UserStatus
    :members:

UserStatusEdit
~~~~~~~~~~~~~~

.. attributetable:: UserStatusEdit

.. autoclass:: UserStatusEdit
    :members:

StatelessUserProfile
~~~~~~~~~~~~~~~~~~~~

.. attributetable:: StatelessUserProfile

.. autoclass:: StatelessUserProfile
    :members:

UserProfile
~~~~~~~~~~~

.. attributetable:: UserProfile

.. autoclass:: UserProfile
    :members:

PartialUserProfile
~~~~~~~~~~~~~~~~~~

.. attributetable:: PartialUserProfile

.. autoclass:: PartialUserProfile
    :members:

UserProfileEdit
~~~~~~~~~~~~~~~

.. attributetable:: UserProfileEdit

.. autoclass:: UserProfileEdit
    :members:

Relationship
~~~~~~~~~~~~

.. attributetable:: Relationship

.. autoclass:: Relationship
    :members:

Mutuals
~~~~~~~

.. attributetable:: Mutuals

.. autoclass:: Mutuals
    :members:

BaseUser
~~~~~~~~

.. attributetable:: BaseUser

.. autoclass:: BaseUser
    :members:

DisplayUser
~~~~~~~~~~~

.. attributetable:: DisplayUser

.. autoclass:: DisplayUser
    :members:
    :inherited-members:

BotUserMetadata
~~~~~~~~~~~~~~~

.. attributetable:: BotUserMetadata

.. autoclass:: BotUserMetadata
    :members:
    :inherited-members:

PartialUser
~~~~~~~~~~~

.. attributetable:: PartialUser

.. autoclass:: PartialUser
    :members:
    :inherited-members:

User
~~~~

.. attributetable:: User

.. autoclass:: User
    :members:
    :inherited-members:

OwnUser
~~~~~~~

.. attributetable:: OwnUser

.. autoclass:: OwnUser
    :members:
    :inherited-members:
    :exclude-members: accept_friend_request, block, deny_friend_request, mutual_friend_ids, mutual_server_ids, mutuals, remove_friend, report, send_friend_request, unblock

UserVoiceState
~~~~~~~~~~~~~~

.. attributetable:: UserVoiceState

.. autoclass:: UserVoiceState
    :members:
    :inherited-members:

PartialUserVoiceState
~~~~~~~~~~~~~~~~~~~~~

.. attributetable:: PartialUserVoiceState

.. autoclass:: PartialUserVoiceState
    :members:
    :inherited-members: