.. currentmodule:: pluralkit.v1

.. _v1_ref:

v1 pluralkit.py API reference
=============================

Client
------

.. autoclass:: Client
   :members:

Models
------

Birthday
~~~~~~~~

.. autoclass:: Birthday
   :members:

Color
~~~~~

.. autoclass:: Color
   :members:

Member
~~~~~~

.. autoclass:: Member
   :members:

Message
~~~~~~~

.. autoclass:: Message
   :members:

ProxyTag
~~~~~~~~

.. autoclass:: ProxyTag
   :members:

ProxyTags
~~~~~~~~~

.. autoclass:: ProxyTags
   :members:

Switch
~~~~~~

.. autoclass:: Switch
   :members:

System
~~~~~~

.. autoclass:: System
   :members:

Timestamp
~~~~~~~~~

.. autoclass:: Timestamp
   :members:

Timezone
~~~~~~~~

.. autoclass:: Timezone
   :members:

Enumerations
------------

Privacy
~~~~~~~

.. autoclass:: Privacy

   .. autoattribute:: Privacy.PUBLIC

      Represents a public PluralKit privacy setting.

   .. autoattribute:: Privacy.PRIVATE

      Represents a private PluralKit privacy setting.

   .. autoattribute:: Privacy.UNKNOWN

      Equivalent to `Privacy.PUBLIC` in effect. Returned for member and system privacy fields if the client does not have an authorization token set.

Exceptions
----------

.. currentmodule:: pluralkit.v1.errors

PluralKitException
~~~~~~~~~~~~~~~~~~

.. autoclass:: PluralKitException

AccessForbidden
~~~~~~~~~~~~~~~

.. autoclass:: AccessForbidden

AuthorizationError
~~~~~~~~~~~~~~~~~~

.. autoclass:: AuthorizationError

DiscordUserNotFound
~~~~~~~~~~~~~~~~~~~

.. autoclass:: DiscordUserNotFound

InvalidBirthday
~~~~~~~~~~~~~~~

.. autoclass:: InvalidBirthday

InvalidKwarg
~~~~~~~~~~~~

.. autoclass:: InvalidKwarg

SystemNotFound
~~~~~~~~~~~~~~

.. autoclass:: SystemNotFound

MemberNotFound
~~~~~~~~~~~~~~

.. autoclass:: MemberNotFound