sidequest_common.schemas.away
=============================

.. py:module:: sidequest_common.schemas.away

.. autoapi-nested-parse::

   Member away date ranges.

   Members declare date ranges (inclusive) they'll be away on ``/account/``; the bot grants/removes the "Away on a
   Quest" role (``GuildConfig.away_role_id``) for whoever's range covers today in America/Chicago
   (``GET /api/guilds/{guild_id}/away-now``), and ``EventDetail.away`` flags members away on an event's start date.



Classes
-------

.. autoapisummary::

   sidequest_common.schemas.away.AwayNowReport
   sidequest_common.schemas.away.AwayRangeIn
   sidequest_common.schemas.away.AwayRangeSchema


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

.. py:class:: AwayNowReport

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


   ``GET /api/guilds/{guild_id}/away-now``: linked members away today (America/Chicago), bot-facing.


   .. py:attribute:: discord_ids
      :type:  list[int]


.. py:class:: AwayRangeIn

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


   Body for ``POST /api/me/away``.


   .. py:attribute:: end_date
      :type:  datetime.date


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


   .. py:attribute:: start_date
      :type:  datetime.date


.. py:class:: AwayRangeSchema

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


   One of the signed-in member's away ranges, as returned by ``GET/POST /api/me/away``.


   .. py:attribute:: end_date
      :type:  datetime.date


   .. py:attribute:: id
      :type:  uuid.UUID


   .. py:attribute:: model_config


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


   .. py:attribute:: start_date
      :type:  datetime.date