sidequest_common.schemas.guild#

Guild configuration schemas.

Classes#

GuildConfigSchema

Full guild configuration as returned by the API.

GuildConfigUpdate

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

Module Contents#

class sidequest_common.schemas.guild.GuildConfigSchema#

Bases: pydantic.BaseModel

Full guild configuration as returned by the API.

announcement_channel_id: int | None = None#
auto_role_id: int | None#
automod_block_invites: bool#
automod_enabled: bool#
automod_exempt_channel_ids: list[int]#
automod_exempt_role_ids: list[int]#
automod_max_mentions: int#
automod_spam_messages: int#
automod_spam_seconds: int#
automod_timeout_seconds: int#
away_role_id: int | None = None#
badge_channel_id: int | None = None#
badge_role_ids: dict[str, int]#
battlenet_role_id: int | None = None#
events_forum_channel_id: int | None = None#
forever_feed_channel_id: int | None = None#
gate_role_id: int | None = None#
guild_id: int#
level_roles_stack: bool#
level_up_channel_id: int | None#
level_up_message: str#
leveling_enabled: bool#
linked_role_id: int | None = None#
log_channel_id: int | None#
model_config#
no_xp_channel_ids: list[int]#
no_xp_role_ids: list[int]#
roster_role_id: int | None = None#
signup_notice_channel_id: int | None = None#
weekly_board_channel_id: int | None = None#
weekly_board_last_week: str | None = None#
welcome_channel_id: int | None#
welcome_message: str#
xp_cooldown_seconds: int#
xp_max: int#
xp_min: int#
class sidequest_common.schemas.guild.GuildConfigUpdate#

Bases: pydantic.BaseModel

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

Send null to clear an optional channel/role.

announcement_channel_id: int | None = None#
auto_role_id: int | None = None#
automod_block_invites: bool | None = None#
automod_enabled: bool | None = None#
automod_exempt_channel_ids: list[int] | None = None#
automod_exempt_role_ids: list[int] | None = None#
automod_max_mentions: int | None#
automod_spam_messages: int | None#
automod_spam_seconds: int | None#
automod_timeout_seconds: int | None#
away_role_id: int | None = None#
badge_channel_id: int | None = None#
badge_role_ids: dict[str, int] | None = None#
battlenet_role_id: int | None = None#
events_forum_channel_id: int | None = None#
forever_feed_channel_id: int | None = None#
gate_role_id: int | None = None#
level_roles_stack: bool | None = None#
level_up_channel_id: int | None = None#
level_up_message: str | None#
leveling_enabled: bool | None = None#
linked_role_id: int | None = None#
log_channel_id: int | None = None#
no_xp_channel_ids: list[int] | None = None#
no_xp_role_ids: list[int] | None = None#
roster_role_id: int | None = None#
signup_notice_channel_id: int | None = None#
weekly_board_channel_id: int | None = None#
weekly_board_last_week: str | None = None#
welcome_channel_id: int | None = None#
welcome_message: str | None#
xp_cooldown_seconds: int | None#
xp_max: int | None#
xp_min: int | None#