Objects¶
Ban¶
ban
¶
BulkGuildBanPart
dataclass
¶
Bases: Part
flowchart TD
scurrypy.api.guilds.ban.BulkGuildBanPart[BulkGuildBanPart]
scurrypy.core.part.Part[Part]
scurrypy.core.part.Part --> scurrypy.api.guilds.ban.BulkGuildBanPart
click scurrypy.api.guilds.ban.BulkGuildBanPart href "" "scurrypy.api.guilds.ban.BulkGuildBanPart"
click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"
Represents fields for creating a bulk ban.
Onboarding¶
onboarding
¶
OnboardingPromptOptionPart
dataclass
¶
Bases: Part
flowchart TD
scurrypy.api.guilds.onboarding.OnboardingPromptOptionPart[OnboardingPromptOptionPart]
scurrypy.core.part.Part[Part]
scurrypy.core.part.Part --> scurrypy.api.guilds.onboarding.OnboardingPromptOptionPart
click scurrypy.api.guilds.onboarding.OnboardingPromptOptionPart href "" "scurrypy.api.guilds.onboarding.OnboardingPromptOptionPart"
click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"
Represents fields for creating an onboarding prompt option.
id: RequiredPartField[Snowflake] = None
class-attribute
instance-attribute
¶
ID of the prompt option.
channel_ids: RequiredPartField[list[Snowflake]] = None
class-attribute
instance-attribute
¶
IDs for channels a member is added to when the option is selected.
role_ids: RequiredPartField[list[Snowflake]] = None
class-attribute
instance-attribute
¶
IDs for roles assigned to a member when the option is selected.
emoji_id: OptionalPartField[Snowflake] = None
class-attribute
instance-attribute
¶
Emoji ID of the option.
emoji_name: OptionalPartField[str] = None
class-attribute
instance-attribute
¶
Emoji name of the option.
emoji_animated: OptionalPartField[bool] = None
class-attribute
instance-attribute
¶
Whether the emoji is animated.
title: RequiredPartField[str] = None
class-attribute
instance-attribute
¶
Title of the option.
description: RequiredNullablePartField[str] = None
class-attribute
instance-attribute
¶
Description of the option.
OnboardingPromptPart
dataclass
¶
Bases: Part
flowchart TD
scurrypy.api.guilds.onboarding.OnboardingPromptPart[OnboardingPromptPart]
scurrypy.core.part.Part[Part]
scurrypy.core.part.Part --> scurrypy.api.guilds.onboarding.OnboardingPromptPart
click scurrypy.api.guilds.onboarding.OnboardingPromptPart href "" "scurrypy.api.guilds.onboarding.OnboardingPromptPart"
click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"
Represents fields for creating an onboarding prompt.
id: RequiredPartField[Snowflake] = None
class-attribute
instance-attribute
¶
ID of the prompt
type: RequiredPartField[PromptType] = None
class-attribute
instance-attribute
¶
Type of prompt.
options: RequiredPartField[list[OnboardingPromptOptionPart]] = None
class-attribute
instance-attribute
¶
Options available with the prompt.
title: RequiredPartField[str] = None
class-attribute
instance-attribute
¶
Title of the prompt.
single_select: RequiredPartField[bool] = None
class-attribute
instance-attribute
¶
Whether the users are limited to selecting one option.
required: RequiredPartField[bool] = None
class-attribute
instance-attribute
¶
Whether the prompt is required to complete the onboarding flow.
Role¶
role
¶
GuildRoleColorsPart
dataclass
¶
Bases: Part
flowchart TD
scurrypy.api.guilds.role.GuildRoleColorsPart[GuildRoleColorsPart]
scurrypy.core.part.Part[Part]
scurrypy.core.part.Part --> scurrypy.api.guilds.role.GuildRoleColorsPart
click scurrypy.api.guilds.role.GuildRoleColorsPart href "" "scurrypy.api.guilds.role.GuildRoleColorsPart"
click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"
Represents fields for setting role colors.
primary_color: RequiredPartField[int] = None
class-attribute
instance-attribute
¶
Primary color of the role.
secondary_color: RequiredNullablePartField[int] = None
class-attribute
instance-attribute
¶
Secondary color of the role. Creates a gradient.
tertiary_color: RequiredNullablePartField[int] = None
class-attribute
instance-attribute
¶
Tertiary color of the role. Creates a holographic style.
GuildRolePart
dataclass
¶
Bases: Part
flowchart TD
scurrypy.api.guilds.role.GuildRolePart[GuildRolePart]
scurrypy.core.part.Part[Part]
scurrypy.core.part.Part --> scurrypy.api.guilds.role.GuildRolePart
click scurrypy.api.guilds.role.GuildRolePart href "" "scurrypy.api.guilds.role.GuildRolePart"
click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"
Represents fields for creating a role.
name: RequiredPartField[str] = None
class-attribute
instance-attribute
¶
Name of the role. Discord defaults to "user role".
colors: RequiredPartField[GuildRoleColorsPart] = None
class-attribute
instance-attribute
¶
Colors of the role. Discord defaults to primary color set to 0.
icon: RequiredNullablePartField[ImageDataPart] = None
class-attribute
instance-attribute
¶
Icon of the role (if guild has ROLE_ICONS feature).
permissions: RequiredPartField[Permissions] = None
class-attribute
instance-attribute
¶
Permission bit set. [INT_LIMIT]
hoist: RequiredPartField[bool] = None
class-attribute
instance-attribute
¶
If the role is pinned in the user listing. Discord defaults to False.
mentionable: RequiredPartField[bool] = None
class-attribute
instance-attribute
¶
If the role is mentionable. Discord defaults to False.
unicode_emoji: RequiredNullablePartField[str] = None
class-attribute
instance-attribute
¶
Unicode emoji of the role.
Welcome Screen¶
welcome_screen
¶
WelcomeScreenChannelPart
dataclass
¶
Bases: Part
flowchart TD
scurrypy.api.guilds.welcome_screen.WelcomeScreenChannelPart[WelcomeScreenChannelPart]
scurrypy.core.part.Part[Part]
scurrypy.core.part.Part --> scurrypy.api.guilds.welcome_screen.WelcomeScreenChannelPart
click scurrypy.api.guilds.welcome_screen.WelcomeScreenChannelPart href "" "scurrypy.api.guilds.welcome_screen.WelcomeScreenChannelPart"
click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"
Represents fields for creating a welcome screen channel.
channel_id: RequiredPartField[Snowflake] = None
class-attribute
instance-attribute
¶
ID of the channel to display.
description: RequiredPartField[str] = None
class-attribute
instance-attribute
¶
Description for the channel to display.
emoji_id: RequiredNullablePartField[Snowflake] = None
class-attribute
instance-attribute
¶
ID of the emoji (if custom).
emoji_name: RequiredNullablePartField[str] = None
class-attribute
instance-attribute
¶
Name of the emoji.