sidequest_common.schemas.role_menus
===================================

.. py:module:: sidequest_common.schemas.role_menus

.. autoapi-nested-parse::

   Role menu schemas.



Classes
-------

.. autoapisummary::

   sidequest_common.schemas.role_menus.RoleMenuCreate
   sidequest_common.schemas.role_menus.RoleMenuOptionSchema
   sidequest_common.schemas.role_menus.RoleMenuOptionUpsert
   sidequest_common.schemas.role_menus.RoleMenuSchema
   sidequest_common.schemas.role_menus.RoleMenuUpdate


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

.. py:class:: RoleMenuCreate

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


   Body for ``POST /role-menus``. The bot posts the message afterwards and PATCHes ``message_id``.


   .. py:attribute:: channel_id
      :type:  int


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


   .. py:attribute:: max_roles
      :type:  int


   .. py:attribute:: title
      :type:  str


.. py:class:: RoleMenuOptionSchema

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


   One role button.


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


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


   .. py:attribute:: label
      :type:  str


   .. py:attribute:: model_config


   .. py:attribute:: position
      :type:  int


   .. py:attribute:: role_id
      :type:  int


.. py:class:: RoleMenuOptionUpsert

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


   Body for ``PUT /role-menus/{menu_id}/options/{role_id}``. Discord allows 25 buttons per message.


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


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


   .. py:attribute:: label
      :type:  str


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


.. py:class:: RoleMenuSchema

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


   A role menu and its options (ordered by ``position``).


   .. py:attribute:: channel_id
      :type:  int


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


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


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


   .. py:attribute:: max_roles
      :type:  int


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


   .. py:attribute:: model_config


   .. py:attribute:: options
      :type:  list[RoleMenuOptionSchema]


   .. py:attribute:: title
      :type:  str


.. py:class:: RoleMenuUpdate

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


   Partial update for ``PATCH /role-menus/{menu_id}`` (``exclude_unset``).


   .. py:attribute:: channel_id
      :type:  int | None
      :value: None



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


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


   .. py:attribute:: message_id
      :type:  int | None
      :value: None



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