Skip to content

Parameters

guild

EditGuildParams dataclass

Bases: Part


              flowchart TD
              scurrypy.params.guild.EditGuildParams[EditGuildParams]
              scurrypy.core.part.Part[Part]

                              scurrypy.core.part.Part --> scurrypy.params.guild.EditGuildParams
                


              click scurrypy.params.guild.EditGuildParams href "" "scurrypy.params.guild.EditGuildParams"
              click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"

Parameters for editing a guild.

name: OptionalParam[str] = Unset class-attribute instance-attribute

Guild name.

afk_channel_id: OptionalNullableParam[Snowflake] = Unset class-attribute instance-attribute

Channel ID for AFK channel.

icon: OptionalNullableParam[ImageDataPart] = Unset class-attribute instance-attribute

Data URI scheme for guild icon.

Note

Can be animated if guild has ANIMATED_ICON feature.

splash: OptionalNullableParam[ImageDataPart] = Unset class-attribute instance-attribute

Data URI scheme for guild splash if guild has INVITE_SPLASH feature.

discovery_splash: OptionalNullableParam[ImageDataPart] = Unset class-attribute instance-attribute

Data URI scheme for guild discovery if guild has DISCOVERABLE feature.

banner: OptionalNullableParam[ImageDataPart] = Unset class-attribute instance-attribute

Data URI scheme for guild banner if guild has BANNER feature.

Note

Can be animated if guild has ANIMATED_BANNER feature.

system_channel_id: OptionalNullableParam[Snowflake] = Unset class-attribute instance-attribute

Channel ID for receiving guild notices (e.g., boosts, user join).

rules_channel_id: OptionalNullableParam[Snowflake] = Unset class-attribute instance-attribute

Channel ID for where guilds display rules.

public_updates_channel_id: OptionalNullableParam[Snowflake] = Unset class-attribute instance-attribute

Channel ID for receiving notices from Discord.

description: OptionalNullableParam[str] = Unset class-attribute instance-attribute

Description for the guild.

premium_progress_bar_enabled: OptionalParam[bool] = Unset class-attribute instance-attribute

Whether the guild's boost progress bar should be shown.

safety_alerts_channel_id: OptionalNullableParam[Snowflake] = Unset class-attribute instance-attribute

Channel ID for receiving safety alerts from Discord.

EditGuildRoleParams dataclass

Bases: Part


              flowchart TD
              scurrypy.params.guild.EditGuildRoleParams[EditGuildRoleParams]
              scurrypy.core.part.Part[Part]

                              scurrypy.core.part.Part --> scurrypy.params.guild.EditGuildRoleParams
                


              click scurrypy.params.guild.EditGuildRoleParams href "" "scurrypy.params.guild.EditGuildRoleParams"
              click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"

Parameters for editing a guild role.

name: OptionalNullableParam[str] = Unset class-attribute instance-attribute

Name of the role.

colors: OptionalNullableParam[GuildRoleColorsPart] = Unset class-attribute instance-attribute

Colors of the role.

hoist: OptionalNullableParam[bool] = Unset class-attribute instance-attribute

Whether the role is displayed separately on the sidebar.

icon: OptionalNullableParam[ImageDataPart] = Unset class-attribute instance-attribute

Icon of the role (if guild has ROLE_ICONS feature).

permissions: OptionalNullableParam[Permissions] = Unset class-attribute instance-attribute

Permission bit set. [INT_LIMIT]

unicode_emoji: OptionalNullableParam[str] = Unset class-attribute instance-attribute

Unicode emoji of the role (if guilde has ROLE_ICONS feature).

mentionable: OptionalNullableParam[bool] = Unset class-attribute instance-attribute

Whether the role should be mentionable.

EditGuildWelcomeScreenParams dataclass

Bases: Part


              flowchart TD
              scurrypy.params.guild.EditGuildWelcomeScreenParams[EditGuildWelcomeScreenParams]
              scurrypy.core.part.Part[Part]

                              scurrypy.core.part.Part --> scurrypy.params.guild.EditGuildWelcomeScreenParams
                


              click scurrypy.params.guild.EditGuildWelcomeScreenParams href "" "scurrypy.params.guild.EditGuildWelcomeScreenParams"
              click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"

Parameters for editing a guild welcome screen.

enabled: OptionalNullableParam[bool] = Unset class-attribute instance-attribute

Whether the welcome scren is enabled.

welcome_channels: OptionalNullableParam[list[WelcomeScreenChannelPart]] = Unset class-attribute instance-attribute

Channels linked when the welcome screen is displayed.

description: OptionalNullableParam[str] = Unset class-attribute instance-attribute

Guild description to show on the welcome screen.

EditOnboardingParams dataclass

Bases: Part


              flowchart TD
              scurrypy.params.guild.EditOnboardingParams[EditOnboardingParams]
              scurrypy.core.part.Part[Part]

                              scurrypy.core.part.Part --> scurrypy.params.guild.EditOnboardingParams
                


              click scurrypy.params.guild.EditOnboardingParams href "" "scurrypy.params.guild.EditOnboardingParams"
              click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"

Parameters for editing a guild onboarding flow.

prompts: OptionalParam[list[OnboardingPromptPart]] = Unset class-attribute instance-attribute

Prompts shown during onboarding.

default_channel_ids: OptionalParam[list[int]] = Unset class-attribute instance-attribute

Channel IDs that members get opted into automatically.

enabled: OptionalParam[bool] = Unset class-attribute instance-attribute

Whether onboarding is enabled in the guild.

mode: OptionalParam[OnboardingMode] = Unset class-attribute instance-attribute

Current mode of onboarding.

EditGuildStickerParams dataclass

Bases: Part


              flowchart TD
              scurrypy.params.guild.EditGuildStickerParams[EditGuildStickerParams]
              scurrypy.core.part.Part[Part]

                              scurrypy.core.part.Part --> scurrypy.params.guild.EditGuildStickerParams
                


              click scurrypy.params.guild.EditGuildStickerParams href "" "scurrypy.params.guild.EditGuildStickerParams"
              click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"

Parameters for editing a guild sticker.

name: OptionalParam[str] = Unset class-attribute instance-attribute

Name of the sticker.

description: OptionalNullableParam[str] = Unset class-attribute instance-attribute

Description of the sticker.

tags: OptionalParam[str] = Unset class-attribute instance-attribute

Autocomplete/suggestion tags for the sticker.