Objects

---

Attachment

---

attachment

AttachmentModel dataclass

Bases: DataModel

              flowchart TD
              scurrypy.api.messages.attachment.AttachmentModel[AttachmentModel]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.core.model.DataModel --> scurrypy.api.messages.attachment.AttachmentModel
                


              click scurrypy.api.messages.attachment.AttachmentModel href "" "scurrypy.api.messages.attachment.AttachmentModel"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
            

Represents an attachment object.

id: Snowflake instance-attribute

Attachment ID.

filename: str instance-attribute

Name of the file.

title: str | None instance-attribute

Title of the file.

description: str | None instance-attribute

Description of the file.

content_type: str | None instance-attribute

Media type of the file.

size: int instance-attribute

Size of file (in bytes).

url: str instance-attribute

Source URL of the file.

proxy_url: str instance-attribute

A proxied URL of the file.

height: int | None instance-attribute

Height of file (if image).

width: int | None instance-attribute

Width of file (if image).

ephemeral: bool | None instance-attribute

Whether this file is ephemeral.

flags: int | None instance-attribute

Attachment flags as a combined bitfield.

AttachmentPart dataclass

Bases: DataModel

              flowchart TD
              scurrypy.api.messages.attachment.AttachmentPart[AttachmentPart]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.core.model.DataModel --> scurrypy.api.messages.attachment.AttachmentPart
                


              click scurrypy.api.messages.attachment.AttachmentPart href "" "scurrypy.api.messages.attachment.AttachmentPart"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
            

Represents an attachment.

path: str | None = None class-attribute instance-attribute

Relative path to the file.

description: str | None = None class-attribute instance-attribute

Description of the file.

id: int | None = field(init=False, default=None) class-attribute instance-attribute

ID of the attachment (internally set).

Embed

---

embed

EmbedAuthor dataclass

Bases: DataModel

              flowchart TD
              scurrypy.api.messages.embed.EmbedAuthor[EmbedAuthor]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.core.model.DataModel --> scurrypy.api.messages.embed.EmbedAuthor
                


              click scurrypy.api.messages.embed.EmbedAuthor href "" "scurrypy.api.messages.embed.EmbedAuthor"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
            

Represents fields for creating an embed author.

name: str | None = None class-attribute instance-attribute

Name of the author.

url: str | None = None class-attribute instance-attribute

URL of the author. http or attachment:// scheme.

icon_url: str | None = None class-attribute instance-attribute

URL of author's icon. http or attachment:// scheme.

EmbedThumbnail dataclass

Bases: DataModel

              flowchart TD
              scurrypy.api.messages.embed.EmbedThumbnail[EmbedThumbnail]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.core.model.DataModel --> scurrypy.api.messages.embed.EmbedThumbnail
                


              click scurrypy.api.messages.embed.EmbedThumbnail href "" "scurrypy.api.messages.embed.EmbedThumbnail"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
            

Represents fields for creating an embed thumbnail.

url: str | None = None class-attribute instance-attribute

Thumbnail content. http or attachment:// scheme.

EmbedField dataclass

Bases: DataModel

              flowchart TD
              scurrypy.api.messages.embed.EmbedField[EmbedField]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.core.model.DataModel --> scurrypy.api.messages.embed.EmbedField
                


              click scurrypy.api.messages.embed.EmbedField href "" "scurrypy.api.messages.embed.EmbedField"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
            

Represents fields for creating an embed field.

name: str | None = None class-attribute instance-attribute

Name of the field.

value: str | None = None class-attribute instance-attribute

Value of the field.

inline: bool | None = False class-attribute instance-attribute

Whether or not this field should display inline. Defaults to False.

EmbedImage dataclass

Bases: DataModel

              flowchart TD
              scurrypy.api.messages.embed.EmbedImage[EmbedImage]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.core.model.DataModel --> scurrypy.api.messages.embed.EmbedImage
                


              click scurrypy.api.messages.embed.EmbedImage href "" "scurrypy.api.messages.embed.EmbedImage"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
            

Represents fields for creating an embed image.

url: str | None = None class-attribute instance-attribute

Image content. http or attachment:// scheme.

EmbedFooter dataclass

Bases: DataModel

              flowchart TD
              scurrypy.api.messages.embed.EmbedFooter[EmbedFooter]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.core.model.DataModel --> scurrypy.api.messages.embed.EmbedFooter
                


              click scurrypy.api.messages.embed.EmbedFooter href "" "scurrypy.api.messages.embed.EmbedFooter"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
            

Represents fields for creating an embed footer.

text: str | None = None class-attribute instance-attribute

Footer text.

icon_url: str | None = None class-attribute instance-attribute

URL of the footer icon. http or attachment:// scheme.

Embed dataclass

Bases: DataModel

              flowchart TD
              scurrypy.api.messages.embed.Embed[Embed]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.core.model.DataModel --> scurrypy.api.messages.embed.Embed
                


              click scurrypy.api.messages.embed.Embed href "" "scurrypy.api.messages.embed.Embed"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
            

Represents fields for creating an embed.

title: str | None = None class-attribute instance-attribute

This embed's title.

description: str | None = None class-attribute instance-attribute

This embed's description.

timestamp: str | None = None class-attribute instance-attribute

Timestamp of when the embed was sent.

color: int | None = None class-attribute instance-attribute

Embed's accent color.

author: EmbedAuthor | None = None class-attribute instance-attribute

Embed's author.

thumbnail: EmbedThumbnail | None = None class-attribute instance-attribute

Embed's thumbnail attachment.

image: EmbedImage | None = None class-attribute instance-attribute

Embed's image attachment.

fields: list[EmbedField] | None = None class-attribute instance-attribute

List of embed's fields.

footer: EmbedFooter | None = None class-attribute instance-attribute

Embed's footer.

set_user_author

Embed author builder.

Parameters:

• user (UserModel) –

  user author

set_timestamp

Embed timestamp builder. Adheres to ISO8601 format.

Parameters:

• dt (datetime, default: None ) –

  datetime object

Message

---

message

MessageModel dataclass

Bases: DataModel

              flowchart TD
              scurrypy.api.messages.message.MessageModel[MessageModel]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.core.model.DataModel --> scurrypy.api.messages.message.MessageModel
                


              click scurrypy.api.messages.message.MessageModel href "" "scurrypy.api.messages.message.MessageModel"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
            

Represents a Discord message.

id: Snowflake instance-attribute

ID of the message.

channel_id: Snowflake instance-attribute

Channel ID of the message.

author: UserModel instance-attribute

User data of author of the message.

content: str instance-attribute

Content of the message.

pinned: bool instance-attribute

If the message is pinned.

type: MessageType instance-attribute

Type of message.

flags: MessageFlags instance-attribute

Message flags.

attachments: list[AttachmentModel] instance-attribute

Attached files.

embeds: list[Embed] instance-attribute

Embedded content.

thread: ChannelModel | None instance-attribute

Thread created from the message.

reactions: list[ReactionModel] instance-attribute

Reactions to the message.

webhook_id: Snowflake | None instance-attribute

ID of the webhook if the message is a webhook.

timestamp: str | None instance-attribute

Timestamp of when the message was sent.

edited_timestamp: str | None instance-attribute

Timestamp of when the message was last edited.

mention_everyone: bool instance-attribute

Whether the message mentions everyone.

mentions: list[UserModel] instance-attribute

List of mentioned users in the message.

mention_roles: list[GuildRoleModel] instance-attribute

List of mentioned roles in the message.

components: list[Component] instance-attribute

Components contained in the message.

PinnedMessageModel dataclass

Bases: DataModel

              flowchart TD
              scurrypy.api.messages.message.PinnedMessageModel[PinnedMessageModel]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.core.model.DataModel --> scurrypy.api.messages.message.PinnedMessageModel
                


              click scurrypy.api.messages.message.PinnedMessageModel href "" "scurrypy.api.messages.message.PinnedMessageModel"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
            

Represents a pinned message.

message: MessageModel instance-attribute

Message resource of the pinned message.

pinned_at: str | None instance-attribute

ISO8601 timestamp of when the message was pinned.

MessageReferencePart dataclass

Bases: DataModel

              flowchart TD
              scurrypy.api.messages.message.MessageReferencePart[MessageReferencePart]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.core.model.DataModel --> scurrypy.api.messages.message.MessageReferencePart
                


              click scurrypy.api.messages.message.MessageReferencePart href "" "scurrypy.api.messages.message.MessageReferencePart"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
            

Represents the Message Reference object.

message_id: Snowflake | None = None class-attribute instance-attribute

ID of the originating message.

channel_id: Snowflake | None = None class-attribute instance-attribute

Channel ID of the originating message.

Note

Optional for default type, but REQUIRED for forwards.

type: MessageReferenceType | None = None class-attribute instance-attribute

Type of reference. Discord defaults to MessageReferenceTypes.DEFAULT.

MessagePart dataclass

Bases: DataModel

              flowchart TD
              scurrypy.api.messages.message.MessagePart[MessagePart]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.core.model.DataModel --> scurrypy.api.messages.message.MessagePart
                


              click scurrypy.api.messages.message.MessagePart href "" "scurrypy.api.messages.message.MessagePart"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
            

Represents a Discord Message.

content: str | None = None class-attribute instance-attribute

Message text content.

flags: MessageFlags | None = None class-attribute instance-attribute

Message flags. Discord defaults to MessageFlags.NO_FLAGS.

components: list[ActionRow | Container] | None = None class-attribute instance-attribute

Components to be attached to this message.

attachments: list[AttachmentPart] | None = None class-attribute instance-attribute

Attachments to be attached to this message.

embeds: list[Embed] | None = None class-attribute instance-attribute

Embeds to be attached to this message.

message_reference: MessageReferencePart | None = None class-attribute instance-attribute

Message reference if reply.

Reaction

---

reaction

ReactionCountDetailsModel dataclass

Bases: DataModel

              flowchart TD
              scurrypy.api.messages.reaction.ReactionCountDetailsModel[ReactionCountDetailsModel]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.core.model.DataModel --> scurrypy.api.messages.reaction.ReactionCountDetailsModel
                


              click scurrypy.api.messages.reaction.ReactionCountDetailsModel href "" "scurrypy.api.messages.reaction.ReactionCountDetailsModel"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
            

Represents details for the reaction.

burst: int instance-attribute

Count of super reactions.

normal: int instance-attribute

Count of normal reactions.

ReactionModel dataclass

Bases: DataModel

              flowchart TD
              scurrypy.api.messages.reaction.ReactionModel[ReactionModel]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.core.model.DataModel --> scurrypy.api.messages.reaction.ReactionModel
                


              click scurrypy.api.messages.reaction.ReactionModel href "" "scurrypy.api.messages.reaction.ReactionModel"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
            

Represents a reaction made.

count: int instance-attribute

Total number of times this reaction was made.

count_details: ReactionCountDetailsModel instance-attribute

me: bool instance-attribute

Whether the bot has reacted with this emoji.

me_burst: bool instance-attribute

Whether the bot has reacted with a super emoji.

emoji: EmojiModel instance-attribute

Emoji info.

burst_colors: list[str] instance-attribute

List of hext colors for the super reaction.

Sticker

---

sticker

StickerModel dataclass

Bases: DataModel

              flowchart TD
              scurrypy.api.messages.sticker.StickerModel[StickerModel]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.core.model.DataModel --> scurrypy.api.messages.sticker.StickerModel
                


              click scurrypy.api.messages.sticker.StickerModel href "" "scurrypy.api.messages.sticker.StickerModel"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
            

Represents the sticker object.

id: Snowflake instance-attribute

ID of the sticker.

pack_id: Snowflake | None instance-attribute

ID of the pack the sticker is from (if standard).

name: str instance-attribute

Name of the sticker.

description: str instance-attribute

Description of the sticker.

tags: str instance-attribute

Autocomplete/suggestion tags for the sticker.

type: StickerType instance-attribute

Type of sticker.

format_type: StickerFormatType instance-attribute

Type of sticker format.

available: bool | None instance-attribute

Whether this guild sticker can be used.

Note

May be False due to loss of Server Boosts

guild_id: Snowflake | None instance-attribute

ID of the guild that owns this sticker.

user: UserModel | None instance-attribute

The user that uploaded the guild sticker.

sort_type: int | None instance-attribute

The standard sticker's sort order within its pack.

StickerItemModel dataclass

Bases: DataModel

              flowchart TD
              scurrypy.api.messages.sticker.StickerItemModel[StickerItemModel]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.core.model.DataModel --> scurrypy.api.messages.sticker.StickerItemModel
                


              click scurrypy.api.messages.sticker.StickerItemModel href "" "scurrypy.api.messages.sticker.StickerItemModel"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
            

Represents a minimal sticker item.

id: Snowflake instance-attribute

ID of the sticker.

name: str instance-attribute

Name of the sticker.

format_type: StickerFormatType instance-attribute

Type of sticker format.

StickerPackModel dataclass

Bases: DataModel

              flowchart TD
              scurrypy.api.messages.sticker.StickerPackModel[StickerPackModel]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.core.model.DataModel --> scurrypy.api.messages.sticker.StickerPackModel
                


              click scurrypy.api.messages.sticker.StickerPackModel href "" "scurrypy.api.messages.sticker.StickerPackModel"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
            

Represents a pack of standard stickers.

id: Snowflake instance-attribute

ID of the sticker pack.

stickers: list[StickerModel] instance-attribute

The stickers in the pack.

name: str instance-attribute

Name of the sticker pack.

sku_id: Snowflake instance-attribute

ID of the pack's SKU.

cover_sticker_id: Snowflake | None instance-attribute

ID of a sticker in the pack which is shown as the pack's icon.

description: str instance-attribute

Description of the sticker pack.

banner_asset_id: Snowflake | None instance-attribute

ID of the sticker pack's banner image.

StickerPart dataclass

Bases: DataModel

              flowchart TD
              scurrypy.api.messages.sticker.StickerPart[StickerPart]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.core.model.DataModel --> scurrypy.api.messages.sticker.StickerPart
                


              click scurrypy.api.messages.sticker.StickerPart href "" "scurrypy.api.messages.sticker.StickerPart"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"
            

Represents fields for creating a sticker.

name: str | None = None class-attribute instance-attribute

Name of the sticker.

description: str | None = None class-attribute instance-attribute

Description of the sticker.

tags: str | None = None class-attribute instance-attribute

Autocomplete/suggestion tags for the sticker.