Skip to content

Events

Guild

guild_events

GuildCreateEvent dataclass

Bases: Event, GuildModel


              flowchart TD
              scurrypy.events.guild_events.GuildCreateEvent[GuildCreateEvent]
              scurrypy.events.base_event.Event[Event]
              scurrypy.api.guilds.guild.GuildModel[GuildModel]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.events.base_event.Event --> scurrypy.events.guild_events.GuildCreateEvent
                                scurrypy.core.model.DataModel --> scurrypy.events.base_event.Event
                

                scurrypy.api.guilds.guild.GuildModel --> scurrypy.events.guild_events.GuildCreateEvent
                                scurrypy.core.model.DataModel --> scurrypy.api.guilds.guild.GuildModel
                



              click scurrypy.events.guild_events.GuildCreateEvent href "" "scurrypy.events.guild_events.GuildCreateEvent"
              click scurrypy.events.base_event.Event href "" "scurrypy.events.base_event.Event"
              click scurrypy.api.guilds.guild.GuildModel href "" "scurrypy.api.guilds.guild.GuildModel"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"

Received when the bot has joined a guild.

dispatch_name = EventType.GUILD_CREATE class-attribute instance-attribute

joined_at: str instance-attribute

ISO8601 timestamp of when app joined the guild.

large: bool instance-attribute

If the guild is considered large.

member_count: int instance-attribute

Total number of members in the guild.

members: list[GuildMemberModel] instance-attribute

Users in the guild.

channels: list[ChannelModel] instance-attribute

Channels in the guild.

threads: list[ChannelModel] instance-attribute

All active threads in the guild that are viewable.

unavailable: bool | None instance-attribute

True if the guild is unavailable due to an outage.

GuildUpdateEvent dataclass

Bases: Event, DataModel


              flowchart TD
              scurrypy.events.guild_events.GuildUpdateEvent[GuildUpdateEvent]
              scurrypy.events.base_event.Event[Event]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.events.base_event.Event --> scurrypy.events.guild_events.GuildUpdateEvent
                                scurrypy.core.model.DataModel --> scurrypy.events.base_event.Event
                

                scurrypy.core.model.DataModel --> scurrypy.events.guild_events.GuildUpdateEvent
                


              click scurrypy.events.guild_events.GuildUpdateEvent href "" "scurrypy.events.guild_events.GuildUpdateEvent"
              click scurrypy.events.base_event.Event href "" "scurrypy.events.base_event.Event"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"

Received when a guild has been edited.

dispatch_name = EventType.GUILD_UPDATE class-attribute instance-attribute

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.

description: str instance-attribute

Description of the guild.

banner: str instance-attribute

Image hash of the guild's banner.

joined_at: str instance-attribute

ISO8601 timestamp of when app joined the guild.

large: bool instance-attribute

If the guild is considered large.

member_count: int instance-attribute

Total number of members in the guild.

GuildDeleteEvent dataclass

Bases: Event, UnavailableGuildModel


              flowchart TD
              scurrypy.events.guild_events.GuildDeleteEvent[GuildDeleteEvent]
              scurrypy.events.base_event.Event[Event]
              scurrypy.api.guilds.guild.UnavailableGuildModel[UnavailableGuildModel]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.events.base_event.Event --> scurrypy.events.guild_events.GuildDeleteEvent
                                scurrypy.core.model.DataModel --> scurrypy.events.base_event.Event
                

                scurrypy.api.guilds.guild.UnavailableGuildModel --> scurrypy.events.guild_events.GuildDeleteEvent
                                scurrypy.core.model.DataModel --> scurrypy.api.guilds.guild.UnavailableGuildModel
                



              click scurrypy.events.guild_events.GuildDeleteEvent href "" "scurrypy.events.guild_events.GuildDeleteEvent"
              click scurrypy.events.base_event.Event href "" "scurrypy.events.base_event.Event"
              click scurrypy.api.guilds.guild.UnavailableGuildModel href "" "scurrypy.api.guilds.guild.UnavailableGuildModel"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"

Received when the bot has left a guild or the guild was deleted.

dispatch_name = EventType.GUILD_DELETE class-attribute instance-attribute

GuildBanAddEvent dataclass

Bases: Event, DataModel


              flowchart TD
              scurrypy.events.guild_events.GuildBanAddEvent[GuildBanAddEvent]
              scurrypy.events.base_event.Event[Event]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.events.base_event.Event --> scurrypy.events.guild_events.GuildBanAddEvent
                                scurrypy.core.model.DataModel --> scurrypy.events.base_event.Event
                

                scurrypy.core.model.DataModel --> scurrypy.events.guild_events.GuildBanAddEvent
                


              click scurrypy.events.guild_events.GuildBanAddEvent href "" "scurrypy.events.guild_events.GuildBanAddEvent"
              click scurrypy.events.base_event.Event href "" "scurrypy.events.base_event.Event"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"

Received when a user is banned from a guild.

dispatch_name = EventType.GUILD_BAN_ADD class-attribute instance-attribute

guild_id: Snowflake instance-attribute

ID of the guild in which the ban took place.

user: UserModel instance-attribute

The user who was banned.

GuildBanRemoveEvent dataclass

Bases: Event, DataModel


              flowchart TD
              scurrypy.events.guild_events.GuildBanRemoveEvent[GuildBanRemoveEvent]
              scurrypy.events.base_event.Event[Event]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.events.base_event.Event --> scurrypy.events.guild_events.GuildBanRemoveEvent
                                scurrypy.core.model.DataModel --> scurrypy.events.base_event.Event
                

                scurrypy.core.model.DataModel --> scurrypy.events.guild_events.GuildBanRemoveEvent
                


              click scurrypy.events.guild_events.GuildBanRemoveEvent href "" "scurrypy.events.guild_events.GuildBanRemoveEvent"
              click scurrypy.events.base_event.Event href "" "scurrypy.events.base_event.Event"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"

Received when a user is unbanned from a guild.

dispatch_name = EventType.GUILD_BAN_REMOVE class-attribute instance-attribute

guild_id: Snowflake instance-attribute

ID of the guild in which the ban took place.

user: UserModel instance-attribute

The user who was banned.

GuildEmojisUpdateEvent dataclass

Bases: Event, DataModel


              flowchart TD
              scurrypy.events.guild_events.GuildEmojisUpdateEvent[GuildEmojisUpdateEvent]
              scurrypy.events.base_event.Event[Event]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.events.base_event.Event --> scurrypy.events.guild_events.GuildEmojisUpdateEvent
                                scurrypy.core.model.DataModel --> scurrypy.events.base_event.Event
                

                scurrypy.core.model.DataModel --> scurrypy.events.guild_events.GuildEmojisUpdateEvent
                


              click scurrypy.events.guild_events.GuildEmojisUpdateEvent href "" "scurrypy.events.guild_events.GuildEmojisUpdateEvent"
              click scurrypy.events.base_event.Event href "" "scurrypy.events.base_event.Event"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"

Received when a guild updates their emojis.

dispatch_name = EventType.GUILD_EMOJIS_UPDATE class-attribute instance-attribute

guild_id: Snowflake instance-attribute

ID of the guild.

emojis: list[EmojiModel] instance-attribute

Complete set of guild emojis with changes.

GuildStickersUpdateEvent dataclass

Bases: Event, DataModel


              flowchart TD
              scurrypy.events.guild_events.GuildStickersUpdateEvent[GuildStickersUpdateEvent]
              scurrypy.events.base_event.Event[Event]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.events.base_event.Event --> scurrypy.events.guild_events.GuildStickersUpdateEvent
                                scurrypy.core.model.DataModel --> scurrypy.events.base_event.Event
                

                scurrypy.core.model.DataModel --> scurrypy.events.guild_events.GuildStickersUpdateEvent
                


              click scurrypy.events.guild_events.GuildStickersUpdateEvent href "" "scurrypy.events.guild_events.GuildStickersUpdateEvent"
              click scurrypy.events.base_event.Event href "" "scurrypy.events.base_event.Event"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"

Received when a guild's stickers have been updated.

dispatch_name = EventType.GUILD_STICKERS_UPDATE class-attribute instance-attribute

guild_id: Snowflake instance-attribute

ID of the guild.

stickers: list[StickerModel] instance-attribute

List of the guild's stickers.

Role

role_events

RoleCreateEvent dataclass

Bases: Event, DataModel


              flowchart TD
              scurrypy.events.role_events.RoleCreateEvent[RoleCreateEvent]
              scurrypy.events.base_event.Event[Event]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.events.base_event.Event --> scurrypy.events.role_events.RoleCreateEvent
                                scurrypy.core.model.DataModel --> scurrypy.events.base_event.Event
                

                scurrypy.core.model.DataModel --> scurrypy.events.role_events.RoleCreateEvent
                


              click scurrypy.events.role_events.RoleCreateEvent href "" "scurrypy.events.role_events.RoleCreateEvent"
              click scurrypy.events.base_event.Event href "" "scurrypy.events.base_event.Event"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"

Received when a guild role is created.

dispatch_name = EventType.ROLE_CREATE class-attribute instance-attribute

guild_id: Snowflake instance-attribute

Guild ID of the role.

role: GuildRoleModel instance-attribute

The new role.

RoleUpdateEvent dataclass

Bases: Event, DataModel


              flowchart TD
              scurrypy.events.role_events.RoleUpdateEvent[RoleUpdateEvent]
              scurrypy.events.base_event.Event[Event]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.events.base_event.Event --> scurrypy.events.role_events.RoleUpdateEvent
                                scurrypy.core.model.DataModel --> scurrypy.events.base_event.Event
                

                scurrypy.core.model.DataModel --> scurrypy.events.role_events.RoleUpdateEvent
                


              click scurrypy.events.role_events.RoleUpdateEvent href "" "scurrypy.events.role_events.RoleUpdateEvent"
              click scurrypy.events.base_event.Event href "" "scurrypy.events.base_event.Event"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"

Received when a guild role is updated.

dispatch_name = EventType.ROLE_UPDATE class-attribute instance-attribute

guild_id: Snowflake instance-attribute

Guild ID of the role.

role: GuildRoleModel instance-attribute

The new role.

RoleDeleteEvent dataclass

Bases: Event, DataModel


              flowchart TD
              scurrypy.events.role_events.RoleDeleteEvent[RoleDeleteEvent]
              scurrypy.events.base_event.Event[Event]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.events.base_event.Event --> scurrypy.events.role_events.RoleDeleteEvent
                                scurrypy.core.model.DataModel --> scurrypy.events.base_event.Event
                

                scurrypy.core.model.DataModel --> scurrypy.events.role_events.RoleDeleteEvent
                


              click scurrypy.events.role_events.RoleDeleteEvent href "" "scurrypy.events.role_events.RoleDeleteEvent"
              click scurrypy.events.base_event.Event href "" "scurrypy.events.base_event.Event"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"

Received when a guild role is deleted.

dispatch_name = EventType.ROLE_DELETE class-attribute instance-attribute

guild_id: Snowflake instance-attribute

Guild ID of the role.

role_id: Snowflake instance-attribute

Role ID of the role.