sidequest_common.schemas.moderation
===================================

.. py:module:: sidequest_common.schemas.moderation

.. autoapi-nested-parse::

   Moderation case schemas.



Classes
-------

.. autoapisummary::

   sidequest_common.schemas.moderation.CaseAction
   sidequest_common.schemas.moderation.ModCaseCreate
   sidequest_common.schemas.moderation.ModCaseSchema
   sidequest_common.schemas.moderation.ModCaseUpdate


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

.. py:class:: CaseAction

   Bases: :py:obj:`enum.StrEnum`


   Kinds of moderation action recorded as cases.

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: AUTOMOD
      :value: 'automod'



   .. py:attribute:: BAN
      :value: 'ban'



   .. py:attribute:: KICK
      :value: 'kick'



   .. py:attribute:: TIMEOUT
      :value: 'timeout'



   .. py:attribute:: UNBAN
      :value: 'unban'



   .. py:attribute:: UNTIMEOUT
      :value: 'untimeout'



   .. py:attribute:: WARN
      :value: 'warn'



.. py:class:: ModCaseCreate

   Bases: :py:obj:`pydantic.BaseModel`


   Body for ``POST /cases``; the API assigns ``case_number``.


   .. py:attribute:: action
      :type:  CaseAction


   .. py:attribute:: duration_seconds
      :type:  int | None


   .. py:attribute:: moderator_id
      :type:  int


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


   .. py:attribute:: user_id
      :type:  int


.. py:class:: ModCaseSchema

   Bases: :py:obj:`pydantic.BaseModel`


   A recorded case.


   .. py:attribute:: action
      :type:  CaseAction


   .. py:attribute:: case_number
      :type:  int


   .. py:attribute:: created_at
      :type:  datetime.datetime


   .. py:attribute:: duration_seconds
      :type:  int | None


   .. py:attribute:: guild_id
      :type:  int


   .. py:attribute:: model_config


   .. py:attribute:: moderator_id
      :type:  int


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


   .. py:attribute:: user_id
      :type:  int


.. py:class:: ModCaseUpdate

   Bases: :py:obj:`pydantic.BaseModel`


   Body for ``PATCH /cases/{case_number}``.


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