sidequest_common.schemas.members
================================

.. py:module:: sidequest_common.schemas.members

.. autoapi-nested-parse::

   Signed-in member profile and officer member-list schemas.



Classes
-------

.. autoapisummary::

   sidequest_common.schemas.members.CalendarLink
   sidequest_common.schemas.members.Me
   sidequest_common.schemas.members.MemberListing


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

.. py:class:: CalendarLink

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


   The signed-in member's private calendar feed link (``GET/POST /api/me/calendar``).

   ``url`` is the full ``https://.../api/calendar/{token}.ics`` address; rotating replaces ``token`` and
   invalidates the old link.


   .. py:attribute:: token
      :type:  str


   .. py:attribute:: url
      :type:  str


.. py:class:: Me

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


   The signed-in member's profile, as returned by ``GET /api/me``.

   ``display_name`` is the guild nick, else the Discord global name, else the username. Discord ids are
   returned as strings because they're 64-bit and JSON numbers aren't safe past 2**53.


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


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


   .. py:attribute:: discord_id
      :type:  str


   .. py:attribute:: display_name
      :type:  str


   .. py:attribute:: id
      :type:  int


   .. py:attribute:: is_gm
      :type:  bool


   .. py:attribute:: is_guild_member
      :type:  bool


   .. py:attribute:: is_officer
      :type:  bool


   .. py:attribute:: model_config


   .. py:attribute:: roster_confirmed
      :type:  bool


   .. py:attribute:: username
      :type:  str


.. py:class:: MemberListing

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


   One row of the officers' member list (``GET /api/members``): who has signed in and what they've linked.

   Officers compare ``battletag`` against the in-game guild roster; it is never shown outside officer views.


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


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


   .. py:attribute:: display_name
      :type:  str


   .. py:attribute:: id
      :type:  int


   .. py:attribute:: is_guild_member
      :type:  bool


   .. py:attribute:: is_officer
      :type:  bool


   .. py:attribute:: last_login_at
      :type:  datetime.datetime | None


   .. py:attribute:: roster_confirmed
      :type:  bool


   .. py:attribute:: username
      :type:  str