Skip to main content
Version: Next

discord-api-types/v10

Index

Enumerations

Interfaces

References

Type Aliases

Variables

References

FormattingPatterns

GatewayURLQuery

Re-exports GatewayURLQuery

Locale

Re-exports Locale

LocaleString

Re-exports LocaleString

LocalizationMap

Re-exports LocalizationMap

PermissionFlagsBits

RESTError

Re-exports RESTError

RESTErrorData

Re-exports RESTErrorData

RESTErrorFieldInformation

RESTErrorGroupWrapper

RESTJSONErrorCodes

RESTRateLimit

Re-exports RESTRateLimit

RPCCloseEventCodes

RPCErrorCodes

Re-exports RPCErrorCodes

Snowflake

Re-exports Snowflake

Utils

Renames and re-exports discord-api-types/utils/v10

Type Aliases

APIActionRowComponentTypes

APIApplicationCommandAttachmentOption

APIApplicationCommandAttachmentOption: APIApplicationCommandOptionBase<ApplicationCommandOptionType.Attachment>

APIApplicationCommandAutocompleteDMInteraction

APIApplicationCommandAutocompleteDMInteraction: APIDMInteractionWrapper<APIApplicationCommandAutocompleteInteraction>

APIApplicationCommandAutocompleteGuildInteraction

APIApplicationCommandAutocompleteGuildInteraction: APIGuildInteractionWrapper<APIApplicationCommandAutocompleteInteraction>

APIApplicationCommandAutocompleteInteraction

APIApplicationCommandAutocompleteInteraction: APIBaseInteraction<InteractionType.ApplicationCommandAutocomplete, APIChatInputApplicationCommandInteractionData> & Required<Pick<APIBaseInteraction<InteractionType.ApplicationCommandAutocomplete, Required<Pick<APIChatInputApplicationCommandInteractionData, options>>>, data>>

APIApplicationCommandBasicOption

APIApplicationCommandBooleanOption

APIApplicationCommandBooleanOption: APIApplicationCommandOptionBase<ApplicationCommandOptionType.Boolean>

APIApplicationCommandDMInteraction

APIApplicationCommandGuildInteraction

APIApplicationCommandIntegerOption

APIApplicationCommandIntegerOption: APIApplicationCommandOptionWithAutocompleteOrChoicesWrapper<APIApplicationCommandIntegerOptionBase, APIApplicationCommandOptionChoice<number>>

APIApplicationCommandInteraction

APIApplicationCommandInteractionData

APIApplicationCommandInteractionDataAttachmentOption

APIApplicationCommandInteractionDataAttachmentOption: APIInteractionDataOptionBase<ApplicationCommandOptionType.Attachment, Snowflake>

APIApplicationCommandInteractionDataBasicOption

APIApplicationCommandInteractionDataBooleanOption

APIApplicationCommandInteractionDataBooleanOption: APIInteractionDataOptionBase<ApplicationCommandOptionType.Boolean, boolean>

APIApplicationCommandInteractionDataChannelOption

APIApplicationCommandInteractionDataChannelOption: APIInteractionDataOptionBase<ApplicationCommandOptionType.Channel, Snowflake>

APIApplicationCommandInteractionDataMentionableOption

APIApplicationCommandInteractionDataMentionableOption: APIInteractionDataOptionBase<ApplicationCommandOptionType.Mentionable, Snowflake>

APIApplicationCommandInteractionDataOption

APIApplicationCommandInteractionDataRoleOption

APIApplicationCommandInteractionDataRoleOption: APIInteractionDataOptionBase<ApplicationCommandOptionType.Role, Snowflake>

APIApplicationCommandInteractionDataUserOption

APIApplicationCommandInteractionDataUserOption: APIInteractionDataOptionBase<ApplicationCommandOptionType.User, Snowflake>

APIApplicationCommandInteractionWrapper

APIApplicationCommandInteractionWrapper<Data>: APIBaseInteraction<InteractionType.ApplicationCommand, Data> & Required<Pick<APIBaseInteraction<InteractionType.ApplicationCommand, Data>, channel | channel_id | data | app_permissions>>

APIApplicationCommandMentionableOption

APIApplicationCommandMentionableOption: APIApplicationCommandOptionBase<ApplicationCommandOptionType.Mentionable>

APIApplicationCommandNumberOption

APIApplicationCommandNumberOption: APIApplicationCommandOptionWithAutocompleteOrChoicesWrapper<APIApplicationCommandNumberOptionBase, APIApplicationCommandOptionChoice<number>>

APIApplicationCommandOption

APIApplicationCommandOptionWithAutocompleteOrChoicesWrapper

APIApplicationCommandOptionWithAutocompleteOrChoicesWrapper<Base, ChoiceType>: (Base & { autocomplete: true; choices?: [] }) | (Base & { autocomplete?: false; choices?: ChoiceType[] })

APIApplicationCommandRoleOption

APIApplicationCommandRoleOption: APIApplicationCommandOptionBase<ApplicationCommandOptionType.Role>

APIApplicationCommandStringOption

APIApplicationCommandStringOption: APIApplicationCommandOptionWithAutocompleteOrChoicesWrapper<APIApplicationCommandStringOptionBase, APIApplicationCommandOptionChoice<string>>

APIApplicationCommandUserOption

APIApplicationCommandUserOption: APIApplicationCommandOptionBase<ApplicationCommandOptionType.User>

APIAuditLogChange

APIAuditLogChange: APIAuditLogChangeKeyName | APIAuditLogChangeKeyDescription | APIAuditLogChangeKeyIconHash | APIAuditLogChangeKeyImageHash | APIAuditLogChangeKeySplashHash | APIAuditLogChangeKeyDiscoverySplashHash | APIAuditLogChangeKeyBannerHash | APIAuditLogChangeKeyOwnerId | APIAuditLogChangeKeyRegion | APIAuditLogChangeKeyPreferredLocale | APIAuditLogChangeKeyAFKChannelId | APIAuditLogChangeKeyAFKTimeout | APIAuditLogChangeKeyRulesChannelId | APIAuditLogChangeKeyPublicUpdatesChannelId | APIAuditLogChangeKeyMFALevel | APIAuditLogChangeKeyVerificationLevel | APIAuditLogChangeKeyExplicitContentFilter | APIAuditLogChangeKeyDefaultMessageNotifications | APIAuditLogChangeKeyVanityURLCode | APIAuditLogChangeKey$Add | APIAuditLogChangeKey$Remove | APIAuditLogChangeKeyPruneDeleteDays | APIAuditLogChangeKeyWidgetEnabled | APIAuditLogChangeKeyWidgetChannelId | APIAuditLogChangeKeySystemChannelId | APIAuditLogChangeKeyPosition | APIAuditLogChangeKeyTopic | APIAuditLogChangeKeyBitrate | APIAuditLogChangeKeyPermissionOverwrites | APIAuditLogChangeKeyNSFW | APIAuditLogChangeKeyApplicationId | APIAuditLogChangeKeyRateLimitPerUser | APIAuditLogChangeKeyPermissions | APIAuditLogChangeKeyColor | APIAuditLogChangeKeyHoist | APIAuditLogChangeKeyMentionable | APIAuditLogChangeKeyAllow | APIAuditLogChangeKeyDeny | APIAuditLogChangeKeyCode | APIAuditLogChangeKeyChannelId | APIAuditLogChangeKeyInviterId | APIAuditLogChangeKeyMaxUses | APIAuditLogChangeKeyUses | APIAuditLogChangeKeyMaxAge | APIAuditLogChangeKeyTemporary | APIAuditLogChangeKeyDeaf | APIAuditLogChangeKeyMute | APIAuditLogChangeKeyNick | APIAuditLogChangeKeyAvatarHash | APIAuditLogChangeKeyId | APIAuditLogChangeKeyType | APIAuditLogChangeKeyEnableEmoticons | APIAuditLogChangeKeyExpireBehavior | APIAuditLogChangeKeyExpireGracePeriod | APIAuditLogChangeKeyUserLimit | APIAuditLogChangeKeyPrivacyLevel | APIAuditLogChangeKeyTags | APIAuditLogChangeKeyFormatType | APIAuditLogChangeKeyAsset | APIAuditLogChangeKeyAvailable | APIAuditLogChangeKeyGuildId | APIAuditLogChangeKeyArchived | APIAuditLogChangeKeyLocked | APIAuditLogChangeKeyAutoArchiveDuration | APIAuditLogChangeKeyDefaultAutoArchiveDuration | APIAuditLogChangeKeyEntityType | APIAuditLogChangeKeyStatus | APIAuditLogChangeKeyLocation | APIAuditLogChangeKeyCommunicationDisabledUntil | APIAuditLogChangeKeyTriggerType | APIAuditLogChangeKeyEventType | APIAuditLogChangeKeyTriggerMetadata | APIAuditLogChangeKeyActions | APIAuditLogChangeKeyEnabled | APIAuditLogChangeKeyExemptRoles | APIAuditLogChangeKeyExemptChannels

APIAuditLogChangeKey$Add

APIAuditLogChangeKey$Add: AuditLogChangeData<$add, APIRole[]>

Returned when new role(s) are added

APIAuditLogChangeKey$Remove

APIAuditLogChangeKey$Remove: AuditLogChangeData<$remove, APIRole[]>

Returned when role(s) are removed

APIAuditLogChangeKeyAFKChannelId

APIAuditLogChangeKeyAFKChannelId: AuditLogChangeData<afk_channel_id, Snowflake>

Returned when a guild’s afk_channel_id is changed

APIAuditLogChangeKeyAFKTimeout

APIAuditLogChangeKeyAFKTimeout: AuditLogChangeData<afk_timeout, number>

Returned when a guild’s afk_timeout is changed

APIAuditLogChangeKeyActions

APIAuditLogChangeKeyActions: AuditLogChangeData<actions, APIAutoModerationAction[]>

Returned when an auto moderation rule’s actions is changed

APIAuditLogChangeKeyAllow

APIAuditLogChangeKeyAllow: AuditLogChangeData<allow, string>

Returned when an overwrite’s allowed permissions bitfield is changed

APIAuditLogChangeKeyApplicationId

APIAuditLogChangeKeyApplicationId: AuditLogChangeData<application_id, Snowflake>

The application ID of the added or removed Webhook or Bot

APIAuditLogChangeKeyArchived

APIAuditLogChangeKeyArchived: AuditLogChangeData<archived, boolean>

Returned when a thread’s archive status is changed

APIAuditLogChangeKeyAsset

APIAuditLogChangeKeyAsset: AuditLogChangeData<asset, >

Empty string

APIAuditLogChangeKeyAutoArchiveDuration

APIAuditLogChangeKeyAutoArchiveDuration: AuditLogChangeData<auto_archive_duration, number>

Returned when a thread’s auto archive duration is changed

APIAuditLogChangeKeyAvailable

APIAuditLogChangeKeyAvailable: AuditLogChangeData<available, boolean>

Returned when a sticker’s availability is changed

APIAuditLogChangeKeyAvatarHash

APIAuditLogChangeKeyAvatarHash: AuditLogChangeData<avatar_hash, string>

Returned when a user’s avatar_hash is changed

APIAuditLogChangeKeyBannerHash

APIAuditLogChangeKeyBannerHash: AuditLogChangeData<banner_hash, string>

Returned when a guild’s banner hash is changed

APIAuditLogChangeKeyBitrate

APIAuditLogChangeKeyBitrate: AuditLogChangeData<bitrate, number>

Returned when a voice channel’s bitrate is changed

APIAuditLogChangeKeyChannelId

APIAuditLogChangeKeyChannelId: AuditLogChangeData<channel_id, Snowflake>

Returned when an invite’s or guild scheduled event’s channel_id is changed

APIAuditLogChangeKeyCode

APIAuditLogChangeKeyCode: AuditLogChangeData<code, string>

Returned when an invite’s code is changed

APIAuditLogChangeKeyColor

APIAuditLogChangeKeyColor: AuditLogChangeData<color, number>

Returned when a role’s color is changed

APIAuditLogChangeKeyCommunicationDisabledUntil

APIAuditLogChangeKeyCommunicationDisabledUntil: AuditLogChangeData<communication_disabled_until, string>

Returned when a user’s timeout is changed

APIAuditLogChangeKeyDeaf

APIAuditLogChangeKeyDeaf: AuditLogChangeData<deaf, boolean>

Returned when a user’s deaf status is changed

APIAuditLogChangeKeyDefaultAutoArchiveDuration

APIAuditLogChangeKeyDefaultAutoArchiveDuration: AuditLogChangeData<default_auto_archive_duration, number>

Returned when a channel’s default auto archive duration for newly created threads is changed

APIAuditLogChangeKeyDefaultMessageNotifications

APIAuditLogChangeKeyDefaultMessageNotifications: AuditLogChangeData<default_message_notifications, GuildDefaultMessageNotifications>

Returned when a guild’s default_message_notifications is changed

APIAuditLogChangeKeyDeny

APIAuditLogChangeKeyDeny: AuditLogChangeData<deny, string>

Returned when an overwrite’s denied permissions bitfield is changed

APIAuditLogChangeKeyDescription

APIAuditLogChangeKeyDescription: AuditLogChangeData<description, string>

Returned when a guild’s or sticker’s or guild scheduled event’s description is changed

APIAuditLogChangeKeyDiscoverySplashHash

APIAuditLogChangeKeyDiscoverySplashHash: AuditLogChangeData<discovery_splash_hash, string>

Returned when a guild’s discovery splash is changed

APIAuditLogChangeKeyEnableEmoticons

APIAuditLogChangeKeyEnableEmoticons: AuditLogChangeData<enable_emoticons, boolean>

Returned when an integration’s enable_emoticons is changed

APIAuditLogChangeKeyEnabled

APIAuditLogChangeKeyEnabled: AuditLogChangeData<enabled, boolean>

Returned when an auto moderation rule’s enabled status is changed

APIAuditLogChangeKeyEntityType

APIAuditLogChangeKeyEntityType: AuditLogChangeData<entity_type, GuildScheduledEventEntityType>

Returned when entity type of a guild scheduled event is changed

APIAuditLogChangeKeyEventType

APIAuditLogChangeKeyEventType: AuditLogChangeData<event_type, AutoModerationRuleEventType>

Returned when an auto moderation rule’s event type is changed

APIAuditLogChangeKeyExemptChannels

APIAuditLogChangeKeyExemptChannels: AuditLogChangeData<exempt_channels, Snowflake[]>

Returned when an auto moderation rule’s exempt channels is changed

APIAuditLogChangeKeyExemptRoles

APIAuditLogChangeKeyExemptRoles: AuditLogChangeData<exempt_roles, Snowflake[]>

Returned when an auto moderation rule’s exempt roles is changed

APIAuditLogChangeKeyExpireBehavior

APIAuditLogChangeKeyExpireBehavior: AuditLogChangeData<expire_behavior, IntegrationExpireBehavior>

Returned when an integration’s expire_behavior is changed

APIAuditLogChangeKeyExpireGracePeriod

APIAuditLogChangeKeyExpireGracePeriod: AuditLogChangeData<expire_grace_period, number>

Returned when an integration’s expire_grace_period is changed

APIAuditLogChangeKeyExplicitContentFilter

APIAuditLogChangeKeyExplicitContentFilter: AuditLogChangeData<explicit_content_filter, GuildExplicitContentFilter>

Returned when a guild’s explicit_content_filter is changed

APIAuditLogChangeKeyFormatType

APIAuditLogChangeKeyFormatType: AuditLogChangeData<format_type, StickerFormatType>

Returned when a sticker’s format_type is changed

APIAuditLogChangeKeyGuildId

APIAuditLogChangeKeyGuildId: AuditLogChangeData<guild_id, Snowflake>

Returned when a sticker’s guild_id is changed

APIAuditLogChangeKeyHoist

APIAuditLogChangeKeyHoist: AuditLogChangeData<hoist, boolean>

Returned when a role’s hoist status is changed

APIAuditLogChangeKeyIconHash

APIAuditLogChangeKeyIconHash: AuditLogChangeData<icon_hash, string>

Returned when a guild’s icon is changed

APIAuditLogChangeKeyId

APIAuditLogChangeKeyId: AuditLogChangeData<id, Snowflake>

The ID of the changed entity - sometimes used in conjunction with other keys

APIAuditLogChangeKeyImageHash

APIAuditLogChangeKeyImageHash: AuditLogChangeData<image_hash, string>

Returned when a guild’s scheduled event’s cover image is changed

APIAuditLogChangeKeyInviterId

APIAuditLogChangeKeyInviterId: AuditLogChangeData<inviter_id, Snowflake>

Returned when an invite’s inviter_id is changed

APIAuditLogChangeKeyLocation

APIAuditLogChangeKeyLocation: AuditLogChangeData<location, string>

Returned when location of a guild scheduled event is changed

APIAuditLogChangeKeyLocked

APIAuditLogChangeKeyLocked: AuditLogChangeData<locked, boolean>

Returned when a thread’s lock status is changed

APIAuditLogChangeKeyMFALevel

APIAuditLogChangeKeyMFALevel: AuditLogChangeData<mfa_level, GuildMFALevel>

Returned when a guild’s mfa_level is changed

APIAuditLogChangeKeyMaxAge

APIAuditLogChangeKeyMaxAge: AuditLogChangeData<max_age, number>

Returned when an invite’s max_age is changed

APIAuditLogChangeKeyMaxUses

APIAuditLogChangeKeyMaxUses: AuditLogChangeData<max_uses, number>

Returned when an invite’s max_uses is changed

APIAuditLogChangeKeyMentionable

APIAuditLogChangeKeyMentionable: AuditLogChangeData<mentionable, boolean>

Returned when a role’s mentionable status is changed

APIAuditLogChangeKeyMute

APIAuditLogChangeKeyMute: AuditLogChangeData<mute, boolean>

Returned when a user’s mute status is changed

APIAuditLogChangeKeyNSFW

APIAuditLogChangeKeyNSFW: AuditLogChangeData<nsfw, boolean>

Returned when a channel’s NSFW restriction is changed

APIAuditLogChangeKeyName

APIAuditLogChangeKeyName: AuditLogChangeData<name, string>

Returned when an entity’s name is changed

APIAuditLogChangeKeyNick

APIAuditLogChangeKeyNick: AuditLogChangeData<nick, string>

Returned when a user’s nick is changed

APIAuditLogChangeKeyOwnerId

APIAuditLogChangeKeyOwnerId: AuditLogChangeData<owner_id, Snowflake>

Returned when a guild’s owner_id is changed

APIAuditLogChangeKeyPermissionOverwrites

APIAuditLogChangeKeyPermissionOverwrites: AuditLogChangeData<permission_overwrites, APIOverwrite[]>

Returned when a channel’s permission overwrites is changed

APIAuditLogChangeKeyPermissions

APIAuditLogChangeKeyPermissions: AuditLogChangeData<permissions, string>

Returned when a permission bitfield is changed

APIAuditLogChangeKeyPosition

APIAuditLogChangeKeyPosition: AuditLogChangeData<position, number>

Returned when a channel’s position is changed

APIAuditLogChangeKeyPreferredLocale

APIAuditLogChangeKeyPreferredLocale: AuditLogChangeData<preferred_locale, string>

Returned when a guild’s preferred_locale is changed

APIAuditLogChangeKeyPrivacyLevel

APIAuditLogChangeKeyPrivacyLevel: AuditLogChangeData<privacy_level, StageInstancePrivacyLevel>

Returned when privacy level of a stage instance or guild scheduled event is changed

APIAuditLogChangeKeyPruneDeleteDays

APIAuditLogChangeKeyPruneDeleteDays: AuditLogChangeData<prune_delete_days, number>

Returned when there is a change in number of days after which inactive and role-unassigned members are kicked

APIAuditLogChangeKeyPublicUpdatesChannelId

APIAuditLogChangeKeyPublicUpdatesChannelId: AuditLogChangeData<public_updates_channel_id, string>

Returned when a guild’s public_updates_channel_id is changed

APIAuditLogChangeKeyRateLimitPerUser

APIAuditLogChangeKeyRateLimitPerUser: AuditLogChangeData<rate_limit_per_user, number>

Returned when a channel’s amount of seconds a user has to wait before sending another message is changed

APIAuditLogChangeKeyRegion

APIAuditLogChangeKeyRegion: AuditLogChangeData<region, string>

Returned when a guild’s region is changed

APIAuditLogChangeKeyRulesChannelId

APIAuditLogChangeKeyRulesChannelId: AuditLogChangeData<rules_channel_id, string>

Returned when a guild’s rules_channel_id is changed

APIAuditLogChangeKeySafetyAlertsChannelId

APIAuditLogChangeKeySafetyAlertsChannelId: AuditLogChangeData<safety_alerts_channel_id, string>

Returned when a guild’s safety_alerts_channel_id is changed

APIAuditLogChangeKeySnowflake

APIAuditLogChangeKeySnowflake: AuditLogChangeData<Snowflake, unknown>

Represents a change where the key is a snowflake. Currently, the only known instance of this is returned when permissions for a command were updated (

<insert name of object here>
)

APIAuditLogChangeKeySplashHash

APIAuditLogChangeKeySplashHash: AuditLogChangeData<splash_hash, string>

Returned when a guild’s splash is changed

APIAuditLogChangeKeyStatus

APIAuditLogChangeKeyStatus: AuditLogChangeData<status, GuildScheduledEventStatus>

Returned when status of a guild scheduled event is changed

APIAuditLogChangeKeySystemChannelId

APIAuditLogChangeKeySystemChannelId: AuditLogChangeData<system_channel_id, Snowflake>

Returned when a guild’s system_channel_id is changed

APIAuditLogChangeKeyTags

APIAuditLogChangeKeyTags: AuditLogChangeData<tags, string>

Returned when a sticker’s related emoji is changed

APIAuditLogChangeKeyTemporary

APIAuditLogChangeKeyTemporary: AuditLogChangeData<temporary, boolean>

Returned when an invite’s temporary status is changed

APIAuditLogChangeKeyTopic

APIAuditLogChangeKeyTopic: AuditLogChangeData<topic, string>

Returned when a channel’s topic is changed

APIAuditLogChangeKeyTriggerMetadata

APIAuditLogChangeKeyTriggerMetadata: AuditLogChangeData<trigger_metadata, APIAutoModerationRuleTriggerMetadata>

Returned when an auto moderation rule’s trigger metadata is changed

APIAuditLogChangeKeyTriggerType

APIAuditLogChangeKeyTriggerType: AuditLogChangeData<trigger_type, AutoModerationRuleTriggerType>

Returned when an auto moderation rule’s trigger type is changed (only in rule creation or deletion)

APIAuditLogChangeKeyType

APIAuditLogChangeKeyType: AuditLogChangeData<type, number | string>

The type of entity created

APIAuditLogChangeKeyUserLimit

APIAuditLogChangeKeyUserLimit: AuditLogChangeData<user_limit, number>

Returned when a voice channel’s user_limit is changed

APIAuditLogChangeKeyUses

APIAuditLogChangeKeyUses: AuditLogChangeData<uses, number>

Returned when an invite’s uses is changed

APIAuditLogChangeKeyVanityURLCode

APIAuditLogChangeKeyVanityURLCode: AuditLogChangeData<vanity_url_code, string>

Returned when a guild’s vanity_url_code is changed

APIAuditLogChangeKeyVerificationLevel

APIAuditLogChangeKeyVerificationLevel: AuditLogChangeData<verification_level, GuildVerificationLevel>

Returned when a guild’s verification_level is changed

APIAuditLogChangeKeyWidgetChannelId

APIAuditLogChangeKeyWidgetChannelId: AuditLogChangeData<widget_channel_id, Snowflake>

Returned when a guild’s widget_channel_id is changed

APIAuditLogChangeKeyWidgetEnabled

APIAuditLogChangeKeyWidgetEnabled: AuditLogChangeData<widget_enabled, boolean>

Returned when a guild’s widget is enabled

APIAutoPopulatedSelectMenuComponent

APIButtonComponent

APIChannel

APIChatInputApplicationCommandDMInteraction

APIChatInputApplicationCommandDMInteraction: APIDMInteractionWrapper<APIChatInputApplicationCommandInteraction>

APIChatInputApplicationCommandGuildInteraction

APIChatInputApplicationCommandGuildInteraction: APIGuildInteractionWrapper<APIChatInputApplicationCommandInteraction>

APIChatInputApplicationCommandInteraction

APIChatInputApplicationCommandInteractionDataResolved

APIChatInputApplicationCommandInteractionDataResolved: APIInteractionDataResolved
@deprecated

Renamed to APIInteractionDataResolved

APIContextMenuDMInteraction

APIContextMenuGuildInteraction

APIContextMenuInteraction

APIContextMenuInteractionData

APIDMInteraction

APIDMInteractionWrapper

APIDMInteractionWrapper<Original>: Omit<Original, member | guild_id> & Required<Pick<Original, user>>

Type parameters

APIGuildCategoryChannel

APIGuildCategoryChannel: APIGuildChannel<ChannelType.GuildCategory>

APIGuildChannelResolvable

APIGuildChannelResolvable: Exclude<APIChannel, APIDMChannel | APIGroupDMChannel>

APIGuildCreatePartialChannel

APIGuildCreatePartialChannel: StrictPartial<DistributivePick<APIGuildChannelResolvable, type | topic | nsfw | bitrate | user_limit | rate_limit_per_user | default_auto_archive_duration | position | rtc_region | video_quality_mode | flags | default_reaction_emoji | available_tags | default_sort_order | default_forum_layout | default_thread_rate_limit_per_user>> & { id?: number | string; name: string; parent_id?: number | string | null; permission_overwrites?: APIGuildCreateOverwrite[] }

APIGuildIntegrationType

APIGuildIntegrationType: twitch | youtube | discord | guild_subscription

APIGuildInteraction

APIGuildInteractionWrapper

APIGuildInteractionWrapper<Original>: Omit<Original, user> & Required<Pick<Original, member | guild_id>>

Type parameters

APIGuildMediaChannel

APIGuildMediaChannel: APIThreadOnlyChannel<ChannelType.GuildMedia>

APIGuildScheduledEvent

APIGuildStageVoiceChannel

APIGuildStageVoiceChannel: APIVoiceChannelBase<ChannelType.GuildStageVoice>

APIGuildVoiceChannel

APIGuildVoiceChannel: APIVoiceChannelBase<ChannelType.GuildVoice>

APIInteraction

APIInteractionDataResolvedChannel

APIInteractionDataResolvedChannel: APIInteractionDataResolvedChannelBase<Exclude<ChannelType, ThreadChannelType>> | (APIInteractionDataResolvedChannelBase<ThreadChannelType> & Pick<APIThreadChannel, thread_metadata | parent_id>)

APIInteractionResponse

APIInteractionResponseCallbackData

APIInteractionResponseCallbackData: Omit<RESTPostAPIWebhookWithTokenJSONBody, username | avatar_url> & { flags?: MessageFlags }

APIInviteGuild

APIInviteGuild: Pick<APIGuild, id | name | splash | banner | icon | vanity_url_code | description | features | verification_level | nsfw_level | premium_subscription_count>

APIMentionableSelectComponent

APIMentionableSelectComponent: APIBaseAutoPopulatedSelectMenuComponent<ComponentType.MentionableSelect, SelectMenuDefaultValueType.User | SelectMenuDefaultValueType.Role>

APIMessageActionRowComponent

APIMessageActionRowComponent: APIButtonComponent | APISelectMenuComponent

APIMessageApplicationCommandDMInteraction

APIMessageApplicationCommandDMInteraction: APIDMInteractionWrapper<APIMessageApplicationCommandInteraction>

APIMessageApplicationCommandGuildInteraction

APIMessageApplicationCommandGuildInteraction: APIGuildInteractionWrapper<APIMessageApplicationCommandInteraction>

APIMessageApplicationCommandInteraction

APIMessageButtonInteractionData

APIMessageButtonInteractionData: APIMessageComponentBaseInteractionData<ComponentType.Button>

APIMessageComponent

APIMessageComponentButtonInteraction

APIMessageComponentButtonInteraction: APIBaseInteraction<InteractionType.MessageComponent, APIMessageButtonInteractionData> & Required<Pick<APIBaseInteraction<InteractionType.MessageComponent, APIMessageButtonInteractionData>, channel | channel_id | data | app_permissions | message>>

APIMessageComponentDMInteraction

APIMessageComponentDMInteraction: APIDMInteractionWrapper<APIMessageComponentInteraction>

APIMessageComponentGuildInteraction

APIMessageComponentGuildInteraction: APIGuildInteractionWrapper<APIMessageComponentInteraction>

APIMessageComponentInteraction

APIMessageComponentInteraction: APIBaseInteraction<InteractionType.MessageComponent, APIMessageComponentInteractionData> & Required<Pick<APIBaseInteraction<InteractionType.MessageComponent, APIMessageComponentInteractionData>, channel | channel_id | data | app_permissions | message>>

APIMessageComponentInteractionData

APIMessageComponentSelectMenuInteraction

APIMessageComponentSelectMenuInteraction: APIBaseInteraction<InteractionType.MessageComponent, APIMessageSelectMenuInteractionData> & Required<Pick<APIBaseInteraction<InteractionType.MessageComponent, APIMessageSelectMenuInteractionData>, channel | channel_id | data | app_permissions | message>>

APIMessageReferenceSend

APIMessageReferenceSend: StrictPartial<APIMessageReference> & AddUndefinedToPossiblyUndefinedPropertiesOfInterface<Required<Pick<APIMessageReference, message_id>>> & { fail_if_not_exists?: boolean }

APIMessageSelectMenuInteractionData

APIModalActionRowComponent

APIModalActionRowComponent: APITextInputComponent

APIModalComponent

APIModalSubmitDMInteraction

APIModalSubmitGuildInteraction

APIModalSubmitGuildInteraction: APIGuildInteractionWrapper<APIModalSubmitInteraction>

APIModalSubmitInteraction

APIModalSubmitInteraction: APIBaseInteraction<InteractionType.ModalSubmit, APIModalSubmission> & Required<Pick<APIBaseInteraction<InteractionType.ModalSubmit, APIModalSubmission>, data>>

APINewsChannel

APINewsChannel: APIGuildTextChannel<ChannelType.GuildAnnouncement>

APIPingInteraction

APIPingInteraction: Omit<APIBaseInteraction<InteractionType.Ping, never>, locale>

APIRoleSelectComponent

APIRoleSelectComponent: APIBaseAutoPopulatedSelectMenuComponent<ComponentType.RoleSelect, SelectMenuDefaultValueType.Role>

APISelectMenuComponent

APIStickerItem

APIStickerItem: Pick<APISticker, id | name | format_type>

APITextChannel

APITextChannel: APIGuildTextChannel<ChannelType.GuildText>

APIUserApplicationCommandDMInteraction

APIUserApplicationCommandDMInteraction: APIDMInteractionWrapper<APIUserApplicationCommandInteraction>

APIUserApplicationCommandGuildInteraction

APIUserApplicationCommandGuildInteraction: APIGuildInteractionWrapper<APIUserApplicationCommandInteraction>

APIUserApplicationCommandInteraction

APIUserApplicationCommandInteractionDataResolved

APIUserApplicationCommandInteractionDataResolved: APIUserInteractionDataResolved
@deprecated

Renamed to APIUserInteractionDataResolved

APIUserInteractionDataResolved

APIUserInteractionDataResolved: Required<Pick<APIInteractionDataResolved, users>> & Pick<APIInteractionDataResolved, members>

users and optional members from APIInteractionDataResolved, for user commands and user selects

APIUserSelectComponent

APIUserSelectComponent: APIBaseAutoPopulatedSelectMenuComponent<ComponentType.UserSelect, SelectMenuDefaultValueType.User>

AchievementIconFormat

AchievementIconFormat: Exclude<ImageFormat, ImageFormat.Lottie | ImageFormat.GIF>

ApplicationAssetFormat

ApplicationAssetFormat: Exclude<ImageFormat, ImageFormat.Lottie | ImageFormat.GIF>

ApplicationCoverFormat

ApplicationCoverFormat: Exclude<ImageFormat, ImageFormat.Lottie | ImageFormat.GIF>

ApplicationIconFormat

ApplicationIconFormat: Exclude<ImageFormat, ImageFormat.Lottie | ImageFormat.GIF>

AuditLogRuleTriggerType

AuditLogRuleTriggerType: `${AutoModerationRuleTriggerType}`

DefaultUserAvatar

DefaultUserAvatar: Extract<ImageFormat, ImageFormat.PNG>

DefaultUserAvatarAssets

DefaultUserAvatarAssets: 0 | 1 | 2 | 3 | 4 | 5

EmojiFormat

EmojiFormat: Exclude<ImageFormat, ImageFormat.Lottie>

GatewayActivityAssets

GatewayActivityAssets: Partial<Record<large_image | large_text | small_image | small_text, string>>

GatewayActivityEmoji

GatewayActivityEmoji: Partial<Pick<APIEmoji, id | animated>> & Pick<APIEmoji, name>

GatewayActivitySecrets

GatewayActivitySecrets: Partial<Record<join | spectate | match, string>>

GatewayActivityUpdateData

GatewayActivityUpdateData: Pick<GatewayActivity, name | state | type | url>

GatewayApplicationCommandPermissionsUpdateDispatch

GatewayApplicationCommandPermissionsUpdateDispatch: DataPayload<GatewayDispatchEvents.ApplicationCommandPermissionsUpdate, GatewayApplicationCommandPermissionsUpdateDispatchData>

GatewayAutoModerationActionExecutionDispatch

GatewayAutoModerationActionExecutionDispatch: DataPayload<GatewayDispatchEvents.AutoModerationActionExecution, GatewayAutoModerationActionExecutionDispatchData>

GatewayAutoModerationRuleCreateDispatch

GatewayAutoModerationRuleCreateDispatch: GatewayAutoModerationRuleModifyDispatch

GatewayAutoModerationRuleCreateDispatchData

GatewayAutoModerationRuleCreateDispatchData: GatewayAutoModerationRuleModifyDispatchData

GatewayAutoModerationRuleDeleteDispatch

GatewayAutoModerationRuleDeleteDispatch: GatewayAutoModerationRuleModifyDispatch

GatewayAutoModerationRuleDeleteDispatchData

GatewayAutoModerationRuleDeleteDispatchData: GatewayAutoModerationRuleModifyDispatchData

GatewayAutoModerationRuleModifyDispatch

GatewayAutoModerationRuleModifyDispatch: DataPayload<GatewayDispatchEvents.AutoModerationRuleCreate | GatewayDispatchEvents.AutoModerationRuleUpdate | GatewayDispatchEvents.AutoModerationRuleDelete, GatewayAutoModerationRuleModifyDispatchData>

GatewayAutoModerationRuleModifyDispatchData

GatewayAutoModerationRuleModifyDispatchData: APIAutoModerationRule

GatewayAutoModerationRuleUpdateDispatch

GatewayAutoModerationRuleUpdateDispatch: GatewayAutoModerationRuleModifyDispatch

GatewayAutoModerationRuleUpdateDispatchData

GatewayAutoModerationRuleUpdateDispatchData: GatewayAutoModerationRuleModifyDispatchData

GatewayChannelCreateDispatch

GatewayChannelCreateDispatch: GatewayChannelModifyDispatch

GatewayChannelCreateDispatchData

GatewayChannelCreateDispatchData: GatewayChannelModifyDispatchData

GatewayChannelDeleteDispatch

GatewayChannelDeleteDispatch: GatewayChannelModifyDispatch

GatewayChannelDeleteDispatchData

GatewayChannelDeleteDispatchData: GatewayChannelModifyDispatchData

GatewayChannelModifyDispatch

GatewayChannelModifyDispatch: DataPayload<GatewayDispatchEvents.ChannelCreate | GatewayDispatchEvents.ChannelDelete | GatewayDispatchEvents.ChannelUpdate, GatewayChannelModifyDispatchData>

GatewayChannelModifyDispatchData

GatewayChannelModifyDispatchData: APIChannel

GatewayChannelPinsUpdateDispatch

GatewayChannelPinsUpdateDispatch: DataPayload<GatewayDispatchEvents.ChannelPinsUpdate, GatewayChannelPinsUpdateDispatchData>

GatewayChannelUpdateDispatch

GatewayChannelUpdateDispatch: GatewayChannelModifyDispatch

GatewayChannelUpdateDispatchData

GatewayChannelUpdateDispatchData: GatewayChannelModifyDispatchData

GatewayDispatchPayload

GatewayDispatchPayload: GatewayAutoModerationRuleModifyDispatch | GatewayAutoModerationRuleCreateDispatch | GatewayAutoModerationRuleDeleteDispatch | GatewayAutoModerationActionExecutionDispatch | GatewayApplicationCommandPermissionsUpdateDispatch | GatewayChannelModifyDispatch | GatewayChannelPinsUpdateDispatch | GatewayGuildBanModifyDispatch | GatewayGuildCreateDispatch | GatewayGuildDeleteDispatch | GatewayGuildEmojisUpdateDispatch | GatewayGuildIntegrationsUpdateDispatch | GatewayGuildMemberAddDispatch | GatewayGuildMemberRemoveDispatch | GatewayGuildMembersChunkDispatch | GatewayGuildMemberUpdateDispatch | GatewayGuildModifyDispatch | GatewayGuildRoleDeleteDispatch | GatewayGuildRoleModifyDispatch | GatewayGuildScheduledEventCreateDispatch | GatewayGuildScheduledEventUpdateDispatch | GatewayGuildScheduledEventDeleteDispatch | GatewayGuildScheduledEventUserAddDispatch | GatewayGuildScheduledEventUserRemoveDispatch | GatewayGuildStickersUpdateDispatch | GatewayIntegrationCreateDispatch | GatewayIntegrationDeleteDispatch | GatewayIntegrationUpdateDispatch | GatewayInteractionCreateDispatch | GatewayInviteCreateDispatch | GatewayInviteDeleteDispatch | GatewayMessageCreateDispatch | GatewayMessageDeleteBulkDispatch | GatewayMessageDeleteDispatch | GatewayMessageReactionAddDispatch | GatewayMessageReactionRemoveAllDispatch | GatewayMessageReactionRemoveDispatch | GatewayMessageReactionRemoveEmojiDispatch | GatewayMessageUpdateDispatch | GatewayPresenceUpdateDispatch | GatewayStageInstanceCreateDispatch | GatewayStageInstanceDeleteDispatch | GatewayStageInstanceUpdateDispatch | GatewayReadyDispatch | GatewayResumedDispatch | GatewayThreadListSyncDispatch | GatewayThreadMembersUpdateDispatch | GatewayThreadMemberUpdateDispatch | GatewayThreadModifyDispatch | GatewayTypingStartDispatch | GatewayUserUpdateDispatch | GatewayVoiceServerUpdateDispatch | GatewayVoiceStateUpdateDispatch | GatewayWebhooksUpdateDispatch | GatewayGuildAuditLogEntryCreateDispatch

GatewayGuildAuditLogEntryCreateDispatch

GatewayGuildAuditLogEntryCreateDispatch: DataPayload<GatewayDispatchEvents.GuildAuditLogEntryCreate, GatewayGuildAuditLogEntryCreateDispatchData>

GatewayGuildBanAddDispatch

GatewayGuildBanAddDispatch: GatewayGuildBanModifyDispatch

GatewayGuildBanAddDispatchData

GatewayGuildBanAddDispatchData: GatewayGuildBanModifyDispatchData

GatewayGuildBanModifyDispatch

GatewayGuildBanModifyDispatch: DataPayload<GatewayDispatchEvents.GuildBanAdd | GatewayDispatchEvents.GuildBanRemove, GatewayGuildBanModifyDispatchData>

GatewayGuildBanRemoveDispatch

GatewayGuildBanRemoveDispatch: GatewayGuildBanModifyDispatch

GatewayGuildBanRemoveDispatchData

GatewayGuildBanRemoveDispatchData: GatewayGuildBanModifyDispatchData

GatewayGuildCreateDispatch

GatewayGuildCreateDispatch: DataPayload<GatewayDispatchEvents.GuildCreate, GatewayGuildCreateDispatchData>

GatewayGuildDeleteDispatch

GatewayGuildDeleteDispatch: DataPayload<GatewayDispatchEvents.GuildDelete, GatewayGuildDeleteDispatchData>

GatewayGuildDeleteDispatchData

GatewayGuildDeleteDispatchData: APIUnavailableGuild

GatewayGuildEmojisUpdateDispatch

GatewayGuildEmojisUpdateDispatch: DataPayload<GatewayDispatchEvents.GuildEmojisUpdate, GatewayGuildEmojisUpdateDispatchData>

GatewayGuildIntegrationsUpdateDispatch

GatewayGuildIntegrationsUpdateDispatch: DataPayload<GatewayDispatchEvents.GuildIntegrationsUpdate, GatewayGuildIntegrationsUpdateDispatchData>

GatewayGuildMemberAddDispatch

GatewayGuildMemberAddDispatch: DataPayload<GatewayDispatchEvents.GuildMemberAdd, GatewayGuildMemberAddDispatchData>

GatewayGuildMemberRemoveDispatch

GatewayGuildMemberRemoveDispatch: DataPayload<GatewayDispatchEvents.GuildMemberRemove, GatewayGuildMemberRemoveDispatchData>

GatewayGuildMemberUpdateDispatch

GatewayGuildMemberUpdateDispatch: DataPayload<GatewayDispatchEvents.GuildMemberUpdate, GatewayGuildMemberUpdateDispatchData>

GatewayGuildMemberUpdateDispatchData

GatewayGuildMemberUpdateDispatchData: Omit<APIGuildMember, deaf | mute | user | joined_at> & Partial<Pick<APIGuildMember, deaf | mute>> & Required<Pick<APIGuildMember, user>> & Nullable<Pick<APIGuildMember, joined_at>> & { guild_id: Snowflake }

GatewayGuildMembersChunkDispatch

GatewayGuildMembersChunkDispatch: DataPayload<GatewayDispatchEvents.GuildMembersChunk, GatewayGuildMembersChunkDispatchData>

GatewayGuildMembersChunkPresence

GatewayGuildMembersChunkPresence: Omit<RawGatewayPresenceUpdate, guild_id>

GatewayGuildModifyDispatch

GatewayGuildModifyDispatch: DataPayload<GatewayDispatchEvents.GuildUpdate, GatewayGuildModifyDispatchData>

GatewayGuildModifyDispatchData

GatewayGuildModifyDispatchData: APIGuild

GatewayGuildRoleCreateDispatch

GatewayGuildRoleCreateDispatch: GatewayGuildRoleModifyDispatch

GatewayGuildRoleCreateDispatchData

GatewayGuildRoleCreateDispatchData: GatewayGuildRoleModifyDispatchData

GatewayGuildRoleDeleteDispatch

GatewayGuildRoleDeleteDispatch: DataPayload<GatewayDispatchEvents.GuildRoleDelete, GatewayGuildRoleDeleteDispatchData>

GatewayGuildRoleModifyDispatch

GatewayGuildRoleModifyDispatch: DataPayload<GatewayDispatchEvents.GuildRoleCreate | GatewayDispatchEvents.GuildRoleUpdate, GatewayGuildRoleModifyDispatchData>

GatewayGuildRoleUpdateDispatch

GatewayGuildRoleUpdateDispatch: GatewayGuildRoleModifyDispatch

GatewayGuildRoleUpdateDispatchData

GatewayGuildRoleUpdateDispatchData: GatewayGuildRoleModifyDispatchData

GatewayGuildScheduledEventCreateDispatch

GatewayGuildScheduledEventCreateDispatch: DataPayload<GatewayDispatchEvents.GuildScheduledEventCreate, GatewayGuildScheduledEventCreateDispatchData>

GatewayGuildScheduledEventCreateDispatchData

GatewayGuildScheduledEventCreateDispatchData: APIGuildScheduledEvent

GatewayGuildScheduledEventDeleteDispatch

GatewayGuildScheduledEventDeleteDispatch: DataPayload<GatewayDispatchEvents.GuildScheduledEventDelete, GatewayGuildScheduledEventDeleteDispatchData>

GatewayGuildScheduledEventDeleteDispatchData

GatewayGuildScheduledEventDeleteDispatchData: APIGuildScheduledEvent

GatewayGuildScheduledEventUpdateDispatch

GatewayGuildScheduledEventUpdateDispatch: DataPayload<GatewayDispatchEvents.GuildScheduledEventUpdate, GatewayGuildScheduledEventUpdateDispatchData>

GatewayGuildScheduledEventUpdateDispatchData

GatewayGuildScheduledEventUpdateDispatchData: APIGuildScheduledEvent

GatewayGuildScheduledEventUserAddDispatch

GatewayGuildScheduledEventUserAddDispatch: DataPayload<GatewayDispatchEvents.GuildScheduledEventUserAdd, GatewayGuildScheduledEventUserAddDispatchData>

GatewayGuildScheduledEventUserRemoveDispatch

GatewayGuildScheduledEventUserRemoveDispatch: DataPayload<GatewayDispatchEvents.GuildScheduledEventUserRemove, GatewayGuildScheduledEventUserAddDispatchData>

GatewayGuildStickersUpdateDispatch

GatewayGuildStickersUpdateDispatch: DataPayload<GatewayDispatchEvents.GuildStickersUpdate, GatewayGuildStickersUpdateDispatchData>

GatewayGuildUpdateDispatch

GatewayGuildUpdateDispatch: GatewayGuildModifyDispatch

GatewayGuildUpdateDispatchData

GatewayGuildUpdateDispatchData: GatewayGuildModifyDispatchData

GatewayHeartbeatData

GatewayHeartbeatData: number | null

GatewayIntegrationCreateDispatch

GatewayIntegrationCreateDispatch: DataPayload<GatewayDispatchEvents.IntegrationCreate, GatewayIntegrationCreateDispatchData>

GatewayIntegrationCreateDispatchData

GatewayIntegrationCreateDispatchData: APIGuildIntegration & { guild_id: Snowflake }

GatewayIntegrationDeleteDispatch

GatewayIntegrationDeleteDispatch: DataPayload<GatewayDispatchEvents.IntegrationDelete, GatewayIntegrationDeleteDispatchData>

GatewayIntegrationUpdateDispatch

GatewayIntegrationUpdateDispatch: DataPayload<GatewayDispatchEvents.IntegrationUpdate, GatewayIntegrationUpdateDispatchData>

GatewayIntegrationUpdateDispatchData

GatewayIntegrationUpdateDispatchData: APIGuildIntegration & { guild_id: Snowflake }

GatewayInteractionCreateDispatch

GatewayInteractionCreateDispatch: DataPayload<GatewayDispatchEvents.InteractionCreate, GatewayInteractionCreateDispatchData>

GatewayInteractionCreateDispatchData

GatewayInteractionCreateDispatchData: APIInteraction

GatewayInvalidSessionData

GatewayInvalidSessionData: boolean

GatewayInviteCreateDispatch

GatewayInviteCreateDispatch: DataPayload<GatewayDispatchEvents.InviteCreate, GatewayInviteCreateDispatchData>

GatewayInviteDeleteDispatch

GatewayInviteDeleteDispatch: DataPayload<GatewayDispatchEvents.InviteDelete, GatewayInviteDeleteDispatchData>

GatewayMessageCreateDispatch

GatewayMessageCreateDispatch: DataPayload<GatewayDispatchEvents.MessageCreate, GatewayMessageCreateDispatchData>

GatewayMessageCreateDispatchData

GatewayMessageCreateDispatchData: Omit<APIMessage, mentions> & GatewayMessageEventExtraFields

GatewayMessageDeleteBulkDispatch

GatewayMessageDeleteBulkDispatch: DataPayload<GatewayDispatchEvents.MessageDeleteBulk, GatewayMessageDeleteBulkDispatchData>

GatewayMessageDeleteDispatch

GatewayMessageDeleteDispatch: DataPayload<GatewayDispatchEvents.MessageDelete, GatewayMessageDeleteDispatchData>

GatewayMessageReactionAddDispatch

GatewayMessageReactionAddDispatch: ReactionData<GatewayDispatchEvents.MessageReactionAdd>

GatewayMessageReactionAddDispatchData

GatewayMessageReactionAddDispatchData: GatewayMessageReactionAddDispatch[d]

GatewayMessageReactionRemoveAllDispatch

GatewayMessageReactionRemoveAllDispatch: DataPayload<GatewayDispatchEvents.MessageReactionRemoveAll, GatewayMessageReactionRemoveAllDispatchData>

GatewayMessageReactionRemoveAllDispatchData

GatewayMessageReactionRemoveAllDispatchData: MessageReactionRemoveData

GatewayMessageReactionRemoveDispatch

GatewayMessageReactionRemoveDispatch: ReactionData<GatewayDispatchEvents.MessageReactionRemove, member | message_author_id>

GatewayMessageReactionRemoveDispatchData

GatewayMessageReactionRemoveDispatchData: GatewayMessageReactionRemoveDispatch[d]

GatewayMessageReactionRemoveEmojiDispatch

GatewayMessageReactionRemoveEmojiDispatch: DataPayload<GatewayDispatchEvents.MessageReactionRemoveEmoji, GatewayMessageReactionRemoveEmojiDispatchData>

GatewayMessageUpdateDispatch

GatewayMessageUpdateDispatch: DataPayload<GatewayDispatchEvents.MessageUpdate, GatewayMessageUpdateDispatchData>

GatewayMessageUpdateDispatchData

GatewayMessageUpdateDispatchData: Omit<Partial<APIMessage>, mentions> & GatewayMessageEventExtraFields & { channel_id: Snowflake; id: Snowflake }

GatewayPresenceUpdateDispatch

GatewayPresenceUpdateDispatch: DataPayload<GatewayDispatchEvents.PresenceUpdate, GatewayPresenceUpdateDispatchData>

GatewayPresenceUpdateDispatchData

GatewayPresenceUpdateDispatchData: RawGatewayPresenceUpdate

GatewayReadyDispatch

GatewayReadyDispatch: DataPayload<GatewayDispatchEvents.Ready, GatewayReadyDispatchData>

GatewayReceivePayload

GatewayRequestGuildMembersData

GatewayResumedDispatch

GatewayResumedDispatch: DataPayload<GatewayDispatchEvents.Resumed, never>

GatewaySendPayload

GatewayStageInstanceCreateDispatch

GatewayStageInstanceCreateDispatch: DataPayload<GatewayDispatchEvents.StageInstanceCreate, GatewayStageInstanceCreateDispatchData>

GatewayStageInstanceCreateDispatchData

GatewayStageInstanceCreateDispatchData: APIStageInstance

GatewayStageInstanceDeleteDispatch

GatewayStageInstanceDeleteDispatch: DataPayload<GatewayDispatchEvents.StageInstanceDelete, GatewayStageInstanceDeleteDispatchData>

GatewayStageInstanceDeleteDispatchData

GatewayStageInstanceDeleteDispatchData: APIStageInstance

GatewayStageInstanceUpdateDispatch

GatewayStageInstanceUpdateDispatch: DataPayload<GatewayDispatchEvents.StageInstanceUpdate, GatewayStageInstanceUpdateDispatchData>

GatewayStageInstanceUpdateDispatchData

GatewayStageInstanceUpdateDispatchData: APIStageInstance

GatewayThreadCreateDispatch

GatewayThreadCreateDispatch: GatewayChannelModifyDispatch

GatewayThreadDeleteDispatch

GatewayThreadDeleteDispatch: GatewayChannelModifyDispatch

GatewayThreadDeleteDispatchData

GatewayThreadDeleteDispatchData: GatewayChannelModifyDispatchData

GatewayThreadListSyncDispatch

GatewayThreadListSyncDispatch: DataPayload<GatewayDispatchEvents.ThreadListSync, GatewayThreadListSyncDispatchData>

GatewayThreadListSyncDispatchData

GatewayThreadListSyncDispatchData: RawGatewayThreadListSync

GatewayThreadMemberUpdateDispatch

GatewayThreadMemberUpdateDispatch: DataPayload<GatewayDispatchEvents.ThreadMemberUpdate, GatewayThreadMemberUpdateDispatchData>

GatewayThreadMemberUpdateDispatchData

GatewayThreadMemberUpdateDispatchData: APIThreadMember & { guild_id: Snowflake }

GatewayThreadMembersUpdateDispatch

GatewayThreadMembersUpdateDispatch: DataPayload<GatewayDispatchEvents.ThreadMembersUpdate, GatewayThreadMembersUpdateDispatchData>

GatewayThreadMembersUpdateDispatchData

GatewayThreadMembersUpdateDispatchData: RawGatewayThreadMembersUpdate

GatewayThreadModifyDispatch

GatewayThreadModifyDispatch: DataPayload<GatewayDispatchEvents.ThreadCreate | GatewayDispatchEvents.ThreadDelete | GatewayDispatchEvents.ThreadUpdate, GatewayChannelModifyDispatchData>

GatewayThreadUpdateDispatch

GatewayThreadUpdateDispatch: GatewayChannelModifyDispatch

GatewayThreadUpdateDispatchData

GatewayThreadUpdateDispatchData: GatewayChannelModifyDispatchData

GatewayTypingStartDispatch

GatewayTypingStartDispatch: DataPayload<GatewayDispatchEvents.TypingStart, GatewayTypingStartDispatchData>

GatewayUserUpdateDispatch

GatewayUserUpdateDispatch: DataPayload<GatewayDispatchEvents.UserUpdate, GatewayUserUpdateDispatchData>

GatewayUserUpdateDispatchData

GatewayUserUpdateDispatchData: APIUser

GatewayVoiceServerUpdateDispatch

GatewayVoiceServerUpdateDispatch: DataPayload<GatewayDispatchEvents.VoiceServerUpdate, GatewayVoiceServerUpdateDispatchData>

GatewayVoiceStateUpdateDispatch

GatewayVoiceStateUpdateDispatch: DataPayload<GatewayDispatchEvents.VoiceStateUpdate, GatewayVoiceStateUpdateDispatchData>

GatewayVoiceStateUpdateDispatchData

GatewayVoiceStateUpdateDispatchData: GatewayVoiceState

GatewayWebhooksUpdateDispatch

GatewayWebhooksUpdateDispatch: DataPayload<GatewayDispatchEvents.WebhooksUpdate, GatewayWebhooksUpdateDispatchData>

GetAPIVoiceRegionsResult

GetAPIVoiceRegionsResult: RESTGetAPIVoiceRegionsResult
@deprecated

This was exported with the wrong name, use RESTGetAPIVoiceRegionsResult instead

GuildBannerFormat

GuildBannerFormat: Exclude<ImageFormat, ImageFormat.Lottie>

GuildChannelType

GuildChannelType: Exclude<ChannelType, ChannelType.DM | ChannelType.GroupDM>

GuildDiscoverySplashFormat

GuildDiscoverySplashFormat: Exclude<ImageFormat, ImageFormat.Lottie | ImageFormat.GIF>

GuildIconFormat

GuildIconFormat: Exclude<ImageFormat, ImageFormat.Lottie>

GuildMemberAvatarFormat

GuildMemberAvatarFormat: Exclude<ImageFormat, ImageFormat.Lottie>

GuildMemberBannerFormat

GuildMemberBannerFormat: Exclude<ImageFormat, ImageFormat.Lottie>

GuildScheduledEventCoverFormat

GuildScheduledEventCoverFormat: Exclude<ImageFormat, ImageFormat.Lottie | ImageFormat.GIF>

GuildSplashFormat

GuildSplashFormat: Exclude<ImageFormat, ImageFormat.Lottie | ImageFormat.GIF>

GuildTextChannelType

GuildTextChannelType: Exclude<TextChannelType, ChannelType.DM | ChannelType.GroupDM>

PartialAPIMessageInteractionGuildMember

PartialAPIMessageInteractionGuildMember: Pick<APIGuildMember, roles | premium_since | pending | nick | mute | joined_at | deaf | communication_disabled_until | avatar>

PresenceUpdateReceiveStatus

PresenceUpdateReceiveStatus: Exclude<PresenceUpdateStatus, PresenceUpdateStatus.Invisible>

RESTDeleteAPIAutoModerationRuleResult

RESTDeleteAPIAutoModerationRuleResult: never

RESTDeleteAPIChannelAllMessageReactionsResult

RESTDeleteAPIChannelAllMessageReactionsResult: never

RESTDeleteAPIChannelMessageOwnReaction

RESTDeleteAPIChannelMessageOwnReaction: never

RESTDeleteAPIChannelMessageReactionResult

RESTDeleteAPIChannelMessageReactionResult: never

RESTDeleteAPIChannelMessageResult

RESTDeleteAPIChannelMessageResult: never

RESTDeleteAPIChannelMessageUserReactionResult

RESTDeleteAPIChannelMessageUserReactionResult: never

RESTDeleteAPIChannelPermissionResult

RESTDeleteAPIChannelPermissionResult: never

RESTDeleteAPIChannelPinResult

RESTDeleteAPIChannelPinResult: never

RESTDeleteAPIChannelRecipientResult

RESTDeleteAPIChannelRecipientResult: unknown

RESTDeleteAPIChannelResult

RESTDeleteAPIChannelResult: APIChannel

RESTDeleteAPIChannelThreadMembersResult

RESTDeleteAPIChannelThreadMembersResult: never

RESTDeleteAPICurrentUserGuildResult

RESTDeleteAPICurrentUserGuildResult: never

RESTDeleteAPIGuildBanResult

RESTDeleteAPIGuildBanResult: never

RESTDeleteAPIGuildEmojiResult

RESTDeleteAPIGuildEmojiResult: never

RESTDeleteAPIGuildIntegrationResult

RESTDeleteAPIGuildIntegrationResult: never

RESTDeleteAPIGuildMemberResult

RESTDeleteAPIGuildMemberResult: never

RESTDeleteAPIGuildMemberRoleResult

RESTDeleteAPIGuildMemberRoleResult: never

RESTDeleteAPIGuildResult

RESTDeleteAPIGuildResult: never

RESTDeleteAPIGuildRoleResult

RESTDeleteAPIGuildRoleResult: never

RESTDeleteAPIGuildScheduledEventResult

RESTDeleteAPIGuildScheduledEventResult: never

RESTDeleteAPIGuildStickerResult

RESTDeleteAPIGuildStickerResult: never

RESTDeleteAPIGuildTemplateResult

RESTDeleteAPIGuildTemplateResult: APITemplate

RESTDeleteAPIInteractionFollowupResult

RESTDeleteAPIInteractionFollowupResult: RESTDeleteAPIWebhookWithTokenMessageResult

RESTDeleteAPIInteractionOriginalResponseResult

RESTDeleteAPIInteractionOriginalResponseResult: RESTDeleteAPIWebhookWithTokenMessageResult

RESTDeleteAPIInviteResult

RESTDeleteAPIInviteResult: APIInvite

RESTDeleteAPIStageInstanceResult

RESTDeleteAPIStageInstanceResult: never

RESTDeleteAPIWebhookResult

RESTDeleteAPIWebhookResult: never

RESTDeleteAPIWebhookWithTokenMessageResult

RESTDeleteAPIWebhookWithTokenMessageResult: never

RESTDeleteAPIWebhookWithTokenResult

RESTDeleteAPIWebhookWithTokenResult: never

RESTGetAPIApplicationCommandPermissionsResult

RESTGetAPIApplicationCommandPermissionsResult: APIGuildApplicationCommandPermissions

RESTGetAPIApplicationCommandResult

RESTGetAPIApplicationCommandResult: APIApplicationCommand

RESTGetAPIApplicationCommandsResult

RESTGetAPIApplicationCommandsResult: APIApplicationCommand[]

RESTGetAPIApplicationGuildCommandResult

RESTGetAPIApplicationGuildCommandResult: Omit<APIApplicationCommand, dm_permission>

RESTGetAPIApplicationGuildCommandsQuery

RESTGetAPIApplicationGuildCommandsQuery: RESTGetAPIApplicationCommandsQuery

RESTGetAPIApplicationGuildCommandsResult

RESTGetAPIApplicationGuildCommandsResult: Omit<APIApplicationCommand, dm_permission>[]

RESTGetAPIApplicationRoleConnectionMetadataResult

RESTGetAPIApplicationRoleConnectionMetadataResult: APIApplicationRoleConnectionMetadata[]

RESTGetAPIAuditLogResult

RESTGetAPIAuditLogResult: APIAuditLog

RESTGetAPIAutoModerationRuleResult

RESTGetAPIAutoModerationRuleResult: APIAutoModerationRule

RESTGetAPIAutoModerationRulesResult

RESTGetAPIAutoModerationRulesResult: APIAutoModerationRule[]

RESTGetAPIChannelInvitesResult

RESTGetAPIChannelInvitesResult: APIExtendedInvite[]

RESTGetAPIChannelMessageReactionUsersResult

RESTGetAPIChannelMessageReactionUsersResult: APIUser[]

RESTGetAPIChannelMessageResult

RESTGetAPIChannelMessageResult: APIMessage

RESTGetAPIChannelMessagesResult

RESTGetAPIChannelMessagesResult: APIMessage[]

RESTGetAPIChannelPinsResult

RESTGetAPIChannelPinsResult: APIMessage[]

RESTGetAPIChannelResult

RESTGetAPIChannelResult: APIChannel

RESTGetAPIChannelThreadMemberResult

RESTGetAPIChannelThreadMemberResult: APIThreadMember

RESTGetAPIChannelThreadMembersResult

RESTGetAPIChannelThreadMembersResult: APIThreadMember[]

RESTGetAPIChannelThreadsArchivedPrivateResult

RESTGetAPIChannelThreadsArchivedPrivateResult: RESTGetAPIChannelUsersThreadsArchivedResult

RESTGetAPIChannelThreadsArchivedPublicResult

RESTGetAPIChannelThreadsArchivedPublicResult: RESTGetAPIChannelUsersThreadsArchivedResult

RESTGetAPIChannelWebhooksResult

RESTGetAPIChannelWebhooksResult: APIWebhook[]

RESTGetAPICurrentUserApplicationRoleConnectionResult

RESTGetAPICurrentUserApplicationRoleConnectionResult: APIApplicationRoleConnection

RESTGetAPICurrentUserConnectionsResult

RESTGetAPICurrentUserConnectionsResult: APIConnection[]

RESTGetAPICurrentUserGuildsResult

RESTGetAPICurrentUserGuildsResult: RESTAPIPartialCurrentUserGuild[]

RESTGetAPICurrentUserResult

RESTGetAPICurrentUserResult: APIUser

RESTGetAPIGatewayBotResult

RESTGetAPIGatewayBotResult: APIGatewayBotInfo

RESTGetAPIGatewayResult

RESTGetAPIGatewayResult: APIGatewayInfo

RESTGetAPIGuildApplicationCommandsPermissionsResult

RESTGetAPIGuildApplicationCommandsPermissionsResult: APIGuildApplicationCommandPermissions[]

RESTGetAPIGuildBanResult

RESTGetAPIGuildBanResult: APIBan

RESTGetAPIGuildBansResult

RESTGetAPIGuildBansResult: APIBan[]

RESTGetAPIGuildChannelsResult

RESTGetAPIGuildChannelsResult: APIChannel[]

RESTGetAPIGuildEmojiResult

RESTGetAPIGuildEmojiResult: APIEmoji

RESTGetAPIGuildEmojisResult

RESTGetAPIGuildEmojisResult: APIEmoji[]

RESTGetAPIGuildIntegrationsResult

RESTGetAPIGuildIntegrationsResult: APIGuildIntegration[]

RESTGetAPIGuildInvitesResult

RESTGetAPIGuildInvitesResult: APIExtendedInvite[]

RESTGetAPIGuildMemberResult

RESTGetAPIGuildMemberResult: APIGuildMember

RESTGetAPIGuildMemberVerificationResult

RESTGetAPIGuildMemberVerificationResult: APIGuildMembershipScreening

RESTGetAPIGuildMembersResult

RESTGetAPIGuildMembersResult: APIGuildMember[]

RESTGetAPIGuildMembersSearchResult

RESTGetAPIGuildMembersSearchResult: APIGuildMember[]

RESTGetAPIGuildOnboardingResult

RESTGetAPIGuildOnboardingResult: APIGuildOnboarding

RESTGetAPIGuildPreviewResult

RESTGetAPIGuildPreviewResult: APIGuildPreview

RESTGetAPIGuildResult

RESTGetAPIGuildResult: APIGuild

RESTGetAPIGuildRolesResult

RESTGetAPIGuildRolesResult: APIRole[]

RESTGetAPIGuildScheduledEventResult

RESTGetAPIGuildScheduledEventResult: APIGuildScheduledEvent

RESTGetAPIGuildScheduledEventUsersResult

RESTGetAPIGuildScheduledEventUsersResult: APIGuildScheduledEventUser[]

RESTGetAPIGuildScheduledEventsResult

RESTGetAPIGuildScheduledEventsResult: APIGuildScheduledEvent[]

RESTGetAPIGuildStickerResult

RESTGetAPIGuildStickerResult: APISticker

RESTGetAPIGuildStickersResult

RESTGetAPIGuildStickersResult: APISticker[]

RESTGetAPIGuildTemplatesResult

RESTGetAPIGuildTemplatesResult: APITemplate[]

RESTGetAPIGuildThreadsResult

RESTGetAPIGuildThreadsResult: APIThreadList

RESTGetAPIGuildVoiceRegionsResult

RESTGetAPIGuildVoiceRegionsResult: APIVoiceRegion[]

RESTGetAPIGuildWebhooksResult

RESTGetAPIGuildWebhooksResult: APIWebhook[]

RESTGetAPIGuildWelcomeScreenResult

RESTGetAPIGuildWelcomeScreenResult: APIGuildWelcomeScreen

RESTGetAPIGuildWidgetImageResult

RESTGetAPIGuildWidgetImageResult: ArrayBuffer

Note: while the return type is ArrayBuffer, the expected result is a buffer of sorts (depends if in browser or on node.js/deno).

RESTGetAPIGuildWidgetJSONResult

RESTGetAPIGuildWidgetJSONResult: APIGuildWidget

RESTGetAPIGuildWidgetSettingsResult

RESTGetAPIGuildWidgetSettingsResult: APIGuildWidgetSettings

RESTGetAPIInteractionFollowupResult

RESTGetAPIInteractionFollowupResult: RESTGetAPIWebhookWithTokenMessageResult

RESTGetAPIInteractionOriginalResponseResult

RESTGetAPIInteractionOriginalResponseResult: RESTGetAPIWebhookWithTokenMessageResult

RESTGetAPIInviteResult

RESTGetAPIInviteResult: APIInvite

RESTGetAPIOAuth2CurrentApplicationResult

RESTGetAPIOAuth2CurrentApplicationResult: Omit<APIApplication, flags>

RESTGetAPIStageInstanceResult

RESTGetAPIStageInstanceResult: APIStageInstance

RESTGetAPIStickerResult

RESTGetAPIStickerResult: APISticker

RESTGetAPITemplateResult

RESTGetAPITemplateResult: APITemplate

RESTGetAPIUserResult

RESTGetAPIUserResult: APIUser

RESTGetAPIVoiceRegionsResult

RESTGetAPIVoiceRegionsResult: APIVoiceRegion[]

RESTGetAPIWebhookResult

RESTGetAPIWebhookResult: APIWebhook

RESTGetAPIWebhookWithTokenMessageResult

RESTGetAPIWebhookWithTokenMessageResult: APIMessage

RESTGetAPIWebhookWithTokenResult

RESTGetAPIWebhookWithTokenResult: Omit<APIWebhook, user>

RESTGetCurrentApplicationResult

RESTGetCurrentApplicationResult: APIApplication

RESTGetCurrentUserGuildMemberResult

RESTGetCurrentUserGuildMemberResult: APIGuildMember

RESTGetNitroStickerPacksResult

RESTGetNitroStickerPacksResult: RESTGetStickerPacksResult
@deprecated

Use RESTGetStickerPacksResult instead

RESTOAuth2ImplicitAuthorizationURLFragmentResult

RESTOAuth2ImplicitAuthorizationURLFragmentResult: Omit<RESTPostOAuth2AccessTokenResult, refresh_token>

RESTPatchAPIApplicationCommandJSONBody

RESTPatchAPIApplicationCommandJSONBody: StrictPartial<RESTPostAPIApplicationCommandsJSONBody>

RESTPatchAPIApplicationCommandResult

RESTPatchAPIApplicationCommandResult: APIApplicationCommand

RESTPatchAPIApplicationGuildCommandJSONBody

RESTPatchAPIApplicationGuildCommandJSONBody: StrictPartial<Omit<RESTPostAPIChatInputApplicationCommandsJSONBody, dm_permission> | Omit<RESTPostAPIContextMenuApplicationCommandsJSONBody, dm_permission>>

RESTPatchAPIApplicationGuildCommandResult

RESTPatchAPIApplicationGuildCommandResult: Omit<APIApplicationCommand, dm_permission>

RESTPatchAPIAutoModerationRuleJSONBody

RESTPatchAPIAutoModerationRuleJSONBody: Omit<Partial<RESTPostAPIAutoModerationRuleJSONBody>, trigger_type>

RESTPatchAPIAutoModerationRuleResult

RESTPatchAPIAutoModerationRuleResult: APIAutoModerationRule

RESTPatchAPIChannelMessageFormDataBody

RESTPatchAPIChannelMessageFormDataBody: ({ payload_json?: string } & Record<`files[${bigint}]`, unknown>) | (RESTPatchAPIChannelMessageJSONBody & Record<`files[${bigint}]`, unknown>)

RESTPatchAPIChannelMessageResult

RESTPatchAPIChannelMessageResult: APIMessage

RESTPatchAPIChannelResult

RESTPatchAPIChannelResult: APIChannel

RESTPatchAPICurrentGuildMemberNicknameResult

RESTPatchAPICurrentGuildMemberNicknameResult: StrictRequired<RESTPatchAPICurrentGuildMemberNicknameJSONBody>

RESTPatchAPICurrentUserResult

RESTPatchAPICurrentUserResult: APIUser

RESTPatchAPIGuildChannelPositionsJSONBody

RESTPatchAPIGuildChannelPositionsJSONBody: { id: Snowflake; lock_permissions?: boolean; parent_id?: Snowflake | null; position: number }[]

RESTPatchAPIGuildChannelPositionsResult

RESTPatchAPIGuildChannelPositionsResult: never

RESTPatchAPIGuildEmojiResult

RESTPatchAPIGuildEmojiResult: APIEmoji

RESTPatchAPIGuildMemberResult

RESTPatchAPIGuildMemberResult: APIGuildMember

RESTPatchAPIGuildMemberVerificationResult

RESTPatchAPIGuildMemberVerificationResult: APIGuildMembershipScreening

RESTPatchAPIGuildResult

RESTPatchAPIGuildResult: APIGuild

RESTPatchAPIGuildRolePositionsJSONBody

RESTPatchAPIGuildRolePositionsJSONBody: { id: Snowflake; position?: number }[]

RESTPatchAPIGuildRolePositionsResult

RESTPatchAPIGuildRolePositionsResult: APIRole[]

RESTPatchAPIGuildRoleResult

RESTPatchAPIGuildRoleResult: APIRole

RESTPatchAPIGuildScheduledEventJSONBody

RESTPatchAPIGuildScheduledEventJSONBody: StrictPartial<RESTPostAPIGuildScheduledEventJSONBody> & { description?: string | null; entity_metadata?: APIGuildScheduledEventEntityMetadata | null; status?: GuildScheduledEventStatus }

RESTPatchAPIGuildScheduledEventResult

RESTPatchAPIGuildScheduledEventResult: APIGuildScheduledEvent

RESTPatchAPIGuildStickerResult

RESTPatchAPIGuildStickerResult: APISticker

RESTPatchAPIGuildTemplateJSONBody

RESTPatchAPIGuildTemplateJSONBody: StrictPartial<RESTPostAPIGuildTemplatesJSONBody>

RESTPatchAPIGuildTemplateResult

RESTPatchAPIGuildTemplateResult: APITemplate

RESTPatchAPIGuildVoiceStateCurrentMemberResult

RESTPatchAPIGuildVoiceStateCurrentMemberResult: never

RESTPatchAPIGuildVoiceStateUserResult

RESTPatchAPIGuildVoiceStateUserResult: never

RESTPatchAPIGuildWelcomeScreenJSONBody

RESTPatchAPIGuildWelcomeScreenJSONBody: Nullable<StrictPartial<APIGuildWelcomeScreen>> & { enabled?: boolean | null }

RESTPatchAPIGuildWelcomeScreenResult

RESTPatchAPIGuildWelcomeScreenResult: APIGuildWelcomeScreen

RESTPatchAPIGuildWidgetSettingsJSONBody

RESTPatchAPIGuildWidgetSettingsJSONBody: StrictPartial<APIGuildWidgetSettings>

RESTPatchAPIGuildWidgetSettingsResult

RESTPatchAPIGuildWidgetSettingsResult: APIGuildWidgetSettings

RESTPatchAPIInteractionFollowupFormDataBody

RESTPatchAPIInteractionFollowupFormDataBody: RESTPatchAPIWebhookWithTokenMessageFormDataBody

RESTPatchAPIInteractionFollowupJSONBody

RESTPatchAPIInteractionFollowupJSONBody: RESTPatchAPIWebhookWithTokenMessageJSONBody

RESTPatchAPIInteractionFollowupResult

RESTPatchAPIInteractionFollowupResult: RESTPatchAPIWebhookWithTokenMessageResult

RESTPatchAPIInteractionOriginalResponseFormDataBody

RESTPatchAPIInteractionOriginalResponseFormDataBody: RESTPatchAPIWebhookWithTokenMessageFormDataBody

RESTPatchAPIInteractionOriginalResponseJSONBody

RESTPatchAPIInteractionOriginalResponseJSONBody: RESTPatchAPIWebhookWithTokenMessageJSONBody

RESTPatchAPIInteractionOriginalResponseResult

RESTPatchAPIInteractionOriginalResponseResult: RESTPatchAPIWebhookWithTokenMessageResult

RESTPatchAPIStageInstanceResult

RESTPatchAPIStageInstanceResult: APIStageInstance

RESTPatchAPIWebhookResult

RESTPatchAPIWebhookResult: APIWebhook

RESTPatchAPIWebhookWithTokenJSONBody

RESTPatchAPIWebhookWithTokenJSONBody: Omit<RESTPatchAPIWebhookJSONBody, channel_id>

RESTPatchAPIWebhookWithTokenMessageFormDataBody

RESTPatchAPIWebhookWithTokenMessageFormDataBody: ({ payload_json?: string } & Record<`files[${bigint}]`, unknown>) | (RESTPatchAPIWebhookWithTokenMessageJSONBody & Record<`files[${bigint}]`, unknown>)

RESTPatchAPIWebhookWithTokenMessageJSONBody

RESTPatchAPIWebhookWithTokenMessageJSONBody: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<Nullable<Pick<RESTPostAPIWebhookWithTokenJSONBody, content | embeds | allowed_mentions | components>>> & { attachments?: RESTAPIAttachment[] }

RESTPatchAPIWebhookWithTokenMessageResult

RESTPatchAPIWebhookWithTokenMessageResult: APIMessage

RESTPatchAPIWebhookWithTokenResult

RESTPatchAPIWebhookWithTokenResult: RESTGetAPIWebhookWithTokenResult

RESTPostAPIApplicationCommandsJSONBody

RESTPostAPIApplicationCommandsResult

RESTPostAPIApplicationCommandsResult: APIApplicationCommand

RESTPostAPIApplicationGuildCommandsJSONBody

RESTPostAPIApplicationGuildCommandsJSONBody: Omit<RESTPostAPIChatInputApplicationCommandsJSONBody, dm_permission> | Omit<RESTPostAPIContextMenuApplicationCommandsJSONBody, dm_permission>

RESTPostAPIApplicationGuildCommandsResult

RESTPostAPIApplicationGuildCommandsResult: Omit<APIApplicationCommand, dm_permission>

RESTPostAPIAutoModerationRuleResult

RESTPostAPIAutoModerationRuleResult: APIAutoModerationRule

RESTPostAPIChannelFollowersResult

RESTPostAPIChannelFollowersResult: APIFollowedChannel

RESTPostAPIChannelInviteResult

RESTPostAPIChannelInviteResult: APIExtendedInvite

RESTPostAPIChannelMessageCrosspostResult

RESTPostAPIChannelMessageCrosspostResult: APIMessage

RESTPostAPIChannelMessageFormDataBody

RESTPostAPIChannelMessageFormDataBody: ({ payload_json?: string } & Record<`files[${bigint}]`, unknown>) | (RESTPostAPIChannelMessageJSONBody & Record<`files[${bigint}]`, unknown>)

RESTPostAPIChannelMessageResult

RESTPostAPIChannelMessageResult: APIMessage

RESTPostAPIChannelMessagesBulkDeleteResult

RESTPostAPIChannelMessagesBulkDeleteResult: never

RESTPostAPIChannelMessagesThreadsResult

RESTPostAPIChannelMessagesThreadsResult: APIChannel

RESTPostAPIChannelThreadsResult

RESTPostAPIChannelThreadsResult: APIChannel

RESTPostAPIChannelTypingResult

RESTPostAPIChannelTypingResult: never

RESTPostAPIChannelWebhookResult

RESTPostAPIChannelWebhookResult: APIWebhook

RESTPostAPICurrentUserCreateDMChannelResult

RESTPostAPICurrentUserCreateDMChannelResult: APIChannel

RESTPostAPIGuildChannelJSONBody

RESTPostAPIGuildChannelJSONBody: DistributiveOmit<APIGuildCreatePartialChannel, id>

RESTPostAPIGuildChannelResult

RESTPostAPIGuildChannelResult: APIChannel

RESTPostAPIGuildEmojiResult

RESTPostAPIGuildEmojiResult: APIEmoji

RESTPostAPIGuildForumThreadsFormDataBody

RESTPostAPIGuildForumThreadsFormDataBody: RESTPostAPIChannelMessagesThreadsJSONBody & { message: string }

RESTPostAPIGuildForumThreadsJSONBody

RESTPostAPIGuildForumThreadsJSONBody: RESTPostAPIChannelMessagesThreadsJSONBody & { applied_tags?: Snowflake[]; message: RESTPostAPIChannelMessageJSONBody }

RESTPostAPIGuildRoleResult

RESTPostAPIGuildRoleResult: APIRole

RESTPostAPIGuildScheduledEventResult

RESTPostAPIGuildScheduledEventResult: APIGuildScheduledEvent

RESTPostAPIGuildStickerResult

RESTPostAPIGuildStickerResult: APISticker

RESTPostAPIGuildTemplatesResult

RESTPostAPIGuildTemplatesResult: APITemplate

RESTPostAPIGuildsMFAResult

RESTPostAPIGuildsMFAResult: RESTPostAPIGuildsMFAJSONBody

RESTPostAPIGuildsResult

RESTPostAPIGuildsResult: APIGuild

RESTPostAPIInteractionCallbackFormDataBody

RESTPostAPIInteractionCallbackFormDataBody: ({ payload_json?: string } & Record<`files[${bigint}]`, unknown>) | (RESTPostAPIInteractionCallbackJSONBody & Record<`files[${bigint}]`, unknown>)

RESTPostAPIInteractionCallbackJSONBody

RESTPostAPIInteractionCallbackJSONBody: APIInteractionResponse

RESTPostAPIInteractionFollowupFormDataBody

RESTPostAPIInteractionFollowupFormDataBody: ({ payload_json?: string } & Record<`files[${bigint}]`, unknown>) | (RESTPostAPIInteractionFollowupJSONBody & Record<`files[${bigint}]`, unknown>)

RESTPostAPIInteractionFollowupJSONBody

RESTPostAPIInteractionFollowupJSONBody: APIInteractionResponseCallbackData

RESTPostAPIInteractionFollowupResult

RESTPostAPIInteractionFollowupResult: RESTPostAPIWebhookWithTokenWaitResult

RESTPostAPIStageInstanceResult

RESTPostAPIStageInstanceResult: APIStageInstance

RESTPostAPITemplateCreateGuildResult

RESTPostAPITemplateCreateGuildResult: APIGuild

RESTPostAPIWebhookWithTokenFormDataBody

RESTPostAPIWebhookWithTokenFormDataBody: ({ payload_json?: string } & Record<`files[${bigint}]`, unknown>) | (RESTPostAPIWebhookWithTokenJSONBody & Record<`files[${bigint}]`, unknown>)

RESTPostAPIWebhookWithTokenGitHubQuery

RESTPostAPIWebhookWithTokenGitHubQuery: RESTPostAPIWebhookWithTokenQuery

RESTPostAPIWebhookWithTokenGitHubResult

RESTPostAPIWebhookWithTokenGitHubResult: never

RESTPostAPIWebhookWithTokenGitHubWaitResult

RESTPostAPIWebhookWithTokenGitHubWaitResult: APIMessage

RESTPostAPIWebhookWithTokenResult

RESTPostAPIWebhookWithTokenResult: never

RESTPostAPIWebhookWithTokenSlackQuery

RESTPostAPIWebhookWithTokenSlackQuery: RESTPostAPIWebhookWithTokenQuery

RESTPostAPIWebhookWithTokenSlackResult

RESTPostAPIWebhookWithTokenSlackResult: never

RESTPostAPIWebhookWithTokenSlackWaitResult

RESTPostAPIWebhookWithTokenSlackWaitResult: APIMessage

RESTPostAPIWebhookWithTokenWaitResult

RESTPostAPIWebhookWithTokenWaitResult: APIMessage

RESTPostOAuth2AccessTokenWithBotAndGuildsAndWebhookIncomingScopeResult

RESTPostOAuth2ClientCredentialsResult

RESTPostOAuth2ClientCredentialsResult: RESTOAuth2ImplicitAuthorizationURLFragmentResult

RESTPostOAuth2RefreshTokenResult

RESTPostOAuth2RefreshTokenResult: RESTPostOAuth2AccessTokenResult

RESTPutAPIApplicationCommandPermissionsResult

RESTPutAPIApplicationCommandPermissionsResult: APIGuildApplicationCommandPermissions

RESTPutAPIApplicationCommandsJSONBody

RESTPutAPIApplicationCommandsJSONBody: RESTPostAPIApplicationCommandsJSONBody[]

RESTPutAPIApplicationCommandsResult

RESTPutAPIApplicationCommandsResult: APIApplicationCommand[]

RESTPutAPIApplicationGuildCommandsJSONBody

RESTPutAPIApplicationGuildCommandsJSONBody: ((Omit<RESTPostAPIChatInputApplicationCommandsJSONBody, dm_permission> & Pick<Partial<APIApplicationCommand>, id>) | (Omit<RESTPostAPIContextMenuApplicationCommandsJSONBody, dm_permission> & Pick<Partial<APIApplicationCommand>, id>))[]

RESTPutAPIApplicationGuildCommandsResult

RESTPutAPIApplicationGuildCommandsResult: Omit<APIApplicationCommand, dm_permission>[]

RESTPutAPIApplicationRoleConnectionMetadataJSONBody

RESTPutAPIApplicationRoleConnectionMetadataJSONBody: APIApplicationRoleConnectionMetadata[]

RESTPutAPIApplicationRoleConnectionMetadataResult

RESTPutAPIApplicationRoleConnectionMetadataResult: APIApplicationRoleConnectionMetadata[]

RESTPutAPIChannelMessageReactionResult

RESTPutAPIChannelMessageReactionResult: never

RESTPutAPIChannelPermissionResult

RESTPutAPIChannelPermissionResult: never

RESTPutAPIChannelPinResult

RESTPutAPIChannelPinResult: never

RESTPutAPIChannelRecipientResult

RESTPutAPIChannelRecipientResult: unknown

RESTPutAPIChannelThreadMembersResult

RESTPutAPIChannelThreadMembersResult: never

RESTPutAPICurrentUserApplicationRoleConnectionResult

RESTPutAPICurrentUserApplicationRoleConnectionResult: APIApplicationRoleConnection

RESTPutAPIGuildApplicationCommandsPermissionsJSONBody

RESTPutAPIGuildApplicationCommandsPermissionsJSONBody: Pick<APIGuildApplicationCommandPermissions, id | permissions>[]

RESTPutAPIGuildApplicationCommandsPermissionsResult

RESTPutAPIGuildApplicationCommandsPermissionsResult: APIGuildApplicationCommandPermissions[]

RESTPutAPIGuildBanResult

RESTPutAPIGuildBanResult: never

RESTPutAPIGuildMemberResult

RESTPutAPIGuildMemberResult: APIGuildMember | undefined

RESTPutAPIGuildMemberRoleResult

RESTPutAPIGuildMemberRoleResult: never

RESTPutAPIGuildOnboardingJSONBody

RESTPutAPIGuildOnboardingJSONBody: Pick<APIGuildOnboarding, default_channel_ids | enabled | mode | prompts>

RESTPutAPIGuildOnboardingResult

RESTPutAPIGuildOnboardingResult: APIGuildOnboarding

RESTPutAPIGuildTemplateSyncResult

RESTPutAPIGuildTemplateSyncResult: APITemplate

RoleIconFormat

RoleIconFormat: Exclude<ImageFormat, ImageFormat.Lottie | ImageFormat.GIF>

StickerFormat

StickerFormat: Extract<ImageFormat, ImageFormat.PNG | ImageFormat.Lottie | ImageFormat.GIF>

StickerPackBannerFormat

StickerPackBannerFormat: Exclude<ImageFormat, ImageFormat.Lottie | ImageFormat.GIF>

TeamIconFormat

TeamIconFormat: Exclude<ImageFormat, ImageFormat.Lottie | ImageFormat.GIF>

TextChannelType

TextChannelType: ChannelType.DM | ChannelType.GroupDM | ChannelType.GuildAnnouncement | ChannelType.PublicThread | ChannelType.PrivateThread | ChannelType.AnnouncementThread | ChannelType.GuildText | ChannelType.GuildForum | ChannelType.GuildVoice | ChannelType.GuildStageVoice | ChannelType.GuildMedia

ThreadChannelType

ThreadChannelType: ChannelType.PublicThread | ChannelType.PrivateThread | ChannelType.AnnouncementThread

UserAvatarFormat

UserAvatarFormat: Exclude<ImageFormat, ImageFormat.Lottie>

UserBannerFormat

UserBannerFormat: Exclude<ImageFormat, ImageFormat.Lottie>

Variables

constAPIApplicationCommandPermissionsConstant

APIApplicationCommandPermissionsConstant: { AllChannels: (guildId: string | bigint) => string; Everyone: (guildId: string | bigint) => string } = ...

Type declaration

  • AllChannels: (guildId: string | bigint) => string
      • (guildId: string | bigint): string
      • Parameters

        • guildId: string | bigint

        Returns string

  • Everyone: (guildId: string | bigint) => string
      • (guildId: string | bigint): string
      • Parameters

        • guildId: string | bigint

        Returns string

constAPIVersion

APIVersion: 10 = '10'

constCDNRoutes

CDNRoutes: { achievementIcon: any; applicationAsset: any; applicationCover: any; applicationIcon: any; defaultUserAvatar: any; emoji: any; guildBanner: any; guildDiscoverySplash: any; guildIcon: any; guildMemberAvatar: any; guildMemberBanner: any; guildScheduledEventCover: any; guildSplash: any; roleIcon: any; sticker: any; stickerPackBanner: any; storePageAsset: any; teamIcon: any; userAvatar: any; userAvatarDecoration: any; userBanner: any } = ...

Type declaration

  • achievementIcon: function
    • achievementIcon(applicationId: string, achievementId: string, achievementIconHash: string, format: AchievementIconFormat): `/app-assets/${string}/achievements/${string}/icons/${string}.jpeg` | `/app-assets/${string}/achievements/${string}/icons/${string}.png` | `/app-assets/${string}/achievements/${string}/icons/${string}.webp`

    • Route for:

      • GET /app-assets/{application.id}/achievements/{achievement.id}/icons/{achievement.icon}.{png|jpeg|webp}

      This route supports the extensions: PNG, JPEG, WebP


      Parameters

      Returns `/app-assets/${string}/achievements/${string}/icons/${string}.jpeg` | `/app-assets/${string}/achievements/${string}/icons/${string}.png` | `/app-assets/${string}/achievements/${string}/icons/${string}.webp`

  • applicationAsset: function
    • applicationAsset(applicationId: string, applicationAssetId: string, format: ApplicationAssetFormat): `/app-assets/${string}/${string}.jpeg` | `/app-assets/${string}/${string}.png` | `/app-assets/${string}/${string}.webp`

    • Route for:

      • GET /app-assets/{application.id}/{application.asset_id}.{png|jpeg|webp}

      This route supports the extensions: PNG, JPEG, WebP


      Parameters

      Returns `/app-assets/${string}/${string}.jpeg` | `/app-assets/${string}/${string}.png` | `/app-assets/${string}/${string}.webp`

  • applicationCover: function
    • applicationCover(applicationId: string, applicationCoverImage: string, format: ApplicationCoverFormat): `/app-icons/${string}/${string}.jpeg` | `/app-icons/${string}/${string}.png` | `/app-icons/${string}/${string}.webp`

    • Route for:

      • GET /app-icons/{application.id}/{application.cover_image}.{png|jpeg|webp}

      This route supports the extensions: PNG, JPEG, WebP


      Parameters

      Returns `/app-icons/${string}/${string}.jpeg` | `/app-icons/${string}/${string}.png` | `/app-icons/${string}/${string}.webp`

  • applicationIcon: function
    • applicationIcon(applicationId: string, applicationIcon: string, format: ApplicationIconFormat): `/app-icons/${string}/${string}.jpeg` | `/app-icons/${string}/${string}.png` | `/app-icons/${string}/${string}.webp`

    • Route for:

      • GET /app-icons/{application.id}/{application.icon}.{png|jpeg|webp}

      This route supports the extensions: PNG, JPEG, WebP


      Parameters

      Returns `/app-icons/${string}/${string}.jpeg` | `/app-icons/${string}/${string}.png` | `/app-icons/${string}/${string}.webp`

  • defaultUserAvatar: function
    • defaultUserAvatar(index: DefaultUserAvatarAssets): /embed/avatars/0.png | /embed/avatars/2.png | /embed/avatars/1.png | /embed/avatars/3.png | /embed/avatars/4.png | /embed/avatars/5.png

    • Route for:

      • GET /embed/avatars/{index}.png

      The value for index parameter depends on whether the user is migrated to the new username system. For users on the new username system, index will be (user.id >> 22) % 6. For users on the legacy username system, index will be user.discriminator % 5.

      This route supports the extension: PNG


      Parameters

      Returns /embed/avatars/0.png | /embed/avatars/2.png | /embed/avatars/1.png | /embed/avatars/3.png | /embed/avatars/4.png | /embed/avatars/5.png

  • emoji: function
    • emoji(emojiId: string, format: EmojiFormat): `/emojis/${string}.jpeg` | `/emojis/${string}.png` | `/emojis/${string}.webp` | `/emojis/${string}.gif`

    • Route for:

      • GET /emojis/{emoji.id}.{png|jpeg|webp|gif}

      As this route supports GIFs, the hash will begin with a_ if it is available in GIF format

      This route supports the extensions: PNG, JPEG, WebP, GIF


      Parameters

      Returns `/emojis/${string}.jpeg` | `/emojis/${string}.png` | `/emojis/${string}.webp` | `/emojis/${string}.gif`

  • guildBanner: function
    • guildBanner(guildId: string, guildBanner: string, format: GuildBannerFormat): `/banners/${string}/${string}.jpeg` | `/banners/${string}/${string}.png` | `/banners/${string}/${string}.webp` | `/banners/${string}/${string}.gif`

    • Route for:

      • GET /banners/{guild.id}/{guild.banner}.{png|jpeg|webp|gif}

      As this route supports GIFs, the hash will begin with a_ if it is available in GIF format

      This route supports the extensions: PNG, JPEG, WebP, GIF


      Parameters

      Returns `/banners/${string}/${string}.jpeg`