Guild API¶
Note
The following classes come from the scurrypy.parts.guild module.
BulkGuildBanPart
dataclass
¶
Bases: DataModel
Represents fields for creating a bulk ban.
user_ids: list[int] = field(default_factory=list)
class-attribute
instance-attribute
¶
List of user IDs to ban. Max 200.
delete_message_seconds: Optional[int] = 0
class-attribute
instance-attribute
¶
seconds back to delete messages. Max 604800 (7 days). Defaults to 0.
to_dict
¶
Recursively turns the dataclass into a dictionary and drops empty fields.
Returns:
-
dict–serialized dataclasss
WelcomeScreenChannelPart
dataclass
¶
Bases: DataModel
Represents fields for creating a welcome screen channel.
channel_id: int = None
class-attribute
instance-attribute
¶
ID of the channel to display.
description: str = None
class-attribute
instance-attribute
¶
Description for the channel to display.
emoji_id: int = None
class-attribute
instance-attribute
¶
ID of the emoji (if custom).
emoji_name: str = None
class-attribute
instance-attribute
¶
Name of the emoji.
to_dict
¶
Recursively turns the dataclass into a dictionary and drops empty fields.
Returns:
-
dict–serialized dataclasss
OnboardingPromptPart
dataclass
¶
Bases: DataModel
Represents fields for creating an onboarding prompt.
type: int = None
class-attribute
instance-attribute
¶
Type of prompt. See PromptTypes
options: list[OnboardingPromptOptionPart] = field(default_factory=list)
class-attribute
instance-attribute
¶
Options available with the prompt.
title: str = None
class-attribute
instance-attribute
¶
Title of the prompt.
single_select: bool = None
class-attribute
instance-attribute
¶
Whether the users are limited to selecting one option.
required: bool = None
class-attribute
instance-attribute
¶
Whether the prompt is required to complete the onboarding flow.
to_dict
¶
Recursively turns the dataclass into a dictionary and drops empty fields.
Returns:
-
dict–serialized dataclasss
OnboardingPromptOptionPart
dataclass
¶
Bases: DataModel
Represents fields for creating an onboarding prompt option.
channel_ids: list[int] = field(default_factory=list)
class-attribute
instance-attribute
¶
IDs for channels a member is added to when the option is selected.
role_ids: list[int] = field(default_factory=list)
class-attribute
instance-attribute
¶
IDs for roles assigned to a member when the option is selected.
wmoji_id: Optional[int] = None
class-attribute
instance-attribute
¶
Emoji ID of the option.
emoji_name: Optional[str] = None
class-attribute
instance-attribute
¶
Emoji name of the option.
emoji_animated: Optional[bool] = None
class-attribute
instance-attribute
¶
Whether the emoji is animated.
title: str = None
class-attribute
instance-attribute
¶
Title of the option.
description: str = None
class-attribute
instance-attribute
¶
Description of the option.
to_dict
¶
Recursively turns the dataclass into a dictionary and drops empty fields.
Returns:
-
dict–serialized dataclasss
OnboardingModes
¶
PromptTypes
¶
GuildStickerPart
dataclass
¶
Bases: DataModel
Represents fields for creating a guild sticker.
name: str = None
class-attribute
instance-attribute
¶
Name of the sticker.
description: str = None
class-attribute
instance-attribute
¶
Description of the sticker.
tags: str = None
class-attribute
instance-attribute
¶
Autocomplete/suggestion tags for the sticker.
to_dict
¶
Recursively turns the dataclass into a dictionary and drops empty fields.
Returns:
-
dict–serialized dataclasss
