sidequest_common.schemas.recruiting
===================================

.. py:module:: sidequest_common.schemas.recruiting

.. autoapi-nested-parse::

   What roles and classes the guild is recruiting for: public read, officer-managed.

   ``wow_class``/``class`` follows the same split as ``Signup`` in ``events.py``: ``class`` is a Python keyword, so the
   Python-side attribute is ``wow_class``, aliased to the wire name ``class``.



Attributes
----------

.. autoapisummary::

   sidequest_common.schemas.recruiting.MAX_RECRUITING_NOTE


Classes
-------

.. autoapisummary::

   sidequest_common.schemas.recruiting.Recruiting
   sidequest_common.schemas.recruiting.RecruitingClassWant
   sidequest_common.schemas.recruiting.RecruitingPriority
   sidequest_common.schemas.recruiting.RecruitingRoleWant
   sidequest_common.schemas.recruiting.RecruitingUpdate


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

.. py:class:: Recruiting

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


   ``GET /api/recruiting`` (public): the current recruiting needs, empty lists if nothing is wanted.


   .. py:attribute:: classes
      :type:  list[RecruitingClassWant]


   .. py:attribute:: roles
      :type:  list[RecruitingRoleWant]


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


.. py:class:: RecruitingClassWant

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


   One class the guild is recruiting for.


   .. py:attribute:: model_config


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


   .. py:attribute:: priority
      :type:  RecruitingPriority


   .. py:attribute:: wow_class
      :type:  sidequest_common.schemas.events.WowClass


.. py:class:: RecruitingPriority

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


   How urgently the guild wants this role or class filled.

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


   .. py:attribute:: HIGH
      :value: 'high'



   .. py:attribute:: NORMAL
      :value: 'normal'



.. py:class:: RecruitingRoleWant

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


   One role the guild is recruiting for.


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


   .. py:attribute:: priority
      :type:  RecruitingPriority


   .. py:attribute:: role
      :type:  sidequest_common.schemas.events.SignupRole


.. py:class:: RecruitingUpdate

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


   ``PUT /api/recruiting`` (officer): replaces the full set. Each role/class may appear at most once.


   .. py:attribute:: classes
      :type:  list[RecruitingClassWant]


   .. py:attribute:: roles
      :type:  list[RecruitingRoleWant]


.. py:data:: MAX_RECRUITING_NOTE
   :value: 140