Sticker Model¶
Note
The following classes come from the scurrypy.models.sticker module.
StickerModel
dataclass
¶
Bases: DataModel
Represents the sticker object.
id: int
instance-attribute
¶
ID of the sticker.
pack_id: Optional[int]
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: int
instance-attribute
¶
Type of sticker. See StickerTypes.
format_type: int
instance-attribute
¶
Type of sticker format. See StickerFormatTypes.
available: Optional[bool]
instance-attribute
¶
Whether this guild sticker can be used.
Note
May be False due to loss of Server Boosts
guild_id: Optional[int]
instance-attribute
¶
ID of the guild that owns this sticker.
user: Optional[UserModel]
instance-attribute
¶
The user that uploaded the guild sticker.
sort_type: Optional[int]
instance-attribute
¶
The standard sticker's sort order within its pack.
to_dict
¶
Recursively turns the dataclass into a dictionary and drops empty fields.
Returns:
-
dict–serialized dataclasss
StickerItemModel
dataclass
¶
Bases: DataModel
Represents a minimal sticker item.
id: int
instance-attribute
¶
ID of the sticker.
name: str
instance-attribute
¶
Name of the sticker.
format_type: int
instance-attribute
¶
Type of sticker format. See StickerFormatTypes.
to_dict
¶
Recursively turns the dataclass into a dictionary and drops empty fields.
Returns:
-
dict–serialized dataclasss
StickerPackModel
dataclass
¶
Bases: DataModel
Represents a pack of standard stickers.
id: int
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: int
instance-attribute
¶
ID of the pack's SKU.
cover_sticker_id: Optional[int]
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: Optional[int]
instance-attribute
¶
ID of the sticker pack's banner image.
to_dict
¶
Recursively turns the dataclass into a dictionary and drops empty fields.
Returns:
-
dict–serialized dataclasss