sidequest_common.schemas.guild
==============================

.. py:module:: sidequest_common.schemas.guild

.. autoapi-nested-parse::

   Guild configuration schemas.



Classes
-------

.. autoapisummary::

   sidequest_common.schemas.guild.GuildConfigSchema
   sidequest_common.schemas.guild.GuildConfigUpdate


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

.. py:class:: GuildConfigSchema

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


   Full guild configuration as returned by the API.


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



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


   .. py:attribute:: automod_block_invites
      :type:  bool


   .. py:attribute:: automod_block_links
      :type:  bool


   .. py:attribute:: automod_enabled
      :type:  bool


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


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


   .. py:attribute:: automod_max_mentions
      :type:  int


   .. py:attribute:: automod_spam_messages
      :type:  int


   .. py:attribute:: automod_spam_seconds
      :type:  int


   .. py:attribute:: automod_timeout_seconds
      :type:  int


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



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



   .. py:attribute:: badge_role_ids
      :type:  dict[str, int]


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



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



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



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



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


   .. py:attribute:: level_roles_stack
      :type:  bool


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


   .. py:attribute:: level_up_message
      :type:  str


   .. py:attribute:: leveling_enabled
      :type:  bool


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



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


   .. py:attribute:: model_config


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


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


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



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



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



   .. py:attribute:: weekly_board_last_week
      :type:  str | None
      :value: None



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


   .. py:attribute:: welcome_message
      :type:  str


   .. py:attribute:: xp_cooldown_seconds
      :type:  int


   .. py:attribute:: xp_max
      :type:  int


   .. py:attribute:: xp_min
      :type:  int


.. py:class:: GuildConfigUpdate

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


   Partial update. Only fields present in the request body change (``exclude_unset``).

   Send ``null`` to clear an optional channel/role.


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



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



   .. py:attribute:: automod_block_invites
      :type:  bool | None
      :value: None



   .. py:attribute:: automod_block_links
      :type:  bool | None
      :value: None



   .. py:attribute:: automod_enabled
      :type:  bool | None
      :value: None



   .. py:attribute:: automod_exempt_channel_ids
      :type:  list[int] | None
      :value: None



   .. py:attribute:: automod_exempt_role_ids
      :type:  list[int] | None
      :value: None



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


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


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


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


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



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



   .. py:attribute:: badge_role_ids
      :type:  dict[str, int] | None
      :value: None



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



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



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



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



   .. py:attribute:: level_roles_stack
      :type:  bool | None
      :value: None



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



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


   .. py:attribute:: leveling_enabled
      :type:  bool | None
      :value: None



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



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



   .. py:attribute:: no_xp_channel_ids
      :type:  list[int] | None
      :value: None



   .. py:attribute:: no_xp_role_ids
      :type:  list[int] | None
      :value: None



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



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



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



   .. py:attribute:: weekly_board_last_week
      :type:  str | None
      :value: None



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



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


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


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


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