コンテンツにスキップ

サーバーとチャンネル

モデルの型付けとデコードの仕組みはモデルのガイドで説明しています。ここにあるクラスはすべて bostie からインポートできます。

bostie.models.guild

RoleColors

Bases: Builder

primary_color instance-attribute 

primary_color: int

secondary_color instance-attribute 

secondary_color: int | None

tertiary_color instance-attribute 

tertiary_color: int | None

RoleTags

Bases: Model

What a role belongs to: a bot, an integration, boosts or a subscription.

bot_id class-attribute instance-attribute 

bot_id: int | None = None

integration_id class-attribute instance-attribute 

integration_id: int | None = None

subscription_listing_id class-attribute instance-attribute 

subscription_listing_id: int | None = None

premium_subscriber property 

premium_subscriber: bool

Whether this is the guild's booster role.

available_for_purchase property 

available_for_purchase: bool

guild_connections property 

guild_connections: bool

Whether this is a linked role.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

Role

Bases: Model, Snowflake

A guild role.

id instance-attribute 

id: int

name instance-attribute 

name: str

colors instance-attribute 

colors: RoleColors

hoist instance-attribute 

hoist: bool

icon class-attribute instance-attribute 

icon: str | None = None

unicode_emoji class-attribute instance-attribute 

unicode_emoji: str | None = None

position instance-attribute 

position: int

managed instance-attribute 

managed: bool

mentionable instance-attribute 

mentionable: bool

tags class-attribute instance-attribute 

tags: RoleTags | None = None

flags instance-attribute 

flags: RoleFlags

permissions property 

permissions: Permissions

mention property 

mention: str

created_at property 

created_at: datetime

When the object was created, in UTC, read from its id.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

PartialMember

Bases: _MemberFields

A member without its user, as messages and resolved data carry it.

deaf class-attribute instance-attribute 

deaf: bool | None = None

mute class-attribute instance-attribute 

mute: bool | None = None

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

roles instance-attribute 

roles: tuple[int, ...]

joined_at instance-attribute 

joined_at: datetime | None

flags instance-attribute 

flags: MemberFlags

nick class-attribute instance-attribute 

nick: str | None = None

avatar class-attribute instance-attribute 

avatar: str | None = None

banner class-attribute instance-attribute 

banner: str | None = None

premium_since class-attribute instance-attribute 

premium_since: datetime | None = None

pending class-attribute instance-attribute 

pending: bool = False

communication_disabled_until class-attribute instance-attribute 

communication_disabled_until: datetime | None = None

unusual_dm_activity_until class-attribute instance-attribute 

unusual_dm_activity_until: datetime | None = None

avatar_decoration_data class-attribute instance-attribute 

avatar_decoration_data: AvatarDecorationData | None = None

collectibles class-attribute instance-attribute 

collectibles: Collectibles | None = None

permissions property 

permissions: Permissions | None

The member's permissions in the channel of an interaction.

ResolvedMember

Bases: _UserMember

A member as an option, a select or a command target resolves it.

created_at property 

created_at: datetime

When the object was created, in UTC, read from its id.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

roles instance-attribute 

roles: tuple[int, ...]

joined_at instance-attribute 

joined_at: datetime | None

flags instance-attribute 

flags: MemberFlags

nick class-attribute instance-attribute 

nick: str | None = None

avatar class-attribute instance-attribute 

avatar: str | None = None

banner class-attribute instance-attribute 

banner: str | None = None

premium_since class-attribute instance-attribute 

premium_since: datetime | None = None

pending class-attribute instance-attribute 

pending: bool = False

communication_disabled_until class-attribute instance-attribute 

communication_disabled_until: datetime | None = None

unusual_dm_activity_until class-attribute instance-attribute 

unusual_dm_activity_until: datetime | None = None

avatar_decoration_data class-attribute instance-attribute 

avatar_decoration_data: AvatarDecorationData | None = None

collectibles class-attribute instance-attribute 

collectibles: Collectibles | None = None

permissions property 

permissions: Permissions | None

The member's permissions in the channel of an interaction.

user instance-attribute 

user: User

id property 

id: int

mention property 

mention: str

display_name property 

display_name: str

Member

Bases: _UserMember

A user's membership in a guild.

deaf instance-attribute 

deaf: bool

mute instance-attribute 

mute: bool

created_at property 

created_at: datetime

When the object was created, in UTC, read from its id.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

roles instance-attribute 

roles: tuple[int, ...]

joined_at instance-attribute 

joined_at: datetime | None

flags instance-attribute 

flags: MemberFlags

nick class-attribute instance-attribute 

nick: str | None = None

avatar class-attribute instance-attribute 

avatar: str | None = None

banner class-attribute instance-attribute 

banner: str | None = None

premium_since class-attribute instance-attribute 

premium_since: datetime | None = None

pending class-attribute instance-attribute 

pending: bool = False

communication_disabled_until class-attribute instance-attribute 

communication_disabled_until: datetime | None = None

unusual_dm_activity_until class-attribute instance-attribute 

unusual_dm_activity_until: datetime | None = None

avatar_decoration_data class-attribute instance-attribute 

avatar_decoration_data: AvatarDecorationData | None = None

collectibles class-attribute instance-attribute 

collectibles: Collectibles | None = None

permissions property 

permissions: Permissions | None

The member's permissions in the channel of an interaction.

user instance-attribute 

user: User

id property 

id: int

mention property 

mention: str

display_name property 

display_name: str

WelcomeScreenChannel

Bases: Builder

channel_id instance-attribute 

channel_id: int

description instance-attribute 

description: str

emoji_id instance-attribute 

emoji_id: int | None

emoji_name instance-attribute 

emoji_name: str | None

WelcomeScreen

Bases: Model

description instance-attribute 

description: str | None

welcome_channels instance-attribute 

welcome_channels: tuple[WelcomeScreenChannel, ...]

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

IncidentsData

Bases: Model

invites_disabled_until instance-attribute 

invites_disabled_until: datetime | None

dms_disabled_until instance-attribute 

dms_disabled_until: datetime | None

dm_spam_detected_at class-attribute instance-attribute 

dm_spam_detected_at: datetime | None = None

raid_detected_at class-attribute instance-attribute 

raid_detected_at: datetime | None = None

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

Guild

Bases: Model, Snowflake

A guild, without its channels or members.

id instance-attribute 

id: int

name instance-attribute 

name: str

icon instance-attribute 

icon: str | None

splash instance-attribute 

splash: str | None

discovery_splash instance-attribute 

discovery_splash: str | None

owner_id instance-attribute 

owner_id: int

afk_channel_id instance-attribute 

afk_channel_id: int | None

afk_timeout instance-attribute 

afk_timeout: int

widget_enabled class-attribute instance-attribute 

widget_enabled: bool = False

widget_channel_id class-attribute instance-attribute 

widget_channel_id: int | None = None

verification_level instance-attribute 

verification_level: VerificationLevel

default_message_notifications instance-attribute 

default_message_notifications: DefaultMessageNotificationLevel

explicit_content_filter instance-attribute 

explicit_content_filter: ExplicitContentFilterLevel

roles instance-attribute 

roles: tuple[Role, ...]

emojis instance-attribute 

emojis: tuple[Emoji, ...]

features instance-attribute 

features: tuple[GuildFeature, ...]

mfa_level instance-attribute 

mfa_level: MFALevel

application_id instance-attribute 

application_id: int | None

system_channel_id instance-attribute 

system_channel_id: int | None

system_channel_flags instance-attribute 

system_channel_flags: SystemChannelFlags

rules_channel_id instance-attribute 

rules_channel_id: int | None

max_presences class-attribute instance-attribute 

max_presences: int | None = None

max_members class-attribute instance-attribute 

max_members: int | None = None

vanity_url_code instance-attribute 

vanity_url_code: str | None

description instance-attribute 

description: str | None

banner instance-attribute 

banner: str | None

premium_tier instance-attribute 

premium_tier: PremiumTier

premium_subscription_count class-attribute instance-attribute 

premium_subscription_count: int | None = None

preferred_locale instance-attribute 

preferred_locale: Locale

public_updates_channel_id instance-attribute 

public_updates_channel_id: int | None

max_video_channel_users class-attribute instance-attribute 

max_video_channel_users: int | None = None

max_stage_video_channel_users class-attribute instance-attribute 

max_stage_video_channel_users: int | None = None

approximate_member_count class-attribute instance-attribute 

approximate_member_count: int | None = None

approximate_presence_count class-attribute instance-attribute 

approximate_presence_count: int | None = None

welcome_screen class-attribute instance-attribute 

welcome_screen: WelcomeScreen | None = None

nsfw_level instance-attribute 

nsfw_level: NSFWLevel

stickers class-attribute instance-attribute 

stickers: tuple[Sticker, ...] = ()

premium_progress_bar_enabled instance-attribute 

premium_progress_bar_enabled: bool

safety_alerts_channel_id instance-attribute 

safety_alerts_channel_id: int | None

incidents_data instance-attribute 

incidents_data: IncidentsData | None

joined_at class-attribute instance-attribute 

joined_at: datetime | None = None

member_count class-attribute instance-attribute 

member_count: int | None = None

large class-attribute instance-attribute 

large: bool | None = None

unavailable class-attribute instance-attribute 

unavailable: bool = False

created_at property 

created_at: datetime

When the object was created, in UTC, read from its id.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

InteractionGuild

Bases: Model, Snowflake

The part of a guild an interaction from it carries.

id instance-attribute 

id: int

locale class-attribute instance-attribute 

locale: Locale | None = None

features class-attribute instance-attribute 

features: tuple[GuildFeature, ...] = ()

created_at property 

created_at: datetime

When the object was created, in UTC, read from its id.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

CurrentUserGuild

Bases: Model, Snowflake

A guild the bot is in, with the bot's permissions there.

id instance-attribute 

id: int

name instance-attribute 

name: str

icon instance-attribute 

icon: str | None

banner instance-attribute 

banner: str | None

owner instance-attribute 

owner: bool

features instance-attribute 

features: tuple[GuildFeature, ...]

approximate_member_count class-attribute instance-attribute 

approximate_member_count: int | None = None

approximate_presence_count class-attribute instance-attribute 

approximate_presence_count: int | None = None

permissions property 

permissions: Permissions

created_at property 

created_at: datetime

When the object was created, in UTC, read from its id.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

GuildPreview

Bases: Model, Snowflake

id instance-attribute 

id: int

name instance-attribute 

name: str

icon instance-attribute 

icon: str | None

splash instance-attribute 

splash: str | None

discovery_splash instance-attribute 

discovery_splash: str | None

emojis instance-attribute 

emojis: tuple[Emoji, ...]

features instance-attribute 

features: tuple[GuildFeature, ...]

approximate_member_count instance-attribute 

approximate_member_count: int

approximate_presence_count instance-attribute 

approximate_presence_count: int

description instance-attribute 

description: str | None

stickers instance-attribute 

stickers: tuple[Sticker, ...]

created_at property 

created_at: datetime

When the object was created, in UTC, read from its id.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

GuildWidgetSettings

Bases: Model

enabled instance-attribute 

enabled: bool

channel_id instance-attribute 

channel_id: int | None

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

GuildWidgetChannel

Bases: Model, Snowflake

id instance-attribute 

id: int

name instance-attribute 

name: str

position instance-attribute 

position: int

created_at property 

created_at: datetime

When the object was created, in UTC, read from its id.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

GuildWidgetMember

Bases: Model

An online member as the widget shows it, with an anonymized id.

id instance-attribute 

id: str

username instance-attribute 

username: str

discriminator instance-attribute 

discriminator: str

avatar instance-attribute 

avatar: str | None

status instance-attribute 

status: Status

avatar_url instance-attribute 

avatar_url: str

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

GuildWidget

Bases: Model, Snowflake

id instance-attribute 

id: int

name instance-attribute 

name: str

instant_invite instance-attribute 

instant_invite: str | None

channels instance-attribute 

channels: tuple[GuildWidgetChannel, ...]

members instance-attribute 

members: tuple[GuildWidgetMember, ...]

presence_count instance-attribute 

presence_count: int

created_at property 

created_at: datetime

When the object was created, in UTC, read from its id.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

VanityURL

Bases: Model

code instance-attribute 

code: str | None

uses instance-attribute 

uses: int

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

Ban

Bases: Model

reason instance-attribute 

reason: str | None

user instance-attribute 

user: User

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

BulkBan

Bases: Model

The ids of the users a bulk ban banned, and of those it did not.

banned_users instance-attribute 

banned_users: tuple[int, ...]

failed_users instance-attribute 

failed_users: tuple[int, ...]

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

UnavailableGuild

Bases: Model, Snowflake

A guild Discord has not sent yet, or one it lost to an outage.

id instance-attribute 

id: int

unavailable instance-attribute 

unavailable: bool

created_at property 

created_at: datetime

When the object was created, in UTC, read from its id.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

VoiceState

Bases: Model

A user's voice connection state in a guild.

guild_id class-attribute instance-attribute 

guild_id: int | None = None

channel_id instance-attribute 

channel_id: int | None

user_id instance-attribute 

user_id: int

member class-attribute instance-attribute 

member: Member | None = None

session_id instance-attribute 

session_id: str

deaf instance-attribute 

deaf: bool

mute instance-attribute 

mute: bool

self_deaf instance-attribute 

self_deaf: bool

self_mute instance-attribute 

self_mute: bool

self_stream class-attribute instance-attribute 

self_stream: bool = False

self_video instance-attribute 

self_video: bool

suppress instance-attribute 

suppress: bool

request_to_speak_timestamp instance-attribute 

request_to_speak_timestamp: datetime | None

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

VoiceRegion

Bases: Model

id instance-attribute 

id: str

name instance-attribute 

name: str

optimal instance-attribute 

optimal: bool

deprecated instance-attribute 

deprecated: bool

custom instance-attribute 

custom: bool

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

IntegrationAccount

Bases: Model

id instance-attribute 

id: str

name instance-attribute 

name: str

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

IntegrationApplication

Bases: Model, Snowflake

id instance-attribute 

id: int

name instance-attribute 

name: str

icon instance-attribute 

icon: str | None

description instance-attribute 

description: str

bot class-attribute instance-attribute 

bot: User | None = None

created_at property 

created_at: datetime

When the object was created, in UTC, read from its id.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

Integration

Bases: Model, Snowflake

A guild integration; bot integrations leave the subscriber fields None.

id instance-attribute 

id: int

name instance-attribute 

name: str

type instance-attribute 

type: IntegrationType

enabled instance-attribute 

enabled: bool

syncing class-attribute instance-attribute 

syncing: bool | None = None

role_id class-attribute instance-attribute 

role_id: int | None = None

enable_emoticons class-attribute instance-attribute 

enable_emoticons: bool | None = None

expire_behavior class-attribute instance-attribute 

expire_behavior: IntegrationExpireBehavior | None = None

expire_grace_period class-attribute instance-attribute 

expire_grace_period: int | None = None

user class-attribute instance-attribute 

user: User | None = None

account instance-attribute 

account: IntegrationAccount

synced_at class-attribute instance-attribute 

synced_at: datetime | None = None

subscriber_count class-attribute instance-attribute 

subscriber_count: int | None = None

revoked class-attribute instance-attribute 

revoked: bool | None = None

application class-attribute instance-attribute 

application: IntegrationApplication | None = None

scopes class-attribute instance-attribute 

scopes: tuple[OAuth2Scope, ...] = ()

created_at property 

created_at: datetime

When the object was created, in UTC, read from its id.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

PartialIntegration

Bases: Model, Snowflake

An integration as the audit log refers to it.

id instance-attribute 

id: int

name instance-attribute 

name: str

type instance-attribute 

type: IntegrationType

account instance-attribute 

account: IntegrationAccount

application_id class-attribute instance-attribute 

application_id: int | None = None

created_at property 

created_at: datetime

When the object was created, in UTC, read from its id.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

RequestGuildMembersRateLimit

Bases: Model

The metadata of a rate limited Request Guild Members.

guild_id instance-attribute 

guild_id: int

nonce class-attribute instance-attribute 

nonce: str | None = None

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

bostie.models.channel

Overwrite

Bases: Model, Snowflake

A permission overwrite for a role or a member.

id instance-attribute 

id: int

type instance-attribute 

type: OverwriteType

allow property 

allow: Permissions

deny property 

deny: Permissions

created_at property 

created_at: datetime

When the object was created, in UTC, read from its id.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

ThreadMetadata

Bases: Model

archived instance-attribute 

archived: bool

auto_archive_duration instance-attribute 

auto_archive_duration: int

archive_timestamp instance-attribute 

archive_timestamp: datetime

locked instance-attribute 

locked: bool

invitable class-attribute instance-attribute 

invitable: bool | None = None

create_timestamp class-attribute instance-attribute 

create_timestamp: datetime | None = None

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

ThreadMember

Bases: _ThreadMember

A user's membership in a thread; flags are its notification settings.

member class-attribute instance-attribute 

member: Member | None = None

created_at property 

created_at: datetime | None

When the object was created, in UTC, or None without an id.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

id class-attribute instance-attribute 

id: int | None = None

user_id class-attribute instance-attribute 

user_id: int | None = None

join_timestamp instance-attribute 

join_timestamp: datetime

flags instance-attribute 

flags: int

AddedThreadMember

Bases: _ThreadMember

A thread member THREAD_MEMBERS_UPDATE adds, with its member and presence.

member instance-attribute 

member: Member

presence instance-attribute 

presence: Presence | None

created_at property 

created_at: datetime | None

When the object was created, in UTC, or None without an id.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

id class-attribute instance-attribute 

id: int | None = None

user_id class-attribute instance-attribute 

user_id: int | None = None

join_timestamp instance-attribute 

join_timestamp: datetime

flags instance-attribute 

flags: int

ForumTag

Bases: Builder, MaybeSnowflake

A tag for threads in a forum or media channel; only name is needed to send.

id class-attribute instance-attribute 

id: int | None = None

name instance-attribute 

name: str

moderated class-attribute instance-attribute 

moderated: bool | None = None

emoji_id class-attribute instance-attribute 

emoji_id: int | None = None

emoji_name class-attribute instance-attribute 

emoji_name: str | None = None

created_at property 

created_at: datetime | None

When the object was created, in UTC, or None without an id.

DefaultReaction

Bases: Builder

The emoji of a forum's reaction button, by custom emoji id or unicode name.

emoji_id class-attribute instance-attribute 

emoji_id: int | None = None

emoji_name class-attribute instance-attribute 

emoji_name: str | None = None

PartialChannel

Bases: Model, Snowflake

A channel as an interaction carries it, with the user's permissions in it.

id instance-attribute 

id: int

type instance-attribute 

type: ChannelType

guild_id class-attribute instance-attribute 

guild_id: int | None = None

position class-attribute instance-attribute 

position: int | None = None

name class-attribute instance-attribute 

name: str | None = None

topic class-attribute instance-attribute 

topic: str | None = None

nsfw class-attribute instance-attribute 

nsfw: bool = False

last_message_id class-attribute instance-attribute 

last_message_id: int | None = None

rate_limit_per_user class-attribute instance-attribute 

rate_limit_per_user: int | None = None

parent_id class-attribute instance-attribute 

parent_id: int | None = None

last_pin_timestamp class-attribute instance-attribute 

last_pin_timestamp: datetime | None = None

thread_metadata class-attribute instance-attribute 

thread_metadata: ThreadMetadata | None = None

flags class-attribute instance-attribute 

flags: ChannelFlags = ChannelFlags(0)

permissions property 

permissions: Permissions | None

The user's permissions in a channel resolved for an interaction.

app_permissions property 

app_permissions: Permissions | None

The bot's permissions in a channel resolved for an interaction.

obfuscated property 

obfuscated: bool

Whether Discord hid this channel's details because the bot cannot view it.

mention property 

mention: str

created_at property 

created_at: datetime

When the object was created, in UTC, read from its id.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

Channel

Bases: PartialChannel

Any channel, thread included.

permission_overwrites class-attribute instance-attribute 

permission_overwrites: tuple[Overwrite, ...] = ()

bitrate class-attribute instance-attribute 

bitrate: int | None = None

user_limit class-attribute instance-attribute 

user_limit: int | None = None

recipients class-attribute instance-attribute 

recipients: tuple[User, ...] = ()

icon class-attribute instance-attribute 

icon: str | None = None

owner_id class-attribute instance-attribute 

owner_id: int | None = None

application_id class-attribute instance-attribute 

application_id: int | None = None

managed class-attribute instance-attribute 

managed: bool = False

rtc_region class-attribute instance-attribute 

rtc_region: str | None = None

video_quality_mode class-attribute instance-attribute 

video_quality_mode: VideoQualityMode | None = None

message_count class-attribute instance-attribute 

message_count: int | None = None

member_count class-attribute instance-attribute 

member_count: int | None = None

member class-attribute instance-attribute 

member: ThreadMember | None = None

default_auto_archive_duration class-attribute instance-attribute 

default_auto_archive_duration: int | None = None

total_message_sent class-attribute instance-attribute 

total_message_sent: int | None = None

available_tags class-attribute instance-attribute 

available_tags: tuple[ForumTag, ...] = ()

applied_tags class-attribute instance-attribute 

applied_tags: tuple[int, ...] = ()

default_reaction_emoji class-attribute instance-attribute 

default_reaction_emoji: DefaultReaction | None = None

default_thread_rate_limit_per_user class-attribute instance-attribute 

default_thread_rate_limit_per_user: int | None = None

default_sort_order class-attribute instance-attribute 

default_sort_order: SortOrderType | None = None

default_forum_layout class-attribute instance-attribute 

default_forum_layout: ForumLayoutType | None = None

created_at property 

created_at: datetime

When the object was created, in UTC, read from its id.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

id instance-attribute 

id: int

type instance-attribute 

type: ChannelType

guild_id class-attribute instance-attribute 

guild_id: int | None = None

position class-attribute instance-attribute 

position: int | None = None

name class-attribute instance-attribute 

name: str | None = None

topic class-attribute instance-attribute 

topic: str | None = None

nsfw class-attribute instance-attribute 

nsfw: bool = False

last_message_id class-attribute instance-attribute 

last_message_id: int | None = None

rate_limit_per_user class-attribute instance-attribute 

rate_limit_per_user: int | None = None

parent_id class-attribute instance-attribute 

parent_id: int | None = None

last_pin_timestamp class-attribute instance-attribute 

last_pin_timestamp: datetime | None = None

thread_metadata class-attribute instance-attribute 

thread_metadata: ThreadMetadata | None = None

flags class-attribute instance-attribute 

flags: ChannelFlags = ChannelFlags(0)

permissions property 

permissions: Permissions | None

The user's permissions in a channel resolved for an interaction.

app_permissions property 

app_permissions: Permissions | None

The bot's permissions in a channel resolved for an interaction.

obfuscated property 

obfuscated: bool

Whether Discord hid this channel's details because the bot cannot view it.

mention property 

mention: str

ActiveThreads

Bases: Model

A guild's active threads and the bot's membership in those it joined.

threads instance-attribute 

threads: tuple[Channel, ...]

members instance-attribute 

members: tuple[ThreadMember, ...]

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

FollowedChannel

Bases: Model

An announcement channel followed through the webhook webhook_id.

channel_id instance-attribute 

channel_id: int

webhook_id instance-attribute 

webhook_id: int

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

VoiceChannelInfo

Bases: Model, Snowflake

A channel's voice status and the start of its voice session.

id instance-attribute 

id: int

status class-attribute instance-attribute 

status: str | None = None

voice_start_time class-attribute instance-attribute 

voice_start_time: datetime | None = None

created_at property 

created_at: datetime

When the object was created, in UTC, read from its id.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

StageInstance

Bases: Model, Snowflake

A live stage.

id instance-attribute 

id: int

guild_id instance-attribute 

guild_id: int

channel_id instance-attribute 

channel_id: int

topic instance-attribute 

topic: str

privacy_level instance-attribute 

privacy_level: StagePrivacyLevel

guild_scheduled_event_id instance-attribute 

guild_scheduled_event_id: int | None

created_at property 

created_at: datetime

When the object was created, in UTC, read from its id.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

bostie.models.moderation

AutoModerationTriggerMetadata

Bases: Builder

What a rule matches; only the fields of its trigger type are set.

keyword_filter class-attribute instance-attribute 

keyword_filter: tuple[str, ...] = ()

regex_patterns class-attribute instance-attribute 

regex_patterns: tuple[str, ...] = ()

presets class-attribute instance-attribute 

presets: tuple[KeywordPresetType, ...] = ()

allow_list class-attribute instance-attribute 

allow_list: tuple[str, ...] = ()

mention_total_limit class-attribute instance-attribute 

mention_total_limit: int | None = None

mention_raid_protection_enabled class-attribute instance-attribute 

mention_raid_protection_enabled: bool | None = None

AutoModerationActionMetadata

Bases: Builder

The settings of an action; only the fields of its action type are set.

channel_id class-attribute instance-attribute 

channel_id: int | None = None

duration_seconds class-attribute instance-attribute 

duration_seconds: int | None = None

custom_message class-attribute instance-attribute 

custom_message: str | None = None

AutoModerationAction

Bases: Builder

type instance-attribute 

type: AutoModerationActionType

metadata class-attribute instance-attribute 

metadata: AutoModerationActionMetadata | None = None

AutoModerationRule

Bases: Model, Snowflake

id instance-attribute 

id: int

guild_id instance-attribute 

guild_id: int

name instance-attribute 

name: str

creator_id instance-attribute 

creator_id: int

event_type instance-attribute 

event_type: AutoModerationEventType

trigger_type instance-attribute 

trigger_type: AutoModerationTriggerType

trigger_metadata instance-attribute 

trigger_metadata: AutoModerationTriggerMetadata

actions instance-attribute 

actions: tuple[AutoModerationAction, ...]

enabled instance-attribute 

enabled: bool

exempt_roles instance-attribute 

exempt_roles: tuple[int, ...]

exempt_channels instance-attribute 

exempt_channels: tuple[int, ...]

created_at property 

created_at: datetime

When the object was created, in UTC, read from its id.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

AuditLogChange

Bases: Model

A changed field, typed as its object types it; an unknown key keeps its JSON.

key instance-attribute 

key: str

new_value class-attribute instance-attribute 

new_value: Any = None

old_value class-attribute instance-attribute 

old_value: Any = None

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

AuditLogRole

Bases: Model, Snowflake

A role a member got or lost, as a $add or $remove change lists it.

id instance-attribute 

id: int

name instance-attribute 

name: str

created_at property 

created_at: datetime

When the object was created, in UTC, read from its id.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

AuditLogEntryInfo

Bases: Model

Extra details of an entry; only the fields of its action type are set.

application_id class-attribute instance-attribute 

application_id: int | None = None

auto_moderation_rule_name class-attribute instance-attribute 

auto_moderation_rule_name: str | None = None

auto_moderation_rule_trigger_type class-attribute instance-attribute 

auto_moderation_rule_trigger_type: str | None = None

channel_id class-attribute instance-attribute 

channel_id: int | None = None

count class-attribute instance-attribute 

count: str | None = None

delete_member_days class-attribute instance-attribute 

delete_member_days: str | None = None

id class-attribute instance-attribute 

id: int | None = None

members_removed class-attribute instance-attribute 

members_removed: str | None = None

message_id class-attribute instance-attribute 

message_id: int | None = None

role_name class-attribute instance-attribute 

role_name: str | None = None

type class-attribute instance-attribute 

type: str | None = None

integration_type class-attribute instance-attribute 

integration_type: str | None = None

status class-attribute instance-attribute 

status: str | None = None

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

AuditLogEntry

Bases: Model, Snowflake

id instance-attribute 

id: int

action_type instance-attribute 

action_type: AuditLogEvent

target_id instance-attribute 

target_id: str | None

user_id instance-attribute 

user_id: int | None

changes class-attribute instance-attribute 

changes: tuple[AuditLogChange, ...] = ()

options class-attribute instance-attribute 

options: AuditLogEntryInfo | None = None

reason class-attribute instance-attribute 

reason: str | None = None

created_at property 

created_at: datetime

When the object was created, in UTC, read from its id.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

AuditLogPage

Bases: Model

A page of entries, with the users, threads and other objects they refer to.

application_commands instance-attribute 

application_commands: tuple[ApplicationCommand, ...]

audit_log_entries instance-attribute 

audit_log_entries: tuple[AuditLogEntry, ...]

auto_moderation_rules instance-attribute 

auto_moderation_rules: tuple[AutoModerationRule, ...]

guild_scheduled_events instance-attribute 

guild_scheduled_events: tuple[ScheduledEvent, ...]

integrations instance-attribute 

integrations: tuple[PartialIntegration, ...]

threads instance-attribute 

threads: tuple[Channel, ...]

users instance-attribute 

users: tuple[User, ...]

webhooks instance-attribute 

webhooks: tuple[Webhook, ...]

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

bostie.models.onboarding

OnboardingPromptOption

Bases: Model, Snowflake

id instance-attribute 

id: int

channel_ids instance-attribute 

channel_ids: tuple[int, ...]

role_ids instance-attribute 

role_ids: tuple[int, ...]

emoji class-attribute instance-attribute 

emoji: PartialEmoji | None = None

emoji_id class-attribute instance-attribute 

emoji_id: int | None = None

emoji_name class-attribute instance-attribute 

emoji_name: str | None = None

emoji_animated class-attribute instance-attribute 

emoji_animated: bool | None = None

title instance-attribute 

title: str

description instance-attribute 

description: str | None

created_at property 

created_at: datetime

When the object was created, in UTC, read from its id.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

OnboardingPrompt

Bases: Model, Snowflake

id instance-attribute 

id: int

type instance-attribute 

type: OnboardingPromptType

options instance-attribute 

options: tuple[OnboardingPromptOption, ...]

title instance-attribute 

title: str

single_select instance-attribute 

single_select: bool

required instance-attribute 

required: bool

in_onboarding instance-attribute 

in_onboarding: bool

created_at property 

created_at: datetime

When the object was created, in UTC, read from its id.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

GuildOnboarding

Bases: Model

The questions and default channels a guild shows its new members.

guild_id instance-attribute 

guild_id: int

prompts instance-attribute 

prompts: tuple[OnboardingPrompt, ...]

default_channel_ids instance-attribute 

default_channel_ids: tuple[int, ...]

enabled instance-attribute 

enabled: bool

mode instance-attribute 

mode: OnboardingMode

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

bostie.models.template

TemplateRole

Bases: Model

A role a template creates; its id is a placeholder counted from 0.

id instance-attribute 

id: int

name instance-attribute 

name: str

permissions instance-attribute 

permissions: Permissions

colors class-attribute instance-attribute 

colors: RoleColors | None = None

hoist instance-attribute 

hoist: bool

mentionable instance-attribute 

mentionable: bool

icon class-attribute instance-attribute 

icon: str | None = None

unicode_emoji class-attribute instance-attribute 

unicode_emoji: str | None = None

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

TemplateGuild

Bases: Model

The guild a template creates; its ids are placeholders counted from 0.

name instance-attribute 

name: str

description instance-attribute 

description: str | None

verification_level instance-attribute 

verification_level: VerificationLevel

default_message_notifications instance-attribute 

default_message_notifications: DefaultMessageNotificationLevel

explicit_content_filter instance-attribute 

explicit_content_filter: ExplicitContentFilterLevel

preferred_locale instance-attribute 

preferred_locale: Locale

afk_timeout instance-attribute 

afk_timeout: int

roles instance-attribute 

roles: tuple[TemplateRole, ...]

channels instance-attribute 

channels: tuple[Channel, ...]

afk_channel_id instance-attribute 

afk_channel_id: int | None

system_channel_id instance-attribute 

system_channel_id: int | None

system_channel_flags instance-attribute 

system_channel_flags: SystemChannelFlags

icon_hash class-attribute instance-attribute 

icon_hash: str | None = None

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

GuildTemplate

Bases: Model

A snapshot of a guild that new guilds can be created from.

code instance-attribute 

code: str

name instance-attribute 

name: str

description instance-attribute 

description: str | None

usage_count instance-attribute 

usage_count: int

creator_id instance-attribute 

creator_id: int

creator instance-attribute 

creator: User

created_at instance-attribute 

created_at: datetime

updated_at instance-attribute 

updated_at: datetime

source_guild_id instance-attribute 

source_guild_id: int

serialized_source_guild instance-attribute 

serialized_source_guild: TemplateGuild

is_dirty instance-attribute 

is_dirty: bool | None

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

bostie.models.scheduled_event

ScheduledEventEntityMetadata

Bases: Builder

location class-attribute instance-attribute 

location: str | None = None

RecurrenceRuleNWeekday

Bases: Builder

A weekday in the n-th week of a month.

n instance-attribute 

n: int

day instance-attribute 

day: Weekday

RecurrenceRule

Bases: Builder

How often an event recurs; only Discord sets end, by_year_day and count.

start instance-attribute 

start: datetime

end class-attribute instance-attribute 

end: datetime | None = None

frequency instance-attribute 

frequency: RecurrenceFrequency

interval instance-attribute 

interval: int

by_weekday class-attribute instance-attribute 

by_weekday: tuple[Weekday, ...] | None = None

by_n_weekday class-attribute instance-attribute 

by_n_weekday: tuple[RecurrenceRuleNWeekday, ...] | None = None

by_month class-attribute instance-attribute 

by_month: tuple[Month, ...] | None = None

by_month_day class-attribute instance-attribute 

by_month_day: tuple[int, ...] | None = None

by_year_day class-attribute instance-attribute 

by_year_day: tuple[int, ...] | None = None

count class-attribute instance-attribute 

count: int | None = None

ScheduledEvent

Bases: Model, Snowflake

An event planned in a guild.

id instance-attribute 

id: int

guild_id instance-attribute 

guild_id: int

channel_id instance-attribute 

channel_id: int | None

creator_id class-attribute instance-attribute 

creator_id: int | None = None

name instance-attribute 

name: str

description class-attribute instance-attribute 

description: str | None = None

scheduled_start_time instance-attribute 

scheduled_start_time: datetime

scheduled_end_time instance-attribute 

scheduled_end_time: datetime | None

privacy_level instance-attribute 

privacy_level: ScheduledEventPrivacyLevel

status instance-attribute 

status: ScheduledEventStatus

entity_type instance-attribute 

entity_type: ScheduledEventEntityType

entity_id instance-attribute 

entity_id: int | None

entity_metadata instance-attribute 

entity_metadata: ScheduledEventEntityMetadata | None

creator class-attribute instance-attribute 

creator: User | None = None

user_count class-attribute instance-attribute 

user_count: int | None = None

image class-attribute instance-attribute 

image: str | None = None

recurrence_rule instance-attribute 

recurrence_rule: RecurrenceRule | None

created_at property 

created_at: datetime

When the object was created, in UTC, read from its id.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

ScheduledEventUser

Bases: Model

A user subscribed to a scheduled event, with their member if asked for.

guild_scheduled_event_id instance-attribute 

guild_scheduled_event_id: int

user instance-attribute 

user: User

member class-attribute instance-attribute 

member: Member | None = None

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

bostie.models.invite

InviteGuild

Bases: Model, Snowflake

The part of a guild an invite shows.

id instance-attribute 

id: int

name instance-attribute 

name: str

splash class-attribute instance-attribute 

splash: str | None = None

banner class-attribute instance-attribute 

banner: str | None = None

description class-attribute instance-attribute 

description: str | None = None

icon class-attribute instance-attribute 

icon: str | None = None

features class-attribute instance-attribute 

features: tuple[GuildFeature, ...] = ()

verification_level class-attribute instance-attribute 

verification_level: VerificationLevel | None = None

vanity_url_code class-attribute instance-attribute 

vanity_url_code: str | None = None

nsfw_level class-attribute instance-attribute 

nsfw_level: NSFWLevel | None = None

premium_subscription_count class-attribute instance-attribute 

premium_subscription_count: int | None = None

created_at property 

created_at: datetime

When the object was created, in UTC, read from its id.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

InviteRole

Bases: Model, Snowflake

A role the user gets by accepting an invite.

id instance-attribute 

id: int

name instance-attribute 

name: str

position instance-attribute 

position: int

colors instance-attribute 

colors: RoleColors

icon class-attribute instance-attribute 

icon: str | None = None

unicode_emoji class-attribute instance-attribute 

unicode_emoji: str | None = None

created_at property 

created_at: datetime

When the object was created, in UTC, read from its id.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

Invite

Bases: Model

A code that adds a user to a guild or a group DM.

type instance-attribute 

type: InviteType

code instance-attribute 

code: str

guild class-attribute instance-attribute 

guild: InviteGuild | None = None

channel instance-attribute 

channel: PartialChannel | None

inviter class-attribute instance-attribute 

inviter: User | None = None

target_type class-attribute instance-attribute 

target_type: InviteTargetType | None = None

target_user class-attribute instance-attribute 

target_user: User | None = None

target_application class-attribute instance-attribute 

target_application: PartialApplication | None = None

approximate_presence_count class-attribute instance-attribute 

approximate_presence_count: int | None = None

approximate_member_count class-attribute instance-attribute 

approximate_member_count: int | None = None

expires_at instance-attribute 

expires_at: datetime | None

guild_scheduled_event class-attribute instance-attribute 

guild_scheduled_event: ScheduledEvent | None = None

flags class-attribute instance-attribute 

flags: GuildInviteFlags = GuildInviteFlags(0)

roles class-attribute instance-attribute 

roles: tuple[InviteRole, ...] = ()

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

InviteWithMetadata

Bases: Invite

An invite with how it has been used, as its managers see it.

uses instance-attribute 

uses: int

max_uses instance-attribute 

max_uses: int

max_age instance-attribute 

max_age: int

temporary instance-attribute 

temporary: bool

created_at instance-attribute 

created_at: datetime

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

type instance-attribute 

type: InviteType

code instance-attribute 

code: str

guild class-attribute instance-attribute 

guild: InviteGuild | None = None

channel instance-attribute 

channel: PartialChannel | None

inviter class-attribute instance-attribute 

inviter: User | None = None

target_type class-attribute instance-attribute 

target_type: InviteTargetType | None = None

target_user class-attribute instance-attribute 

target_user: User | None = None

target_application class-attribute instance-attribute 

target_application: PartialApplication | None = None

approximate_presence_count class-attribute instance-attribute 

approximate_presence_count: int | None = None

approximate_member_count class-attribute instance-attribute 

approximate_member_count: int | None = None

expires_at instance-attribute 

expires_at: datetime | None

guild_scheduled_event class-attribute instance-attribute 

guild_scheduled_event: ScheduledEvent | None = None

flags class-attribute instance-attribute 

flags: GuildInviteFlags = GuildInviteFlags(0)

roles class-attribute instance-attribute 

roles: tuple[InviteRole, ...] = ()

TargetUsersJob

Bases: Model

How far Discord got adding the users of an uploaded CSV to an invite.

status instance-attribute 

status: TargetUsersJobStatus

total_users instance-attribute 

total_users: int

processed_users instance-attribute 

processed_users: int

created_at instance-attribute 

created_at: datetime | None

completed_at instance-attribute 

completed_at: datetime | None

error_message instance-attribute 

error_message: str | None

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

decode_invite 

decode_invite(data: bytes) -> Invite | InviteWithMetadata

Decode an invite, with its metadata when Discord sent it.

bostie.models.expressions

Emoji

Bases: Model, MaybeSnowflake

id instance-attribute 

id: int | None

name instance-attribute 

name: str | None

roles class-attribute instance-attribute 

roles: tuple[int, ...] = ()

user class-attribute instance-attribute 

user: User | None = None

require_colons class-attribute instance-attribute 

require_colons: bool | None = None

managed class-attribute instance-attribute 

managed: bool = False

animated class-attribute instance-attribute 

animated: bool = False

available class-attribute instance-attribute 

available: bool | None = None

created_at property 

created_at: datetime | None

When the object was created, in UTC, or None without an id.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

Sticker

Bases: Model, Snowflake

id instance-attribute 

id: int

pack_id class-attribute instance-attribute 

pack_id: int | None = None

name instance-attribute 

name: str

description instance-attribute 

description: str | None

tags instance-attribute 

tags: str

type instance-attribute 

type: StickerType

format_type instance-attribute 

format_type: StickerFormatType

available class-attribute instance-attribute 

available: bool | None = None

guild_id class-attribute instance-attribute 

guild_id: int | None = None

user class-attribute instance-attribute 

user: User | None = None

sort_value class-attribute instance-attribute 

sort_value: int | None = None

created_at property 

created_at: datetime

When the object was created, in UTC, read from its id.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

StickerPack

Bases: Model, Snowflake

A pack of standard stickers.

id instance-attribute 

id: int

stickers instance-attribute 

stickers: tuple[Sticker, ...]

name instance-attribute 

name: str

sku_id instance-attribute 

sku_id: int

cover_sticker_id class-attribute instance-attribute 

cover_sticker_id: int | None = None

description instance-attribute 

description: str

banner_asset_id class-attribute instance-attribute 

banner_asset_id: int | None = None

created_at property 

created_at: datetime

When the object was created, in UTC, read from its id.

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.

SoundboardSound

Bases: Model

sound_id instance-attribute 

sound_id: int

name instance-attribute 

name: str

volume instance-attribute 

volume: float

emoji_id instance-attribute 

emoji_id: int | None

emoji_name instance-attribute 

emoji_name: str | None

guild_id class-attribute instance-attribute 

guild_id: int | None = None

available instance-attribute 

available: bool

user class-attribute instance-attribute 

user: User | None = None

raw_json class-attribute instance-attribute 

raw_json: bytes | None = msgspec.field(default=None, name='__bostie_raw__')

raw property 

raw: Any

The payload this object was received as, or None for nested objects.