Skip to main content
Version: 0.37.106

discord-api-types/v9

Index

Enumerations

Interfaces

References

Type Aliases

Variables

References

FormattingPatterns

Re-exports FormattingPatterns

GatewayURLQuery

Re-exports GatewayURLQuery

Locale

Re-exports Locale

LocaleString

Re-exports LocaleString

LocalizationMap

Re-exports LocalizationMap

PermissionFlagsBits

Re-exports PermissionFlagsBits

RESTError

Re-exports RESTError

RESTErrorData

Re-exports RESTErrorData

RESTErrorFieldInformation

Re-exports RESTErrorFieldInformation

RESTErrorGroupWrapper

Re-exports RESTErrorGroupWrapper

RESTJSONErrorCodes

Re-exports RESTJSONErrorCodes

RESTRateLimit

Re-exports RESTRateLimit

RPCCloseEventCodes

Re-exports RPCCloseEventCodes

RPCErrorCodes

Re-exports RPCErrorCodes

Snowflake

Re-exports Snowflake

Utils

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

Type Aliases

APIActionRowComponentTypes

APIActionRowComponentTypes: APIMessageActionRowComponent | APIModalActionRowComponent

APIApplicationCommandAttachmentOption

APIApplicationCommandAttachmentOption: APIApplicationCommandOptionBase<ApplicationCommandOptionType.Attachment>

APIApplicationCommandAutocompleteDMInteraction

APIApplicationCommandAutocompleteDMInteraction: APIDMInteractionWrapper<APIApplicationCommandAutocompleteInteraction>

https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object

APIApplicationCommandAutocompleteGuildInteraction

APIApplicationCommandAutocompleteGuildInteraction: APIGuildInteractionWrapper<APIApplicationCommandAutocompleteInteraction>

https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object

APIApplicationCommandAutocompleteInteraction

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

APIApplicationCommandBasicOption

APIApplicationCommandBasicOption: APIApplicationCommandAttachmentOption | APIApplicationCommandBooleanOption | APIApplicationCommandChannelOption | APIApplicationCommandIntegerOption | APIApplicationCommandMentionableOption | APIApplicationCommandNumberOption | APIApplicationCommandRoleOption | APIApplicationCommandStringOption | APIApplicationCommandUserOption

https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-option-structure

APIApplicationCommandBooleanOption

APIApplicationCommandBooleanOption: APIApplicationCommandOptionBase<ApplicationCommandOptionType.Boolean>

APIApplicationCommandDMInteraction

APIApplicationCommandDMInteraction: APIChatInputApplicationCommandDMInteraction | APIContextMenuDMInteraction

https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object

APIApplicationCommandGuildInteraction

APIApplicationCommandGuildInteraction: APIChatInputApplicationCommandGuildInteraction | APIContextMenuGuildInteraction

https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object

APIApplicationCommandIntegerOption

APIApplicationCommandIntegerOption: APIApplicationCommandOptionWithAutocompleteOrChoicesWrapper<APIApplicationCommandIntegerOptionBase, APIApplicationCommandOptionChoice<number>>

APIApplicationCommandInteraction

APIApplicationCommandInteraction: APIChatInputApplicationCommandInteraction | APIContextMenuInteraction

https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object

APIApplicationCommandInteractionData

APIApplicationCommandInteractionData: APIChatInputApplicationCommandInteractionData | APIContextMenuInteractionData

https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data

APIApplicationCommandInteractionDataAttachmentOption

APIApplicationCommandInteractionDataAttachmentOption: APIInteractionDataOptionBase<ApplicationCommandOptionType.Attachment, Snowflake>

APIApplicationCommandInteractionDataBasicOption

APIApplicationCommandInteractionDataBasicOption: APIApplicationCommandInteractionDataAttachmentOption | APIApplicationCommandInteractionDataBooleanOption | APIApplicationCommandInteractionDataChannelOption | APIApplicationCommandInteractionDataIntegerOption | APIApplicationCommandInteractionDataMentionableOption | APIApplicationCommandInteractionDataNumberOption | APIApplicationCommandInteractionDataRoleOption | APIApplicationCommandInteractionDataStringOption | APIApplicationCommandInteractionDataUserOption

APIApplicationCommandInteractionDataBooleanOption

APIApplicationCommandInteractionDataBooleanOption: APIInteractionDataOptionBase<ApplicationCommandOptionType.Boolean, boolean>

APIApplicationCommandInteractionDataChannelOption

APIApplicationCommandInteractionDataChannelOption: APIInteractionDataOptionBase<ApplicationCommandOptionType.Channel, Snowflake>

APIApplicationCommandInteractionDataMentionableOption

APIApplicationCommandInteractionDataMentionableOption: APIInteractionDataOptionBase<ApplicationCommandOptionType.Mentionable, Snowflake>

APIApplicationCommandInteractionDataOption

APIApplicationCommandInteractionDataOption: APIApplicationCommandInteractionDataBasicOption | APIApplicationCommandInteractionDataSubcommandGroupOption | APIApplicationCommandInteractionDataSubcommandOption

https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-interaction-data-option-structure

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>, app_permissions | channel_id | channel | data>>

https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object

Type parameters

APIApplicationCommandMentionableOption

APIApplicationCommandMentionableOption: APIApplicationCommandOptionBase<ApplicationCommandOptionType.Mentionable>

APIApplicationCommandNumberOption

APIApplicationCommandNumberOption: APIApplicationCommandOptionWithAutocompleteOrChoicesWrapper<APIApplicationCommandNumberOptionBase, APIApplicationCommandOptionChoice<number>>

APIApplicationCommandOption

APIApplicationCommandOption: APIApplicationCommandBasicOption | APIApplicationCommandSubcommandGroupOption | APIApplicationCommandSubcommandOption

https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-option-structure

APIApplicationCommandOptionWithAutocompleteOrChoicesWrapper

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

Type parameters

APIApplicationCommandRoleOption

APIApplicationCommandRoleOption: APIApplicationCommandOptionBase<ApplicationCommandOptionType.Role>

APIApplicationCommandStringOption

APIApplicationCommandStringOption: APIApplicationCommandOptionWithAutocompleteOrChoicesWrapper<APIApplicationCommandStringOptionBase, APIApplicationCommandOptionChoice<string>>

APIApplicationCommandUserOption

APIApplicationCommandUserOption: APIApplicationCommandOptionBase<ApplicationCommandOptionType.User>

APIApplicationIntegrationTypesConfigMap

APIApplicationIntegrationTypesConfigMap: { [ key in ApplicationIntegrationType ]?: APIApplicationIntegrationTypeConfiguration }

APIAuditLogChange

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

https://discord.com/developers/docs/resources/audit-log#audit-log-change-object-audit-log-change-structure

APIAuditLogChangeKey$Add

APIAuditLogChangeKey$Add: AuditLogChangeData<$add, Pick<APIRole, id | name>[]>

Returned when new role(s) are added

APIAuditLogChangeKey$Remove

APIAuditLogChangeKey$Remove: AuditLogChangeData<$remove, Pick<APIRole, id | name>[]>

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

APIAuditLogChangeKeyAvailableTags

APIAuditLogChangeKeyAvailableTags: AuditLogChangeData<available_tags, APIGuildForumTag[]>

Returned when a guild forum’s available tags gets 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

APIAuditLogChangeKeyDefaultReactionEmoji

APIAuditLogChangeKeyDefaultReactionEmoji: AuditLogChangeData<default_reaction_emoji, APIGuildForumDefaultReactionEmoji>

Returned when a guild forum’s default reaction emoji gets changed

APIAuditLogChangeKeyDefaultThreadRateLimitPerUser

APIAuditLogChangeKeyDefaultThreadRateLimitPerUser: AuditLogChangeData<default_thread_rate_limit_per_user, number>

Returned when a thread’s amount of seconds a user has to wait before creating another thread gets 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

APIAuditLogChangeKeyEmojiId

APIAuditLogChangeKeyEmojiId: AuditLogChangeData<emoji_id, Snowflake>

Returned when a soundboard’s custom emoji is changed

APIAuditLogChangeKeyEmojiName

APIAuditLogChangeKeyEmojiName: AuditLogChangeData<emoji_name, string>

Returned when a soundboard’s unicode emoji 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

APIAuditLogChangeKeyFlags

APIAuditLogChangeKeyFlags: AuditLogChangeData<flags, number>

Returned when a channel flag gets 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

APIAuditLogChangeKeyPremiumProgressBarEnabled

APIAuditLogChangeKeyPremiumProgressBarEnabled: AuditLogChangeData<premium_progress_bar_enabled, boolean>

Returned when a guild’s boost progress bar is enabled

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

APIAuditLogChangeKeyRecurrenceRule

APIAuditLogChangeKeyRecurrenceRule: AuditLogChangeData<recurrence_rule, APIGuildScheduledEventRecurrenceRule>

Returned when a guild scheduled event’s recurrence_rule 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>
)

APIAuditLogChangeKeySoundId

APIAuditLogChangeKeySoundId: AuditLogChangeData<sound_id, Snowflake>

Returned when a soundboard is create or deleted

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

APIAuditLogChangeKeySystemChannelFlags

APIAuditLogChangeKeySystemChannelFlags: AuditLogChangeData<system_channel_flags, GuildSystemChannelFlags>

Returned when a guild’s system_channel_flags 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

APIAuditLogChangeKeyUserId

APIAuditLogChangeKeyUserId: AuditLogChangeData<user_id, Snowflake>

Returned when a sounboard is 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

APIAuditLogChangeKeyVolume

APIAuditLogChangeKeyVolume: AuditLogChangeData<volume, number>

Returned when a soundboard’s volume 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

APIAuthorizingIntegrationOwnersMap

APIAuthorizingIntegrationOwnersMap: { [ key in ApplicationIntegrationType ]?: Snowflake }

APIAutoPopulatedSelectMenuComponent

APIAutoPopulatedSelectMenuComponent: APIChannelSelectComponent | APIMentionableSelectComponent | APIRoleSelectComponent | APIUserSelectComponent

APIButtonComponent

APIButtonComponent: APIButtonComponentWithCustomId | APIButtonComponentWithSKUId | APIButtonComponentWithURL

APIChannel

APIChannel: APIDMChannel | APIGroupDMChannel | APIGuildCategoryChannel | APIGuildForumChannel | APIGuildMediaChannel | APIGuildStageVoiceChannel | APIGuildVoiceChannel | APINewsChannel | APITextChannel | APIThreadChannel

https://discord.com/developers/docs/resources/channel#channel-object-channel-structure

APIChannelPatchOverwrite

APIChannelPatchOverwrite: RESTAPIChannelPatchOverwrite
@deprecated

Use RESTAPIChannelPatchOverwrite instead

APIChatInputApplicationCommandDMInteraction

APIChatInputApplicationCommandDMInteraction: APIDMInteractionWrapper<APIChatInputApplicationCommandInteraction>

https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object

APIChatInputApplicationCommandGuildInteraction

APIChatInputApplicationCommandGuildInteraction: APIGuildInteractionWrapper<APIChatInputApplicationCommandInteraction>

https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object

APIChatInputApplicationCommandInteraction

APIChatInputApplicationCommandInteraction: APIApplicationCommandInteractionWrapper<APIChatInputApplicationCommandInteractionData>

https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object

APIChatInputApplicationCommandInteractionDataResolved

APIChatInputApplicationCommandInteractionDataResolved: APIInteractionDataResolved
@deprecated

Renamed to APIInteractionDataResolved

APIContextMenuDMInteraction

APIContextMenuDMInteraction: APIMessageApplicationCommandDMInteraction | APIUserApplicationCommandDMInteraction

https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object

APIContextMenuGuildInteraction

APIContextMenuGuildInteraction: APIMessageApplicationCommandGuildInteraction | APIUserApplicationCommandGuildInteraction

https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object

APIContextMenuInteraction

APIContextMenuInteraction: APIMessageApplicationCommandInteraction | APIUserApplicationCommandInteraction

https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object

APIContextMenuInteractionData

APIContextMenuInteractionData: APIMessageApplicationCommandInteractionData | APIUserApplicationCommandInteractionData

https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data

APIDMInteraction

APIDMInteraction: APIApplicationCommandAutocompleteDMInteraction | APIApplicationCommandDMInteraction | APIMessageComponentDMInteraction | APIModalSubmitDMInteraction

https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object

APIDMInteractionWrapper

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

Type parameters

APIGuildCategoryChannel

APIGuildCategoryChannel: APIGuildChannel<ChannelType.GuildCategory>

APIGuildChannelResolvable

APIGuildChannelResolvable: RESTAPIGuildChannelResolvable
@deprecated

Use RESTAPIGuildChannelResolvable instead

APIGuildCreateOverwrite

APIGuildCreateOverwrite: RESTAPIGuildCreateOverwrite
@deprecated

Use RESTAPIGuildCreateOverwrite instead

APIGuildCreatePartialChannel

APIGuildCreatePartialChannel: RESTAPIGuildCreatePartialChannel
@deprecated

Use RESTAPIGuildCreatePartialChannel instead

APIGuildCreateRole

APIGuildCreateRole: RESTAPIGuildCreateRole
@deprecated

Use RESTAPIGuildCreateRole instead

APIGuildIntegrationType

APIGuildIntegrationType: discord | guild_subscription | twitch | youtube

APIGuildInteraction

APIGuildInteraction: APIApplicationCommandAutocompleteGuildInteraction | APIApplicationCommandGuildInteraction | APIMessageComponentGuildInteraction | APIModalSubmitGuildInteraction

https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object

APIGuildInteractionWrapper

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

Type parameters

APIGuildMediaChannel

APIGuildMediaChannel: APIThreadOnlyChannel<ChannelType.GuildMedia>

APIGuildScheduledEvent

APIGuildScheduledEvent: APIExternalGuildScheduledEvent | APIStageInstanceGuildScheduledEvent | APIVoiceGuildScheduledEvent

https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-structure

APIGuildStageVoiceChannel

APIGuildStageVoiceChannel: APIVoiceChannelBase<ChannelType.GuildStageVoice>

APIGuildVoiceChannel

APIGuildVoiceChannel: APIVoiceChannelBase<ChannelType.GuildVoice>

APIInteraction

APIInteraction: APIApplicationCommandAutocompleteInteraction | APIApplicationCommandInteraction | APIMessageComponentInteraction | APIModalSubmitInteraction | APIPingInteraction

https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object

APIInteractionDataResolvedChannel

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

https://discord.com/developers/docs/resources/channel#channel-object

APIInteractionResponse

APIInteractionResponse: APIApplicationCommandAutocompleteResponse | APIInteractionResponseChannelMessageWithSource | APIInteractionResponseDeferredChannelMessageWithSource | APIInteractionResponseDeferredMessageUpdate | APIInteractionResponsePong | APIInteractionResponseUpdateMessage | APIModalInteractionResponse | APIPremiumRequiredInteractionResponse

https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-response-object

APIInteractionResponseCallbackData

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

https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-response-object-interaction-callback-data-structure

APIInviteGuild

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

APIMentionableSelectComponent

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

https://discord.com/developers/docs/interactions/message-components#select-menus

APIMessageActionRowComponent

APIMessageActionRowComponent: APIButtonComponent | APISelectMenuComponent

https://discord.com/developers/docs/interactions/message-components#message-components

APIMessageApplicationCommandDMInteraction

APIMessageApplicationCommandDMInteraction: APIDMInteractionWrapper<APIMessageApplicationCommandInteraction>

https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object

APIMessageApplicationCommandGuildInteraction

APIMessageApplicationCommandGuildInteraction: APIGuildInteractionWrapper<APIMessageApplicationCommandInteraction>

https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object

APIMessageApplicationCommandInteraction

APIMessageApplicationCommandInteraction: APIApplicationCommandInteractionWrapper<APIMessageApplicationCommandInteractionData>

https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object

APIMessageButtonInteractionData

APIMessageButtonInteractionData: APIMessageComponentBaseInteractionData<ComponentType.Button>

APIMessageComponent

APIMessageComponent: APIActionRowComponent<APIMessageActionRowComponent> | APIMessageActionRowComponent

https://discord.com/developers/docs/interactions/message-components#message-components

APIMessageComponentButtonInteraction

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

APIMessageComponentDMInteraction

APIMessageComponentDMInteraction: APIDMInteractionWrapper<APIMessageComponentInteraction>

APIMessageComponentGuildInteraction

APIMessageComponentGuildInteraction: APIGuildInteractionWrapper<APIMessageComponentInteraction>

APIMessageComponentInteraction

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

APIMessageComponentInteractionData

APIMessageComponentInteractionData: APIMessageButtonInteractionData | APIMessageSelectMenuInteractionData

APIMessageComponentSelectMenuInteraction

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

APIMessageInteractionMetadata

APIMessageInteractionMetadata: APIApplicationCommandInteractionMetadata | APIMessageComponentInteractionMetadata | APIModalSubmitInteractionMetadata

https://discord.com/developers/docs/resources/channel#message-interaction-metadata-object

APIMessageReferenceSend

APIMessageReferenceSend: RESTAPIMessageReference
@deprecated

Use RESTAPIMessageReference instead

APIMessageSelectMenuInteractionData

APIMessageSelectMenuInteractionData: APIMessageChannelSelectInteractionData | APIMessageMentionableSelectInteractionData | APIMessageRoleSelectInteractionData | APIMessageStringSelectInteractionData | APIMessageUserSelectInteractionData

APIMessageSnapshotFields

APIMessageSnapshotFields: Pick<APIMessage, attachments | components | content | edited_timestamp | embeds | flags | mention_roles | mentions | sticker_items | stickers | timestamp | type>

APIModalActionRowComponent

APIModalActionRowComponent: APITextInputComponent

APIModalComponent

APIModalComponent: APIActionRowComponent<APIModalActionRowComponent> | APIModalActionRowComponent

APIModalSubmitDMInteraction

APIModalSubmitDMInteraction: APIDMInteractionWrapper<APIModalSubmitInteraction>

https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object

APIModalSubmitGuildInteraction

APIModalSubmitGuildInteraction: APIGuildInteractionWrapper<APIModalSubmitInteraction>

https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object

APIModalSubmitInteraction

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

https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object

APINewsChannel

APINewsChannel: APIGuildTextChannel<ChannelType.GuildAnnouncement>

APIPingInteraction

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

APIRoleSelectComponent

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

https://discord.com/developers/docs/interactions/message-components#select-menus

APISelectMenuComponent

APISelectMenuComponent: APIChannelSelectComponent | APIMentionableSelectComponent | APIRoleSelectComponent | APIStringSelectComponent | APIUserSelectComponent

https://discord.com/developers/docs/interactions/message-components#select-menus

APIStickerItem

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

https://discord.com/developers/docs/resources/sticker#sticker-item-object

APITextChannel

APITextChannel: APIGuildTextChannel<ChannelType.GuildText>

APIUserApplicationCommandDMInteraction

APIUserApplicationCommandDMInteraction: APIDMInteractionWrapper<APIUserApplicationCommandInteraction>

https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object

APIUserApplicationCommandGuildInteraction

APIUserApplicationCommandGuildInteraction: APIGuildInteractionWrapper<APIUserApplicationCommandInteraction>

https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object

APIUserApplicationCommandInteraction

APIUserApplicationCommandInteraction: APIApplicationCommandInteractionWrapper<APIUserApplicationCommandInteractionData>

https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object

APIUserApplicationCommandInteractionDataResolved

APIUserApplicationCommandInteractionDataResolved: APIUserInteractionDataResolved
@deprecated

Renamed to APIUserInteractionDataResolved

APIUserInteractionDataResolved

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

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

APIUserSelectComponent

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

https://discord.com/developers/docs/interactions/message-components#select-menus

AchievementIconFormat

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

ApplicationAssetFormat

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

ApplicationCoverFormat

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

ApplicationIconFormat

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

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>>

https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-assets

GatewayActivityEmoji

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

https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-emoji

GatewayActivitySecrets

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

https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-secrets

GatewayActivityUpdateData

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

https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-structure

GatewayApplicationCommandPermissionsUpdateDispatch

GatewayApplicationCommandPermissionsUpdateDispatch: DataPayload<GatewayDispatchEvents.ApplicationCommandPermissionsUpdate, GatewayApplicationCommandPermissionsUpdateDispatchData>

https://discord.com/developers/docs/topics/gateway-events#application-command-permissions-update

GatewayAutoModerationActionExecutionDispatch

GatewayAutoModerationActionExecutionDispatch: DataPayload<GatewayDispatchEvents.AutoModerationActionExecution, GatewayAutoModerationActionExecutionDispatchData>

https://discord.com/developers/docs/topics/gateway-events#auto-moderation-action-execution

GatewayAutoModerationRuleCreateDispatch

GatewayAutoModerationRuleCreateDispatch: GatewayAutoModerationRuleModifyDispatch

https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-create

GatewayAutoModerationRuleCreateDispatchData

GatewayAutoModerationRuleCreateDispatchData: GatewayAutoModerationRuleModifyDispatchData

https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-create

GatewayAutoModerationRuleDeleteDispatch

GatewayAutoModerationRuleDeleteDispatch: GatewayAutoModerationRuleModifyDispatch

https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-delete

GatewayAutoModerationRuleDeleteDispatchData

GatewayAutoModerationRuleDeleteDispatchData: GatewayAutoModerationRuleModifyDispatchData

https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-delete

GatewayAutoModerationRuleModifyDispatch

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

https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-create https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-update https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-delete

GatewayAutoModerationRuleModifyDispatchData

GatewayAutoModerationRuleModifyDispatchData: APIAutoModerationRule

https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-create https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-update https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-delete

GatewayAutoModerationRuleUpdateDispatch

GatewayAutoModerationRuleUpdateDispatch: GatewayAutoModerationRuleModifyDispatch

https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-update

GatewayAutoModerationRuleUpdateDispatchData

GatewayAutoModerationRuleUpdateDispatchData: GatewayAutoModerationRuleModifyDispatchData

https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-update

GatewayChannelCreateDispatch

GatewayChannelCreateDispatch: GatewayChannelModifyDispatch

https://discord.com/developers/docs/topics/gateway-events#channel-create

GatewayChannelCreateDispatchData

GatewayChannelCreateDispatchData: GatewayChannelModifyDispatchData

https://discord.com/developers/docs/topics/gateway-events#channel-create

GatewayChannelDeleteDispatch

GatewayChannelDeleteDispatch: GatewayChannelModifyDispatch

https://discord.com/developers/docs/topics/gateway-events#channel-delete

GatewayChannelDeleteDispatchData

GatewayChannelDeleteDispatchData: GatewayChannelModifyDispatchData

https://discord.com/developers/docs/topics/gateway-events#channel-delete

GatewayChannelModifyDispatch

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

https://discord.com/developers/docs/topics/gateway-events#channel-create https://discord.com/developers/docs/topics/gateway-events#channel-update https://discord.com/developers/docs/topics/gateway-events#channel-delete

GatewayChannelModifyDispatchData

GatewayChannelModifyDispatchData: APIChannel

https://discord.com/developers/docs/topics/gateway-events#channel-create https://discord.com/developers/docs/topics/gateway-events#channel-update https://discord.com/developers/docs/topics/gateway-events#channel-delete

GatewayChannelPinsUpdateDispatch

GatewayChannelPinsUpdateDispatch: DataPayload<GatewayDispatchEvents.ChannelPinsUpdate, GatewayChannelPinsUpdateDispatchData>

https://discord.com/developers/docs/topics/gateway-events#channel-pins-update

GatewayChannelUpdateDispatch

GatewayChannelUpdateDispatch: GatewayChannelModifyDispatch

https://discord.com/developers/docs/topics/gateway-events#channel-update

GatewayChannelUpdateDispatchData

GatewayChannelUpdateDispatchData: GatewayChannelModifyDispatchData

https://discord.com/developers/docs/topics/gateway-events#channel-update

GatewayDispatchPayload

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

GatewayEntitlementCreateDispatch

GatewayEntitlementCreateDispatch: GatewayEntitlementModifyDispatch

https://discord.com/developers/docs/topics/gateway-events#entitlement-create

GatewayEntitlementCreateDispatchData

GatewayEntitlementCreateDispatchData: Omit<GatewayEntitlementModifyDispatchData, ends_at> & { ends_at: GatewayEntitlementModifyDispatchData[ends_at] | null }

https://discord.com/developers/docs/topics/gateway-events#entitlement-create

GatewayEntitlementDeleteDispatch

GatewayEntitlementDeleteDispatch: GatewayEntitlementModifyDispatch

https://discord.com/developers/docs/topics/gateway-events#entitlement-delete

GatewayEntitlementDeleteDispatchData

GatewayEntitlementDeleteDispatchData: GatewayEntitlementModifyDispatchData

https://discord.com/developers/docs/topics/gateway-events#entitlement-delete

GatewayEntitlementModifyDispatch

GatewayEntitlementModifyDispatch: DataPayload<GatewayDispatchEvents.EntitlementCreate | GatewayDispatchEvents.EntitlementDelete | GatewayDispatchEvents.EntitlementUpdate, GatewayEntitlementModifyDispatchData>

https://discord.com/developers/docs/topics/gateway-events#entitlement-create https://discord.com/developers/docs/topics/gateway-events#entitlement-update https://discord.com/developers/docs/topics/gateway-events#entitlement-delete

GatewayEntitlementModifyDispatchData

GatewayEntitlementModifyDispatchData: APIEntitlement

https://discord.com/developers/docs/topics/gateway-events#entitlement-create https://discord.com/developers/docs/topics/gateway-events#entitlement-update https://discord.com/developers/docs/topics/gateway-events#entitlement-delete

GatewayEntitlementUpdateDispatch

GatewayEntitlementUpdateDispatch: GatewayEntitlementModifyDispatch

https://discord.com/developers/docs/topics/gateway-events#entitlement-update

GatewayEntitlementUpdateDispatchData

GatewayEntitlementUpdateDispatchData: GatewayEntitlementModifyDispatchData

https://discord.com/developers/docs/topics/gateway-events#entitlement-update

GatewayGuildAuditLogEntryCreateDispatch

GatewayGuildAuditLogEntryCreateDispatch: DataPayload<GatewayDispatchEvents.GuildAuditLogEntryCreate, GatewayGuildAuditLogEntryCreateDispatchData>

https://discord.com/developers/docs/topics/gateway-events#guild-audit-log-entry-create

GatewayGuildBanAddDispatch

GatewayGuildBanAddDispatch: GatewayGuildBanModifyDispatch

https://discord.com/developers/docs/topics/gateway-events#guild-ban-add

GatewayGuildBanAddDispatchData

GatewayGuildBanAddDispatchData: GatewayGuildBanModifyDispatchData

https://discord.com/developers/docs/topics/gateway-events#guild-ban-add

GatewayGuildBanModifyDispatch

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

https://discord.com/developers/docs/topics/gateway-events#guild-ban-add https://discord.com/developers/docs/topics/gateway-events#guild-ban-remove

GatewayGuildBanRemoveDispatch

GatewayGuildBanRemoveDispatch: GatewayGuildBanModifyDispatch

https://discord.com/developers/docs/topics/gateway-events#guild-ban-remove

GatewayGuildBanRemoveDispatchData

GatewayGuildBanRemoveDispatchData: GatewayGuildBanModifyDispatchData

https://discord.com/developers/docs/topics/gateway-events#guild-ban-remove

GatewayGuildCreateDispatch

GatewayGuildCreateDispatch: DataPayload<GatewayDispatchEvents.GuildCreate, GatewayGuildCreateDispatchData>

https://discord.com/developers/docs/topics/gateway-events#guild-create

GatewayGuildDeleteDispatch

GatewayGuildDeleteDispatch: DataPayload<GatewayDispatchEvents.GuildDelete, GatewayGuildDeleteDispatchData>

https://discord.com/developers/docs/topics/gateway-events#guild-delete

GatewayGuildEmojisUpdateDispatch

GatewayGuildEmojisUpdateDispatch: DataPayload<GatewayDispatchEvents.GuildEmojisUpdate, GatewayGuildEmojisUpdateDispatchData>

https://discord.com/developers/docs/topics/gateway-events#guild-emojis-update

GatewayGuildIntegrationsUpdateDispatch

GatewayGuildIntegrationsUpdateDispatch: DataPayload<GatewayDispatchEvents.GuildIntegrationsUpdate, GatewayGuildIntegrationsUpdateDispatchData>

https://discord.com/developers/docs/topics/gateway-events#guild-integrations-update

GatewayGuildMemberAddDispatch

GatewayGuildMemberAddDispatch: DataPayload<GatewayDispatchEvents.GuildMemberAdd, GatewayGuildMemberAddDispatchData>

https://discord.com/developers/docs/topics/gateway-events#guild-member-add

GatewayGuildMemberRemoveDispatch

GatewayGuildMemberRemoveDispatch: DataPayload<GatewayDispatchEvents.GuildMemberRemove, GatewayGuildMemberRemoveDispatchData>

https://discord.com/developers/docs/topics/gateway-events#guild-member-remove

GatewayGuildMemberUpdateDispatch

GatewayGuildMemberUpdateDispatch: DataPayload<GatewayDispatchEvents.GuildMemberUpdate, GatewayGuildMemberUpdateDispatchData>

https://discord.com/developers/docs/topics/gateway-events#guild-member-update

GatewayGuildMemberUpdateDispatchData

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

https://discord.com/developers/docs/topics/gateway-events#guild-member-update

GatewayGuildMembersChunkDispatch

GatewayGuildMembersChunkDispatch: DataPayload<GatewayDispatchEvents.GuildMembersChunk, GatewayGuildMembersChunkDispatchData>

https://discord.com/developers/docs/topics/gateway-events#guild-members-chunk

GatewayGuildMembersChunkPresence

GatewayGuildMembersChunkPresence: Omit<RawGatewayPresenceUpdate, guild_id>

https://discord.com/developers/docs/topics/gateway-events#update-presence

GatewayGuildModifyDispatch

GatewayGuildModifyDispatch: DataPayload<GatewayDispatchEvents.GuildUpdate, GatewayGuildModifyDispatchData>

https://discord.com/developers/docs/topics/gateway-events#guild-update

GatewayGuildModifyDispatchData

GatewayGuildModifyDispatchData: APIGuild

https://discord.com/developers/docs/topics/gateway-events#guild-update

GatewayGuildRoleCreateDispatch

GatewayGuildRoleCreateDispatch: GatewayGuildRoleModifyDispatch

https://discord.com/developers/docs/topics/gateway-events#guild-role-create

GatewayGuildRoleCreateDispatchData

GatewayGuildRoleCreateDispatchData: GatewayGuildRoleModifyDispatchData

https://discord.com/developers/docs/topics/gateway-events#guild-role-create

GatewayGuildRoleDeleteDispatch

GatewayGuildRoleDeleteDispatch: DataPayload<GatewayDispatchEvents.GuildRoleDelete, GatewayGuildRoleDeleteDispatchData>

https://discord.com/developers/docs/topics/gateway-events#guild-role-delete

GatewayGuildRoleModifyDispatch

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

https://discord.com/developers/docs/topics/gateway-events#guild-role-create https://discord.com/developers/docs/topics/gateway-events#guild-role-update

GatewayGuildRoleUpdateDispatch

GatewayGuildRoleUpdateDispatch: GatewayGuildRoleModifyDispatch

https://discord.com/developers/docs/topics/gateway-events#guild-role-update

GatewayGuildRoleUpdateDispatchData

GatewayGuildRoleUpdateDispatchData: GatewayGuildRoleModifyDispatchData

https://discord.com/developers/docs/topics/gateway-events#guild-role-update

GatewayGuildScheduledEventCreateDispatch

GatewayGuildScheduledEventCreateDispatch: DataPayload<GatewayDispatchEvents.GuildScheduledEventCreate, GatewayGuildScheduledEventCreateDispatchData>

https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-create

GatewayGuildScheduledEventCreateDispatchData

GatewayGuildScheduledEventCreateDispatchData: APIGuildScheduledEvent

https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-create

GatewayGuildScheduledEventDeleteDispatch

GatewayGuildScheduledEventDeleteDispatch: DataPayload<GatewayDispatchEvents.GuildScheduledEventDelete, GatewayGuildScheduledEventDeleteDispatchData>

https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-delete

GatewayGuildScheduledEventDeleteDispatchData

GatewayGuildScheduledEventDeleteDispatchData: APIGuildScheduledEvent

https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-delete

GatewayGuildScheduledEventUpdateDispatch

GatewayGuildScheduledEventUpdateDispatch: DataPayload<GatewayDispatchEvents.GuildScheduledEventUpdate, GatewayGuildScheduledEventUpdateDispatchData>

https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-update

GatewayGuildScheduledEventUpdateDispatchData

GatewayGuildScheduledEventUpdateDispatchData: APIGuildScheduledEvent

https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-update

GatewayGuildScheduledEventUserAddDispatch

GatewayGuildScheduledEventUserAddDispatch: DataPayload<GatewayDispatchEvents.GuildScheduledEventUserAdd, GatewayGuildScheduledEventUserAddDispatchData>

https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-user-add

GatewayGuildScheduledEventUserRemoveDispatch

GatewayGuildScheduledEventUserRemoveDispatch: DataPayload<GatewayDispatchEvents.GuildScheduledEventUserRemove, GatewayGuildScheduledEventUserAddDispatchData>

https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-user-remove

GatewayGuildSoundboardSoundCreateDispatch

GatewayGuildSoundboardSoundCreateDispatch: DataPayload<GatewayDispatchEvents.GuildSoundboardSoundCreate, GatewayGuildSoundboardSoundCreateDispatchData>

https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sound-create

GatewayGuildSoundboardSoundCreateDispatchData

GatewayGuildSoundboardSoundCreateDispatchData: APISoundboardSound

https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sound-create

GatewayGuildSoundboardSoundDeleteDispatch

GatewayGuildSoundboardSoundDeleteDispatch: DataPayload<GatewayDispatchEvents.GuildSoundboardSoundDelete, GatewayGuildSoundboardSoundDeleteDispatchData>

https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sound-delete

GatewayGuildSoundboardSoundUpdateDispatch

GatewayGuildSoundboardSoundUpdateDispatch: DataPayload<GatewayDispatchEvents.GuildSoundboardSoundUpdate, GatewayGuildSoundboardSoundUpdateDispatchData>

https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sound-update

GatewayGuildSoundboardSoundUpdateDispatchData

GatewayGuildSoundboardSoundUpdateDispatchData: APISoundboardSound

https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sound-update

GatewayGuildSoundboardSoundsUpdateDispatch

GatewayGuildSoundboardSoundsUpdateDispatch: DataPayload<GatewayDispatchEvents.GuildSoundboardSoundsUpdate, GatewayGuildSoundboardSoundsUpdateDispatchData>

https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sounds-update

GatewayGuildStickersUpdateDispatch

GatewayGuildStickersUpdateDispatch: DataPayload<GatewayDispatchEvents.GuildStickersUpdate, GatewayGuildStickersUpdateDispatchData>

https://discord.com/developers/docs/topics/gateway-events#guild-stickers-update

GatewayGuildUpdateDispatch

GatewayGuildUpdateDispatch: GatewayGuildModifyDispatch

https://discord.com/developers/docs/topics/gateway-events#guild-update

GatewayGuildUpdateDispatchData

GatewayGuildUpdateDispatchData: GatewayGuildModifyDispatchData

https://discord.com/developers/docs/topics/gateway-events#guild-update

GatewayHeartbeatData

GatewayHeartbeatData: number | null

https://discord.com/developers/docs/topics/gateway#sending-heartbeats

GatewayIntegrationCreateDispatch

GatewayIntegrationCreateDispatch: DataPayload<GatewayDispatchEvents.IntegrationCreate, GatewayIntegrationCreateDispatchData>

https://discord.com/developers/docs/topics/gateway-events#integration-create

GatewayIntegrationCreateDispatchData

GatewayIntegrationCreateDispatchData: APIGuildIntegration & { guild_id: Snowflake }

https://discord.com/developers/docs/topics/gateway-events#integration-create

GatewayIntegrationDeleteDispatch

GatewayIntegrationDeleteDispatch: DataPayload<GatewayDispatchEvents.IntegrationDelete, GatewayIntegrationDeleteDispatchData>

https://discord.com/developers/docs/topics/gateway-events#integration-update

GatewayIntegrationUpdateDispatch

GatewayIntegrationUpdateDispatch: DataPayload<GatewayDispatchEvents.IntegrationUpdate, GatewayIntegrationUpdateDispatchData>

https://discord.com/developers/docs/topics/gateway-events#integration-update

GatewayIntegrationUpdateDispatchData

GatewayIntegrationUpdateDispatchData: APIGuildIntegration & { guild_id: Snowflake }

https://discord.com/developers/docs/topics/gateway-events#integration-update

GatewayInteractionCreateDispatch

GatewayInteractionCreateDispatch: DataPayload<GatewayDispatchEvents.InteractionCreate, GatewayInteractionCreateDispatchData>

https://discord.com/developers/docs/topics/gateway-events#interaction-create

GatewayInteractionCreateDispatchData

GatewayInteractionCreateDispatchData: APIInteraction

https://discord.com/developers/docs/topics/gateway-events#interaction-create

GatewayInvalidSessionData

GatewayInvalidSessionData: boolean

https://discord.com/developers/docs/topics/gateway-events#invalid-session

GatewayInviteCreateDispatch

GatewayInviteCreateDispatch: DataPayload<GatewayDispatchEvents.InviteCreate, GatewayInviteCreateDispatchData>

https://discord.com/developers/docs/topics/gateway-events#invite-create

GatewayInviteDeleteDispatch

GatewayInviteDeleteDispatch: DataPayload<GatewayDispatchEvents.InviteDelete, GatewayInviteDeleteDispatchData>

https://discord.com/developers/docs/topics/gateway-events#invite-delete

GatewayMessageCreateDispatch

GatewayMessageCreateDispatch: DataPayload<GatewayDispatchEvents.MessageCreate, GatewayMessageCreateDispatchData>

https://discord.com/developers/docs/topics/gateway-events#message-create

GatewayMessageCreateDispatchData

GatewayMessageCreateDispatchData: GatewayMessageEventExtraFields & Omit<APIMessage, mentions>

https://discord.com/developers/docs/topics/gateway-events#message-create

GatewayMessageDeleteBulkDispatch

GatewayMessageDeleteBulkDispatch: DataPayload<GatewayDispatchEvents.MessageDeleteBulk, GatewayMessageDeleteBulkDispatchData>

https://discord.com/developers/docs/topics/gateway-events#message-delete-bulk

GatewayMessageDeleteDispatch

GatewayMessageDeleteDispatch: DataPayload<GatewayDispatchEvents.MessageDelete, GatewayMessageDeleteDispatchData>

https://discord.com/developers/docs/topics/gateway-events#message-delete

GatewayMessagePollVoteAddDispatch

GatewayMessagePollVoteAddDispatch: DataPayload<GatewayDispatchEvents.MessagePollVoteAdd, GatewayMessagePollVoteDispatchData>

https://discord.com/developers/docs/topics/gateway-events#message-poll-vote-add

GatewayMessagePollVoteRemoveDispatch

GatewayMessagePollVoteRemoveDispatch: DataPayload<GatewayDispatchEvents.MessagePollVoteRemove, GatewayMessagePollVoteDispatchData>

https://discord.com/developers/docs/topics/gateway-events#message-poll-vote-remove

GatewayMessageReactionAddDispatch

GatewayMessageReactionAddDispatch: ReactionData<GatewayDispatchEvents.MessageReactionAdd>

https://discord.com/developers/docs/topics/gateway-events#message-reaction-add

GatewayMessageReactionAddDispatchData

GatewayMessageReactionAddDispatchData: GatewayMessageReactionAddDispatch[d]

https://discord.com/developers/docs/topics/gateway-events#message-reaction-add

GatewayMessageReactionRemoveAllDispatch

GatewayMessageReactionRemoveAllDispatch: DataPayload<GatewayDispatchEvents.MessageReactionRemoveAll, GatewayMessageReactionRemoveAllDispatchData>

https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove-all

GatewayMessageReactionRemoveAllDispatchData

GatewayMessageReactionRemoveAllDispatchData: MessageReactionRemoveData

https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove-all

GatewayMessageReactionRemoveDispatch

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

https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove

GatewayMessageReactionRemoveDispatchData

GatewayMessageReactionRemoveDispatchData: GatewayMessageReactionRemoveDispatch[d]

https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove

GatewayMessageReactionRemoveEmojiDispatch

GatewayMessageReactionRemoveEmojiDispatch: DataPayload<GatewayDispatchEvents.MessageReactionRemoveEmoji, GatewayMessageReactionRemoveEmojiDispatchData>

https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove-emoji

GatewayMessageUpdateDispatch

GatewayMessageUpdateDispatch: DataPayload<GatewayDispatchEvents.MessageUpdate, GatewayMessageUpdateDispatchData>

https://discord.com/developers/docs/topics/gateway-events#message-update

GatewayMessageUpdateDispatchData

GatewayMessageUpdateDispatchData: GatewayMessageEventExtraFields & Omit<APIMessage, mentions>

https://discord.com/developers/docs/topics/gateway-events#message-update

GatewayPresenceUpdateDispatch

GatewayPresenceUpdateDispatch: DataPayload<GatewayDispatchEvents.PresenceUpdate, GatewayPresenceUpdateDispatchData>

https://discord.com/developers/docs/topics/gateway-events#presence-update

GatewayPresenceUpdateDispatchData

GatewayPresenceUpdateDispatchData: RawGatewayPresenceUpdate

https://discord.com/developers/docs/topics/gateway-events#presence-update

GatewayReadyDispatch

GatewayReadyDispatch: DataPayload<GatewayDispatchEvents.Ready, GatewayReadyDispatchData>

https://discord.com/developers/docs/topics/gateway-events#ready

GatewayReceivePayload

GatewayReceivePayload: GatewayDispatchPayload | GatewayHeartbeatAck | GatewayHeartbeatRequest | GatewayHello | GatewayInvalidSession | GatewayReconnect

GatewayRequestGuildMembersData

GatewayRequestGuildMembersData: GatewayRequestGuildMembersDataWithQuery | GatewayRequestGuildMembersDataWithUserIds

https://discord.com/developers/docs/topics/gateway-events#request-guild-members

GatewayResumedDispatch

GatewayResumedDispatch: DataPayload<GatewayDispatchEvents.Resumed, never>

https://discord.com/developers/docs/topics/gateway-events#resumed

GatewaySendPayload

GatewaySendPayload: GatewayHeartbeat | GatewayIdentify | GatewayRequestGuildMembers | GatewayRequestSoundboardSounds | GatewayResume | GatewayUpdatePresence | GatewayVoiceStateUpdate

GatewaySoundboardSoundsDispatch

GatewaySoundboardSoundsDispatch: DataPayload<GatewayDispatchEvents.SoundboardSounds, GatewaySoundboardSoundsDispatchData>

https://discord.com/developers/docs/events/gateway-events#soundboard-sounds

GatewayStageInstanceCreateDispatch

GatewayStageInstanceCreateDispatch: DataPayload<GatewayDispatchEvents.StageInstanceCreate, GatewayStageInstanceCreateDispatchData>

https://discord.com/developers/docs/topics/gateway-events#stage-instance-create

GatewayStageInstanceCreateDispatchData

GatewayStageInstanceCreateDispatchData: APIStageInstance

https://discord.com/developers/docs/topics/gateway-events#stage-instance-create

GatewayStageInstanceDeleteDispatch

GatewayStageInstanceDeleteDispatch: DataPayload<GatewayDispatchEvents.StageInstanceDelete, GatewayStageInstanceDeleteDispatchData>

https://discord.com/developers/docs/topics/gateway-events#stage-instance-delete

GatewayStageInstanceDeleteDispatchData

GatewayStageInstanceDeleteDispatchData: APIStageInstance

https://discord.com/developers/docs/topics/gateway-events#stage-instance-delete

GatewayStageInstanceUpdateDispatch

GatewayStageInstanceUpdateDispatch: DataPayload<GatewayDispatchEvents.StageInstanceUpdate, GatewayStageInstanceUpdateDispatchData>

https://discord.com/developers/docs/topics/gateway-events#stage-instance-update

GatewayStageInstanceUpdateDispatchData

GatewayStageInstanceUpdateDispatchData: APIStageInstance

https://discord.com/developers/docs/topics/gateway-events#stage-instance-update

GatewaySubscriptionCreateDispatch

GatewaySubscriptionCreateDispatch: GatewaySubscriptionModifyDispatch

https://discord.com/developers/docs/topics/gateway-events#subscription-create

GatewaySubscriptionCreateDispatchData

GatewaySubscriptionCreateDispatchData: GatewaySubscriptionModifyDispatchData

https://discord.com/developers/docs/topics/gateway-events#subscription-create

GatewaySubscriptionDeleteDispatch

GatewaySubscriptionDeleteDispatch: GatewaySubscriptionModifyDispatch

https://discord.com/developers/docs/topics/gateway-events#subscription-delete

GatewaySubscriptionDeleteDispatchData

GatewaySubscriptionDeleteDispatchData: GatewaySubscriptionModifyDispatchData

https://discord.com/developers/docs/topics/gateway-events#subscription-delete

GatewaySubscriptionModifyDispatch

GatewaySubscriptionModifyDispatch: DataPayload<GatewayDispatchEvents.SubscriptionCreate | GatewayDispatchEvents.SubscriptionDelete | GatewayDispatchEvents.SubscriptionUpdate, GatewaySubscriptionModifyDispatchData>

https://discord.com/developers/docs/topics/gateway-events#subscription-create https://discord.com/developers/docs/topics/gateway-events#subscription-update https://discord.com/developers/docs/topics/gateway-events#subscription-delete

GatewaySubscriptionModifyDispatchData

GatewaySubscriptionModifyDispatchData: APISubscription

https://discord.com/developers/docs/topics/gateway-events#subscription-create https://discord.com/developers/docs/topics/gateway-events#subscription-update https://discord.com/developers/docs/topics/gateway-events#subscription-delete

GatewaySubscriptionUpdateDispatch

GatewaySubscriptionUpdateDispatch: GatewaySubscriptionModifyDispatch

https://discord.com/developers/docs/topics/gateway-events#subscription-update

GatewaySubscriptionUpdateDispatchData

GatewaySubscriptionUpdateDispatchData: GatewaySubscriptionModifyDispatchData

https://discord.com/developers/docs/topics/gateway-events#subscription-update

GatewayThreadCreateDispatch

GatewayThreadCreateDispatch: DataPayload<GatewayDispatchEvents.ThreadCreate, GatewayThreadCreateDispatchData>

https://discord.com/developers/docs/topics/gateway-events#thread-create

GatewayThreadDeleteDispatch

GatewayThreadDeleteDispatch: DataPayload<GatewayDispatchEvents.ThreadDelete, GatewayThreadDeleteDispatchData>

https://discord.com/developers/docs/topics/gateway-events#thread-delete

GatewayThreadListSyncDispatch

GatewayThreadListSyncDispatch: DataPayload<GatewayDispatchEvents.ThreadListSync, GatewayThreadListSyncDispatchData>

https://discord.com/developers/docs/topics/gateway-events#thread-list-sync

GatewayThreadListSyncDispatchData

GatewayThreadListSyncDispatchData: RawGatewayThreadListSync

https://discord.com/developers/docs/topics/gateway-events#thread-list-sync

GatewayThreadMemberUpdateDispatch

GatewayThreadMemberUpdateDispatch: DataPayload<GatewayDispatchEvents.ThreadMemberUpdate, GatewayThreadMemberUpdateDispatchData>

https://discord.com/developers/docs/topics/gateway-events#thread-member-update

GatewayThreadMemberUpdateDispatchData

GatewayThreadMemberUpdateDispatchData: APIThreadMember & { guild_id: Snowflake }

https://discord.com/developers/docs/topics/gateway-events#thread-member-update

GatewayThreadMembersUpdateDispatch

GatewayThreadMembersUpdateDispatch: DataPayload<GatewayDispatchEvents.ThreadMembersUpdate, GatewayThreadMembersUpdateDispatchData>

https://discord.com/developers/docs/topics/gateway-events#thread-members-update

GatewayThreadMembersUpdateDispatchData

GatewayThreadMembersUpdateDispatchData: RawGatewayThreadMembersUpdate

https://discord.com/developers/docs/topics/gateway-events#thread-members-update

GatewayThreadModifyDispatch

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

This type doesn’t accurately reflect the Discord API. Use GatewayThreadCreateDispatch, GatewayThreadUpdateDispatch, or GatewayThreadDeleteDispatch instead. https://discord.com/developers/docs/topics/gateway-events#thread-create https://discord.com/developers/docs/topics/gateway-events#thread-update https://discord.com/developers/docs/topics/gateway-events#thread-delete

GatewayThreadUpdateDispatch

GatewayThreadUpdateDispatch: DataPayload<GatewayDispatchEvents.ThreadUpdate, GatewayThreadUpdateDispatchData>

https://discord.com/developers/docs/topics/gateway-events#thread-update

GatewayThreadUpdateDispatchData

GatewayThreadUpdateDispatchData: APIThreadChannel

https://discord.com/developers/docs/topics/gateway-events#thread-update

GatewayTypingStartDispatch

GatewayTypingStartDispatch: DataPayload<GatewayDispatchEvents.TypingStart, GatewayTypingStartDispatchData>

https://discord.com/developers/docs/topics/gateway-events#typing-start

GatewayUserUpdateDispatch

GatewayUserUpdateDispatch: DataPayload<GatewayDispatchEvents.UserUpdate, GatewayUserUpdateDispatchData>

https://discord.com/developers/docs/topics/gateway-events#user-update

GatewayUserUpdateDispatchData

GatewayUserUpdateDispatchData: APIUser

https://discord.com/developers/docs/topics/gateway-events#user-update

GatewayVoiceChannelEffectSendDispatch

GatewayVoiceChannelEffectSendDispatch: DataPayload<GatewayDispatchEvents.VoiceChannelEffectSend, GatewayVoiceChannelEffectSendDispatchData>

https://discord.com/developers/docs/topics/gateway-events#voice-channel-effect-send

GatewayVoiceServerUpdateDispatch

GatewayVoiceServerUpdateDispatch: DataPayload<GatewayDispatchEvents.VoiceServerUpdate, GatewayVoiceServerUpdateDispatchData>

https://discord.com/developers/docs/topics/gateway-events#voice-server-update

GatewayVoiceState

GatewayVoiceState: APIVoiceState

https://discord.com/developers/docs/resources/voice#voice-state-object

@deprecated

This is deprecated, use APIVoiceState

GatewayVoiceStateUpdateDispatch

GatewayVoiceStateUpdateDispatch: DataPayload<GatewayDispatchEvents.VoiceStateUpdate, GatewayVoiceStateUpdateDispatchData>

https://discord.com/developers/docs/topics/gateway-events#voice-state-update

GatewayVoiceStateUpdateDispatchData

GatewayVoiceStateUpdateDispatchData: APIVoiceState

https://discord.com/developers/docs/topics/gateway-events#voice-state-update

GatewayWebhooksUpdateDispatch

GatewayWebhooksUpdateDispatch: DataPayload<GatewayDispatchEvents.WebhooksUpdate, GatewayWebhooksUpdateDispatchData>

https://discord.com/developers/docs/topics/gateway-events#webhooks-update

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.GIF | ImageFormat.Lottie>

GuildIconFormat

GuildIconFormat: Exclude<ImageFormat, ImageFormat.Lottie>

GuildMemberAvatarFormat

GuildMemberAvatarFormat: Exclude<ImageFormat, ImageFormat.Lottie>

GuildMemberBannerFormat

GuildMemberBannerFormat: Exclude<ImageFormat, ImageFormat.Lottie>

GuildScheduledEventCoverFormat

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

GuildSplashFormat

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

GuildTextChannelType

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

PartialAPIMessageInteractionGuildMember

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

PresenceUpdateReceiveStatus

PresenceUpdateReceiveStatus: Exclude<PresenceUpdateStatus, PresenceUpdateStatus.Invisible>

RESTAPIAttachment

RESTAPIAttachment: Partial<Pick<APIAttachment, description | duration_secs | filename | title | waveform>> & { id: Snowflake | number }

https://discord.com/developers/docs/resources/message#attachment-object-attachment-structure

RESTAPIGuildChannelResolvable

RESTAPIGuildChannelResolvable: Exclude<APIChannel, APIDMChannel | APIGroupDMChannel>

RESTAPIGuildCreatePartialChannel

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

RESTAPIGuildOnboardingPrompt

RESTAPIGuildOnboardingPrompt: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<Partial<Omit<APIGuildOnboardingPrompt, guild_id | id | options | title>>> & Pick<APIGuildOnboardingPrompt, id | title> & { options: RESTAPIGuildOnboardingPromptOption[] }

RESTAPIGuildOnboardingPromptOption

RESTAPIGuildOnboardingPromptOption: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<Partial<Omit<APIGuildOnboardingPromptOption, emoji | guild_id | title>>> & Pick<APIGuildOnboardingPromptOption, title> & { emoji_animated?: boolean | null; emoji_id?: Snowflake | null; emoji_name?: string | null }

RESTAPIMessageReference

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

https://discord.com/developers/docs/resources/channel#message-reference-object-message-reference-structure

RESTAPIModifyGuildOnboardingPromptData

RESTAPIModifyGuildOnboardingPromptData: RESTAPIGuildOnboardingPrompt
@deprecated

Use RESTAPIGuildOnboardingPrompt instead.

RESTAPIModifyGuildOnboardingPromptOptionData

RESTAPIModifyGuildOnboardingPromptOptionData: RESTAPIGuildOnboardingPromptOption
@deprecated

Use RESTAPIGuildOnboardingPromptOption instead.

RESTAPIPollCreate

RESTAPIPollCreate: RESTAPIPoll
@deprecated

Use RESTAPIPoll instead

RESTDeleteAPIApplicationEmojiResult

RESTDeleteAPIApplicationEmojiResult: never

https://discord.com/developers/docs/resources/emoji#delete-application-emoji

RESTDeleteAPIAutoModerationRuleResult

RESTDeleteAPIAutoModerationRuleResult: never

https://discord.com/developers/docs/resources/auto-moderation#delete-auto-moderation-rule

RESTDeleteAPIChannelAllMessageReactionsResult

RESTDeleteAPIChannelAllMessageReactionsResult: never

https://discord.com/developers/docs/resources/channel#delete-all-reactions

RESTDeleteAPIChannelMessageOwnReaction

RESTDeleteAPIChannelMessageOwnReaction: RESTDeleteAPIChannelMessageOwnReactionResult
@deprecated

Use RESTDeleteAPIChannelMessageOwnReactionResult instead

RESTDeleteAPIChannelMessageOwnReactionResult

RESTDeleteAPIChannelMessageOwnReactionResult: never

https://discord.com/developers/docs/resources/channel#delete-own-reaction

RESTDeleteAPIChannelMessageReactionResult

RESTDeleteAPIChannelMessageReactionResult: never

https://discord.com/developers/docs/resources/channel#delete-all-reactions-for-emoji

RESTDeleteAPIChannelMessageResult

RESTDeleteAPIChannelMessageResult: never

https://discord.com/developers/docs/resources/channel#delete-message

RESTDeleteAPIChannelMessageUserReactionResult

RESTDeleteAPIChannelMessageUserReactionResult: never

https://discord.com/developers/docs/resources/channel#delete-user-reaction

RESTDeleteAPIChannelPermissionResult

RESTDeleteAPIChannelPermissionResult: never

https://discord.com/developers/docs/resources/channel#delete-channel-permission

RESTDeleteAPIChannelPinResult

RESTDeleteAPIChannelPinResult: never

https://discord.com/developers/docs/resources/channel#unpin-message

RESTDeleteAPIChannelRecipientResult

RESTDeleteAPIChannelRecipientResult: unknown

https://discord.com/developers/docs/resources/channel#group-dm-remove-recipient

RESTDeleteAPIChannelResult

RESTDeleteAPIChannelResult: APIChannel

https://discord.com/developers/docs/resources/channel#deleteclose-channel

RESTDeleteAPIChannelThreadMembersResult

RESTDeleteAPIChannelThreadMembersResult: never

https://discord.com/developers/docs/resources/channel#leave-thread

RESTDeleteAPICurrentUserGuildResult

RESTDeleteAPICurrentUserGuildResult: never

https://discord.com/developers/docs/resources/user#leave-guild

RESTDeleteAPIEntitlementResult

RESTDeleteAPIEntitlementResult: never

https://discord.com/developers/docs/resources/entitlement#delete-test-entitlement

RESTDeleteAPIGuildBanResult

RESTDeleteAPIGuildBanResult: never

https://discord.com/developers/docs/resources/guild#remove-guild-ban

RESTDeleteAPIGuildEmojiResult

RESTDeleteAPIGuildEmojiResult: never

https://discord.com/developers/docs/resources/emoji#delete-guild-emoji

RESTDeleteAPIGuildIntegrationResult

RESTDeleteAPIGuildIntegrationResult: never

https://discord.com/developers/docs/resources/guild#delete-guild-integration

RESTDeleteAPIGuildMemberResult

RESTDeleteAPIGuildMemberResult: never

https://discord.com/developers/docs/resources/guild#remove-guild-member

RESTDeleteAPIGuildMemberRoleResult

RESTDeleteAPIGuildMemberRoleResult: never

https://discord.com/developers/docs/resources/guild#remove-guild-member-role

RESTDeleteAPIGuildResult

RESTDeleteAPIGuildResult: never

https://discord.com/developers/docs/resources/guild#delete-guild

RESTDeleteAPIGuildRoleResult

RESTDeleteAPIGuildRoleResult: never

https://discord.com/developers/docs/resources/guild#delete-guild-role

RESTDeleteAPIGuildScheduledEventResult

RESTDeleteAPIGuildScheduledEventResult: never

https://discord.com/developers/docs/resources/guild-scheduled-event#delete-guild-scheduled-event

RESTDeleteAPIGuildSoundboardSoundResult

RESTDeleteAPIGuildSoundboardSoundResult: never

https://discord.com/developers/docs/resources/soundboard#delete-guild-soundboard-sound

RESTDeleteAPIGuildStickerResult

RESTDeleteAPIGuildStickerResult: never

https://discord.com/developers/docs/resources/sticker#delete-guild-sticker

RESTDeleteAPIGuildTemplateResult

RESTDeleteAPIGuildTemplateResult: APITemplate

https://discord.com/developers/docs/resources/guild-template#delete-guild-template

RESTDeleteAPIInteractionFollowupResult

RESTDeleteAPIInteractionFollowupResult: RESTDeleteAPIWebhookWithTokenMessageResult

https://discord.com/developers/docs/interactions/receiving-and-responding#delete-followup-message

RESTDeleteAPIInteractionOriginalResponseResult

RESTDeleteAPIInteractionOriginalResponseResult: RESTDeleteAPIWebhookWithTokenMessageResult

https://discord.com/developers/docs/interactions/receiving-and-responding#delete-original-interaction-response

RESTDeleteAPIInviteResult

RESTDeleteAPIInviteResult: APIInvite

https://discord.com/developers/docs/resources/invite#delete-invite

RESTDeleteAPIStageInstanceResult

RESTDeleteAPIStageInstanceResult: never

https://discord.com/developers/docs/resources/stage-instance#delete-stage-instance

RESTDeleteAPIWebhookResult

RESTDeleteAPIWebhookResult: never

https://discord.com/developers/docs/resources/webhook#delete-webhook

RESTDeleteAPIWebhookWithTokenMessageResult

RESTDeleteAPIWebhookWithTokenMessageResult: never

https://discord.com/developers/docs/resources/webhook#delete-webhook-message

RESTDeleteAPIWebhookWithTokenResult

RESTDeleteAPIWebhookWithTokenResult: never

https://discord.com/developers/docs/resources/webhook#delete-webhook-with-token

RESTGetAPIApplicationCommandPermissionsResult

RESTGetAPIApplicationCommandPermissionsResult: APIGuildApplicationCommandPermissions

https://discord.com/developers/docs/interactions/application-commands#get-application-command-permissions

RESTGetAPIApplicationCommandResult

RESTGetAPIApplicationCommandResult: APIApplicationCommand

https://discord.com/developers/docs/interactions/application-commands#get-global-application-command

RESTGetAPIApplicationCommandsResult

RESTGetAPIApplicationCommandsResult: APIApplicationCommand[]

https://discord.com/developers/docs/interactions/application-commands#get-global-application-commands

RESTGetAPIApplicationEmojiResult

RESTGetAPIApplicationEmojiResult: APIEmoji

https://discord.com/developers/docs/resources/emoji#get-application-emoji

RESTGetAPIApplicationGuildCommandResult

RESTGetAPIApplicationGuildCommandResult: Omit<APIApplicationCommand, dm_permission>

https://discord.com/developers/docs/interactions/application-commands#get-guild-application-commands

RESTGetAPIApplicationGuildCommandsQuery

RESTGetAPIApplicationGuildCommandsQuery: RESTGetAPIApplicationCommandsQuery

https://discord.com/developers/docs/interactions/application-commands#get-guild-application-commands

RESTGetAPIApplicationGuildCommandsResult

RESTGetAPIApplicationGuildCommandsResult: Omit<APIApplicationCommand, dm_permission>[]

https://discord.com/developers/docs/interactions/application-commands#get-guild-application-commands

RESTGetAPIApplicationRoleConnectionMetadataResult

RESTGetAPIApplicationRoleConnectionMetadataResult: APIApplicationRoleConnectionMetadata[]

https://discord.com/developers/docs/resources/application-role-connection-metadata#get-application-role-connection-metadata-records

RESTGetAPIAuditLogResult

RESTGetAPIAuditLogResult: APIAuditLog

RESTGetAPIAutoModerationRuleResult

RESTGetAPIAutoModerationRuleResult: APIAutoModerationRule

https://discord.com/developers/docs/resources/auto-moderation#get-auto-moderation-rule

RESTGetAPIAutoModerationRulesResult

RESTGetAPIAutoModerationRulesResult: APIAutoModerationRule[]

https://discord.com/developers/docs/resources/auto-moderation#list-auto-moderation-rules-for-guild

RESTGetAPIChannelInvitesResult

RESTGetAPIChannelInvitesResult: APIExtendedInvite[]

https://discord.com/developers/docs/resources/channel#get-channel-invites

RESTGetAPIChannelMessageReactionUsersResult

RESTGetAPIChannelMessageReactionUsersResult: APIUser[]

https://discord.com/developers/docs/resources/channel#get-reactions

RESTGetAPIChannelMessageResult

RESTGetAPIChannelMessageResult: APIMessage

https://discord.com/developers/docs/resources/channel#get-channel-message

RESTGetAPIChannelMessagesResult

RESTGetAPIChannelMessagesResult: APIMessage[]

https://discord.com/developers/docs/resources/channel#get-channel-messages

RESTGetAPIChannelPinsResult

RESTGetAPIChannelPinsResult: APIMessage[]

https://discord.com/developers/docs/resources/channel#get-pinned-messages

RESTGetAPIChannelResult

RESTGetAPIChannelResult: APIChannel

https://discord.com/developers/docs/resources/channel#get-channel

RESTGetAPIChannelThreadMemberResult

RESTGetAPIChannelThreadMemberResult: APIThreadMember

https://discord.com/developers/docs/resources/channel#get-thread-member

RESTGetAPIChannelThreadMembersResult

RESTGetAPIChannelThreadMembersResult: APIThreadMember[]

https://discord.com/developers/docs/resources/channel#list-thread-members

RESTGetAPIChannelThreadsArchivedPrivateResult

RESTGetAPIChannelThreadsArchivedPrivateResult: RESTGetAPIChannelUsersThreadsArchivedResult

https://discord.com/developers/docs/resources/channel#list-private-archived-threads

RESTGetAPIChannelThreadsArchivedPublicResult

RESTGetAPIChannelThreadsArchivedPublicResult: RESTGetAPIChannelUsersThreadsArchivedResult

https://discord.com/developers/docs/resources/channel#list-public-archived-threads

RESTGetAPIChannelThreadsResult

RESTGetAPIChannelThreadsResult: APIThreadList

https://discord.com/developers/docs/resources/channel#list-active-threads

@deprecated

Removed in API v10, use List Active Guild Threads instead.

RESTGetAPIChannelUsersThreadsArchivedResult

RESTGetAPIChannelUsersThreadsArchivedResult: APIThreadList

https://discord.com/developers/docs/resources/channel#list-joined-private-archived-threads

RESTGetAPIChannelWebhooksResult

RESTGetAPIChannelWebhooksResult: APIWebhook[]

https://discord.com/developers/docs/resources/webhook#get-channel-webhooks

RESTGetAPICurrentUserApplicationRoleConnectionResult

RESTGetAPICurrentUserApplicationRoleConnectionResult: APIApplicationRoleConnection

https://discord.com/developers/docs/resources/user#get-user-application-role-connection

RESTGetAPICurrentUserConnectionsResult

RESTGetAPICurrentUserConnectionsResult: APIConnection[]

https://discord.com/developers/docs/resources/user#get-user-connections

RESTGetAPICurrentUserGuildsResult

RESTGetAPICurrentUserGuildsResult: RESTAPIPartialCurrentUserGuild[]

https://discord.com/developers/docs/resources/user#get-current-user-guilds

RESTGetAPICurrentUserResult

RESTGetAPICurrentUserResult: APIUser

https://discord.com/developers/docs/resources/user#get-current-user

RESTGetAPIEntitlementsResult

RESTGetAPIEntitlementsResult: APIEntitlement[]

https://discord.com/developers/docs/resources/entitlement#list-entitlements

RESTGetAPIGatewayBotResult

RESTGetAPIGatewayBotResult: APIGatewayBotInfo

https://discord.com/developers/docs/topics/gateway#get-gateway-bot

RESTGetAPIGatewayResult

RESTGetAPIGatewayResult: APIGatewayInfo

https://discord.com/developers/docs/topics/gateway#get-gateway

RESTGetAPIGuildApplicationCommandsPermissionsResult

RESTGetAPIGuildApplicationCommandsPermissionsResult: APIGuildApplicationCommandPermissions[]

https://discord.com/developers/docs/interactions/application-commands#get-guild-application-command-permissions

RESTGetAPIGuildBanResult

RESTGetAPIGuildBanResult: APIBan

https://discord.com/developers/docs/resources/guild#get-guild-ban

RESTGetAPIGuildBansResult

RESTGetAPIGuildBansResult: APIBan[]

https://discord.com/developers/docs/resources/guild#get-guild-bans

RESTGetAPIGuildChannelsResult

RESTGetAPIGuildChannelsResult: APIChannel[]

https://discord.com/developers/docs/resources/guild#get-guild-channels

RESTGetAPIGuildEmojiResult

RESTGetAPIGuildEmojiResult: APIEmoji

https://discord.com/developers/docs/resources/emoji#get-guild-emoji

RESTGetAPIGuildEmojisResult

RESTGetAPIGuildEmojisResult: APIEmoji[]

https://discord.com/developers/docs/resources/emoji#list-guild-emojis

RESTGetAPIGuildIntegrationsResult

RESTGetAPIGuildIntegrationsResult: APIGuildIntegration[]

https://discord.com/developers/docs/resources/guild#get-guild-integrations

RESTGetAPIGuildInvitesResult

RESTGetAPIGuildInvitesResult: APIExtendedInvite[]

https://discord.com/developers/docs/resources/guild#get-guild-invites

RESTGetAPIGuildMemberResult

RESTGetAPIGuildMemberResult: APIGuildMember

https://discord.com/developers/docs/resources/guild#get-guild-member

RESTGetAPIGuildMemberVerificationResult

RESTGetAPIGuildMemberVerificationResult: APIGuildMembershipScreening

RESTGetAPIGuildMembersResult

RESTGetAPIGuildMembersResult: APIGuildMember[]

https://discord.com/developers/docs/resources/guild#list-guild-members

RESTGetAPIGuildMembersSearchResult

RESTGetAPIGuildMembersSearchResult: APIGuildMember[]

RESTGetAPIGuildOnboardingResult

RESTGetAPIGuildOnboardingResult: APIGuildOnboarding

https://discord.com/developers/docs/resources/guild#get-guild-onboarding

RESTGetAPIGuildPreviewResult

RESTGetAPIGuildPreviewResult: APIGuildPreview

https://discord.com/developers/docs/resources/guild#get-guild-preview

RESTGetAPIGuildResult

RESTGetAPIGuildResult: APIGuild

https://discord.com/developers/docs/resources/guild#get-guild

RESTGetAPIGuildRoleResult

RESTGetAPIGuildRoleResult: APIRole

https://discord.com/developers/docs/resources/guild#get-guild-role

RESTGetAPIGuildRolesResult

RESTGetAPIGuildRolesResult: APIRole[]

https://discord.com/developers/docs/resources/guild#get-guild-roles

RESTGetAPIGuildScheduledEventResult

RESTGetAPIGuildScheduledEventResult: APIGuildScheduledEvent

https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event

RESTGetAPIGuildScheduledEventUsersResult

RESTGetAPIGuildScheduledEventUsersResult: APIGuildScheduledEventUser[]

https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event-users

RESTGetAPIGuildScheduledEventsResult

RESTGetAPIGuildScheduledEventsResult: APIGuildScheduledEvent[]

https://discord.com/developers/docs/resources/guild-scheduled-event#list-scheduled-events-for-guild

RESTGetAPIGuildSoundboardSoundResult

RESTGetAPIGuildSoundboardSoundResult: APISoundboardSound

https://discord.com/developers/docs/resources/soundboard#get-guild-soundboard-sound

RESTGetAPIGuildStickerResult

RESTGetAPIGuildStickerResult: APISticker

https://discord.com/developers/docs/resources/sticker#get-guild-sticker

RESTGetAPIGuildStickersResult

RESTGetAPIGuildStickersResult: APISticker[]

https://discord.com/developers/docs/resources/sticker#list-guild-stickers

RESTGetAPIGuildTemplatesResult

RESTGetAPIGuildTemplatesResult: APITemplate[]

https://discord.com/developers/docs/resources/guild-template#get-guild-templates

RESTGetAPIGuildThreadsResult

RESTGetAPIGuildThreadsResult: Omit<APIThreadList, has_more>

https://discord.com/developers/docs/resources/guild#list-active-guild-threads

RESTGetAPIGuildVoiceRegionsResult

RESTGetAPIGuildVoiceRegionsResult: APIVoiceRegion[]

https://discord.com/developers/docs/resources/guild#get-guild-voice-regions

RESTGetAPIGuildVoiceStateCurrentMemberResult

RESTGetAPIGuildVoiceStateCurrentMemberResult: APIVoiceState

https://discord.com/developers/docs/resources/voice#get-current-user-voice-state

RESTGetAPIGuildVoiceStateUserResult

RESTGetAPIGuildVoiceStateUserResult: APIVoiceState

https://discord.com/developers/docs/resources/voice#get-user-voice-state

RESTGetAPIGuildWebhooksResult

RESTGetAPIGuildWebhooksResult: APIWebhook[]

https://discord.com/developers/docs/resources/webhook#get-guild-webhooks

RESTGetAPIGuildWelcomeScreenResult

RESTGetAPIGuildWelcomeScreenResult: APIGuildWelcomeScreen

https://discord.com/developers/docs/resources/guild#get-guild-welcome-screen

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

https://discord.com/developers/docs/resources/guild#get-guild-widget

RESTGetAPIGuildWidgetSettingsResult

RESTGetAPIGuildWidgetSettingsResult: APIGuildWidgetSettings

https://discord.com/developers/docs/resources/guild#get-guild-widget-settings

RESTGetAPIInteractionFollowupResult

RESTGetAPIInteractionFollowupResult: RESTGetAPIWebhookWithTokenMessageResult

https://discord.com/developers/docs/interactions/receiving-and-responding#get-followup-message

RESTGetAPIInteractionOriginalResponseResult

RESTGetAPIInteractionOriginalResponseResult: RESTGetAPIWebhookWithTokenMessageResult

https://discord.com/developers/docs/interactions/receiving-and-responding#get-original-interaction-response

RESTGetAPIInviteResult

RESTGetAPIInviteResult: APIInvite

RESTGetAPIOAuth2CurrentApplicationResult

RESTGetAPIOAuth2CurrentApplicationResult: Omit<APIApplication, flags>

https://discord.com/developers/docs/topics/oauth2#get-current-bot-application-information

RESTGetAPISKUSubscriptionResult

RESTGetAPISKUSubscriptionResult: APISubscription

https://discord.com/developers/docs/resources/subscription#get-sku-subscription

RESTGetAPISKUSubscriptionsResult

RESTGetAPISKUSubscriptionsResult: APISubscription[]

https://discord.com/developers/docs/resources/subscription#list-sku-subscriptions

RESTGetAPISKUsResult

RESTGetAPISKUsResult: APISKU[]

https://discord.com/developers/docs/resources/sku#list-skus

RESTGetAPISoundboardDefaultSoundsResult

RESTGetAPISoundboardDefaultSoundsResult: APISoundboardSound[]

https://discord.com/developers/docs/resources/soundboard#list-soundboard-default-sounds

RESTGetAPIStageInstanceResult

RESTGetAPIStageInstanceResult: APIStageInstance

https://discord.com/developers/docs/resources/stage-instance#get-stage-instance

RESTGetAPIStickerPack

RESTGetAPIStickerPack: RESTGetAPIStickerPackResult
@deprecated

Use RESTGetAPIStickerPackResult instead

RESTGetAPIStickerPackResult

RESTGetAPIStickerPackResult: APIStickerPack

https://discord.com/developers/docs/resources/sticker#get-sticker-pack

RESTGetAPIStickerResult

RESTGetAPIStickerResult: APISticker

https://discord.com/developers/docs/resources/sticker#get-sticker

RESTGetAPITemplateResult

RESTGetAPITemplateResult: APITemplate

https://discord.com/developers/docs/resources/guild-template#get-guild-template

RESTGetAPIUserResult

RESTGetAPIUserResult: APIUser

https://discord.com/developers/docs/resources/user#get-user

RESTGetAPIVoiceRegionsResult

RESTGetAPIVoiceRegionsResult: APIVoiceRegion[]

https://discord.com/developers/docs/resources/voice#list-voice-regions

RESTGetAPIWebhookResult

RESTGetAPIWebhookResult: APIWebhook

https://discord.com/developers/docs/resources/webhook#get-webhook

RESTGetAPIWebhookWithTokenMessageResult

RESTGetAPIWebhookWithTokenMessageResult: APIMessage

https://discord.com/developers/docs/resources/webhook#get-webhook-message

RESTGetAPIWebhookWithTokenResult

RESTGetAPIWebhookWithTokenResult: Omit<APIWebhook, user>

https://discord.com/developers/docs/resources/webhook#get-webhook-with-token

RESTGetCurrentApplicationResult

RESTGetCurrentApplicationResult: APIApplication

https://discord.com/developers/docs/resources/application#get-current-application

RESTGetCurrentUserGuildMemberResult

RESTGetCurrentUserGuildMemberResult: APIGuildMember

https://discord.com/developers/docs/resources/user#get-current-user-guild-member

RESTGetNitroStickerPacksResult

RESTGetNitroStickerPacksResult: RESTGetStickerPacksResult

https://discord.com/developers/docs/resources/sticker#list-sticker-packs

@deprecated

Use RESTGetStickerPacksResult instead

RESTOAuth2AuthorizationQueryResult

RESTOAuth2AuthorizationQueryResult: RESTPostOAuth2AuthorizationQueryResult
@deprecated

Use RESTPostOAuth2AuthorizationQueryResult instead

RESTOAuth2ImplicitAuthorizationURLFragmentResult

RESTOAuth2ImplicitAuthorizationURLFragmentResult: Omit<RESTPostOAuth2AccessTokenResult, refresh_token>

https://discord.com/developers/docs/topics/oauth2#implicit-grant-redirect-url-example

RESTPatchAPIApplicationCommandJSONBody

RESTPatchAPIApplicationCommandJSONBody: StrictPartial<RESTPostAPIApplicationCommandsJSONBody>

https://discord.com/developers/docs/interactions/application-commands#edit-global-application-command

RESTPatchAPIApplicationCommandResult

RESTPatchAPIApplicationCommandResult: APIApplicationCommand

https://discord.com/developers/docs/interactions/application-commands#edit-global-application-command

RESTPatchAPIApplicationEmojiJSONBody

RESTPatchAPIApplicationEmojiJSONBody: Pick<RESTPatchAPIGuildEmojiJSONBody, name>

https://discord.com/developers/docs/resources/emoji#modify-application-emoji

RESTPatchAPIApplicationEmojiResult

RESTPatchAPIApplicationEmojiResult: APIEmoji

https://discord.com/developers/docs/resources/emoji#modify-application-emoji

RESTPatchAPIApplicationGuildCommandJSONBody

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

https://discord.com/developers/docs/interactions/application-commands#edit-guild-application-command

RESTPatchAPIApplicationGuildCommandResult

RESTPatchAPIApplicationGuildCommandResult: Omit<APIApplicationCommand, dm_permission>

https://discord.com/developers/docs/interactions/application-commands#edit-guild-application-command

RESTPatchAPIAutoModerationRuleJSONBody

RESTPatchAPIAutoModerationRuleJSONBody: Omit<Partial<RESTPostAPIAutoModerationRuleJSONBody>, trigger_type>

https://discord.com/developers/docs/resources/auto-moderation#modify-auto-moderation-rule

RESTPatchAPIAutoModerationRuleResult

RESTPatchAPIAutoModerationRuleResult: APIAutoModerationRule

https://discord.com/developers/docs/resources/auto-moderation#modify-auto-moderation-rule

RESTPatchAPIChannelMessageFormDataBody

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

https://discord.com/developers/docs/resources/channel#edit-message

RESTPatchAPIChannelMessageResult

RESTPatchAPIChannelMessageResult: APIMessage

https://discord.com/developers/docs/resources/channel#edit-message

RESTPatchAPIChannelResult

RESTPatchAPIChannelResult: APIChannel

https://discord.com/developers/docs/resources/channel#modify-channel

RESTPatchAPICurrentGuildMemberNicknameResult

RESTPatchAPICurrentGuildMemberNicknameResult: StrictRequired<RESTPatchAPICurrentGuildMemberNicknameJSONBody>

https://discord.com/developers/docs/resources/guild#modify-current-user-nick

@deprecated

Use Modify Current Member instead.

RESTPatchAPICurrentUserResult

RESTPatchAPICurrentUserResult: APIUser

https://discord.com/developers/docs/resources/user#modify-current-user

RESTPatchAPIGuildChannelPositionsJSONBody

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

https://discord.com/developers/docs/resources/guild#modify-guild-channel-positions

RESTPatchAPIGuildChannelPositionsResult

RESTPatchAPIGuildChannelPositionsResult: never

https://discord.com/developers/docs/resources/guild#modify-guild-channel-positions

RESTPatchAPIGuildEmojiResult

RESTPatchAPIGuildEmojiResult: APIEmoji

https://discord.com/developers/docs/resources/emoji#modify-guild-emoji

RESTPatchAPIGuildMemberResult

RESTPatchAPIGuildMemberResult: APIGuildMember

https://discord.com/developers/docs/resources/guild#add-guild-member

RESTPatchAPIGuildMemberVerificationResult

RESTPatchAPIGuildMemberVerificationResult: APIGuildMembershipScreening

RESTPatchAPIGuildResult

RESTPatchAPIGuildResult: APIGuild

https://discord.com/developers/docs/resources/guild#modify-guild

RESTPatchAPIGuildRolePositionsJSONBody

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

https://discord.com/developers/docs/resources/guild#modify-guild-role-positions

RESTPatchAPIGuildRolePositionsResult

RESTPatchAPIGuildRolePositionsResult: APIRole[]

https://discord.com/developers/docs/resources/guild#modify-guild-role-positions

RESTPatchAPIGuildRoleResult

RESTPatchAPIGuildRoleResult: APIRole

https://discord.com/developers/docs/resources/guild#modify-guild-role

RESTPatchAPIGuildScheduledEventJSONBody

RESTPatchAPIGuildScheduledEventJSONBody: Nullable<Pick<RESTPostAPIGuildScheduledEventJSONBody, description | entity_metadata | recurrence_rule>> & StrictPartial<Omit<RESTPostAPIGuildScheduledEventJSONBody, description | entity_metadata | recurrence_rule>> & { status?: GuildScheduledEventStatus }

https://discord.com/developers/docs/resources/guild-scheduled-event#modify-guild-scheduled-event

RESTPatchAPIGuildScheduledEventResult

RESTPatchAPIGuildScheduledEventResult: APIGuildScheduledEvent

https://discord.com/developers/docs/resources/guild-scheduled-event#modify-guild-scheduled-event

RESTPatchAPIGuildSoundboardSoundResult

RESTPatchAPIGuildSoundboardSoundResult: APISoundboardSound

https://discord.com/developers/docs/resources/soundboard#modify-guild-soundboard-sound

RESTPatchAPIGuildStickerResult

RESTPatchAPIGuildStickerResult: APISticker

https://discord.com/developers/docs/resources/sticker#modify-guild-sticker

RESTPatchAPIGuildTemplateJSONBody

RESTPatchAPIGuildTemplateJSONBody: StrictPartial<RESTPostAPIGuildTemplatesJSONBody>

https://discord.com/developers/docs/resources/guild-template#modify-guild-template

RESTPatchAPIGuildTemplateResult

RESTPatchAPIGuildTemplateResult: APITemplate

https://discord.com/developers/docs/resources/guild-template#modify-guild-template

RESTPatchAPIGuildVoiceStateCurrentMemberResult

RESTPatchAPIGuildVoiceStateCurrentMemberResult: never

https://discord.com/developers/docs/resources/voice#modify-current-user-voice-state

RESTPatchAPIGuildVoiceStateUserResult

RESTPatchAPIGuildVoiceStateUserResult: never

https://discord.com/developers/docs/resources/voice#modify-user-voice-state

RESTPatchAPIGuildWelcomeScreenJSONBody

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

https://discord.com/developers/docs/resources/guild#modify-guild-welcome-screen

RESTPatchAPIGuildWelcomeScreenResult

RESTPatchAPIGuildWelcomeScreenResult: APIGuildWelcomeScreen

https://discord.com/developers/docs/resources/guild#modify-guild-welcome-screen

RESTPatchAPIGuildWidgetSettingsJSONBody

RESTPatchAPIGuildWidgetSettingsJSONBody: StrictPartial<APIGuildWidgetSettings>

https://discord.com/developers/docs/resources/guild#modify-guild-widget

RESTPatchAPIGuildWidgetSettingsResult

RESTPatchAPIGuildWidgetSettingsResult: APIGuildWidgetSettings

https://discord.com/developers/docs/resources/guild#modify-guild-widget

RESTPatchAPIInteractionFollowupFormDataBody

RESTPatchAPIInteractionFollowupFormDataBody: RESTPatchAPIWebhookWithTokenMessageFormDataBody

https://discord.com/developers/docs/interactions/receiving-and-responding#edit-followup-message

RESTPatchAPIInteractionFollowupJSONBody

RESTPatchAPIInteractionFollowupJSONBody: RESTPatchAPIWebhookWithTokenMessageJSONBody

https://discord.com/developers/docs/interactions/receiving-and-responding#edit-followup-message

RESTPatchAPIInteractionFollowupResult

RESTPatchAPIInteractionFollowupResult: RESTPatchAPIWebhookWithTokenMessageResult

https://discord.com/developers/docs/interactions/receiving-and-responding#edit-followup-message

RESTPatchAPIInteractionOriginalResponseFormDataBody

RESTPatchAPIInteractionOriginalResponseFormDataBody: RESTPatchAPIWebhookWithTokenMessageFormDataBody

https://discord.com/developers/docs/interactions/receiving-and-responding#edit-original-interaction-response

RESTPatchAPIInteractionOriginalResponseJSONBody

RESTPatchAPIInteractionOriginalResponseJSONBody: RESTPatchAPIWebhookWithTokenMessageJSONBody

https://discord.com/developers/docs/interactions/receiving-and-responding#edit-original-interaction-response

RESTPatchAPIInteractionOriginalResponseResult

RESTPatchAPIInteractionOriginalResponseResult: RESTPatchAPIWebhookWithTokenMessageResult

https://discord.com/developers/docs/interactions/receiving-and-responding#edit-original-interaction-response

RESTPatchAPIStageInstanceResult

RESTPatchAPIStageInstanceResult: APIStageInstance

https://discord.com/developers/docs/resources/stage-instance#modify-stage-instance

RESTPatchAPIWebhookResult

RESTPatchAPIWebhookResult: APIWebhook

https://discord.com/developers/docs/resources/webhook#modify-webhook

RESTPatchAPIWebhookWithTokenJSONBody

RESTPatchAPIWebhookWithTokenJSONBody: Omit<RESTPatchAPIWebhookJSONBody, channel_id>

https://discord.com/developers/docs/resources/webhook#modify-webhook-with-token

RESTPatchAPIWebhookWithTokenMessageFormDataBody

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

https://discord.com/developers/docs/resources/webhook#edit-webhook-message

RESTPatchAPIWebhookWithTokenMessageJSONBody

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

https://discord.com/developers/docs/resources/webhook#edit-webhook-message

RESTPatchAPIWebhookWithTokenMessageResult

RESTPatchAPIWebhookWithTokenMessageResult: APIMessage

https://discord.com/developers/docs/resources/webhook#edit-webhook-message

RESTPatchAPIWebhookWithTokenResult

RESTPatchAPIWebhookWithTokenResult: RESTGetAPIWebhookWithTokenResult

https://discord.com/developers/docs/resources/webhook#modify-webhook-with-token

RESTPatchCurrentApplicationJSONBody

RESTPatchCurrentApplicationJSONBody: StrictPartial<Nullable<Pick<APIApplication, cover_image | icon>> & Pick<APIApplication, custom_install_url | description | flags | install_params | integration_types_config | interactions_endpoint_url | role_connections_verification_url | tags>>

https://discord.com/developers/docs/resources/application#edit-current-application

RESTPatchCurrentApplicationResult

RESTPatchCurrentApplicationResult: APIApplication

https://discord.com/developers/docs/resources/application#edit-current-application

RESTPostAPIApplicationCommandsJSONBody

RESTPostAPIApplicationCommandsJSONBody: RESTPostAPIChatInputApplicationCommandsJSONBody | RESTPostAPIContextMenuApplicationCommandsJSONBody

https://discord.com/developers/docs/interactions/application-commands#create-global-application-command

RESTPostAPIApplicationCommandsResult

RESTPostAPIApplicationCommandsResult: APIApplicationCommand

https://discord.com/developers/docs/interactions/application-commands#create-global-application-command

RESTPostAPIApplicationEmojiJSONBody

RESTPostAPIApplicationEmojiJSONBody: Pick<RESTPostAPIGuildEmojiJSONBody, image | name>

https://discord.com/developers/docs/resources/emoji#create-application-emoji-json-params

RESTPostAPIApplicationEmojiResult

RESTPostAPIApplicationEmojiResult: APIEmoji

https://discord.com/developers/docs/resources/emoji#create-application-emoji

RESTPostAPIApplicationGuildCommandsJSONBody

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

https://discord.com/developers/docs/interactions/application-commands#create-guild-application-command

RESTPostAPIApplicationGuildCommandsResult

RESTPostAPIApplicationGuildCommandsResult: Omit<APIApplicationCommand, dm_permission>

https://discord.com/developers/docs/interactions/application-commands#create-guild-application-command

RESTPostAPIAutoModerationRuleResult

RESTPostAPIAutoModerationRuleResult: APIAutoModerationRule

https://discord.com/developers/docs/resources/auto-moderation#create-auto-moderation-rule

RESTPostAPIChannelFollowersResult

RESTPostAPIChannelFollowersResult: APIFollowedChannel

https://discord.com/developers/docs/resources/channel#follow-news-channel

RESTPostAPIChannelInviteResult

RESTPostAPIChannelInviteResult: APIExtendedInvite

https://discord.com/developers/docs/resources/channel#create-channel-invite

RESTPostAPIChannelMessageCrosspostResult

RESTPostAPIChannelMessageCrosspostResult: APIMessage

https://discord.com/developers/docs/resources/channel#crosspost-message

RESTPostAPIChannelMessageFormDataBody

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

https://discord.com/developers/docs/resources/channel#create-message

RESTPostAPIChannelMessageResult

RESTPostAPIChannelMessageResult: APIMessage

https://discord.com/developers/docs/resources/channel#create-message

RESTPostAPIChannelMessagesBulkDeleteResult

RESTPostAPIChannelMessagesBulkDeleteResult: never

https://discord.com/developers/docs/resources/channel#bulk-delete-messages

RESTPostAPIChannelMessagesThreadsResult

RESTPostAPIChannelMessagesThreadsResult: APIChannel

https://discord.com/developers/docs/resources/channel#start-thread-from-message

RESTPostAPIChannelThreadsResult

RESTPostAPIChannelThreadsResult: APIChannel

https://discord.com/developers/docs/resources/channel#start-thread-without-message

RESTPostAPIChannelTypingResult

RESTPostAPIChannelTypingResult: never

https://discord.com/developers/docs/resources/channel#trigger-typing-indicator

RESTPostAPIChannelWebhookResult

RESTPostAPIChannelWebhookResult: APIWebhook

https://discord.com/developers/docs/resources/webhook#create-webhook

RESTPostAPICurrentUserCreateDMChannelResult

RESTPostAPICurrentUserCreateDMChannelResult: APIChannel

https://discord.com/developers/docs/resources/user#create-dm

RESTPostAPIEntitlementBody

RESTPostAPIEntitlementBody: RESTPostAPIEntitlementJSONBody
@deprecated

Use RESTPostAPIEntitlementJSONBody instead

RESTPostAPIEntitlementConsumeResult

RESTPostAPIEntitlementConsumeResult: never

https://discord.com/developers/docs/resources/entitlement#consume-an-entitlement

RESTPostAPIEntitlementResult

RESTPostAPIEntitlementResult: Partial<Omit<APIEntitlement, ends_at | starts_at>>

https://discord.com/developers/docs/resources/entitlement#create-test-entitlement

RESTPostAPIGuildChannelJSONBody

RESTPostAPIGuildChannelJSONBody: DistributiveOmit<RESTAPIGuildCreatePartialChannel, id>

https://discord.com/developers/docs/resources/guild#create-guild-channel

RESTPostAPIGuildChannelResult

RESTPostAPIGuildChannelResult: APIChannel

https://discord.com/developers/docs/resources/guild#create-guild-channel

RESTPostAPIGuildEmojiResult

RESTPostAPIGuildEmojiResult: APIEmoji

https://discord.com/developers/docs/resources/emoji#create-guild-emoji

RESTPostAPIGuildForumThreadsFormDataBody

RESTPostAPIGuildForumThreadsFormDataBody: RESTPostAPIChannelMessagesThreadsJSONBody & { message: string }

https://discord.com/developers/docs/resources/channel#start-thread-in-forum-or-media-channel

RESTPostAPIGuildForumThreadsJSONBody

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

https://discord.com/developers/docs/resources/channel#start-thread-in-forum-or-media-channel

RESTPostAPIGuildRoleResult

RESTPostAPIGuildRoleResult: APIRole

https://discord.com/developers/docs/resources/guild#create-guild-role

RESTPostAPIGuildScheduledEventResult

RESTPostAPIGuildScheduledEventResult: APIGuildScheduledEvent

https://discord.com/developers/docs/resources/guild-scheduled-event#create-guild-scheduled-event

RESTPostAPIGuildSoundboardSoundResult

RESTPostAPIGuildSoundboardSoundResult: APISoundboardSound

https://discord.com/developers/docs/resources/soundboard#create-guild-soundboard-sound

RESTPostAPIGuildStickerResult

RESTPostAPIGuildStickerResult: APISticker

https://discord.com/developers/docs/resources/sticker#create-guild-sticker

RESTPostAPIGuildTemplatesResult

RESTPostAPIGuildTemplatesResult: APITemplate

https://discord.com/developers/docs/resources/guild-template#create-guild-template

RESTPostAPIGuildsMFAResult

RESTPostAPIGuildsMFAResult: RESTPostAPIGuildsMFAJSONBody

https://discord.com/developers/docs/resources/guild#modify-guild-mfa-level

RESTPostAPIGuildsResult

RESTPostAPIGuildsResult: APIGuild

https://discord.com/developers/docs/resources/guild#create-guild

RESTPostAPIInteractionCallbackFormDataBody

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

https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response

RESTPostAPIInteractionCallbackJSONBody

RESTPostAPIInteractionCallbackJSONBody: APIInteractionResponse

https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response

RESTPostAPIInteractionCallbackResult

RESTPostAPIInteractionCallbackResult: never

https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response

RESTPostAPIInteractionFollowupFormDataBody

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

https://discord.com/developers/docs/interactions/receiving-and-responding#create-followup-message

RESTPostAPIInteractionFollowupJSONBody

RESTPostAPIInteractionFollowupJSONBody: APIInteractionResponseCallbackData

https://discord.com/developers/docs/interactions/receiving-and-responding#create-followup-message

RESTPostAPIInteractionFollowupResult

RESTPostAPIInteractionFollowupResult: RESTPostAPIWebhookWithTokenWaitResult

https://discord.com/developers/docs/interactions/receiving-and-responding#create-followup-message

RESTPostAPIPollExpireResult

RESTPostAPIPollExpireResult: APIMessage

https://discord.com/developers/docs/resources/poll#expire-poll

RESTPostAPISendSoundboardSoundResult

RESTPostAPISendSoundboardSoundResult: APISoundboardSound

https://discord.com/developers/docs/resources/soundboard#send-soundboard-sound

RESTPostAPIStageInstanceResult

RESTPostAPIStageInstanceResult: APIStageInstance

https://discord.com/developers/docs/resources/stage-instance#create-stage-instance

RESTPostAPITemplateCreateGuildResult

RESTPostAPITemplateCreateGuildResult: APIGuild

https://discord.com/developers/docs/resources/guild-template#create-guild-from-guild-template

RESTPostAPIWebhookWithTokenFormDataBody

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

https://discord.com/developers/docs/resources/webhook#execute-webhook

RESTPostAPIWebhookWithTokenGitHubQuery

RESTPostAPIWebhookWithTokenGitHubQuery: RESTPostAPIWebhookWithTokenQuery

https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook-querystring-params

RESTPostAPIWebhookWithTokenGitHubResult

RESTPostAPIWebhookWithTokenGitHubResult: never

https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook

RESTPostAPIWebhookWithTokenGitHubWaitResult

RESTPostAPIWebhookWithTokenGitHubWaitResult: APIMessage

Received when a call to https://discord.com/developers/docs/resources/webhook#execute-webhook receives the wait query parameter set to true

See https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook-querystring-params

RESTPostAPIWebhookWithTokenResult

RESTPostAPIWebhookWithTokenResult: never

https://discord.com/developers/docs/resources/webhook#execute-webhook

RESTPostAPIWebhookWithTokenSlackQuery

RESTPostAPIWebhookWithTokenSlackQuery: RESTPostAPIWebhookWithTokenQuery

https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook-querystring-params

RESTPostAPIWebhookWithTokenSlackResult

RESTPostAPIWebhookWithTokenSlackResult: never

https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook

RESTPostAPIWebhookWithTokenSlackWaitResult

RESTPostAPIWebhookWithTokenSlackWaitResult: APIMessage

Received when a call to https://discord.com/developers/docs/resources/webhook#execute-webhook receives the wait query parameter set to true

See https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook-querystring-params

RESTPostAPIWebhookWithTokenWaitResult

RESTPostAPIWebhookWithTokenWaitResult: APIMessage

Received when a call to https://discord.com/developers/docs/resources/webhook#execute-webhook receives the wait query parameter set to true

See https://discord.com/developers/docs/resources/webhook#execute-webhook-querystring-params

RESTPostOAuth2AccessTokenWithBotAndGuildsAndWebhookIncomingScopeResult

RESTPostOAuth2AccessTokenWithBotAndGuildsAndWebhookIncomingScopeResult: RESTPostOAuth2AccessTokenWithBotAndGuildsScopeResult & RESTPostOAuth2AccessTokenWithBotAndWebhookIncomingScopeResult

RESTPostOAuth2ClientCredentialsResult

RESTPostOAuth2ClientCredentialsResult: RESTOAuth2ImplicitAuthorizationURLFragmentResult

RESTPostOAuth2RefreshTokenResult

RESTPostOAuth2RefreshTokenResult: RESTPostOAuth2AccessTokenResult

RESTPutAPIApplicationCommandPermissionsResult

RESTPutAPIApplicationCommandPermissionsResult: APIGuildApplicationCommandPermissions

https://discord.com/developers/docs/interactions/application-commands#edit-application-command-permissions

RESTPutAPIApplicationCommandsJSONBody

RESTPutAPIApplicationCommandsJSONBody: RESTPostAPIApplicationCommandsJSONBody[]

https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-global-application-commands

RESTPutAPIApplicationCommandsResult

RESTPutAPIApplicationCommandsResult: APIApplicationCommand[]

https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-global-application-commands

RESTPutAPIApplicationGuildCommandsJSONBody

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

https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-guild-application-commands

RESTPutAPIApplicationGuildCommandsResult

RESTPutAPIApplicationGuildCommandsResult: Omit<APIApplicationCommand, dm_permission>[]

https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-guild-application-commands

RESTPutAPIApplicationRoleConnectionMetadataJSONBody

RESTPutAPIApplicationRoleConnectionMetadataJSONBody: APIApplicationRoleConnectionMetadata[]

https://discord.com/developers/docs/resources/application-role-connection-metadata#update-application-role-connection-metadata-records

RESTPutAPIApplicationRoleConnectionMetadataResult

RESTPutAPIApplicationRoleConnectionMetadataResult: APIApplicationRoleConnectionMetadata[]

https://discord.com/developers/docs/resources/application-role-connection-metadata#update-application-role-connection-metadata-records

RESTPutAPIChannelMessageReactionResult

RESTPutAPIChannelMessageReactionResult: never

https://discord.com/developers/docs/resources/channel#create-reaction

RESTPutAPIChannelPermissionResult

RESTPutAPIChannelPermissionResult: never

https://discord.com/developers/docs/resources/channel#edit-channel-permissions

RESTPutAPIChannelPinResult

RESTPutAPIChannelPinResult: never

https://discord.com/developers/docs/resources/channel#pin-message

RESTPutAPIChannelRecipientResult

RESTPutAPIChannelRecipientResult: unknown

https://discord.com/developers/docs/resources/channel#group-dm-add-recipient

RESTPutAPIChannelThreadMembersResult

RESTPutAPIChannelThreadMembersResult: never

https://discord.com/developers/docs/resources/channel#join-thread

RESTPutAPICurrentUserApplicationRoleConnectionResult

RESTPutAPICurrentUserApplicationRoleConnectionResult: APIApplicationRoleConnection

https://discord.com/developers/docs/resources/user#update-user-application-role-connection

RESTPutAPIGuildApplicationCommandsPermissionsJSONBody

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

https://discord.com/developers/docs/interactions/application-commands#batch-edit-application-command-permissions

RESTPutAPIGuildApplicationCommandsPermissionsResult

RESTPutAPIGuildApplicationCommandsPermissionsResult: APIGuildApplicationCommandPermissions[]

https://discord.com/developers/docs/interactions/application-commands#batch-edit-application-command-permissions

RESTPutAPIGuildBanResult

RESTPutAPIGuildBanResult: never

https://discord.com/developers/docs/resources/guild#create-guild-ban

RESTPutAPIGuildMemberResult

RESTPutAPIGuildMemberResult: APIGuildMember | undefined

RESTPutAPIGuildMemberRoleResult

RESTPutAPIGuildMemberRoleResult: never

https://discord.com/developers/docs/resources/guild#add-guild-member-role

RESTPutAPIGuildOnboardingJSONBody

RESTPutAPIGuildOnboardingJSONBody: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<Partial<Pick<APIGuildOnboarding, default_channel_ids | enabled | mode>>> & { prompts?: RESTAPIGuildOnboardingPrompt[] }

https://discord.com/developers/docs/resources/guild#modify-guild-onboarding

RESTPutAPIGuildOnboardingResult

RESTPutAPIGuildOnboardingResult: APIGuildOnboarding

https://discord.com/developers/docs/resources/guild#modify-guild-onboarding

RESTPutAPIGuildTemplateSyncResult

RESTPutAPIGuildTemplateSyncResult: APITemplate

https://discord.com/developers/docs/resources/guild-template#sync-guild-template

RoleIconFormat

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

StickerFormat

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

StickerPackBannerFormat

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

StorePageAssetFormat

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

TeamIconFormat

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

TextChannelType

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

ThreadChannelType

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

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 } = ...

https://discord.com/developers/docs/interactions/application-commands#application-command-permissions-object-application-command-permissions-constants

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: 9 = '9'

constCDNRoutes

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

Type declaration

  • achievementIcon: function
    • achievementIcon<Format>(applicationId: string, achievementId: string, achievementIconHash: string, format: Format): `/app-assets/${string}/achievements/${string}/icons/${string}.${Format}`

    • Route for:

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

      This route supports the extensions: PNG, JPEG, WebP

      Type parameters

      Parameters

      • applicationId: string
      • achievementId: string
      • achievementIconHash: string
      • format: Format

      Returns `/app-assets/${string}/achievements/${string}/icons/${string}.${Format}`

  • applicationAsset: function
    • applicationAsset<Format>(applicationId: string, applicationAssetId: string, format: Format): `/app-assets/${string}/${string}.${Format}`

    • Route for:

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

      This route supports the extensions: PNG, JPEG, WebP

      Type parameters

      Parameters

      • applicationId: string
      • applicationAssetId: string
      • format: Format

      Returns `/app-assets/${string}/${string}.${Format}`

  • applicationCover: function
    • applicationCover<Format>(applicationId: string, applicationCoverImage: string, format: Format): `/app-icons/${string}/${string}.${Format}`

    • Route for:

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

      This route supports the extensions: PNG, JPEG, WebP

      Type parameters

      Parameters

      • applicationId: string
      • applicationCoverImage: string
      • format: Format

      Returns `/app-icons/${string}/${string}.${Format}`

  • applicationIcon: function
    • applicationIcon<Format>(applicationId: string, applicationIcon: string, format: Format): `/app-icons/${string}/${string}.${Format}`

    • Route for:

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

      This route supports the extensions: PNG, JPEG, WebP

      Type parameters

      Parameters

      • applicationId: string
      • applicationIcon: string
      • format: Format

      Returns `/app-icons/${string}/${string}.${Format}`

  • avatarDecoration: function
    • avatarDecoration(avatarDecorationDataAsset: string): `/avatar-decoration-presets/${string}.png`

    • Route for:

      • GET /avatar-decoration-presets/{avatar_decoration_data_asset}.png

      This route supports the extension: PNG

      Parameters

      • avatarDecorationDataAsset: string

      Returns `/avatar-decoration-presets/${string}.png`

  • defaultUserAvatar: function
    • defaultUserAvatar<Index>(index: Index): `/embed/avatars/${Index}.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

      Type parameters

      Parameters

      • index: Index

      Returns `/embed/avatars/${Index}.png`

  • emoji: function
    • emoji<Format>(emojiId: string, format: Format): `/emojis/${string}.${Format}`

    • 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

      Type parameters

      Parameters

      • emojiId: string
      • format: Format

      Returns `/emojis/${string}.${Format}`

  • guildBanner: function
    • guildBanner<Format>(guildId: string, guildBanner: string, format: Format): `/banners/${string}/${string}.${Format}`

    • 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

      Type parameters

      Parameters

      • guildId: string
      • guildBanner: string
      • format: Format

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

  • guildDiscoverySplash: function
    • guildDiscoverySplash<Format>(guildId: string, guildDiscoverySplash: string, format: Format): `/discovery-splashes/${string}/${string}.${Format}`

    • Route for:

      • GET /discovery-splashes/{guild.id}/{guild.discovery_splash}.{png|jpeg|webp}

      This route supports the extensions: PNG, JPEG, WebP

      Type parameters

      Parameters

      • guildId: string
      • guildDiscoverySplash: string
      • format: Format

      Returns `/discovery-splashes/${string}/${string}.${Format}`

  • guildIcon: function
    • guildIcon<Format>(guildId: string, guildIcon: string, format: Format): `/icons/${string}/${string}.${Format}`

    • Route for:

      • GET /icons/{guild.id}/{guild.icon}.{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

      Type parameters

      Parameters

      • guildId: string
      • guildIcon: string
      • format: Format

      Returns `/icons/${string}/${string}.${Format}`

  • guildMemberAvatar: function
    • guildMemberAvatar<Format>(guildId: string, userId: string, memberAvatar: string, format: Format): `/guilds/${string}/users/${string}/avatars/${string}.${Format}`

    • Route for:

      • GET /guilds/{guild.id}/users/{user.id}/avatars/{guild_member.avatar}.{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

      Type parameters

      Parameters

      • guildId: string
      • userId: string
      • memberAvatar: string
      • format: Format

      Returns `/guilds/${string}/users/${string}/avatars/${string}.${Format}`

  • guildMemberBanner: function
    • guildMemberBanner<Format>(guildId: string, userId: string, guildMemberBanner: string, format: Format): `/guilds/${string}/users/${string}/banners/${string}.${Format}`

    • Route for:

      • GET /guilds/${guild.id}/users/${user.id}/banners/${guild_member.banner}.{png|jpeg|webp|gif}

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

      Type parameters

      Parameters

      • guildId: string
      • userId: string
      • guildMemberBanner: string
      • format: Format

      Returns `/guilds/${string}/users/${string}/banners/${string}.${Format}`

  • guildScheduledEventCover: function
    • guildScheduledEventCover<Format>(guildScheduledEventId: string, guildScheduledEventCoverImage: string, format: Format): `/guild-events/${string}/${string}.${Format}`

    • Route for:

      • GET /guild-events/{guild_scheduled_event.id}/{guild_scheduled_event.image}.{png|jpeg|webp}

      This route supports the extensions: PNG, JPEG, WebP

      Type parameters

      Parameters

      • guildScheduledEventId: string
      • guildScheduledEventCoverImage: string
      • format: Format

      Returns `/guild-events/${string}/${string}.${Format}`

  • guildSplash: function
    • guildSplash<Format>(guildId: string, guildSplash: string, format: Format): `/splashes/${string}/${string}.${Format}`

    • Route for:

      • GET /splashes/{guild.id}/{guild.splash}.{png|jpeg|webp}

      This route supports the extensions: PNG, JPEG, WebP

      Type parameters

      Parameters

      • guildId: string
      • guildSplash: string
      • format: Format

      Returns `/splashes/${string}/${string}.${Format}`

  • roleIcon: function
    • roleIcon<Format>(roleId: string, roleIcon: string, format: Format): `/role-icons/${string}/${string}.${Format}`

    • Route for:

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

      This route supports the extensions: PNG, JPEG, WebP

      Type parameters

      Parameters

      • roleId: string
      • roleIcon: string
      • format: Format

      Returns `/role-icons/${string}/${string}.${Format}`

  • soundboardSound: function
    • soundboardSound(soundId: string): `/soundboard-sounds/${string}`

    • Route for:

      • GET /soundboard-sounds/${sound.id}

      Parameters

      • soundId: string

      Returns `/soundboard-sounds/${string}`

  • sticker: function
    • sticker<Format>(stickerId: string, format: Format): `/stickers/${string}.${Format}`

    • Route for:

      • GET /stickers/{sticker.id}.{png|json}

      This route supports the extensions: PNG, Lottie, GIF

      Type parameters

      Parameters

      • stickerId: string
      • format: Format

      Returns `/stickers/${string}.${Format}`

  • stickerPackBanner: function
    • stickerPackBanner<Format>(stickerPackBannerAssetId: string, format: Format): `/app-assets/710982414301790216/store/${string}.${Format}`

    • Route for:

      • GET /app-assets/710982414301790216/store/{sticker_pack.banner.asset_id}.{png|jpeg|webp}

      This route supports the extensions: PNG, JPEG, WebP

      Type parameters

      Parameters

      • stickerPackBannerAssetId: string
      • format: Format

      Returns `/app-assets/710982414301790216/store/${string}.${Format}`

  • storePageAsset: function
    • storePageAsset<Format>(applicationId: string, assetId: string, format?: Format): `/app-assets/${string}/store/${string}.${Format}`

    • Route for:

      • GET /app-assets/${application.id}/store/${asset.id}.{png|jpeg|webp}}

      This route supports the extensions: PNG, JPEG, WebP

      Type parameters

      Parameters

      • applicationId: string
      • assetId: string
      • format: Format = ...

      Returns `/app-assets/${string}/store/${string}.${Format}`

  • teamIcon: function
    • teamIcon<Format>(teamId: string, teamIcon: string, format: Format): `/team-icons/${string}/${string}.${Format}`

    • Route for:

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

      This route supports the extensions: PNG, JPEG, WebP

      Type parameters

      Parameters

      • teamId: string
      • teamIcon: string
      • format: Format

      Returns `/team-icons/${string}/${string}.${Format}`

  • userAvatar: function
    • userAvatar<Format>(userId: string, userAvatar: string, format: Format): `/avatars/${string}/${string}.${Format}`

    • Route for:

      • GET /avatars/{user.id}/{user.avatar}.{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

      Type parameters

      Parameters

      • userId: string
      • userAvatar: string
      • format: Format

      Returns `/avatars/${string}/${string}.${Format}`

  • userAvatarDecoration: function
    • userAvatarDecoration(userId: string, userAvatarDecoration: string): `/avatar-decorations/${string}/${string}.png`

    • Route for:

      • GET /avatar-decorations/{user.id}/{user.avatar_decoration}.png

      This route supports the extension: PNG

      @deprecated

      Use CDNRoutes.avatarDecoration instead.

      Parameters

      • userId: string
      • userAvatarDecoration: string

      Returns `/avatar-decorations/${string}/${string}.png`

  • userBanner: function
    • userBanner<Format>(userId: string, userBanner: string, format: Format): `/banners/${string}/${string}.${Format}`

    • Route for:

      • GET /banners/{user.id}/{user.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

      Type parameters

      Parameters

      • userId: string
      • userBanner: string
      • format: Format

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

constGatewayVersion

GatewayVersion: 9 = '9'

constOAuth2Routes

OAuth2Routes: { authorizationURL: https://discord.com/api/v9/oauth2/authorize; tokenRevocationURL: https://discord.com/api/v9/oauth2/token/revoke; tokenURL: https://discord.com/api/v9/oauth2/token } = ...

Type declaration

  • authorizationURL: https://discord.com/api/v9/oauth2/authorize
  • tokenRevocationURL: https://discord.com/api/v9/oauth2/token/revoke

    See https://tools.ietf.org/html/rfc7009

  • tokenURL: https://discord.com/api/v9/oauth2/token

constRouteBases

RouteBases: { api: https://discord.com/api/v9; cdn: https://cdn.discordapp.com; gift: https://discord.gift; invite: https://discord.gg; scheduledEvent: https://discord.com/events; template: https://discord.new } = ...

Type declaration

  • api: https://discord.com/api/v9
  • cdn: https://cdn.discordapp.com
  • gift: https://discord.gift
  • invite: https://discord.gg
  • scheduledEvent: https://discord.com/events
  • template: https://discord.new

constRoutes

Routes: { applicationCommand: any; applicationCommandPermissions: any; applicationCommands: any; applicationEmoji: any; applicationEmojis: any; applicationGuildCommand: any; applicationGuildCommands: any; applicationRoleConnectionMetadata: any; channel: any; channelBulkDelete: any; channelFollowers: any; channelInvites: any; channelJoinedArchivedThreads: any; channelMessage: any; channelMessageAllReactions: any; channelMessageCrosspost: any; channelMessageOwnReaction: any; channelMessageReaction: any; channelMessageUserReaction: any; channelMessages: any; channelPermission: any; channelPin: any; channelPins: any; channelRecipient: any; channelThreads: any; channelTyping: any; channelWebhooks: any; consumeEntitlement: any; currentApplication: any; entitlement: any; entitlements: any; expirePoll: any; gateway: any; gatewayBot: any; guild: any; guildActiveThreads: any; guildApplicationCommandsPermissions: any; guildAuditLog: any; guildAutoModerationRule: any; guildAutoModerationRules: any; guildBan: any; guildBans: any; guildBulkBan: any; guildChannels: any; guildCurrentMemberNickname: any; guildEmoji: any; guildEmojis: any; guildIntegration: any; guildIntegrations: any; guildInvites: any; guildMFA: any; guildMember: any; guildMemberRole: any; guildMemberVerification: any; guildMembers: any; guildMembersSearch: any; guildOnboarding: any; guildPreview: any; guildPrune: any; guildRole: any; guildRoles: any; guildScheduledEvent: any; guildScheduledEventUsers: any; guildScheduledEvents: any; guildSoundboardSound: any; guildSoundboardSounds: any; guildSticker: any; guildStickers: any; guildTemplate: any; guildTemplates: any; guildVanityUrl: any; guildVoiceRegions: any; guildVoiceState: any; guildWebhooks: any; guildWelcomeScreen: any; guildWidgetImage: any; guildWidgetJSON: any; guildWidgetSettings: any; guilds: any; interactionCallback: any; invite: any; nitroStickerPacks: any; oauth2Authorization: any; oauth2CurrentApplication: any; oauth2CurrentAuthorization: any; oauth2TokenExchange: any; oauth2TokenRevocation: any; pollAnswerVoters: any; sendSoundboardSound: any; skuSubscription: any; skuSubscriptions: any; skus: any; soundboardDefaultSounds: any; stageInstance: any; stageInstances: any; sticker: any; stickerPack: any; stickerPacks: any; template: any; threadMembers: any; threads: any; user: any; userApplicationRoleConnection: any; userChannels: any; userConnections: any; userGuild: any; userGuildMember: any; userGuilds: any; voiceRegions: any; webhook: any; webhookMessage: any; webhookPlatform: any } = ...

Type declaration

  • applicationCommand: function
    • applicationCommand(applicationId: string, commandId: string): `/applications/${string}/commands/${string}`

    • Route for:

      • GET /applications/{application.id}/commands/{command.id}
      • PATCH /applications/{application.id}/commands/{command.id}
      • DELETE /applications/{application.id}/commands/{command.id}

      Parameters

      • applicationId: string
      • commandId: string

      Returns `/applications/${string}/commands/${string}`

  • applicationCommandPermissions: function
    • applicationCommandPermissions(applicationId: string, guildId: string, commandId: string): `/applications/${string}/guilds/${string}/commands/${string}/permissions`

    • Route for:

      • GET /applications/{application.id}/guilds/{guild.id}/commands/{command.id}/permissions
      • PUT /applications/{application.id}/guilds/{guild.id}/commands/{command.id}/permissions

      Parameters

      • applicationId: string
      • guildId: string
      • commandId: string

      Returns `/applications/${string}/guilds/${string}/commands/${string}/permissions`

  • applicationCommands: function
    • applicationCommands(applicationId: string): `/applications/${string}/commands`

    • Route for:

      • GET /applications/{application.id}/commands
      • PUT /applications/{application.id}/commands
      • POST /applications/{application.id}/commands

      Parameters

      • applicationId: string

      Returns `/applications/${string}/commands`

  • applicationEmoji: function
    • applicationEmoji(applicationId: string, emojiId: string): `/applications/${string}/emojis/${string}`

    • Route for:

      • GET /applications/{application.id}/emojis/{emoji.id}
      • PATCH /applications/{application.id}/emojis/{emoji.id}
      • DELETE /applications/{application.id}/emojis/{emoji.id}

      Parameters

      • applicationId: string
      • emojiId: string

      Returns `/applications/${string}/emojis/${string}`

  • applicationEmojis: function
    • applicationEmojis(applicationId: string): `/applications/${string}/emojis`

    • Route for:

      • GET /applications/{application.id}/emojis
      • POST /applications/{application.id}/emojis

      Parameters

      • applicationId: string

      Returns `/applications/${string}/emojis`

  • applicationGuildCommand: function
    • applicationGuildCommand(applicationId: string, guildId: string, commandId: string): `/applications/${string}/guilds/${string}/commands/${string}`

    • Route for:

      • GET /applications/{application.id}/guilds/{guild.id}/commands/{command.id}
      • PATCH /applications/{application.id}/guilds/{guild.id}/commands/{command.id}
      • DELETE /applications/{application.id}/guilds/{guild.id}/commands/{command.id}

      Parameters

      • applicationId: string
      • guildId: string
      • commandId: string

      Returns `/applications/${string}/guilds/${string}/commands/${string}`

  • applicationGuildCommands: function
    • applicationGuildCommands(applicationId: string, guildId: string): `/applications/${string}/guilds/${string}/commands`

    • Route for:

      • GET /applications/{application.id}/guilds/{guild.id}/commands
      • PUT /applications/{application.id}/guilds/{guild.id}/commands
      • POST /applications/{application.id}/guilds/{guild.id}/commands

      Parameters

      • applicationId: string
      • guildId: string

      Returns `/applications/${string}/guilds/${string}/commands`

  • applicationRoleConnectionMetadata: function
    • applicationRoleConnectionMetadata(applicationId: string): `/applications/${string}/role-connections/metadata`

    • Route for:

      • GET /applications/{application.id}/role-connections/metadata
      • PUT /applications/{application.id}/role-connections/metadata

      Parameters

      • applicationId: string

      Returns `/applications/${string}/role-connections/metadata`

  • channel: function
    • channel(channelId: string): `/channels/${string}`

    • Route for:

      • GET /channels/{channel.id}
      • PATCH /channels/{channel.id}
      • DELETE /channels/{channel.id}

      Parameters

      • channelId: string

      Returns `/channels/${string}`

  • channelBulkDelete: function
    • channelBulkDelete(channelId: string): `/channels/${string}/messages/bulk-delete`

    • Route for:

      • POST /channels/{channel.id}/messages/bulk-delete

      Parameters

      • channelId: string

      Returns `/channels/${string}/messages/bulk-delete`

  • channelFollowers: function
    • channelFollowers(channelId: string): `/channels/${string}/followers`

    • Route for:

      • POST /channels/{channel.id}/followers

      Parameters

      • channelId: string

      Returns `/channels/${string}/followers`

  • channelInvites: function
    • channelInvites(channelId: string): `/channels/${string}/invites`

    • Route for:

      • GET /channels/{channel.id}/invites
      • POST /channels/{channel.id}/invites

      Parameters

      • channelId: string

      Returns `/channels/${string}/invites`

  • channelJoinedArchivedThreads: function
    • channelJoinedArchivedThreads(channelId: string): `/channels/${string}/users/@me/threads/archived/private`

    • Route for:

      • GET /channels/{channel.id}/users/@me/threads/archived/private

      Parameters

      • channelId: string

      Returns `/channels/${string}/users/@me/threads/archived/private`

  • channelMessage: function
    • channelMessage(channelId: string, messageId: string): `/channels/${string}/messages/${string}`

    • Route for:

      • GET /channels/{channel.id}/messages/{message.id}
      • PATCH /channels/{channel.id}/messages/{message.id}
      • DELETE /channels/{channel.id}/messages/{message.id}

      Parameters

      • channelId: string
      • messageId: string

      Returns `/channels/${string}/messages/${string}`

  • channelMessageAllReactions: function
    • channelMessageAllReactions(channelId: string, messageId: string): `/channels/${string}/messages/${string}/reactions`

    • Route for:

      • DELETE /channels/{channel.id}/messages/{message.id}/reactions

      Parameters

      • channelId: string
      • messageId: string

      Returns `/channels/${string}/messages/${string}/reactions`

  • channelMessageCrosspost: function
    • channelMessageCrosspost(channelId: string, messageId: string): `/channels/${string}/messages/${string}/crosspost`

    • Route for:

      • POST /channels/{channel.id}/messages/{message.id}/crosspost

      Parameters

      • channelId: string
      • messageId: string

      Returns `/channels/${string}/messages/${string}/crosspost`

  • channelMessageOwnReaction: function
    • channelMessageOwnReaction(channelId: string, messageId: string, emoji: string): `/channels/${string}/messages/${string}/reactions/${string}/@me`

    • Route for:

      • PUT /channels/{channel.id}/messages/{message.id}/reactions/{emoji}/@me
      • DELETE /channels/{channel.id}/messages/{message.id}/reactions/{emoji}/@me

      Note: You need to URL encode the emoji yourself

      Parameters

      • channelId: string
      • messageId: string
      • emoji: string

      Returns `/channels/${string}/messages/${string}/reactions/${string}/@me`

  • channelMessageReaction: function
    • channelMessageReaction(channelId: string, messageId: string, emoji: string): `/channels/${string}/messages/${string}/reactions/${string}`

    • Route for:

      • GET /channels/{channel.id}/messages/{message.id}/reactions/{emoji}
      • DELETE /channels/{channel.id}/messages/{message.id}/reactions/{emoji}

      Note: You need to URL encode the emoji yourself

      Parameters

      • channelId: string
      • messageId: string
      • emoji: string

      Returns `/channels/${string}/messages/${string}/reactions/${string}`

  • channelMessageUserReaction: function
    • channelMessageUserReaction(channelId: string, messageId: string, emoji: string, userId: string): `/channels/${string}/messages/${string}/reactions/${string}/${string}`

    • Route for:

      • DELETE /channels/{channel.id}/messages/{message.id}/reactions/{emoji}/{user.id}

      Note: You need to URL encode the emoji yourself

      Parameters

      • channelId: string
      • messageId: string
      • emoji: string
      • userId: string

      Returns `/channels/${string}/messages/${string}/reactions/${string}/${string}`

  • channelMessages: function
    • channelMessages(channelId: string): `/channels/${string}/messages`

    • Route for:

      • GET /channels/{channel.id}/messages
      • POST /channels/{channel.id}/messages

      Parameters

      • channelId: string

      Returns `/channels/${string}/messages`

  • channelPermission: function
    • channelPermission(channelId: string, overwriteId: string): `/channels/${string}/permissions/${string}`

    • Route for:

      • PUT /channels/{channel.id}/permissions/{overwrite.id}
      • DELETE /channels/{channel.id}/permissions/{overwrite.id}

      Parameters

      • channelId: string
      • overwriteId: string

      Returns `/channels/${string}/permissions/${string}`

  • channelPin: function
    • channelPin(channelId: string, messageId: string): `/channels/${string}/pins/${string}`

    • Route for:

      • PUT /channels/{channel.id}/pins/{message.id}
      • DELETE /channels/{channel.id}/pins/{message.id}

      Parameters

      • channelId: string
      • messageId: string

      Returns `/channels/${string}/pins/${string}`

  • channelPins: function
    • channelPins(channelId: string): `/channels/${string}/pins`

    • Route for:

      • GET /channels/{channel.id}/pins

      Parameters

      • channelId: string

      Returns `/channels/${string}/pins`

  • channelRecipient: function
    • channelRecipient(channelId: string, userId: string): `/channels/${string}/recipients/${string}`

    • Route for:

      • PUT /channels/{channel.id}/recipients/{user.id}
      • DELETE /channels/{channel.id}/recipients/{user.id}

      Parameters

      • channelId: string
      • userId: string

      Returns `/channels/${string}/recipients/${string}`

  • channelThreads: function
    • channelThreads(channelId: string, archived?: private | public): `/channels/${string}/threads/archived/private` | `/channels/${string}/threads/archived/public` | `/channels/${string}/threads/active`

    • Route for:

      • GET /channels/{channel.id}/threads/active (deprecated, removed in API v10, use List Active Guild Threads instead.)
      • GET /channels/{channel.id}/threads/archived/public
      • GET /channels/{channel.id}/threads/archived/private

      Parameters

      • channelId: string
      • optionalarchived: private | public

      Returns `/channels/${string}/threads/archived/private` | `/channels/${string}/threads/archived/public` | `/channels/${string}/threads/active`

  • channelTyping: function
    • channelTyping(channelId: string): `/channels/${string}/typing`

    • Route for:

      • POST /channels/{channel.id}/typing

      Parameters

      • channelId: string

      Returns `/channels/${string}/typing`

  • channelWebhooks: function
    • channelWebhooks(channelId: string): `/channels/${string}/webhooks`

    • Route for:

      • GET /channels/{channel.id}/webhooks
      • POST /channels/{channel.id}/webhooks

      Parameters

      • channelId: string

      Returns `/channels/${string}/webhooks`

  • consumeEntitlement: function
    • consumeEntitlement(applicationId: string, entitlementId: string): `/applications/${string}/entitlements/${string}/consume`

    • Route for:

      • POST /applications/{application.id}/entitlements/{entitlement.id}/consume

      Parameters

      • applicationId: string
      • entitlementId: string

      Returns `/applications/${string}/entitlements/${string}/consume`

  • currentApplication: function
    • currentApplication(): /applications/@me

    • Route for:

      • GET /applications/@me
      • PATCH /applications/@me

      Returns /applications/@me

  • entitlement: function
    • entitlement(applicationId: string, entitlementId: string): `/applications/${string}/entitlements/${string}`

    • Route for:

      • DELETE /applications/{application.id}/entitlements/{entitlement.id}

      Parameters

      • applicationId: string
      • entitlementId: string

      Returns `/applications/${string}/entitlements/${string}`

  • entitlements: function
    • entitlements(applicationId: string): `/applications/${string}/entitlements`

    • Route for:

      • GET /applications/{application.id}/entitlements
      • POST /applications/{application.id}/entitlements

      Parameters

      • applicationId: string

      Returns `/applications/${string}/entitlements`

  • expirePoll: function
    • expirePoll(channelId: string, messageId: string): `/channels/${string}/polls/${string}/expire`

    • Route for:

      • POST /channels/{channel.id}/polls/{message.id}/expire

      Parameters

      • channelId: string
      • messageId: string

      Returns `/channels/${string}/polls/${string}/expire`

  • gateway: function
    • gateway(): /gateway

    • Route for:

      • GET /gateway

      Returns /gateway

  • gatewayBot: function
    • gatewayBot(): /gateway/bot

    • Route for:

      • GET /gateway/bot

      Returns /gateway/bot

  • guild: function
    • guild(guildId: string): `/guilds/${string}`

    • Route for:

      • GET /guilds/{guild.id}
      • PATCH /guilds/{guild.id}
      • DELETE /guilds/{guild.id}

      Parameters

      • guildId: string

      Returns `/guilds/${string}`

  • guildActiveThreads: function
    • guildActiveThreads(guildId: string): `/guilds/${string}/threads/active`

    • Route for:

      • GET /guilds/{guild.id}/threads/active

      Parameters

      • guildId: string

      Returns `/guilds/${string}/threads/active`

  • guildApplicationCommandsPermissions: function
    • guildApplicationCommandsPermissions(applicationId: string, guildId: string): `/applications/${string}/guilds/${string}/commands/permissions`

    • Route for:

      • GET /applications/{application.id}/guilds/{guild.id}/commands/permissions
      • PUT /applications/{application.id}/guilds/{guild.id}/commands/permissions

      Parameters

      • applicationId: string
      • guildId: string

      Returns `/applications/${string}/guilds/${string}/commands/permissions`

  • guildAuditLog: function
    • guildAuditLog(guildId: string): `/guilds/${string}/audit-logs`

    • Route for:

      • GET /guilds/{guild.id}/audit-logs

      Parameters

      • guildId: string

      Returns `/guilds/${string}/audit-logs`

  • guildAutoModerationRule: function
    • guildAutoModerationRule(guildId: string, ruleId: string): `/guilds/${string}/auto-moderation/rules/${string}`

    • Routes for:

      • GET /guilds/{guild.id}/auto-moderation/rules/{rule.id}
      • PATCH /guilds/{guild.id}/auto-moderation/rules/{rule.id}
      • DELETE /guilds/{guild.id}/auto-moderation/rules/{rule.id}

      Parameters

      • guildId: string
      • ruleId: string

      Returns `/guilds/${string}/auto-moderation/rules/${string}`

  • guildAutoModerationRules: function
    • guildAutoModerationRules(guildId: string): `/guilds/${string}/auto-moderation/rules`

    • Route for:

      • GET /guilds/{guild.id}/auto-moderation/rules
      • POST /guilds/{guild.id}/auto-moderation/rules

      Parameters

      • guildId: string

      Returns `/guilds/${string}/auto-moderation/rules`

  • guildBan: function
    • guildBan(guildId: string, userId: string): `/guilds/${string}/bans/${string}`

    • Route for:

      • GET /guilds/{guild.id}/bans/{user.id}
      • PUT /guilds/{guild.id}/bans/{user.id}
      • DELETE /guilds/{guild.id}/bans/{user.id}

      Parameters

      • guildId: string
      • userId: string

      Returns `/guilds/${string}/bans/${string}`

  • guildBans: function
    • guildBans(guildId: string): `/guilds/${string}/bans`

    • Route for:

      • GET /guilds/{guild.id}/bans

      Parameters

      • guildId: string

      Returns `/guilds/${string}/bans`

  • guildBulkBan: function
    • guildBulkBan(guildId: string): `/guilds/${string}/bulk-ban`

    • Route for:

      • POST /guilds/{guild.id}/bulk-ban

      Parameters

      • guildId: string

      Returns `/guilds/${string}/bulk-ban`

  • guildChannels: function
    • guildChannels(guildId: string): `/guilds/${string}/channels`

    • Route for:

      • GET /guilds/{guild.id}/channels
      • POST /guilds/{guild.id}/channels
      • PATCH /guilds/{guild.id}/channels

      Parameters

      • guildId: string

      Returns `/guilds/${string}/channels`

  • guildCurrentMemberNickname: function
    • guildCurrentMemberNickname(guildId: string): `/guilds/${string}/members/@me/nick`

    • Route for:

      • PATCH /guilds/{guild.id}/members/@me/nick
      @deprecated

      Use Routes.guildMember instead.

      Parameters

      • guildId: string

      Returns `/guilds/${string}/members/@me/nick`

  • guildEmoji: function
    • guildEmoji(guildId: string, emojiId: string): `/guilds/${string}/emojis/${string}`

    • Route for:

      • GET /guilds/{guild.id}/emojis/{emoji.id}
      • PATCH /guilds/{guild.id}/emojis/{emoji.id}
      • DELETE /guilds/{guild.id}/emojis/{emoji.id}

      Parameters

      • guildId: string
      • emojiId: string

      Returns `/guilds/${string}/emojis/${string}`

  • guildEmojis: function
    • guildEmojis(guildId: string): `/guilds/${string}/emojis`

    • Route for:

      • GET /guilds/{guild.id}/emojis
      • POST /guilds/{guild.id}/emojis

      Parameters

      • guildId: string

      Returns `/guilds/${string}/emojis`

  • guildIntegration: function
    • guildIntegration(guildId: string, integrationId: string): `/guilds/${string}/integrations/${string}`

    • Route for:

      • DELETE /guilds/{guild.id}/integrations/{integration.id}

      Parameters

      • guildId: string
      • integrationId: string

      Returns `/guilds/${string}/integrations/${string}`

  • guildIntegrations: function
    • guildIntegrations(guildId: string): `/guilds/${string}/integrations`

    • Route for:

      • GET /guilds/{guild.id}/integrations

      Parameters

      • guildId: string

      Returns `/guilds/${string}/integrations`

  • guildInvites: function
    • guildInvites(guildId: string): `/guilds/${string}/invites`

    • Route for:

      • GET /guilds/{guild.id}/invites

      Parameters

      • guildId: string

      Returns `/guilds/${string}/invites`

  • guildMFA: function
    • guildMFA(guildId: string): `/guilds/${string}/mfa`

    • Route for:

      • POST /guilds/{guild.id}/mfa

      Parameters

      • guildId: string

      Returns `/guilds/${string}/mfa`

  • guildMember: function
    • guildMember(guildId: string, userId?: string): `/guilds/${string}/members/${string}`

    • Route for:

      • GET /guilds/{guild.id}/members/{user.id}
      • PUT /guilds/{guild.id}/members/{user.id}
      • PATCH /guilds/{guild.id}/members/@me
      • PATCH /guilds/{guild.id}/members/{user.id}
      • DELETE /guilds/{guild.id}/members/{user.id}

      Parameters

      • guildId: string
      • userId: string = '@me'

      Returns `/guilds/${string}/members/${string}`

  • guildMemberRole: function
    • guildMemberRole(guildId: string, memberId: string, roleId: string): `/guilds/${string}/members/${string}/roles/${string}`

    • Route for:

      • PUT /guilds/{guild.id}/members/{user.id}/roles/{role.id}
      • DELETE /guilds/{guild.id}/members/{user.id}/roles/{role.id}

      Parameters

      • guildId: string
      • memberId: string
      • roleId: string

      Returns `/guilds/${string}/members/${string}/roles/${string}`

  • guildMemberVerification: function
    • guildMemberVerification(guildId: string): `/guilds/${string}/member-verification`

    • Route for:

      • GET /guilds/{guild.id}/member-verification
      • PATCH /guilds/{guild.id}/member-verification

      Parameters

      • guildId: string

      Returns `/guilds/${string}/member-verification`

  • guildMembers: function
    • guildMembers(guildId: string): `/guilds/${string}/members`

    • Route for:

      • GET /guilds/{guild.id}/members

      Parameters

      • guildId: string

      Returns `/guilds/${string}/members`

  • guildMembersSearch: function
    • guildMembersSearch(guildId: string): `/guilds/${string}/members/search`

    • Route for:

      • GET /guilds/{guild.id}/members/search

      Parameters

      • guildId: string

      Returns `/guilds/${string}/members/search`

  • guildOnboarding: function
    • guildOnboarding(guildId: string): `/guilds/${string}/onboarding`

    • Route for:

      • GET /guilds/{guild.id}/onboarding
      • PUT /guilds/{guild.id}/onboarding

      Parameters

      • guildId: string

      Returns `/guilds/${string}/onboarding`

  • guildPreview: function
    • guildPreview(guildId: string): `/guilds/${string}/preview`

    • Route for:

      • GET /guilds/{guild.id}/preview

      Parameters

      • guildId: string

      Returns `/guilds/${string}/preview`

  • guildPrune: function
    • guildPrune(guildId: string): `/guilds/${string}/prune`

    • Route for:

      • GET /guilds/{guild.id}/prune
      • POST /guilds/{guild.id}/prune

      Parameters

      • guildId: string

      Returns `/guilds/${string}/prune`

  • guildRole: function
    • guildRole(guildId: string, roleId: string): `/guilds/${string}/roles/${string}`

    • Route for:

      • GET /guilds/{guild.id}/roles/{role.id}
      • PATCH /guilds/{guild.id}/roles/{role.id}
      • DELETE /guilds/{guild.id}/roles/{role.id}

      Parameters

      • guildId: string
      • roleId: string

      Returns `/guilds/${string}/roles/${string}`

  • guildRoles: function
    • guildRoles(guildId: string): `/guilds/${string}/roles`

    • Route for:

      • GET /guilds/{guild.id}/roles
      • POST /guilds/{guild.id}/roles
      • PATCH /guilds/{guild.id}/roles

      Parameters

      • guildId: string

      Returns `/guilds/${string}/roles`

  • guildScheduledEvent: function
    • guildScheduledEvent(guildId: string, guildScheduledEventId: string): `/guilds/${string}/scheduled-events/${string}`

    • Route for:

      • GET /guilds/{guild.id}/scheduled-events/{guildScheduledEvent.id}
      • PATCH /guilds/{guild.id}/scheduled-events/{guildScheduledEvent.id}
      • DELETE /guilds/{guild.id}/scheduled-events/{guildScheduledEvent.id}

      Parameters

      • guildId: string
      • guildScheduledEventId: string

      Returns `/guilds/${string}/scheduled-events/${string}`

  • guildScheduledEventUsers: function
    • guildScheduledEventUsers(guildId: string, guildScheduledEventId: string): `/guilds/${string}/scheduled-events/${string}/users`

    • Route for:

      • GET /guilds/{guild.id}/scheduled-events/{guildScheduledEvent.id}/users

      Parameters

      • guildId: string
      • guildScheduledEventId: string

      Returns `/guilds/${string}/scheduled-events/${string}/users`

  • guildScheduledEvents: function
    • guildScheduledEvents(guildId: string): `/guilds/${string}/scheduled-events`

    • Route for:

      • GET /guilds/{guild.id}/scheduled-events
      • POST /guilds/{guild.id}/scheduled-events

      Parameters

      • guildId: string

      Returns `/guilds/${string}/scheduled-events`

  • guildSoundboardSound: function
    • guildSoundboardSound(guildId: string, soundId: string): `/guilds/${string}/soundboard-sounds/${string}`

    • Route for:

      • GET /guilds/{guild.id}/soundboard-sounds/{sound.id}
      • PATCH /guilds/{guild.id}/soundboard-sounds/{sound.id}
      • DELETE /guilds/{guild.id}/soundboard-sounds/{sound.id}

      Parameters

      • guildId: string
      • soundId: string

      Returns `/guilds/${string}/soundboard-sounds/${string}`

  • guildSoundboardSounds: function
    • guildSoundboardSounds(guildId: string): `/guilds/${string}/soundboard-sounds`

    • Route for:

      • GET /guilds/{guild.id}/soundboard-sounds
      • POST /guilds/{guild.id}/soundboard-sounds

      Parameters

      • guildId: string

      Returns `/guilds/${string}/soundboard-sounds`

  • guildSticker: function
    • guildSticker(guildId: string, stickerId: string): `/guilds/${string}/stickers/${string}`

    • Route for:

      • GET /guilds/{guild.id}/stickers/{sticker.id}
      • PATCH /guilds/{guild.id}/stickers/{sticker.id}
      • DELETE /guilds/{guild.id}/stickers/{sticker.id}

      Parameters

      • guildId: string
      • stickerId: string

      Returns `/guilds/${string}/stickers/${string}`

  • guildStickers: function
    • guildStickers(guildId: string): `/guilds/${string}/stickers`

    • Route for:

      • GET /guilds/{guild.id}/stickers
      • POST /guilds/{guild.id}/stickers

      Parameters

      • guildId: string

      Returns `/guilds/${string}/stickers`

  • guildTemplate: function
    • guildTemplate(guildId: string, code: string): `/guilds/${string}/templates/${string}`

    • Route for:

      • PUT /guilds/{guild.id}/templates/{template.code}
      • PATCH /guilds/{guild.id}/templates/{template.code}
      • DELETE /guilds/{guild.id}/templates/{template.code}

      Parameters

      • guildId: string
      • code: string

      Returns `/guilds/${string}/templates/${string}`

  • guildTemplates: function
    • guildTemplates(guildId: string): `/guilds/${string}/templates`

    • Route for:

      • GET /guilds/{guild.id}/templates
      • POST /guilds/{guild.id}/templates

      Parameters

      • guildId: string

      Returns `/guilds/${string}/templates`

  • guildVanityUrl: function
    • guildVanityUrl(guildId: string): `/guilds/${string}/vanity-url`

    • Route for:

      • GET /guilds/{guild.id}/vanity-url

      Parameters

      • guildId: string

      Returns `/guilds/${string}/vanity-url`

  • guildVoiceRegions: function
    • guildVoiceRegions(guildId: string): `/guilds/${string}/regions`

    • Route for:

      • GET /guilds/{guild.id}/regions

      Parameters

      • guildId: string

      Returns `/guilds/${string}/regions`

  • guildVoiceState: function
    • guildVoiceState(guildId: string, userId?: string): `/guilds/${string}/voice-states/${string}`

    • Route for:

      • GET /guilds/{guild.id}/voice-states/@me
      • GET /guilds/{guild.id}/voice-states/{user.id}
      • PATCH /guilds/{guild.id}/voice-states/@me
      • PATCH /guilds/{guild.id}/voice-states/{user.id}

      Parameters

      • guildId: string
      • userId: string = '@me'

      Returns `/guilds/${string}/voice-states/${string}`

  • guildWebhooks: function
    • guildWebhooks(guildId: string): `/guilds/${string}/webhooks`

    • Route for:

      • GET /guilds/{guild.id}/webhooks

      Parameters

      • guildId: string

      Returns `/guilds/${string}/webhooks`

  • guildWelcomeScreen: function
    • guildWelcomeScreen(guildId: string): `/guilds/${string}/welcome-screen`

    • Route for:

      • GET /guilds/{guild.id}/welcome-screen
      • PATCH /guilds/{guild.id}/welcome-screen

      Parameters

      • guildId: string

      Returns `/guilds/${string}/welcome-screen`

  • guildWidgetImage: function
    • guildWidgetImage(guildId: string): `/guilds/${string}/widget.png`

    • Route for:

      • GET /guilds/{guild.id}/widget.png

      Parameters

      • guildId: string

      Returns `/guilds/${string}/widget.png`

  • guildWidgetJSON: function
    • guildWidgetJSON(guildId: string): `/guilds/${string}/widget.json`

    • Route for:

      • GET /guilds/{guild.id}/widget.json

      Parameters

      • guildId: string

      Returns `/guilds/${string}/widget.json`

  • guildWidgetSettings: function
    • guildWidgetSettings(guildId: string): `/guilds/${string}/widget`

    • Route for:

      • GET /guilds/{guild.id}/widget
      • PATCH /guilds/{guild.id}/widget

      Parameters

      • guildId: string

      Returns `/guilds/${string}/widget`

  • guilds: function
    • guilds(): /guilds

    • Route for:

      • POST /guilds

      Returns /guilds

  • interactionCallback: function
    • interactionCallback(interactionId: string, interactionToken: string): `/interactions/${string}/${string}/callback`

    • Route for:

      • POST /interactions/{interaction.id}/{interaction.token}/callback

      Parameters

      • interactionId: string
      • interactionToken: string

      Returns `/interactions/${string}/${string}/callback`

  • invite: function
    • invite(code: string): `/invites/${string}`

    • Route for:

      • GET /invites/{invite.code}
      • DELETE /invites/{invite.code}

      Parameters

      • code: string

      Returns `/invites/${string}`

  • nitroStickerPacks: function
    • nitroStickerPacks(): /sticker-packs

    • Route for:

      • GET /sticker-packs
      @deprecated

      Use Routes.stickerPacks instead.

      Returns /sticker-packs

  • oauth2Authorization: function
    • oauth2Authorization(): /oauth2/authorize

    • Route for:

      • GET /oauth2/authorize

      Returns /oauth2/authorize

  • oauth2CurrentApplication: function
    • oauth2CurrentApplication(): /oauth2/applications/@me

    • Route for:

      • GET /oauth2/applications/@me

      Returns /oauth2/applications/@me

  • oauth2CurrentAuthorization: function
    • oauth2CurrentAuthorization(): /oauth2/@me

    • Route for:

      • GET /oauth2/@me

      Returns /oauth2/@me

  • oauth2TokenExchange: function
    • oauth2TokenExchange(): /oauth2/token

    • Route for:

      • POST /oauth2/token

      Returns /oauth2/token

  • oauth2TokenRevocation: function
    • oauth2TokenRevocation(): /oauth2/token/revoke

    • Route for:

      • POST /oauth2/token/revoke

      Returns /oauth2/token/revoke

  • pollAnswerVoters: function
    • pollAnswerVoters(channelId: string, messageId: string, answerId: number): `/channels/${string}/polls/${string}/answers/${number}`

    • Route for:

      • GET /channels/{channel.id}/polls/{message.id}/answers/{answer_id}

      Parameters

      • channelId: string
      • messageId: string
      • answerId: number

      Returns `/channels/${string}/polls/${string}/answers/${number}`

  • sendSoundboardSound: function
    • sendSoundboardSound(channelId: string): `/channels/${string}/send-soundboard-sound`

    • Route for:

      • POST /channels/{channel.id}/send-soundboard-sound

      Parameters

      • channelId: string

      Returns `/channels/${string}/send-soundboard-sound`

  • skuSubscription: function
    • skuSubscription(skuId: string, subscriptionId: string): `/skus/${string}/subscriptions/${string}`

    • Route for:

      • GET /skus/{sku.id}/subscriptions/{subscription.id}

      Parameters

      • skuId: string
      • subscriptionId: string

      Returns `/skus/${string}/subscriptions/${string}`

  • skuSubscriptions: function
    • skuSubscriptions(skuId: string): `/skus/${string}/subscriptions`

    • Route for:

      • GET /skus/{sku.id}/subscriptions

      Parameters

      • skuId: string

      Returns `/skus/${string}/subscriptions`

  • skus: function
    • skus(applicationId: string): `/applications/${string}/skus`

    • Route for:

      • GET /applications/{application.id}/skus

      Parameters

      • applicationId: string

      Returns `/applications/${string}/skus`

  • soundboardDefaultSounds: function
    • soundboardDefaultSounds(): /soundboard-default-sounds

    • Route for:

      • GET /soundboard-default-sounds

      Returns /soundboard-default-sounds

  • stageInstance: function
    • stageInstance(channelId: string): `/stage-instances/${string}`

    • Route for:

      • GET /stage-instances/{channel.id}
      • PATCH /stage-instances/{channel.id}
      • DELETE /stage-instances/{channel.id}

      Parameters

      • channelId: string

      Returns `/stage-instances/${string}`

  • stageInstances: function
    • stageInstances(): /stage-instances

    • Route for:

      • POST /stage-instances

      Returns /stage-instances

  • sticker: function
    • sticker(stickerId: string): `/stickers/${string}`

    • Route for:

      • GET /stickers/{sticker.id}

      Parameters

      • stickerId: string

      Returns `/stickers/${string}`

  • stickerPack: function
    • stickerPack(packId: string): `/sticker-packs/${string}`

    • Route for:

      • GET /sticker-packs/{pack.id}

      Parameters

      • packId: string

      Returns `/sticker-packs/${string}`

  • stickerPacks: function
    • stickerPacks(): /sticker-packs

    • Route for:

      • GET /sticker-packs

      Returns /sticker-packs

  • template: function
    • template(code: string): `/guilds/templates/${string}`

    • Route for:

      • GET /guilds/templates/{template.code}
      • POST /guilds/templates/{template.code}

      Parameters

      • code: string

      Returns `/guilds/templates/${string}`

  • threadMembers: function
    • threadMembers(threadId: string, userId?: string): `/channels/${string}/thread-members/${string}` | `/channels/${string}/thread-members`

    • Route for:

      • GET /channels/{thread.id}/thread-members
      • GET /channels/{thread.id}/thread-members/{user.id}
      • PUT /channels/{thread.id}/thread-members/@me
      • PUT /channels/{thread.id}/thread-members/{user.id}
      • DELETE /channels/{thread.id}/thread-members/@me
      • DELETE /channels/{thread.id}/thread-members/{user.id}

      Parameters

      • threadId: string
      • optionaluserId: string

      Returns `/channels/${string}/thread-members/${string}` | `/channels/${string}/thread-members`

  • threads: function
    • threads(parentId: string, messageId?: string): `/channels/${string}/messages/${string}/threads` | `/channels/${string}/threads`

    • Route for:

      • POST /channels/{channel.id}/threads
      • POST /channels/{channel.id}/messages/{message.id}/threads

      Parameters

      • parentId: string
      • optionalmessageId: string

      Returns `/channels/${string}/messages/${string}/threads` | `/channels/${string}/threads`

  • user: function
    • user(userId?: string): `/users/${string}`

    • Route for:

      • GET /users/@me
      • GET /users/{user.id}
      • PATCH /users/@me

      Parameters

      • userId: string = '@me'

      Returns `/users/${string}`

  • userApplicationRoleConnection: function
    • userApplicationRoleConnection(applicationId: string): `/users/@me/applications/${string}/role-connection`

    • Route for:

      • GET /users/@me/applications/{application.id}/role-connection
      • PUT /users/@me/applications/{application.id}/role-connection

      Parameters

      • applicationId: string

      Returns `/users/@me/applications/${string}/role-connection`

  • userChannels: function
    • userChannels(): /users/@me/channels

    • Route for:

      • POST /users/@me/channels

      Returns /users/@me/channels

  • userConnections: function
    • userConnections(): /users/@me/connections

    • Route for:

      • GET /users/@me/connections

      Returns /users/@me/connections

  • userGuild: function
    • userGuild(guildId: string): `/users/@me/guilds/${string}`

    • Route for:

      • DELETE /users/@me/guilds/{guild.id}

      Parameters

      • guildId: string

      Returns `/users/@me/guilds/${string}`

  • userGuildMember: function
    • userGuildMember(guildId: string): `/users/@me/guilds/${string}/member`

    • Route for:

      • GET /users/@me/guilds/{guild.id}/member

      Parameters

      • guildId: string

      Returns `/users/@me/guilds/${string}/member`

  • userGuilds: function
    • userGuilds(): /users/@me/guilds

    • Route for:

      • GET /users/@me/guilds

      Returns /users/@me/guilds

  • voiceRegions: function
    • voiceRegions(): /voice/regions

    • Route for:

      • GET /voice/regions

      Returns /voice/regions

  • webhook: function
    • webhook(webhookId: string, webhookToken?: string): `/webhooks/${string}/${string}` | `/webhooks/${string}`

    • Route for:

      • GET /webhooks/{webhook.id}
      • GET /webhooks/{webhook.id}/{webhook.token}
      • PATCH /webhooks/{webhook.id}
      • PATCH /webhooks/{webhook.id}/{webhook.token}
      • DELETE /webhooks/{webhook.id}
      • DELETE /webhooks/{webhook.id}/{webhook.token}
      • POST /webhooks/{webhook.id}/{webhook.token}
      • POST /webhooks/{application.id}/{interaction.token}

      Parameters

      • webhookId: string
      • optionalwebhookToken: string

      Returns `/webhooks/${string}/${string}` | `/webhooks/${string}`

  • webhookMessage: function
    • webhookMessage(webhookId: string, webhookToken: string, messageId?: string): `/webhooks/${string}/${string}/messages/${string}`

    • Route for:

      • GET /webhooks/{webhook.id}/{webhook.token}/messages/@original
      • GET /webhooks/{webhook.id}/{webhook.token}/messages/{message.id}
      • PATCH /webhooks/{webhook.id}/{webhook.token}/messages/@original
      • PATCH /webhooks/{webhook.id}/{webhook.token}/messages/{message.id}
      • DELETE /webhooks/{webhook.id}/{webhook.token}/messages/@original
      • DELETE /webhooks/{webhook.id}/{webhook.token}/messages/{message.id}
      • PATCH /webhooks/{application.id}/{interaction.token}/messages/@original
      • PATCH /webhooks/{application.id}/{interaction.token}/messages/{message.id}
      • DELETE /webhooks/{application.id}/{interaction.token}/messages/{message.id}

      Parameters

      • webhookId: string
      • webhookToken: string
      • messageId: string = '@original'

      Returns `/webhooks/${string}/${string}/messages/${string}`

  • webhookPlatform: function
    • webhookPlatform(webhookId: string, webhookToken: string, platform: github | slack): `/webhooks/${string}/${string}/github` | `/webhooks/${string}/${string}/slack`

    • Route for:

      • POST /webhooks/{webhook.id}/{webhook.token}/github
      • POST /webhooks/{webhook.id}/{webhook.token}/slack

      Parameters

      • webhookId: string
      • webhookToken: string
      • platform: github | slack

      Returns `/webhooks/${string}/${string}/github` | `/webhooks/${string}/${string}/slack`

constStickerPackApplicationId

StickerPackApplicationId: 710982414301790216 = '710982414301790216'