Objects¶
Ban¶
ban
¶
GuildBanModel
dataclass
¶
Bases: DataModel
flowchart TD
scurrypy.api.guilds.ban.GuildBanModel[GuildBanModel]
scurrypy.core.model.DataModel[DataModel]
scurrypy.core.model.DataModel --> scurrypy.api.guilds.ban.GuildBanModel
click scurrypy.api.guilds.ban.GuildBanModel href "" "scurrypy.api.guilds.ban.GuildBanModel"
click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
Represents the guild ban object.
BulkGuildBanModel
dataclass
¶
Bases: DataModel
flowchart TD
scurrypy.api.guilds.ban.BulkGuildBanModel[BulkGuildBanModel]
scurrypy.core.model.DataModel[DataModel]
scurrypy.core.model.DataModel --> scurrypy.api.guilds.ban.BulkGuildBanModel
click scurrypy.api.guilds.ban.BulkGuildBanModel href "" "scurrypy.api.guilds.ban.BulkGuildBanModel"
click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
Response body for creating bulk guild bans.
BulkGuildBanPart
dataclass
¶
Bases: DataModel
flowchart TD
scurrypy.api.guilds.ban.BulkGuildBanPart[BulkGuildBanPart]
scurrypy.core.model.DataModel[DataModel]
scurrypy.core.model.DataModel --> scurrypy.api.guilds.ban.BulkGuildBanPart
click scurrypy.api.guilds.ban.BulkGuildBanPart href "" "scurrypy.api.guilds.ban.BulkGuildBanPart"
click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
Represents fields for creating a bulk ban.
Guild¶
guild
¶
ReadyGuildModel
dataclass
¶
Bases: DataModel
flowchart TD
scurrypy.api.guilds.guild.ReadyGuildModel[ReadyGuildModel]
scurrypy.core.model.DataModel[DataModel]
scurrypy.core.model.DataModel --> scurrypy.api.guilds.guild.ReadyGuildModel
click scurrypy.api.guilds.guild.ReadyGuildModel href "" "scurrypy.api.guilds.guild.ReadyGuildModel"
click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
Guild info from Ready event.
UnavailableGuildModel
dataclass
¶
Bases: DataModel
flowchart TD
scurrypy.api.guilds.guild.UnavailableGuildModel[UnavailableGuildModel]
scurrypy.core.model.DataModel[DataModel]
scurrypy.core.model.DataModel --> scurrypy.api.guilds.guild.UnavailableGuildModel
click scurrypy.api.guilds.guild.UnavailableGuildModel href "" "scurrypy.api.guilds.guild.UnavailableGuildModel"
click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
Guild info during an outage or before bot bootup.
GuildModel
dataclass
¶
Bases: DataModel
flowchart TD
scurrypy.api.guilds.guild.GuildModel[GuildModel]
scurrypy.core.model.DataModel[DataModel]
scurrypy.core.model.DataModel --> scurrypy.api.guilds.guild.GuildModel
click scurrypy.api.guilds.guild.GuildModel href "" "scurrypy.api.guilds.guild.GuildModel"
click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
Represents a Discord guild.
id: Snowflake
instance-attribute
¶
ID of the guild.
name: str
instance-attribute
¶
Name of the guild.
icon: str
instance-attribute
¶
Image hash of the guild's icon.
splash: str
instance-attribute
¶
Image hash of the guild's splash.
owner: bool | None
instance-attribute
¶
If the member is the owner.
owner_id: Snowflake
instance-attribute
¶
ID of the owner of the guild.
emojis: list[EmojiModel]
instance-attribute
¶
List of emojis registered in the guild.
roles: list[GuildRoleModel]
instance-attribute
¶
Roles in the guild.
mfa_level: int
instance-attribute
¶
Required MFA level of the guild.
application_id: Snowflake
instance-attribute
¶
ID of the application if the guild is created by a bot.
system_channel_id: Snowflake
instance-attribute
¶
Channel ID where system messages go (e.g., welcome messages, boost events).
system_channel_flags: int
instance-attribute
¶
System channel flags.
rules_channel_id: Snowflake
instance-attribute
¶
Channel ID where rules are posted.
max_members: int | None
instance-attribute
¶
Maximum member capacity for the guild.
description: str
instance-attribute
¶
Description of the guild.
banner: str
instance-attribute
¶
Image hash of the guild's banner.
preferred_locale: str
instance-attribute
¶
Preferred locale of the guild.
public_updates_channel_id: Snowflake
instance-attribute
¶
Channel ID of announcement or public updates.
approximate_member_count: int
instance-attribute
¶
Approximate number of members in the guild.
nsfw_level: int
instance-attribute
¶
NSFW level of the guild.
safety_alerts_channel_id: Snowflake
instance-attribute
¶
Channel ID for safety alerts.
Onboarding¶
onboarding
¶
OnboardingPromptOptionModel
dataclass
¶
Bases: DataModel
flowchart TD
scurrypy.api.guilds.onboarding.OnboardingPromptOptionModel[OnboardingPromptOptionModel]
scurrypy.core.model.DataModel[DataModel]
scurrypy.core.model.DataModel --> scurrypy.api.guilds.onboarding.OnboardingPromptOptionModel
click scurrypy.api.guilds.onboarding.OnboardingPromptOptionModel href "" "scurrypy.api.guilds.onboarding.OnboardingPromptOptionModel"
click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
Represents a guild's prompt option for onboarding.
id: Snowflake
instance-attribute
¶
ID of the prompt option.
channel_ids: list[Snowflake]
instance-attribute
¶
Channel IDs a member is added to when selected.
role_ids: list[Snowflake]
instance-attribute
¶
Role IDs a member is given when selected.
emoji: EmojiModel | None
instance-attribute
¶
Emoji for the option.
emoji_id: Snowflake | None
instance-attribute
¶
ID for the emoji of the option.
emoji_name: str | None
instance-attribute
¶
Name for the emoji of the option.
emoji_animated: bool | None
instance-attribute
¶
Whether the emoji of the option is animated.
title: str
instance-attribute
¶
Title of the option.
description: str
instance-attribute
¶
Description of the option.
OnboardingPromptModel
dataclass
¶
Bases: DataModel
flowchart TD
scurrypy.api.guilds.onboarding.OnboardingPromptModel[OnboardingPromptModel]
scurrypy.core.model.DataModel[DataModel]
scurrypy.core.model.DataModel --> scurrypy.api.guilds.onboarding.OnboardingPromptModel
click scurrypy.api.guilds.onboarding.OnboardingPromptModel href "" "scurrypy.api.guilds.onboarding.OnboardingPromptModel"
click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
Represents a guild's prompt for onboarding.
id: Snowflake
instance-attribute
¶
ID of the prompt.
type: PromptType
instance-attribute
¶
Type of prompt.
options: list[OnboardingPromptOptionModel]
instance-attribute
¶
Options available with the prompt.
title: str
instance-attribute
¶
Title of the prompt.
single_select: bool
instance-attribute
¶
Whether users are limited to selecting one option.
required: bool
instance-attribute
¶
Whether the prompt is required for completing the onboarding process.
in_onboarding: bool
instance-attribute
¶
Whether the prompt is present in the onboarding flow.
GuildOnboadingModel
dataclass
¶
Bases: DataModel
flowchart TD
scurrypy.api.guilds.onboarding.GuildOnboadingModel[GuildOnboadingModel]
scurrypy.core.model.DataModel[DataModel]
scurrypy.core.model.DataModel --> scurrypy.api.guilds.onboarding.GuildOnboadingModel
click scurrypy.api.guilds.onboarding.GuildOnboadingModel href "" "scurrypy.api.guilds.onboarding.GuildOnboadingModel"
click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
Represents a guild's onboarding flow.
guild_id: Snowflake
instance-attribute
¶
ID of the guild for onboarding.
prompts: list[OnboardingPromptModel]
instance-attribute
¶
Prompts shown during onboarding.
default_channel_ids: list[Snowflake]
instance-attribute
¶
Channel IDs members are opted into by default.
enabled: bool
instance-attribute
¶
Whether onboarding is enabled for the guild.
mode: OnboardingMode
instance-attribute
¶
Current mode of onboarding.
OnboardingPromptOptionPart
dataclass
¶
Bases: DataModel
flowchart TD
scurrypy.api.guilds.onboarding.OnboardingPromptOptionPart[OnboardingPromptOptionPart]
scurrypy.core.model.DataModel[DataModel]
scurrypy.core.model.DataModel --> scurrypy.api.guilds.onboarding.OnboardingPromptOptionPart
click scurrypy.api.guilds.onboarding.OnboardingPromptOptionPart href "" "scurrypy.api.guilds.onboarding.OnboardingPromptOptionPart"
click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
Represents fields for creating an onboarding prompt option.
channel_ids: list[Snowflake] | None = None
class-attribute
instance-attribute
¶
IDs for channels a member is added to when the option is selected.
role_ids: list[Snowflake] | None = None
class-attribute
instance-attribute
¶
IDs for roles assigned to a member when the option is selected.
wmoji_id: Snowflake | None = None
class-attribute
instance-attribute
¶
Emoji ID of the option.
emoji_name: str | None = None
class-attribute
instance-attribute
¶
Emoji name of the option.
emoji_animated: bool | None = None
class-attribute
instance-attribute
¶
Whether the emoji is animated.
title: str | None = None
class-attribute
instance-attribute
¶
Title of the option.
description: str | None = None
class-attribute
instance-attribute
¶
Description of the option.
OnboardingPromptPart
dataclass
¶
Bases: DataModel
flowchart TD
scurrypy.api.guilds.onboarding.OnboardingPromptPart[OnboardingPromptPart]
scurrypy.core.model.DataModel[DataModel]
scurrypy.core.model.DataModel --> scurrypy.api.guilds.onboarding.OnboardingPromptPart
click scurrypy.api.guilds.onboarding.OnboardingPromptPart href "" "scurrypy.api.guilds.onboarding.OnboardingPromptPart"
click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
Represents fields for creating an onboarding prompt.
type: PromptType | None = None
class-attribute
instance-attribute
¶
Type of prompt.
options: list[OnboardingPromptOptionPart] | None = None
class-attribute
instance-attribute
¶
Options available with the prompt.
title: str | None = None
class-attribute
instance-attribute
¶
Title of the prompt.
single_select: bool | None = None
class-attribute
instance-attribute
¶
Whether the users are limited to selecting one option.
required: bool | None = None
class-attribute
instance-attribute
¶
Whether the prompt is required to complete the onboarding flow.
Role¶
role
¶
GuildRoleColorModel
dataclass
¶
Bases: DataModel
flowchart TD
scurrypy.api.guilds.role.GuildRoleColorModel[GuildRoleColorModel]
scurrypy.core.model.DataModel[DataModel]
scurrypy.core.model.DataModel --> scurrypy.api.guilds.role.GuildRoleColorModel
click scurrypy.api.guilds.role.GuildRoleColorModel href "" "scurrypy.api.guilds.role.GuildRoleColorModel"
click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
Represents role color data.
GuildRoleModel
dataclass
¶
Bases: DataModel
flowchart TD
scurrypy.api.guilds.role.GuildRoleModel[GuildRoleModel]
scurrypy.core.model.DataModel[DataModel]
scurrypy.core.model.DataModel --> scurrypy.api.guilds.role.GuildRoleModel
click scurrypy.api.guilds.role.GuildRoleModel href "" "scurrypy.api.guilds.role.GuildRoleModel"
click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
Represents a Discord role.
id: Snowflake
instance-attribute
¶
ID of the role.
name: str
instance-attribute
¶
Name of the role.
colors: GuildRoleColorModel
instance-attribute
¶
Colors of the role.
hoist: bool
instance-attribute
¶
If the role is pinned in user listing.
position: int
instance-attribute
¶
Position of the role.
permissions: Permissions
instance-attribute
¶
Permission bit set. [INT_LIMIT]
managed: bool
instance-attribute
¶
If the role is managed by an integration.
mentionable: bool
instance-attribute
¶
If the role is mentionable.
flags: int
instance-attribute
¶
Role flags combined as a bitfield.
icon: str | None
instance-attribute
¶
Icon hash of the role.
unicode_emoji: str | None
instance-attribute
¶
Unicode emoji of the role.
GuildRoleColorsPart
dataclass
¶
Bases: DataModel
flowchart TD
scurrypy.api.guilds.role.GuildRoleColorsPart[GuildRoleColorsPart]
scurrypy.core.model.DataModel[DataModel]
scurrypy.core.model.DataModel --> scurrypy.api.guilds.role.GuildRoleColorsPart
click scurrypy.api.guilds.role.GuildRoleColorsPart href "" "scurrypy.api.guilds.role.GuildRoleColorsPart"
click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
Parameters for setting role colors.
primary_color: int | None = None
class-attribute
instance-attribute
¶
Primary color of the role.
secondary_color: int | None = None
class-attribute
instance-attribute
¶
Secondary color of the role. Creates a gradient.
tertiary_color: int | None = None
class-attribute
instance-attribute
¶
Tertiary color of the role. Creates a holographic style.
GuildRolePart
dataclass
¶
Bases: DataModel
flowchart TD
scurrypy.api.guilds.role.GuildRolePart[GuildRolePart]
scurrypy.core.model.DataModel[DataModel]
scurrypy.core.model.DataModel --> scurrypy.api.guilds.role.GuildRolePart
click scurrypy.api.guilds.role.GuildRolePart href "" "scurrypy.api.guilds.role.GuildRolePart"
click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
Parameters for creating a role.
name: str | None = None
class-attribute
instance-attribute
¶
Name of the role. Discord defaults to "user role".
colors: GuildRoleColorsPart | None = None
class-attribute
instance-attribute
¶
Colors of the role. Discord defaults to primary color set to 0.
icon: ImageDataPart | None = None
class-attribute
instance-attribute
¶
Icon of the role (if guild has ROLE_ICONS feature).
permissions: Permissions | None = None
class-attribute
instance-attribute
¶
Permission bit set. [INT_LIMIT]
hoist: bool | None = None
class-attribute
instance-attribute
¶
If the role is pinned in the user listing. Discord defaults to False.
mentionable: bool | None = None
class-attribute
instance-attribute
¶
If the role is mentionable. Discord defaults to False.
unicode_emoji: str | None = None
class-attribute
instance-attribute
¶
Unicode emoji of the role.
Welcome Screen¶
welcome_screen
¶
GuildWelcomeChannelModel
dataclass
¶
Bases: DataModel
flowchart TD
scurrypy.api.guilds.welcome_screen.GuildWelcomeChannelModel[GuildWelcomeChannelModel]
scurrypy.core.model.DataModel[DataModel]
scurrypy.core.model.DataModel --> scurrypy.api.guilds.welcome_screen.GuildWelcomeChannelModel
click scurrypy.api.guilds.welcome_screen.GuildWelcomeChannelModel href "" "scurrypy.api.guilds.welcome_screen.GuildWelcomeChannelModel"
click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
Represents channels shown on a welcome screen.
GuildWelcomeScreenModel
dataclass
¶
Bases: DataModel
flowchart TD
scurrypy.api.guilds.welcome_screen.GuildWelcomeScreenModel[GuildWelcomeScreenModel]
scurrypy.core.model.DataModel[DataModel]
scurrypy.core.model.DataModel --> scurrypy.api.guilds.welcome_screen.GuildWelcomeScreenModel
click scurrypy.api.guilds.welcome_screen.GuildWelcomeScreenModel href "" "scurrypy.api.guilds.welcome_screen.GuildWelcomeScreenModel"
click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
Represents a guild's welcome screen.
WelcomeScreenChannelPart
dataclass
¶
Bases: DataModel
flowchart TD
scurrypy.api.guilds.welcome_screen.WelcomeScreenChannelPart[WelcomeScreenChannelPart]
scurrypy.core.model.DataModel[DataModel]
scurrypy.core.model.DataModel --> scurrypy.api.guilds.welcome_screen.WelcomeScreenChannelPart
click scurrypy.api.guilds.welcome_screen.WelcomeScreenChannelPart href "" "scurrypy.api.guilds.welcome_screen.WelcomeScreenChannelPart"
click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
Represents fields for creating a welcome screen channel.
channel_id: Snowflake | None = None
class-attribute
instance-attribute
¶
ID of the channel to display.
description: str | None = None
class-attribute
instance-attribute
¶
Description for the channel to display.
emoji_id: Snowflake | None = None
class-attribute
instance-attribute
¶
ID of the emoji (if custom).
emoji_name: str | None = None
class-attribute
instance-attribute
¶
Name of the emoji.