Version: Next

discord-api-types/v10

Index

References

Namespaces

Utils

Enumerations

Interfaces

Type Aliases

Variables

References

FormattingPatterns

Re-exports FormattingPatterns

Permissions

Re-exports Permissions

Snowflake

Re-exports Snowflake

Type Aliases

_AddUndefinedToPossiblyUndefinedPropertiesOfInterface

_AddUndefinedToPossiblyUndefinedPropertiesOfInterface<Base>: { [ K in keyof Base ]: Base[K] extends Exclude<Base[K], undefined> ? _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<Base[K]> : _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<Base[K]> | undefined }

Type parameters

Base

_DistributiveKeys

_DistributiveKeys<T>: T extends unknown ? _Keys<T> : never

Type parameters

_DistributiveOmit

_DistributiveOmit<T, K>: T extends unknown ? { [ P in keyof _Omit<T, K> ]: _Omit<T, K>[P] } : never

Allows omitting of keys from unions that are disjoint

Type parameters

T
K: _DistributiveKeys<T>

_DistributivePick

_DistributivePick<T, K>: T extends unknown ? keyof _Pick<T, K> extends never ? never : { [ P in keyof _Pick<T, K> ]: _Pick<T, K>[P] } : never

Allows picking of keys from unions that are disjoint

Type parameters

T
K: _DistributiveKeys<T>

_Keys

_Keys<T>: keyof T

Type parameters

_NonDispatchPayload

_NonDispatchPayload: Omit<_BasePayload, s | t> & { s: null; t: null }

_NonNullableFields

_NonNullableFields<T>: { [ P in keyof T ]: NonNullable<T[P]> }

Type parameters

_Nullable

_Nullable<T>: { [ P in keyof T ]: T[P] | null }

Type parameters

_Omit

_Omit<T, K>: Omit<T, Extract<keyof T, K>>

Type parameters

_Pick

_Pick<T, K>: Pick<T, Extract<keyof T, K>>

Type parameters

_StrictPartial

_StrictPartial<Base>: _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<Partial<Base>>

Type parameters

Base

_StrictRequired

_StrictRequired<Base>: Required<{ [ K in keyof Base ]: Exclude<Base[K], undefined> }>

Type parameters

Base

_UnionToIntersection

_UnionToIntersection<U>: (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never

Type parameters

AchievementIconFormat

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

APIAnnouncementThreadChannel

APIAnnouncementThreadChannel: APIThreadChannel<ChannelType.AnnouncementThread>

APIApplicationCommandAttachmentOption

APIApplicationCommandAttachmentOption: APIApplicationCommandOptionBase<ApplicationCommandOptionType.Attachment>

APIApplicationCommandAutocompleteDMInteraction

APIApplicationCommandAutocompleteDMInteraction: APIDMInteractionWrapper<APIApplicationCommandAutocompleteInteraction>

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

APIApplicationCommandAutocompleteGuildInteraction

APIApplicationCommandAutocompleteGuildInteraction: APIGuildInteractionWrapper<APIApplicationCommandAutocompleteInteraction>

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

APIApplicationCommandAutocompleteInteraction

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

APIApplicationCommandBasicOption

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

APIApplicationCommandBooleanOption

APIApplicationCommandBooleanOption: APIApplicationCommandOptionBase<ApplicationCommandOptionType.Boolean>

APIApplicationCommandInteractionDataAttachmentOption

APIApplicationCommandInteractionDataAttachmentOption: APIInteractionDataOptionBase<ApplicationCommandOptionType.Attachment, Snowflake>

APIApplicationCommandInteractionDataBasicOption

Type parameters

Type: InteractionType = InteractionType

APIApplicationCommandInteractionDataBooleanOption

APIApplicationCommandInteractionDataBooleanOption: APIInteractionDataOptionBase<ApplicationCommandOptionType.Boolean, boolean>

APIApplicationCommandInteractionDataChannelOption

APIApplicationCommandInteractionDataChannelOption: APIInteractionDataOptionBase<ApplicationCommandOptionType.Channel, Snowflake>

APIApplicationCommandInteractionDataMentionableOption

APIApplicationCommandInteractionDataMentionableOption: APIInteractionDataOptionBase<ApplicationCommandOptionType.Mentionable, Snowflake>

APIApplicationCommandInteractionDataOption

APIApplicationCommandInteractionDataOption<Type>: APIApplicationCommandInteractionDataBasicOption<Type> | APIApplicationCommandInteractionDataSubcommandGroupOption<Type> | APIApplicationCommandInteractionDataSubcommandOption<Type>

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

Type parameters

Type: InteractionType = InteractionType

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

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

Type parameters

Data: APIApplicationCommandInteractionData

APIApplicationCommandMentionableOption

APIApplicationCommandMentionableOption: APIApplicationCommandOptionBase<ApplicationCommandOptionType.Mentionable>

APIApplicationCommandNumberOption

APIApplicationCommandNumberOption: APIApplicationCommandOptionWithAutocompleteOrChoicesWrapper<APIApplicationCommandNumberOptionBase, APIApplicationCommandOptionChoice<number>>

APIApplicationCommandOption

APIApplicationCommandOption: APIApplicationCommandBasicOption | APIApplicationCommandSubcommandGroupOption | APIApplicationCommandSubcommandOption

@see: 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

Base: APIApplicationCommandOptionBase<ApplicationCommandOptionType>
ChoiceType: APIApplicationCommandOptionChoice

APIApplicationCommandRoleOption

APIApplicationCommandRoleOption: APIApplicationCommandOptionBase<ApplicationCommandOptionType.Role>

APIApplicationCommandStringOption

APIApplicationCommandStringOption: APIApplicationCommandOptionWithAutocompleteOrChoicesWrapper<APIApplicationCommandStringOptionBase, APIApplicationCommandOptionChoice<string>>

APIApplicationCommandUserOption

APIApplicationCommandUserOption: APIApplicationCommandOptionBase<ApplicationCommandOptionType.User>

APIApplicationEmoji

APIApplicationEmoji: _NonNullableFields<Required<Pick<APIEmoji, animated | id | name | user>>> & { available: true; managed: false; require_colons: true; roles: [] }

@see: https://discord.com/developers/docs/resources/emoji#emoji-object-applicationowned-emoji

APIApplicationIntegrationTypesConfigMap

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

APIAuditLogChange

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

APIAuditLogChangeKey$Add

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

Returned when new role(s) are added

APIAuditLogChangeKey$Remove

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

Returned when role(s) are removed

APIAuditLogChangeKeyActions

APIAuditLogChangeKeyActions: APIAuditLogChangeData<actions, APIAutoModerationAction[]>

Returned when an auto moderation rule's actions is changed

APIAuditLogChangeKeyAFKChannelId

APIAuditLogChangeKeyAFKChannelId: APIAuditLogChangeData<afk_channel_id, Snowflake>

Returned when a guild's afk_channel_id is changed

APIAuditLogChangeKeyAFKTimeout

APIAuditLogChangeKeyAFKTimeout: APIAuditLogChangeData<afk_timeout, number>

Returned when a guild's afk_timeout is changed

APIAuditLogChangeKeyAllow

APIAuditLogChangeKeyAllow: APIAuditLogChangeData<allow, string>

Returned when an overwrite's allowed permissions bitfield is changed

APIAuditLogChangeKeyApplicationId

APIAuditLogChangeKeyApplicationId: APIAuditLogChangeData<application_id, Snowflake>

The application ID of the added or removed Webhook or Bot

APIAuditLogChangeKeyArchived

APIAuditLogChangeKeyArchived: APIAuditLogChangeData<archived, boolean>

Returned when a thread's archive status is changed

APIAuditLogChangeKeyAsset

APIAuditLogChangeKeyAsset: APIAuditLogChangeData<asset, >

Empty string

APIAuditLogChangeKeyAutoArchiveDuration

APIAuditLogChangeKeyAutoArchiveDuration: APIAuditLogChangeData<auto_archive_duration, number>

Returned when a thread's auto archive duration is changed

APIAuditLogChangeKeyAvailable

APIAuditLogChangeKeyAvailable: APIAuditLogChangeData<available, boolean>

Returned when a sticker's availability is changed

APIAuditLogChangeKeyAvailableTags

APIAuditLogChangeKeyAvailableTags: APIAuditLogChangeData<available_tags, APIGuildForumTag[]>

Returned when a guild forum's available tags gets changed

APIAuditLogChangeKeyAvatarHash

APIAuditLogChangeKeyAvatarHash: APIAuditLogChangeData<avatar_hash, string>

Returned when a user's avatar_hash is changed

APIAuditLogChangeKeyBannerHash

APIAuditLogChangeKeyBannerHash: APIAuditLogChangeData<banner_hash, string>

Returned when a guild's banner hash is changed

APIAuditLogChangeKeyBitrate

APIAuditLogChangeKeyBitrate: APIAuditLogChangeData<bitrate, number>

Returned when a voice channel's bitrate is changed

APIAuditLogChangeKeyChannelId

APIAuditLogChangeKeyChannelId: APIAuditLogChangeData<channel_id, Snowflake>

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

APIAuditLogChangeKeyCode

APIAuditLogChangeKeyCode: APIAuditLogChangeData<code, string>

Returned when an invite's code is changed

APIAuditLogChangeKeyColor

APIAuditLogChangeKeyColor: APIAuditLogChangeData<color, number>

Returned when a role's color is changed

APIAuditLogChangeKeyCommunicationDisabledUntil

APIAuditLogChangeKeyCommunicationDisabledUntil: APIAuditLogChangeData<communication_disabled_until, string>

Returned when a user's timeout is changed

APIAuditLogChangeKeyDeaf

APIAuditLogChangeKeyDeaf: APIAuditLogChangeData<deaf, boolean>

Returned when a user's deaf status is changed

APIAuditLogChangeKeyDefaultAutoArchiveDuration

APIAuditLogChangeKeyDefaultAutoArchiveDuration: APIAuditLogChangeData<default_auto_archive_duration, number>

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

APIAuditLogChangeKeyDefaultMessageNotifications

APIAuditLogChangeKeyDefaultMessageNotifications: APIAuditLogChangeData<default_message_notifications, GuildDefaultMessageNotifications>

Returned when a guild's default_message_notifications is changed

APIAuditLogChangeKeyDefaultReactionEmoji

APIAuditLogChangeKeyDefaultReactionEmoji: APIAuditLogChangeData<default_reaction_emoji, APIGuildForumDefaultReactionEmoji>

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

APIAuditLogChangeKeyDefaultThreadRateLimitPerUser

APIAuditLogChangeKeyDefaultThreadRateLimitPerUser: APIAuditLogChangeData<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: APIAuditLogChangeData<deny, string>

Returned when an overwrite's denied permissions bitfield is changed

APIAuditLogChangeKeyDescription

APIAuditLogChangeKeyDescription: APIAuditLogChangeData<description, string>

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

APIAuditLogChangeKeyDiscoverySplashHash

APIAuditLogChangeKeyDiscoverySplashHash: APIAuditLogChangeData<discovery_splash_hash, string>

Returned when a guild's discovery splash is changed

APIAuditLogChangeKeyEmojiId

APIAuditLogChangeKeyEmojiId: APIAuditLogChangeData<emoji_id, Snowflake>

Returned when a soundboard's custom emoji is changed

APIAuditLogChangeKeyEmojiName

APIAuditLogChangeKeyEmojiName: APIAuditLogChangeData<emoji_name, string>

Returned when a soundboard's unicode emoji is changed

APIAuditLogChangeKeyEnabled

APIAuditLogChangeKeyEnabled: APIAuditLogChangeData<enabled, boolean>

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

APIAuditLogChangeKeyEnableEmoticons

APIAuditLogChangeKeyEnableEmoticons: APIAuditLogChangeData<enable_emoticons, boolean>

Returned when an integration's enable_emoticons is changed

APIAuditLogChangeKeyEntityType

APIAuditLogChangeKeyEntityType: APIAuditLogChangeData<entity_type, GuildScheduledEventEntityType>

Returned when entity type of a guild scheduled event is changed

APIAuditLogChangeKeyEventType

APIAuditLogChangeKeyEventType: APIAuditLogChangeData<event_type, AutoModerationRuleEventType>

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

APIAuditLogChangeKeyExemptChannels

APIAuditLogChangeKeyExemptChannels: APIAuditLogChangeData<exempt_channels, Snowflake[]>

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

APIAuditLogChangeKeyExemptRoles

APIAuditLogChangeKeyExemptRoles: APIAuditLogChangeData<exempt_roles, Snowflake[]>

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

APIAuditLogChangeKeyExpireBehavior

APIAuditLogChangeKeyExpireBehavior: APIAuditLogChangeData<expire_behavior, IntegrationExpireBehavior>

Returned when an integration's expire_behavior is changed

APIAuditLogChangeKeyExpireGracePeriod

APIAuditLogChangeKeyExpireGracePeriod: APIAuditLogChangeData<expire_grace_period, number>

Returned when an integration's expire_grace_period is changed

APIAuditLogChangeKeyExplicitContentFilter

APIAuditLogChangeKeyExplicitContentFilter: APIAuditLogChangeData<explicit_content_filter, GuildExplicitContentFilter>

Returned when a guild's explicit_content_filter is changed

APIAuditLogChangeKeyFlags

APIAuditLogChangeKeyFlags: APIAuditLogChangeData<flags, number>

Returned when a channel flag gets changed

APIAuditLogChangeKeyFormatType

APIAuditLogChangeKeyFormatType: APIAuditLogChangeData<format_type, StickerFormatType>

Returned when a sticker's format_type is changed

APIAuditLogChangeKeyGuildId

APIAuditLogChangeKeyGuildId: APIAuditLogChangeData<guild_id, Snowflake>

Returned when a sticker's guild_id is changed

APIAuditLogChangeKeyHoist

APIAuditLogChangeKeyHoist: APIAuditLogChangeData<hoist, boolean>

Returned when a role's hoist status is changed

APIAuditLogChangeKeyIconHash

APIAuditLogChangeKeyIconHash: APIAuditLogChangeData<icon_hash, string>

Returned when a guild's icon is changed

APIAuditLogChangeKeyId

APIAuditLogChangeKeyId: APIAuditLogChangeData<id, Snowflake>

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

APIAuditLogChangeKeyImageHash

APIAuditLogChangeKeyImageHash: APIAuditLogChangeData<image_hash, string>

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

APIAuditLogChangeKeyInviterId

APIAuditLogChangeKeyInviterId: APIAuditLogChangeData<inviter_id, Snowflake>

Returned when an invite's inviter_id is changed

APIAuditLogChangeKeyLocation

APIAuditLogChangeKeyLocation: APIAuditLogChangeData<location, string>

Returned when location of a guild scheduled event is changed

APIAuditLogChangeKeyLocked

APIAuditLogChangeKeyLocked: APIAuditLogChangeData<locked, boolean>

Returned when a thread's lock status is changed

APIAuditLogChangeKeyMaxAge

APIAuditLogChangeKeyMaxAge: APIAuditLogChangeData<max_age, number>

Returned when an invite's max_age is changed

APIAuditLogChangeKeyMaxUses

APIAuditLogChangeKeyMaxUses: APIAuditLogChangeData<max_uses, number>

Returned when an invite's max_uses is changed

APIAuditLogChangeKeyMentionable

APIAuditLogChangeKeyMentionable: APIAuditLogChangeData<mentionable, boolean>

Returned when a role's mentionable status is changed

APIAuditLogChangeKeyMFALevel

APIAuditLogChangeKeyMFALevel: APIAuditLogChangeData<mfa_level, GuildMFALevel>

Returned when a guild's mfa_level is changed

APIAuditLogChangeKeyMute

APIAuditLogChangeKeyMute: APIAuditLogChangeData<mute, boolean>

Returned when a user's mute status is changed

APIAuditLogChangeKeyName

APIAuditLogChangeKeyName: APIAuditLogChangeData<name, string>

Returned when an entity's name is changed

APIAuditLogChangeKeyNick

APIAuditLogChangeKeyNick: APIAuditLogChangeData<nick, string>

Returned when a user's nick is changed

APIAuditLogChangeKeyNSFW

APIAuditLogChangeKeyNSFW: APIAuditLogChangeData<nsfw, boolean>

Returned when a channel's NSFW restriction is changed

APIAuditLogChangeKeyOwnerId

APIAuditLogChangeKeyOwnerId: APIAuditLogChangeData<owner_id, Snowflake>

Returned when a guild's owner_id is changed

APIAuditLogChangeKeyPermissionOverwrites

APIAuditLogChangeKeyPermissionOverwrites: APIAuditLogChangeData<permission_overwrites, APIOverwrite[]>

Returned when a channel's permission overwrites is changed

APIAuditLogChangeKeyPermissions

APIAuditLogChangeKeyPermissions: APIAuditLogChangeData<permissions, string>

Returned when a permission bitfield is changed

APIAuditLogChangeKeyPosition

APIAuditLogChangeKeyPosition: APIAuditLogChangeData<position, number>

Returned when a channel's position is changed

APIAuditLogChangeKeyPreferredLocale

APIAuditLogChangeKeyPreferredLocale: APIAuditLogChangeData<preferred_locale, string>

Returned when a guild's preferred_locale is changed

APIAuditLogChangeKeyPremiumProgressBarEnabled

APIAuditLogChangeKeyPremiumProgressBarEnabled: APIAuditLogChangeData<premium_progress_bar_enabled, boolean>

Returned when a guild's boost progress bar is enabled

APIAuditLogChangeKeyPrivacyLevel

APIAuditLogChangeKeyPrivacyLevel: APIAuditLogChangeData<privacy_level, StageInstancePrivacyLevel>

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

APIAuditLogChangeKeyPruneDeleteDays

APIAuditLogChangeKeyPruneDeleteDays: APIAuditLogChangeData<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: APIAuditLogChangeData<public_updates_channel_id, string>

Returned when a guild's public_updates_channel_id is changed

APIAuditLogChangeKeyRateLimitPerUser

APIAuditLogChangeKeyRateLimitPerUser: APIAuditLogChangeData<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: APIAuditLogChangeData<recurrence_rule, APIGuildScheduledEventRecurrenceRule>

Returned when a guild scheduled event's recurrence_rule is changed

APIAuditLogChangeKeyRegion

APIAuditLogChangeKeyRegion: APIAuditLogChangeData<region, string>

Returned when a guild's region is changed

APIAuditLogChangeKeyRulesChannelId

APIAuditLogChangeKeyRulesChannelId: APIAuditLogChangeData<rules_channel_id, string>

Returned when a guild's rules_channel_id is changed

APIAuditLogChangeKeySafetyAlertsChannelId

APIAuditLogChangeKeySafetyAlertsChannelId: APIAuditLogChangeData<safety_alerts_channel_id, string>

Returned when a guild's safety_alerts_channel_id is changed

APIAuditLogChangeKeySnowflake

APIAuditLogChangeKeySnowflake: APIAuditLogChangeData<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

APIAuditLogChangeKeySoundId

APIAuditLogChangeKeySoundId: APIAuditLogChangeData<sound_id, Snowflake>

Returned when a soundboard is create or deleted

APIAuditLogChangeKeySplashHash

APIAuditLogChangeKeySplashHash: APIAuditLogChangeData<splash_hash, string>

Returned when a guild's splash is changed

APIAuditLogChangeKeyStatus

APIAuditLogChangeKeyStatus: APIAuditLogChangeData<status, GuildScheduledEventStatus>

Returned when status of a guild scheduled event is changed

APIAuditLogChangeKeySystemChannelFlags

APIAuditLogChangeKeySystemChannelFlags: APIAuditLogChangeData<system_channel_flags, GuildSystemChannelFlags>

Returned when a guild's system_channel_flags is changed

APIAuditLogChangeKeySystemChannelId

APIAuditLogChangeKeySystemChannelId: APIAuditLogChangeData<system_channel_id, Snowflake>

Returned when a guild's system_channel_id is changed

APIAuditLogChangeKeyTags

APIAuditLogChangeKeyTags: APIAuditLogChangeData<tags, string>

Returned when a sticker's related emoji is changed

APIAuditLogChangeKeyTemporary

APIAuditLogChangeKeyTemporary: APIAuditLogChangeData<temporary, boolean>

Returned when an invite's temporary status is changed

APIAuditLogChangeKeyTopic

APIAuditLogChangeKeyTopic: APIAuditLogChangeData<topic, string>

Returned when a channel's topic is changed

APIAuditLogChangeKeyTriggerMetadata

APIAuditLogChangeKeyTriggerMetadata: APIAuditLogChangeData<trigger_metadata, APIAutoModerationRuleTriggerMetadata>

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

APIAuditLogChangeKeyTriggerType

APIAuditLogChangeKeyTriggerType: APIAuditLogChangeData<trigger_type, AutoModerationRuleTriggerType>

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

APIAuditLogChangeKeyType

APIAuditLogChangeKeyType: APIAuditLogChangeData<type, number | string>

The type of entity created

APIAuditLogChangeKeyUserId

APIAuditLogChangeKeyUserId: APIAuditLogChangeData<user_id, Snowflake>

Returned when a sounboard is created

APIAuditLogChangeKeyUserLimit

APIAuditLogChangeKeyUserLimit: APIAuditLogChangeData<user_limit, number>

Returned when a voice channel's user_limit is changed

APIAuditLogChangeKeyUses

APIAuditLogChangeKeyUses: APIAuditLogChangeData<uses, number>

Returned when an invite's uses is changed

APIAuditLogChangeKeyVanityURLCode

APIAuditLogChangeKeyVanityURLCode: APIAuditLogChangeData<vanity_url_code, string>

Returned when a guild's vanity_url_code is changed

APIAuditLogChangeKeyVerificationLevel

APIAuditLogChangeKeyVerificationLevel: APIAuditLogChangeData<verification_level, GuildVerificationLevel>

Returned when a guild's verification_level is changed

APIAuditLogChangeKeyVolume

APIAuditLogChangeKeyVolume: APIAuditLogChangeData<volume, number>

Returned when a soundboard's volume is changed

APIAuditLogChangeKeyWidgetChannelId

APIAuditLogChangeKeyWidgetChannelId: APIAuditLogChangeData<widget_channel_id, Snowflake>

Returned when a guild's widget_channel_id is changed

APIAuditLogChangeKeyWidgetEnabled

APIAuditLogChangeKeyWidgetEnabled: APIAuditLogChangeData<widget_enabled, boolean>

Returned when a guild's widget is enabled

APIAuthorizingIntegrationOwnersMap

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

APIAutoPopulatedSelectMenuComponent

APIAutoPopulatedSelectMenuComponent: APIChannelSelectComponent | APIMentionableSelectComponent | APIRoleSelectComponent | APIUserSelectComponent

@see: https://discord.com/developers/docs/components/reference

APIButtonComponent

APIButtonComponent: APIButtonComponentWithCustomId | APIButtonComponentWithSKUId | APIButtonComponentWithURL

A Button is an interactive component that can only be used in messages. It creates clickable elements that users can interact with, sending an interaction to your app when clicked.

Buttons must be placed inside an Action Row or a Section's accessory field.

@see: https://discord.com/developers/docs/components/reference#button

APIChannel

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

APIChannelPatchOverwrite

APIChannelPatchOverwrite: RESTAPIChannelPatchOverwrite

@deprecated: Use RESTAPIChannelPatchOverwrite instead

APIChatInputApplicationCommandDMInteraction

APIChatInputApplicationCommandDMInteraction: APIDMInteractionWrapper<APIChatInputApplicationCommandInteraction>

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

APIChatInputApplicationCommandGuildInteraction

APIChatInputApplicationCommandGuildInteraction: APIGuildInteractionWrapper<APIChatInputApplicationCommandInteraction>

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

APIChatInputApplicationCommandInteraction

APIChatInputApplicationCommandInteraction: APIApplicationCommandInteractionWrapper<APIChatInputApplicationCommandInteractionData>

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

APIChatInputApplicationCommandInteractionDataResolved

APIChatInputApplicationCommandInteractionDataResolved: APIInteractionDataResolved

@deprecated: Renamed to APIInteractionDataResolved

APIComponentInActionRow

APIComponentInActionRow: APIComponentInMessageActionRow | APIComponentInModalActionRow

@see: https://discord.com/developers/docs/components/reference#action-row

APIComponentInContainer

@see: https://discord.com/developers/docs/components/reference#container

APIComponentInMessageActionRow

APIComponentInMessageActionRow: APIButtonComponent | APISelectMenuComponent

@see: https://discord.com/developers/docs/components/reference#action-row

APIComponentInModalActionRow

APIComponentInModalActionRow: APITextInputComponent

@see: https://discord.com/developers/docs/components/reference#action-row

APIContextMenuDMInteraction

APIContextMenuDMInteraction: APIMessageApplicationCommandDMInteraction | APIUserApplicationCommandDMInteraction

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

APIContextMenuGuildInteraction

APIContextMenuGuildInteraction: APIMessageApplicationCommandGuildInteraction | APIUserApplicationCommandGuildInteraction

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

APIContextMenuInteraction

APIContextMenuInteraction: APIMessageApplicationCommandInteraction | APIUserApplicationCommandInteraction

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

APIContextMenuInteractionData

APIContextMenuInteractionData: APIMessageApplicationCommandInteractionData | APIUserApplicationCommandInteractionData

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

APIDMInteraction

APIDMInteraction: APIApplicationCommandAutocompleteDMInteraction | APIApplicationCommandDMInteraction | APIMessageComponentDMInteraction | APIModalSubmitDMInteraction

@see: 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

Original: APIBaseInteraction<InteractionType, unknown>

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

@see: 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

Original: APIBaseInteraction<InteractionType, unknown>

APIGuildMediaChannel

APIGuildMediaChannel: APIThreadOnlyChannel<ChannelType.GuildMedia>

APIGuildScheduledEvent

APIGuildScheduledEvent: APIExternalGuildScheduledEvent | APIStageInstanceGuildScheduledEvent | APIVoiceGuildScheduledEvent

@see: 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

@see: 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>)

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

APIInteractionResponse

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

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

APIInteractionResponseCallbackData

APIInteractionResponseCallbackData: Omit<RESTPostAPIWebhookWithTokenJSONBody, avatar_url | username>

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

APIInviteGuild

APIMentionableSelectComponent

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

A Mentionable Select is an interactive component that allows users to select one or more mentionables in a message. Options are automatically populated based on available mentionables in the server.

Mentionable Selects can be configured for both single-select and multi-select behavior. When a user finishes making their choice(s), your app receives an interaction.

Mentionable Selects must be placed inside an Action Row and are only available in messages. An Action Row can contain only one select menu and cannot contain buttons if it has a select menu.

@see: https://discord.com/developers/docs/components/reference#mentionable-select

APIMessageApplicationCommandDMInteraction

APIMessageApplicationCommandDMInteraction: APIDMInteractionWrapper<APIMessageApplicationCommandInteraction>

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

APIMessageApplicationCommandGuildInteraction

APIMessageApplicationCommandGuildInteraction: APIGuildInteractionWrapper<APIMessageApplicationCommandInteraction>

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

APIMessageApplicationCommandInteraction

APIMessageApplicationCommandInteraction: APIApplicationCommandInteractionWrapper<APIMessageApplicationCommandInteractionData>

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

APIMessageButtonInteractionData

APIMessageButtonInteractionData: APIMessageComponentBaseInteractionData<ComponentType.Button>

APIMessageComponent

All components that can appear in messages.

For more specific sets, see APIMessageTopLevelComponent, APIComponentInMessageActionRow, APIComponentInContainer, and APISectionAccessoryComponent

@see: https://discord.com/developers/docs/components/reference

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

@see: 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

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

APIMessageTopLevelComponent

@see: https://discord.com/developers/docs/components/reference

APIModalComponent

APIModalComponent: APIActionRowComponent<APIComponentInModalActionRow> | APIComponentInModalActionRow

@see: https://discord.com/developers/docs/components/reference

APIModalSubmitDMInteraction

APIModalSubmitDMInteraction: APIDMInteractionWrapper<APIModalSubmitInteraction>

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

APIModalSubmitGuildInteraction

APIModalSubmitGuildInteraction: APIGuildInteractionWrapper<APIModalSubmitInteraction>

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

APIModalSubmitInteraction

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

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

APINewsChannel

APINewsChannel: APIGuildTextChannel<ChannelType.GuildAnnouncement>

APIPingInteraction

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

APIPrimaryEntryPointCommandDMInteraction

APIPrimaryEntryPointCommandDMInteraction: APIDMInteractionWrapper<APIPrimaryEntryPointCommandInteraction>

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

APIPrimaryEntryPointCommandGuildInteraction

APIPrimaryEntryPointCommandGuildInteraction: APIGuildInteractionWrapper<APIPrimaryEntryPointCommandInteraction>

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

APIPrimaryEntryPointCommandInteraction

APIPrimaryEntryPointCommandInteraction: APIApplicationCommandInteractionWrapper<APIPrimaryEntryPointCommandInteractionData>

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

APIPrimaryEntryPointCommandInteractionData

APIPrimaryEntryPointCommandInteractionData: APIBaseApplicationCommandInteractionData<ApplicationCommandType.PrimaryEntryPoint>

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

APIPrivateThreadChannel

APIPrivateThreadChannel: APIThreadChannel<ChannelType.PrivateThread>

APIPublicThreadChannel

APIPublicThreadChannel: APIThreadChannel<ChannelType.PublicThread>

APIRoleSelectComponent

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

A Role Select is an interactive component that allows users to select one or more roles in a message. Options are automatically populated based on the server's available roles.

Role Selects can be configured for both single-select and multi-select behavior. When a user finishes making their choice(s) your app receives an interaction.

Role Selects must be placed inside an Action Row and are only available in messages. An Action Row can contain only one select menu and cannot contain buttons if it has a select menu.

@see: https://discord.com/developers/docs/components/reference#role-select

APISectionAccessoryComponent

APISectionAccessoryComponent: APIButtonComponent | APIThumbnailComponent

@see: https://discord.com/developers/docs/components/reference#section

APISelectMenuComponent

APISelectMenuComponent: APIChannelSelectComponent | APIMentionableSelectComponent | APIRoleSelectComponent | APIStringSelectComponent | APIUserSelectComponent

@see: https://discord.com/developers/docs/components/reference

APIStickerItem

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

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

APITextChannel

APITextChannel: APIGuildTextChannel<ChannelType.GuildText>

APIUserApplicationCommandDMInteraction

APIUserApplicationCommandDMInteraction: APIDMInteractionWrapper<APIUserApplicationCommandInteraction>

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

APIUserApplicationCommandGuildInteraction

APIUserApplicationCommandGuildInteraction: APIGuildInteractionWrapper<APIUserApplicationCommandInteraction>

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

APIUserApplicationCommandInteraction

APIUserApplicationCommandInteraction: APIApplicationCommandInteractionWrapper<APIUserApplicationCommandInteractionData>

@see: 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>

A User Select is an interactive component that allows users to select one or more users in a message. Options are automatically populated based on the server's available users.

User Selects can be configured for both single-select and multi-select behavior. When a user finishes making their choice(s) your app receives an interaction.

User Selects must be placed inside an Action Row and are only available in messages. An Action Row can contain only one select menu and cannot contain buttons if it has a select menu.

@see: https://discord.com/developers/docs/components/reference#user-select

APIWebhookEvent

APIWebhookEvent: APIWebhookEventBase<ApplicationWebhookType.Event, APIWebhookEventBody> | APIWebhookEventBase<ApplicationWebhookType.Ping, never>

@see: https://discord.com/developers/docs/events/webhook-events#webhook-event-payloads

APIWebhookEventBody

APIWebhookEventBody: APIWebhookEventEventBase<ApplicationWebhookEventType.ApplicationAuthorized, APIWebhookEventApplicationAuthorizedData> | APIWebhookEventEventBase<ApplicationWebhookEventType.EntitlementCreate, APIWebhookEventEntitlementCreateData> | APIWebhookEventEventBase<ApplicationWebhookEventType.QuestUserEnrollment, APIWebhookEventQuestUserEnrollmentData>

@see: https://discord.com/developers/docs/events/webhook-events#event-body-object

APIWebhookEventEntitlementCreateData

APIWebhookEventEntitlementCreateData: APIEntitlement

APIWebhookEventQuestUserEnrollmentData

APIWebhookEventQuestUserEnrollmentData: never

APIWebhookSourceChannel

APIWebhookSourceChannel: Required<_NonNullableFields<Pick<APIPartialChannel, id | name>>>

Source channel of channel follower webhooks.

APIWebhookSourceGuild

APIWebhookSourceGuild: Pick<APIPartialGuild, icon | id | name>

Source guild of channel follower webhooks.

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

@deprecated: Use DefaultUserAvatarFormat instead.

DefaultUserAvatarAssets

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

DefaultUserAvatarFormat

DefaultUserAvatarFormat: Extract<ImageFormat, ImageFormat.PNG>

EmojiFormat

EmojiFormat: Exclude<ImageFormat, ImageFormat.Lottie>

GatewayActivityAssets

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

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

GatewayActivityEmoji

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

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

GatewayActivitySecrets

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

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

GatewayActivityUpdateData

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

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

GatewayApplicationCommandPermissionsUpdateDispatch

GatewayApplicationCommandPermissionsUpdateDispatch: _DataPayload<GatewayDispatchEvents.ApplicationCommandPermissionsUpdate, GatewayApplicationCommandPermissionsUpdateDispatchData>

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

GatewayAutoModerationActionExecutionDispatch

GatewayAutoModerationActionExecutionDispatch: _DataPayload<GatewayDispatchEvents.AutoModerationActionExecution, GatewayAutoModerationActionExecutionDispatchData>

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

GatewayAutoModerationRuleCreateDispatch

GatewayAutoModerationRuleCreateDispatch: GatewayAutoModerationRuleModifyDispatch

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

GatewayAutoModerationRuleCreateDispatchData

GatewayAutoModerationRuleCreateDispatchData: GatewayAutoModerationRuleModifyDispatchData

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

GatewayAutoModerationRuleDeleteDispatch

GatewayAutoModerationRuleDeleteDispatch: GatewayAutoModerationRuleModifyDispatch

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

GatewayAutoModerationRuleDeleteDispatchData

GatewayAutoModerationRuleDeleteDispatchData: GatewayAutoModerationRuleModifyDispatchData

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

GatewayAutoModerationRuleModifyDispatch

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

@see

GatewayAutoModerationRuleModifyDispatchData

GatewayAutoModerationRuleModifyDispatchData: APIAutoModerationRule

@see

GatewayAutoModerationRuleUpdateDispatch

GatewayAutoModerationRuleUpdateDispatch: GatewayAutoModerationRuleModifyDispatch

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

GatewayAutoModerationRuleUpdateDispatchData

GatewayAutoModerationRuleUpdateDispatchData: GatewayAutoModerationRuleModifyDispatchData

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

GatewayChannelCreateDispatch

GatewayChannelCreateDispatch: GatewayChannelModifyDispatch

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

GatewayChannelCreateDispatchData

GatewayChannelCreateDispatchData: GatewayChannelModifyDispatchData

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

GatewayChannelDeleteDispatch

GatewayChannelDeleteDispatch: GatewayChannelModifyDispatch

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

GatewayChannelDeleteDispatchData

GatewayChannelDeleteDispatchData: GatewayChannelModifyDispatchData

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

GatewayChannelModifyDispatch

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

@see

GatewayChannelModifyDispatchData

GatewayChannelModifyDispatchData: APIChannel & { guild_id: Snowflake; type: Exclude<GuildChannelType, ThreadChannelType> }

@see

GatewayChannelPinsUpdateDispatch

GatewayChannelPinsUpdateDispatch: _DataPayload<GatewayDispatchEvents.ChannelPinsUpdate, GatewayChannelPinsUpdateDispatchData>

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

GatewayChannelUpdateDispatch

GatewayChannelUpdateDispatch: GatewayChannelModifyDispatch

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

GatewayChannelUpdateDispatchData

GatewayChannelUpdateDispatchData: GatewayChannelModifyDispatchData

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

GatewayDispatchPayload

GatewayEntitlementCreateDispatch

GatewayEntitlementCreateDispatch: GatewayEntitlementModifyDispatch

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

GatewayEntitlementCreateDispatchData

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

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

GatewayEntitlementDeleteDispatch

GatewayEntitlementDeleteDispatch: GatewayEntitlementModifyDispatch

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

GatewayEntitlementDeleteDispatchData

GatewayEntitlementDeleteDispatchData: GatewayEntitlementModifyDispatchData

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

GatewayEntitlementModifyDispatch

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

@see

GatewayEntitlementModifyDispatchData

GatewayEntitlementModifyDispatchData: APIEntitlement

@see

GatewayEntitlementUpdateDispatch

GatewayEntitlementUpdateDispatch: GatewayEntitlementModifyDispatch

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

GatewayEntitlementUpdateDispatchData

GatewayEntitlementUpdateDispatchData: GatewayEntitlementModifyDispatchData

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

GatewayGuildAuditLogEntryCreateDispatch

GatewayGuildAuditLogEntryCreateDispatch: _DataPayload<GatewayDispatchEvents.GuildAuditLogEntryCreate, GatewayGuildAuditLogEntryCreateDispatchData>

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

GatewayGuildBanAddDispatch

GatewayGuildBanAddDispatch: GatewayGuildBanModifyDispatch

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

GatewayGuildBanAddDispatchData

GatewayGuildBanAddDispatchData: GatewayGuildBanModifyDispatchData

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

GatewayGuildBanModifyDispatch

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

@see

GatewayGuildBanRemoveDispatch

GatewayGuildBanRemoveDispatch: GatewayGuildBanModifyDispatch

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

GatewayGuildBanRemoveDispatchData

GatewayGuildBanRemoveDispatchData: GatewayGuildBanModifyDispatchData

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

GatewayGuildCreateDispatch

GatewayGuildCreateDispatch: _DataPayload<GatewayDispatchEvents.GuildCreate, GatewayGuildCreateDispatchData>

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

GatewayGuildDeleteDispatch

GatewayGuildDeleteDispatch: _DataPayload<GatewayDispatchEvents.GuildDelete, GatewayGuildDeleteDispatchData>

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

GatewayGuildEmojisUpdateDispatch

GatewayGuildEmojisUpdateDispatch: _DataPayload<GatewayDispatchEvents.GuildEmojisUpdate, GatewayGuildEmojisUpdateDispatchData>

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

GatewayGuildIntegrationsUpdateDispatch

GatewayGuildIntegrationsUpdateDispatch: _DataPayload<GatewayDispatchEvents.GuildIntegrationsUpdate, GatewayGuildIntegrationsUpdateDispatchData>

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

GatewayGuildMemberAddDispatch

GatewayGuildMemberAddDispatch: _DataPayload<GatewayDispatchEvents.GuildMemberAdd, GatewayGuildMemberAddDispatchData>

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

GatewayGuildMemberRemoveDispatch

GatewayGuildMemberRemoveDispatch: _DataPayload<GatewayDispatchEvents.GuildMemberRemove, GatewayGuildMemberRemoveDispatchData>

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

GatewayGuildMembersChunkDispatch

GatewayGuildMembersChunkDispatch: _DataPayload<GatewayDispatchEvents.GuildMembersChunk, GatewayGuildMembersChunkDispatchData>

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

GatewayGuildMembersChunkPresence

GatewayGuildMembersChunkPresence: Omit<RawGatewayPresenceUpdate, guild_id>

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

GatewayGuildMemberUpdateDispatch

GatewayGuildMemberUpdateDispatch: _DataPayload<GatewayDispatchEvents.GuildMemberUpdate, GatewayGuildMemberUpdateDispatchData>

@see: 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 }

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

GatewayGuildModifyDispatch

GatewayGuildModifyDispatch: _DataPayload<GatewayDispatchEvents.GuildUpdate, GatewayGuildModifyDispatchData>

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

GatewayGuildModifyDispatchData

GatewayGuildModifyDispatchData: APIGuild

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

GatewayGuildRoleCreateDispatch

GatewayGuildRoleCreateDispatch: GatewayGuildRoleModifyDispatch

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

GatewayGuildRoleCreateDispatchData

GatewayGuildRoleCreateDispatchData: GatewayGuildRoleModifyDispatchData

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

GatewayGuildRoleDeleteDispatch

GatewayGuildRoleDeleteDispatch: _DataPayload<GatewayDispatchEvents.GuildRoleDelete, GatewayGuildRoleDeleteDispatchData>

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

GatewayGuildRoleModifyDispatch

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

@see

GatewayGuildRoleUpdateDispatch

GatewayGuildRoleUpdateDispatch: GatewayGuildRoleModifyDispatch

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

GatewayGuildRoleUpdateDispatchData

GatewayGuildRoleUpdateDispatchData: GatewayGuildRoleModifyDispatchData

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

GatewayGuildScheduledEventCreateDispatch

GatewayGuildScheduledEventCreateDispatch: _DataPayload<GatewayDispatchEvents.GuildScheduledEventCreate, GatewayGuildScheduledEventCreateDispatchData>

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

GatewayGuildScheduledEventCreateDispatchData

GatewayGuildScheduledEventCreateDispatchData: APIGuildScheduledEvent

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

GatewayGuildScheduledEventDeleteDispatch

GatewayGuildScheduledEventDeleteDispatch: _DataPayload<GatewayDispatchEvents.GuildScheduledEventDelete, GatewayGuildScheduledEventDeleteDispatchData>

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

GatewayGuildScheduledEventDeleteDispatchData

GatewayGuildScheduledEventDeleteDispatchData: APIGuildScheduledEvent

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

GatewayGuildScheduledEventUpdateDispatch

GatewayGuildScheduledEventUpdateDispatch: _DataPayload<GatewayDispatchEvents.GuildScheduledEventUpdate, GatewayGuildScheduledEventUpdateDispatchData>

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

GatewayGuildScheduledEventUpdateDispatchData

GatewayGuildScheduledEventUpdateDispatchData: APIGuildScheduledEvent

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

GatewayGuildScheduledEventUserAddDispatch

GatewayGuildScheduledEventUserAddDispatch: _DataPayload<GatewayDispatchEvents.GuildScheduledEventUserAdd, GatewayGuildScheduledEventUserAddDispatchData>

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

GatewayGuildScheduledEventUserRemoveDispatch

GatewayGuildScheduledEventUserRemoveDispatch: _DataPayload<GatewayDispatchEvents.GuildScheduledEventUserRemove, GatewayGuildScheduledEventUserAddDispatchData>

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

GatewayGuildSoundboardSoundCreateDispatch

GatewayGuildSoundboardSoundCreateDispatch: _DataPayload<GatewayDispatchEvents.GuildSoundboardSoundCreate, GatewayGuildSoundboardSoundCreateDispatchData>

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

GatewayGuildSoundboardSoundCreateDispatchData

GatewayGuildSoundboardSoundCreateDispatchData: APISoundboardSound

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

GatewayGuildSoundboardSoundDeleteDispatch

GatewayGuildSoundboardSoundDeleteDispatch: _DataPayload<GatewayDispatchEvents.GuildSoundboardSoundDelete, GatewayGuildSoundboardSoundDeleteDispatchData>

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

GatewayGuildSoundboardSoundsUpdateDispatch

GatewayGuildSoundboardSoundsUpdateDispatch: _DataPayload<GatewayDispatchEvents.GuildSoundboardSoundsUpdate, GatewayGuildSoundboardSoundsUpdateDispatchData>

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

GatewayGuildSoundboardSoundUpdateDispatch

GatewayGuildSoundboardSoundUpdateDispatch: _DataPayload<GatewayDispatchEvents.GuildSoundboardSoundUpdate, GatewayGuildSoundboardSoundUpdateDispatchData>

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

GatewayGuildSoundboardSoundUpdateDispatchData

GatewayGuildSoundboardSoundUpdateDispatchData: APISoundboardSound

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

GatewayGuildStickersUpdateDispatch

GatewayGuildStickersUpdateDispatch: _DataPayload<GatewayDispatchEvents.GuildStickersUpdate, GatewayGuildStickersUpdateDispatchData>

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

GatewayGuildUpdateDispatch

GatewayGuildUpdateDispatch: GatewayGuildModifyDispatch

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

GatewayGuildUpdateDispatchData

GatewayGuildUpdateDispatchData: GatewayGuildModifyDispatchData

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

GatewayHeartbeatData

GatewayHeartbeatData: number | null

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

GatewayIntegrationCreateDispatch

GatewayIntegrationCreateDispatch: _DataPayload<GatewayDispatchEvents.IntegrationCreate, GatewayIntegrationCreateDispatchData>

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

GatewayIntegrationCreateDispatchData

GatewayIntegrationCreateDispatchData: APIGuildIntegration & { guild_id: Snowflake }

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

GatewayIntegrationDeleteDispatch

GatewayIntegrationDeleteDispatch: _DataPayload<GatewayDispatchEvents.IntegrationDelete, GatewayIntegrationDeleteDispatchData>

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

GatewayIntegrationUpdateDispatch

GatewayIntegrationUpdateDispatch: _DataPayload<GatewayDispatchEvents.IntegrationUpdate, GatewayIntegrationUpdateDispatchData>

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

GatewayIntegrationUpdateDispatchData

GatewayIntegrationUpdateDispatchData: APIGuildIntegration & { guild_id: Snowflake }

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

GatewayInteractionCreateDispatch

GatewayInteractionCreateDispatch: _DataPayload<GatewayDispatchEvents.InteractionCreate, GatewayInteractionCreateDispatchData>

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

GatewayInteractionCreateDispatchData

GatewayInteractionCreateDispatchData: APIInteraction

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

GatewayInvalidSessionData

GatewayInvalidSessionData: boolean

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

GatewayInviteCreateDispatch

GatewayInviteCreateDispatch: _DataPayload<GatewayDispatchEvents.InviteCreate, GatewayInviteCreateDispatchData>

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

GatewayInviteDeleteDispatch

GatewayInviteDeleteDispatch: _DataPayload<GatewayDispatchEvents.InviteDelete, GatewayInviteDeleteDispatchData>

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

GatewayMessageCreateDispatch

GatewayMessageCreateDispatch: _DataPayload<GatewayDispatchEvents.MessageCreate, GatewayMessageCreateDispatchData>

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

GatewayMessageCreateDispatchData

GatewayMessageCreateDispatchData: GatewayMessageEventExtraFields & Omit<APIMessage, mentions>

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

GatewayMessageDeleteBulkDispatch

GatewayMessageDeleteBulkDispatch: _DataPayload<GatewayDispatchEvents.MessageDeleteBulk, GatewayMessageDeleteBulkDispatchData>

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

GatewayMessageDeleteDispatch

GatewayMessageDeleteDispatch: _DataPayload<GatewayDispatchEvents.MessageDelete, GatewayMessageDeleteDispatchData>

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

GatewayMessagePollVoteAddDispatch

GatewayMessagePollVoteAddDispatch: _DataPayload<GatewayDispatchEvents.MessagePollVoteAdd, GatewayMessagePollVoteDispatchData>

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

GatewayMessagePollVoteRemoveDispatch

GatewayMessagePollVoteRemoveDispatch: _DataPayload<GatewayDispatchEvents.MessagePollVoteRemove, GatewayMessagePollVoteDispatchData>

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

GatewayMessageReactionAddDispatch

GatewayMessageReactionAddDispatch: GatewayMessageReactionData<GatewayDispatchEvents.MessageReactionAdd>

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

GatewayMessageReactionAddDispatchData

GatewayMessageReactionAddDispatchData: GatewayMessageReactionAddDispatch[d]

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

GatewayMessageReactionData

GatewayMessageReactionData<E, O>: _DataPayload<E, Omit<{ burst: boolean; burst_colors: string[]; channel_id: Snowflake; emoji: APIEmoji; guild_id?: Snowflake; member?: APIGuildMember; message_author_id?: Snowflake; message_id: Snowflake; type: ReactionType; user_id: Snowflake }, O>>

Type parameters

E: GatewayDispatchEvents
O: string = never

GatewayMessageReactionRemoveAllDispatch

GatewayMessageReactionRemoveAllDispatch: _DataPayload<GatewayDispatchEvents.MessageReactionRemoveAll, GatewayMessageReactionRemoveAllDispatchData>

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

GatewayMessageReactionRemoveAllDispatchData

GatewayMessageReactionRemoveAllDispatchData: GatewayMessageReactionRemoveData

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

GatewayMessageReactionRemoveDispatch

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

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

GatewayMessageReactionRemoveDispatchData

GatewayMessageReactionRemoveDispatchData: GatewayMessageReactionRemoveDispatch[d]

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

GatewayMessageReactionRemoveEmojiDispatch

GatewayMessageReactionRemoveEmojiDispatch: _DataPayload<GatewayDispatchEvents.MessageReactionRemoveEmoji, GatewayMessageReactionRemoveEmojiDispatchData>

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

GatewayMessageUpdateDispatch

GatewayMessageUpdateDispatch: _DataPayload<GatewayDispatchEvents.MessageUpdate, GatewayMessageUpdateDispatchData>

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

GatewayMessageUpdateDispatchData

GatewayMessageUpdateDispatchData: GatewayMessageEventExtraFields & Omit<APIMessage, mentions>

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

GatewayPresenceUpdateDispatch

GatewayPresenceUpdateDispatch: _DataPayload<GatewayDispatchEvents.PresenceUpdate, GatewayPresenceUpdateDispatchData>

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

GatewayPresenceUpdateDispatchData

GatewayPresenceUpdateDispatchData: RawGatewayPresenceUpdate

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

GatewayReadyDispatch

GatewayReadyDispatch: _DataPayload<GatewayDispatchEvents.Ready, GatewayReadyDispatchData>

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

GatewayReceivePayload

GatewayRequestGuildMembersData

GatewayRequestGuildMembersData: GatewayRequestGuildMembersDataWithQuery | GatewayRequestGuildMembersDataWithUserIds

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

GatewayResumedDispatch

GatewayResumedDispatch: _DataPayload<GatewayDispatchEvents.Resumed, never>

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

GatewaySendPayload

GatewaySoundboardSoundsDispatch

GatewaySoundboardSoundsDispatch: _DataPayload<GatewayDispatchEvents.SoundboardSounds, GatewaySoundboardSoundsDispatchData>

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

GatewayStageInstanceCreateDispatch

GatewayStageInstanceCreateDispatch: _DataPayload<GatewayDispatchEvents.StageInstanceCreate, GatewayStageInstanceCreateDispatchData>

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

GatewayStageInstanceCreateDispatchData

GatewayStageInstanceCreateDispatchData: APIStageInstance

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

GatewayStageInstanceDeleteDispatch

GatewayStageInstanceDeleteDispatch: _DataPayload<GatewayDispatchEvents.StageInstanceDelete, GatewayStageInstanceDeleteDispatchData>

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

GatewayStageInstanceDeleteDispatchData

GatewayStageInstanceDeleteDispatchData: APIStageInstance

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

GatewayStageInstanceUpdateDispatch

GatewayStageInstanceUpdateDispatch: _DataPayload<GatewayDispatchEvents.StageInstanceUpdate, GatewayStageInstanceUpdateDispatchData>

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

GatewayStageInstanceUpdateDispatchData

GatewayStageInstanceUpdateDispatchData: APIStageInstance

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

GatewaySubscriptionCreateDispatch

GatewaySubscriptionCreateDispatch: GatewaySubscriptionModifyDispatch

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

GatewaySubscriptionCreateDispatchData

GatewaySubscriptionCreateDispatchData: GatewaySubscriptionModifyDispatchData

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

GatewaySubscriptionDeleteDispatch

GatewaySubscriptionDeleteDispatch: GatewaySubscriptionModifyDispatch

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

GatewaySubscriptionDeleteDispatchData

GatewaySubscriptionDeleteDispatchData: GatewaySubscriptionModifyDispatchData

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

GatewaySubscriptionModifyDispatch

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

@see

GatewaySubscriptionModifyDispatchData

GatewaySubscriptionModifyDispatchData: APISubscription

@see

GatewaySubscriptionUpdateDispatch

GatewaySubscriptionUpdateDispatch: GatewaySubscriptionModifyDispatch

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

GatewaySubscriptionUpdateDispatchData

GatewaySubscriptionUpdateDispatchData: GatewaySubscriptionModifyDispatchData

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

GatewayThreadCreateDispatch

GatewayThreadCreateDispatch: _DataPayload<GatewayDispatchEvents.ThreadCreate, GatewayThreadCreateDispatchData>

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

GatewayThreadDeleteDispatch

GatewayThreadDeleteDispatch: _DataPayload<GatewayDispatchEvents.ThreadDelete, GatewayThreadDeleteDispatchData>

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

GatewayThreadListSyncDispatch

GatewayThreadListSyncDispatch: _DataPayload<GatewayDispatchEvents.ThreadListSync, GatewayThreadListSyncDispatchData>

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

GatewayThreadListSyncDispatchData

GatewayThreadListSyncDispatchData: RawGatewayThreadListSync

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

GatewayThreadMembersUpdateDispatch

GatewayThreadMembersUpdateDispatch: _DataPayload<GatewayDispatchEvents.ThreadMembersUpdate, GatewayThreadMembersUpdateDispatchData>

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

GatewayThreadMembersUpdateDispatchData

GatewayThreadMembersUpdateDispatchData: RawGatewayThreadMembersUpdate

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

GatewayThreadMemberUpdateDispatch

GatewayThreadMemberUpdateDispatch: _DataPayload<GatewayDispatchEvents.ThreadMemberUpdate, GatewayThreadMemberUpdateDispatchData>

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

GatewayThreadMemberUpdateDispatchData

GatewayThreadMemberUpdateDispatchData: APIThreadMember & { guild_id: Snowflake }

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

GatewayThreadModifyDispatch

GatewayThreadModifyDispatch: _DataPayload<GatewayDispatchEvents.ThreadCreate | GatewayDispatchEvents.ThreadDelete | GatewayDispatchEvents.ThreadUpdate, APIThreadChannel>

@deprecated

This type doesn't accurately reflect the Discord API. Use GatewayThreadCreateDispatch, GatewayThreadUpdateDispatch, or GatewayThreadDeleteDispatch instead.

@see

GatewayThreadUpdateDispatch

GatewayThreadUpdateDispatch: _DataPayload<GatewayDispatchEvents.ThreadUpdate, GatewayThreadUpdateDispatchData>

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

GatewayThreadUpdateDispatchData

GatewayThreadUpdateDispatchData: APIThreadChannel

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

GatewayTypingStartDispatch

GatewayTypingStartDispatch: _DataPayload<GatewayDispatchEvents.TypingStart, GatewayTypingStartDispatchData>

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

GatewayUserUpdateDispatch

GatewayUserUpdateDispatch: _DataPayload<GatewayDispatchEvents.UserUpdate, GatewayUserUpdateDispatchData>

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

GatewayUserUpdateDispatchData

GatewayUserUpdateDispatchData: APIUser

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

GatewayVoiceChannelEffectSendDispatch

GatewayVoiceChannelEffectSendDispatch: _DataPayload<GatewayDispatchEvents.VoiceChannelEffectSend, GatewayVoiceChannelEffectSendDispatchData>

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

GatewayVoiceServerUpdateDispatch

GatewayVoiceServerUpdateDispatch: _DataPayload<GatewayDispatchEvents.VoiceServerUpdate, GatewayVoiceServerUpdateDispatchData>

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

GatewayVoiceState

GatewayVoiceState: APIVoiceState

@see: https://discord.com/developers/docs/resources/voice#voice-state-object
@deprecated: This is deprecated, use APIVoiceState

GatewayVoiceStateUpdateDispatch

GatewayVoiceStateUpdateDispatch: _DataPayload<GatewayDispatchEvents.VoiceStateUpdate, GatewayVoiceStateUpdateDispatchData>

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

GatewayVoiceStateUpdateDispatchData

GatewayVoiceStateUpdateDispatchData: APIVoiceState

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

GatewayWebhooksUpdateDispatch

GatewayWebhooksUpdateDispatch: _DataPayload<GatewayDispatchEvents.WebhooksUpdate, GatewayWebhooksUpdateDispatchData>

@see: 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>

GuildScheduledEventRecurrenceRuleNWeekday

GuildScheduledEventRecurrenceRuleNWeekday: APIGuildScheduledEventRecurrenceRuleNWeekday

@deprecated: Use APIGuildScheduledEventRecurrenceRuleNWeekday instead

GuildSplashFormat

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

GuildTextChannelType

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

ImageSize

ImageSize: 1024 | 2048 | 4096 | 16 | 32 | 64 | 128 | 256 | 512 | (number & {})

LocaleString

LocaleString: `${Locale}`

@deprecated: Use Locale instead.

LocalizationMap

LocalizationMap: Partial<Record<Locale, string | null>>

PartialAPIMessageInteractionGuildMember

PresenceUpdateReceiveStatus

PresenceUpdateReceiveStatus: Exclude<PresenceUpdateStatus, PresenceUpdateStatus.Invisible>

RESTAPIAttachment

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

@see: 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 }

@see: 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

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

RESTDeleteAPIAutoModerationRuleResult

RESTDeleteAPIAutoModerationRuleResult: never

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

RESTDeleteAPIChannelAllMessageReactionsResult

RESTDeleteAPIChannelAllMessageReactionsResult: never

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

RESTDeleteAPIChannelMessageOwnReaction

RESTDeleteAPIChannelMessageOwnReaction: RESTDeleteAPIChannelMessageOwnReactionResult

@deprecated: Use RESTDeleteAPIChannelMessageOwnReactionResult instead

RESTDeleteAPIChannelMessageOwnReactionResult

RESTDeleteAPIChannelMessageOwnReactionResult: never

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

RESTDeleteAPIChannelMessageReactionResult

RESTDeleteAPIChannelMessageReactionResult: never

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

RESTDeleteAPIChannelMessageResult

RESTDeleteAPIChannelMessageResult: never

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

RESTDeleteAPIChannelMessageUserReactionResult

RESTDeleteAPIChannelMessageUserReactionResult: never

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

RESTDeleteAPIChannelPermissionResult

RESTDeleteAPIChannelPermissionResult: never

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

RESTDeleteAPIChannelPinResult

RESTDeleteAPIChannelPinResult: never

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

RESTDeleteAPIChannelRecipientResult

RESTDeleteAPIChannelRecipientResult: unknown

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

RESTDeleteAPIChannelResult

RESTDeleteAPIChannelResult: APIChannel

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

RESTDeleteAPIChannelThreadMembersResult

RESTDeleteAPIChannelThreadMembersResult: never

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

RESTDeleteAPICurrentUserGuildResult

RESTDeleteAPICurrentUserGuildResult: never

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

RESTDeleteAPIEntitlementResult

RESTDeleteAPIEntitlementResult: never

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

RESTDeleteAPIGuildBanResult

RESTDeleteAPIGuildBanResult: never

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

RESTDeleteAPIGuildEmojiResult

RESTDeleteAPIGuildEmojiResult: never

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

RESTDeleteAPIGuildIntegrationResult

RESTDeleteAPIGuildIntegrationResult: never

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

RESTDeleteAPIGuildMemberResult

RESTDeleteAPIGuildMemberResult: never

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

RESTDeleteAPIGuildMemberRoleResult

RESTDeleteAPIGuildMemberRoleResult: never

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

RESTDeleteAPIGuildResult

RESTDeleteAPIGuildResult: never

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

RESTDeleteAPIGuildRoleResult

RESTDeleteAPIGuildRoleResult: never

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

RESTDeleteAPIGuildScheduledEventResult

RESTDeleteAPIGuildScheduledEventResult: never

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

RESTDeleteAPIGuildSoundboardSoundResult

RESTDeleteAPIGuildSoundboardSoundResult: never

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

RESTDeleteAPIGuildStickerResult

RESTDeleteAPIGuildStickerResult: never

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

RESTDeleteAPIGuildTemplateResult

RESTDeleteAPIGuildTemplateResult: APITemplate

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

RESTDeleteAPIInteractionFollowupResult

RESTDeleteAPIInteractionFollowupResult: RESTDeleteAPIWebhookWithTokenMessageResult

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

RESTDeleteAPIInteractionOriginalResponseResult

RESTDeleteAPIInteractionOriginalResponseResult: RESTDeleteAPIWebhookWithTokenMessageResult

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

RESTDeleteAPIInviteResult

RESTDeleteAPIInviteResult: APIInvite

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

RESTDeleteAPIStageInstanceResult

RESTDeleteAPIStageInstanceResult: never

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

RESTDeleteAPIWebhookResult

RESTDeleteAPIWebhookResult: never

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

RESTDeleteAPIWebhookWithTokenMessageResult

RESTDeleteAPIWebhookWithTokenMessageResult: never

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

RESTDeleteAPIWebhookWithTokenResult

RESTDeleteAPIWebhookWithTokenResult: never

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

RESTErrorData

RESTErrorData: RESTErrorFieldInformation | RESTErrorGroupWrapper | string | {}

RESTGetAPIApplicationCommandPermissionsResult

RESTGetAPIApplicationCommandPermissionsResult: APIGuildApplicationCommandPermissions

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

RESTGetAPIApplicationCommandResult

RESTGetAPIApplicationCommandResult: APIApplicationCommand

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

RESTGetAPIApplicationCommandsResult

RESTGetAPIApplicationCommandsResult: APIApplicationCommand[]

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

RESTGetAPIApplicationEmojiResult

RESTGetAPIApplicationEmojiResult: APIApplicationEmoji

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

RESTGetAPIApplicationGuildCommandResult

RESTGetAPIApplicationGuildCommandResult: Omit<APIApplicationCommand, dm_permission>

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

RESTGetAPIApplicationGuildCommandsQuery

RESTGetAPIApplicationGuildCommandsQuery: RESTGetAPIApplicationCommandsQuery

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

RESTGetAPIApplicationGuildCommandsResult

RESTGetAPIApplicationGuildCommandsResult: Omit<APIApplicationCommand, dm_permission>[]

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

RESTGetAPIApplicationRoleConnectionMetadataResult

RESTGetAPIApplicationRoleConnectionMetadataResult: APIApplicationRoleConnectionMetadata[]

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

RESTGetAPIAuditLogResult

RESTGetAPIAuditLogResult: APIAuditLog

RESTGetAPIAutoModerationRuleResult

RESTGetAPIAutoModerationRuleResult: APIAutoModerationRule

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

RESTGetAPIAutoModerationRulesResult

RESTGetAPIAutoModerationRulesResult: APIAutoModerationRule[]

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

RESTGetAPIChannelInvitesResult

RESTGetAPIChannelInvitesResult: APIExtendedInvite[]

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

RESTGetAPIChannelMessageReactionUsersResult

RESTGetAPIChannelMessageReactionUsersResult: APIUser[]

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

RESTGetAPIChannelMessageResult

RESTGetAPIChannelMessageResult: APIMessage

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

RESTGetAPIChannelMessagesResult

RESTGetAPIChannelMessagesResult: APIMessage[]

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

RESTGetAPIChannelPinsResult

RESTGetAPIChannelPinsResult: APIMessage[]

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

RESTGetAPIChannelResult

RESTGetAPIChannelResult: APIChannel

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

RESTGetAPIChannelThreadMemberResult

RESTGetAPIChannelThreadMemberResult: APIThreadMember

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

RESTGetAPIChannelThreadMembersResult

RESTGetAPIChannelThreadMembersResult: APIThreadMember[]

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

RESTGetAPIChannelThreadsArchivedPrivateResult

RESTGetAPIChannelThreadsArchivedPrivateResult: RESTGetAPIChannelUsersThreadsArchivedResult

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

RESTGetAPIChannelThreadsArchivedPublicResult

RESTGetAPIChannelThreadsArchivedPublicResult: RESTGetAPIChannelUsersThreadsArchivedResult

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

RESTGetAPIChannelWebhooksResult

RESTGetAPIChannelWebhooksResult: APIWebhook[]

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

RESTGetAPICurrentUserApplicationRoleConnectionResult

RESTGetAPICurrentUserApplicationRoleConnectionResult: APIApplicationRoleConnection

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

RESTGetAPICurrentUserConnectionsResult

RESTGetAPICurrentUserConnectionsResult: APIConnection[]

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

RESTGetAPICurrentUserGuildsResult

RESTGetAPICurrentUserGuildsResult: RESTAPIPartialCurrentUserGuild[]

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

RESTGetAPICurrentUserResult

RESTGetAPICurrentUserResult: APIUser

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

RESTGetAPIEntitlementResult

RESTGetAPIEntitlementResult: APIEntitlement

@see: https://discord.com/developers/docs/resources/entitlement#get-entitlement

RESTGetAPIEntitlementsResult

RESTGetAPIEntitlementsResult: APIEntitlement[]

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

RESTGetAPIGatewayBotResult

RESTGetAPIGatewayBotResult: APIGatewayBotInfo

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

RESTGetAPIGatewayResult

RESTGetAPIGatewayResult: APIGatewayInfo

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

RESTGetAPIGuildApplicationCommandsPermissionsResult

RESTGetAPIGuildApplicationCommandsPermissionsResult: APIGuildApplicationCommandPermissions[]

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

RESTGetAPIGuildBanResult

RESTGetAPIGuildBanResult: APIBan

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

RESTGetAPIGuildBansResult

RESTGetAPIGuildBansResult: APIBan[]

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

RESTGetAPIGuildChannelsResult

RESTGetAPIGuildChannelsResult: APIChannel[]

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

RESTGetAPIGuildEmojiResult

RESTGetAPIGuildEmojiResult: APIEmoji

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

RESTGetAPIGuildEmojisResult

RESTGetAPIGuildEmojisResult: APIEmoji[]

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

RESTGetAPIGuildIntegrationsResult

RESTGetAPIGuildIntegrationsResult: APIGuildIntegration[]

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

RESTGetAPIGuildInvitesResult

RESTGetAPIGuildInvitesResult: APIExtendedInvite[]

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

RESTGetAPIGuildMemberResult

RESTGetAPIGuildMemberResult: APIGuildMember

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

RESTGetAPIGuildMembersResult

RESTGetAPIGuildMembersResult: APIGuildMember[]

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

RESTGetAPIGuildMembersSearchResult

RESTGetAPIGuildMembersSearchResult: APIGuildMember[]

RESTGetAPIGuildMemberVerificationResult

RESTGetAPIGuildMemberVerificationResult: APIGuildMembershipScreening

RESTGetAPIGuildOnboardingResult

RESTGetAPIGuildOnboardingResult: APIGuildOnboarding

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

RESTGetAPIGuildPreviewResult

RESTGetAPIGuildPreviewResult: APIGuildPreview

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

RESTGetAPIGuildResult

RESTGetAPIGuildResult: APIGuild

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

RESTGetAPIGuildRoleResult

RESTGetAPIGuildRoleResult: APIRole

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

RESTGetAPIGuildRolesResult

RESTGetAPIGuildRolesResult: APIRole[]

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

RESTGetAPIGuildScheduledEventResult

RESTGetAPIGuildScheduledEventResult: APIGuildScheduledEvent

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

RESTGetAPIGuildScheduledEventsResult

RESTGetAPIGuildScheduledEventsResult: APIGuildScheduledEvent[]

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

RESTGetAPIGuildScheduledEventUsersResult

RESTGetAPIGuildScheduledEventUsersResult: APIGuildScheduledEventUser[]

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

RESTGetAPIGuildSoundboardSoundResult

RESTGetAPIGuildSoundboardSoundResult: APISoundboardSound

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

RESTGetAPIGuildStickerResult

RESTGetAPIGuildStickerResult: APISticker

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

RESTGetAPIGuildStickersResult

RESTGetAPIGuildStickersResult: APISticker[]

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

RESTGetAPIGuildTemplatesResult

RESTGetAPIGuildTemplatesResult: APITemplate[]

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

RESTGetAPIGuildThreadsResult

RESTGetAPIGuildThreadsResult: APIThreadList

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

RESTGetAPIGuildVoiceRegionsResult

RESTGetAPIGuildVoiceRegionsResult: APIVoiceRegion[]

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

RESTGetAPIGuildVoiceStateCurrentMemberResult

RESTGetAPIGuildVoiceStateCurrentMemberResult: APIVoiceState

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

RESTGetAPIGuildVoiceStateUserResult

RESTGetAPIGuildVoiceStateUserResult: APIVoiceState

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

RESTGetAPIGuildWebhooksResult

RESTGetAPIGuildWebhooksResult: APIWebhook[]

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

RESTGetAPIGuildWelcomeScreenResult

RESTGetAPIGuildWelcomeScreenResult: APIGuildWelcomeScreen

@see: 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

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

RESTGetAPIGuildWidgetSettingsResult

RESTGetAPIGuildWidgetSettingsResult: APIGuildWidgetSettings

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

RESTGetAPIInteractionFollowupResult

RESTGetAPIInteractionFollowupResult: RESTGetAPIWebhookWithTokenMessageResult

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

RESTGetAPIInteractionOriginalResponseResult

RESTGetAPIInteractionOriginalResponseResult: RESTGetAPIWebhookWithTokenMessageResult

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

RESTGetAPIInviteResult

RESTGetAPIInviteResult: APIInvite

RESTGetAPIOAuth2CurrentApplicationResult

RESTGetAPIOAuth2CurrentApplicationResult: Omit<APIApplication, flags>

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

RESTGetAPISKUsResult

RESTGetAPISKUsResult: APISKU[]

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

RESTGetAPISKUSubscriptionResult

RESTGetAPISKUSubscriptionResult: APISubscription

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

RESTGetAPISKUSubscriptionsResult

RESTGetAPISKUSubscriptionsResult: APISubscription[]

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

RESTGetAPISoundboardDefaultSoundsResult

RESTGetAPISoundboardDefaultSoundsResult: APISoundboardSound[]

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

RESTGetAPIStageInstanceResult

RESTGetAPIStageInstanceResult: APIStageInstance

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

RESTGetAPIStickerPack

RESTGetAPIStickerPack: RESTGetAPIStickerPackResult

@deprecated: Use RESTGetAPIStickerPackResult instead

RESTGetAPIStickerPackResult

RESTGetAPIStickerPackResult: APIStickerPack

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

RESTGetAPIStickerResult

RESTGetAPIStickerResult: APISticker

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

RESTGetAPITemplateResult

RESTGetAPITemplateResult: APITemplate

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

RESTGetAPIUserResult

RESTGetAPIUserResult: APIUser

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

RESTGetAPIVoiceRegionsResult

RESTGetAPIVoiceRegionsResult: APIVoiceRegion[]

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

RESTGetAPIWebhookResult

RESTGetAPIWebhookResult: APIWebhook

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

RESTGetAPIWebhookWithTokenMessageResult

RESTGetAPIWebhookWithTokenMessageResult: APIMessage

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

RESTGetAPIWebhookWithTokenResult

RESTGetAPIWebhookWithTokenResult: Omit<APIWebhook, user>

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

RESTGetCurrentApplicationResult

RESTGetCurrentApplicationResult: APIApplication

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

RESTGetCurrentUserGuildMemberResult

RESTGetCurrentUserGuildMemberResult: APIGuildMember

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

RESTGetNitroStickerPacksResult

RESTGetNitroStickerPacksResult: RESTGetStickerPacksResult

@see: 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>

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

RESTOAuth2TokenOptionalClientCredentials

RESTOAuth2TokenOptionalClientCredentials: { client_id: Snowflake; client_secret: string } | { client_id?: never; client_secret?: never }

RESTPatchAPIApplicationCommandJSONBody

RESTPatchAPIApplicationCommandJSONBody: _StrictPartial<RESTPostAPIApplicationCommandsJSONBody>

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

RESTPatchAPIApplicationCommandResult

RESTPatchAPIApplicationCommandResult: APIApplicationCommand

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

RESTPatchAPIApplicationEmojiJSONBody

RESTPatchAPIApplicationEmojiJSONBody: Pick<RESTPatchAPIGuildEmojiJSONBody, name>

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

RESTPatchAPIApplicationEmojiResult

RESTPatchAPIApplicationEmojiResult: APIApplicationEmoji

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

RESTPatchAPIApplicationGuildCommandJSONBody

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

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

RESTPatchAPIApplicationGuildCommandResult

RESTPatchAPIApplicationGuildCommandResult: Omit<APIApplicationCommand, dm_permission>

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

RESTPatchAPIAutoModerationRuleJSONBody

RESTPatchAPIAutoModerationRuleJSONBody: Omit<Partial<RESTPostAPIAutoModerationRuleJSONBody>, trigger_type>

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

RESTPatchAPIAutoModerationRuleResult

RESTPatchAPIAutoModerationRuleResult: APIAutoModerationRule

@see: 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)

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

RESTPatchAPIChannelMessageResult

RESTPatchAPIChannelMessageResult: APIMessage

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

RESTPatchAPIChannelResult

RESTPatchAPIChannelResult: APIChannel

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

RESTPatchAPICurrentGuildMemberNicknameResult

RESTPatchAPICurrentGuildMemberNicknameResult: _StrictRequired<RESTPatchAPICurrentGuildMemberNicknameJSONBody>

@see: https://discord.com/developers/docs/resources/guild#modify-current-user-nick
@deprecated: Use Current Member instead.

RESTPatchAPICurrentUserResult

RESTPatchAPICurrentUserResult: APIUser

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

RESTPatchAPIGuildChannelPositionsJSONBody

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

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

RESTPatchAPIGuildChannelPositionsResult

RESTPatchAPIGuildChannelPositionsResult: never

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

RESTPatchAPIGuildEmojiResult

RESTPatchAPIGuildEmojiResult: APIEmoji

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

RESTPatchAPIGuildMemberResult

RESTPatchAPIGuildMemberResult: APIGuildMember

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

RESTPatchAPIGuildMemberVerificationResult

RESTPatchAPIGuildMemberVerificationResult: APIGuildMembershipScreening

RESTPatchAPIGuildResult

RESTPatchAPIGuildResult: APIGuild

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

RESTPatchAPIGuildRolePositionsJSONBody

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

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

RESTPatchAPIGuildRolePositionsResult

RESTPatchAPIGuildRolePositionsResult: APIRole[]

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

RESTPatchAPIGuildRoleResult

RESTPatchAPIGuildRoleResult: APIRole

@see: 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 }

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

RESTPatchAPIGuildScheduledEventResult

RESTPatchAPIGuildScheduledEventResult: APIGuildScheduledEvent

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

RESTPatchAPIGuildSoundboardSoundResult

RESTPatchAPIGuildSoundboardSoundResult: APISoundboardSound

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

RESTPatchAPIGuildStickerResult

RESTPatchAPIGuildStickerResult: APISticker

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

RESTPatchAPIGuildTemplateJSONBody

RESTPatchAPIGuildTemplateJSONBody: _StrictPartial<RESTPostAPIGuildTemplatesJSONBody>

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

RESTPatchAPIGuildTemplateResult

RESTPatchAPIGuildTemplateResult: APITemplate

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

RESTPatchAPIGuildVoiceStateCurrentMemberResult

RESTPatchAPIGuildVoiceStateCurrentMemberResult: never

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

RESTPatchAPIGuildVoiceStateUserResult

RESTPatchAPIGuildVoiceStateUserResult: never

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

RESTPatchAPIGuildWelcomeScreenJSONBody

RESTPatchAPIGuildWelcomeScreenJSONBody: _Nullable<_StrictPartial<APIGuildWelcomeScreen>> & { enabled?: boolean | null }

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

RESTPatchAPIGuildWelcomeScreenResult

RESTPatchAPIGuildWelcomeScreenResult: APIGuildWelcomeScreen

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

RESTPatchAPIGuildWidgetSettingsJSONBody

RESTPatchAPIGuildWidgetSettingsJSONBody: _StrictPartial<APIGuildWidgetSettings>

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

RESTPatchAPIGuildWidgetSettingsResult

RESTPatchAPIGuildWidgetSettingsResult: APIGuildWidgetSettings

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

RESTPatchAPIInteractionFollowupFormDataBody

RESTPatchAPIInteractionFollowupFormDataBody: RESTPatchAPIWebhookWithTokenMessageFormDataBody

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

RESTPatchAPIInteractionFollowupJSONBody

RESTPatchAPIInteractionFollowupJSONBody: RESTPatchAPIWebhookWithTokenMessageJSONBody

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

RESTPatchAPIInteractionFollowupResult

RESTPatchAPIInteractionFollowupResult: RESTPatchAPIWebhookWithTokenMessageResult

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

RESTPatchAPIInteractionOriginalResponseFormDataBody

RESTPatchAPIInteractionOriginalResponseFormDataBody: RESTPatchAPIWebhookWithTokenMessageFormDataBody

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

RESTPatchAPIInteractionOriginalResponseJSONBody

RESTPatchAPIInteractionOriginalResponseJSONBody: RESTPatchAPIWebhookWithTokenMessageJSONBody

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

RESTPatchAPIInteractionOriginalResponseResult

RESTPatchAPIInteractionOriginalResponseResult: RESTPatchAPIWebhookWithTokenMessageResult

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

RESTPatchAPIStageInstanceResult

RESTPatchAPIStageInstanceResult: APIStageInstance

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

RESTPatchAPIWebhookResult

RESTPatchAPIWebhookResult: APIWebhook

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

RESTPatchAPIWebhookWithTokenJSONBody

RESTPatchAPIWebhookWithTokenJSONBody: Omit<RESTPatchAPIWebhookJSONBody, channel_id>

@see: 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)

@see: 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 }

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

RESTPatchAPIWebhookWithTokenMessageQuery

RESTPatchAPIWebhookWithTokenMessageQuery: Pick<RESTPostAPIWebhookWithTokenQuery, thread_id | with_components>

@see: https://discord.com/developers/docs/resources/webhook#edit-webhook-message-query-string-params

RESTPatchAPIWebhookWithTokenMessageResult

RESTPatchAPIWebhookWithTokenMessageResult: APIMessage

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

RESTPatchAPIWebhookWithTokenResult

RESTPatchAPIWebhookWithTokenResult: RESTGetAPIWebhookWithTokenResult

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

RESTPatchCurrentApplicationJSONBody

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

RESTPatchCurrentApplicationResult

RESTPatchCurrentApplicationResult: APIApplication

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

RESTPostAPIApplicationCommandsJSONBody

RESTPostAPIApplicationCommandsJSONBody: RESTPostAPIChatInputApplicationCommandsJSONBody | RESTPostAPIContextMenuApplicationCommandsJSONBody | RESTPostAPIPrimaryEntryPointApplicationCommandJSONBody

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

RESTPostAPIApplicationCommandsResult

RESTPostAPIApplicationCommandsResult: APIApplicationCommand

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

RESTPostAPIApplicationEmojiJSONBody

RESTPostAPIApplicationEmojiJSONBody: Pick<RESTPostAPIGuildEmojiJSONBody, image | name>

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

RESTPostAPIApplicationEmojiResult

RESTPostAPIApplicationEmojiResult: APIApplicationEmoji

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

RESTPostAPIApplicationGuildCommandsJSONBody

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

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

RESTPostAPIApplicationGuildCommandsResult

RESTPostAPIApplicationGuildCommandsResult: Omit<APIApplicationCommand, dm_permission>

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

RESTPostAPIAutoModerationRuleResult

RESTPostAPIAutoModerationRuleResult: APIAutoModerationRule

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

RESTPostAPIBaseApplicationCommandsJSONBody

RESTPostAPIChannelFollowersResult

RESTPostAPIChannelFollowersResult: APIFollowedChannel

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

RESTPostAPIChannelInviteResult

RESTPostAPIChannelInviteResult: APIExtendedInvite

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

RESTPostAPIChannelMessageCrosspostResult

RESTPostAPIChannelMessageCrosspostResult: APIMessage

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

RESTPostAPIChannelMessageFormDataBody

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

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

RESTPostAPIChannelMessageResult

RESTPostAPIChannelMessageResult: APIMessage

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

RESTPostAPIChannelMessagesBulkDeleteResult

RESTPostAPIChannelMessagesBulkDeleteResult: never

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

RESTPostAPIChannelMessagesThreadsResult

RESTPostAPIChannelMessagesThreadsResult: APIChannel

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

RESTPostAPIChannelThreadsResult

RESTPostAPIChannelThreadsResult: APIChannel

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

RESTPostAPIChannelTypingResult

RESTPostAPIChannelTypingResult: never

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

RESTPostAPIChannelWebhookResult

RESTPostAPIChannelWebhookResult: APIWebhook

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

RESTPostAPICurrentUserCreateDMChannelResult

RESTPostAPICurrentUserCreateDMChannelResult: APIChannel

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

RESTPostAPIEntitlementBody

RESTPostAPIEntitlementBody: RESTPostAPIEntitlementJSONBody

@deprecated: Use RESTPostAPIEntitlementJSONBody instead

RESTPostAPIEntitlementConsumeResult

RESTPostAPIEntitlementConsumeResult: never

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

RESTPostAPIEntitlementResult

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

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

RESTPostAPIGuildChannelJSONBody

RESTPostAPIGuildChannelJSONBody: _DistributiveOmit<RESTAPIGuildCreatePartialChannel, id>

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

RESTPostAPIGuildChannelResult

RESTPostAPIGuildChannelResult: APIChannel

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

RESTPostAPIGuildEmojiResult

RESTPostAPIGuildEmojiResult: APIEmoji

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

RESTPostAPIGuildForumThreadsFormDataBody

RESTPostAPIGuildForumThreadsFormDataBody: RESTPostAPIChannelMessagesThreadsJSONBody & { message: string }

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

RESTPostAPIGuildForumThreadsJSONBody

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

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

RESTPostAPIGuildRoleResult

RESTPostAPIGuildRoleResult: APIRole

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

RESTPostAPIGuildScheduledEventResult

RESTPostAPIGuildScheduledEventResult: APIGuildScheduledEvent

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

RESTPostAPIGuildsMFAResult

RESTPostAPIGuildsMFAResult: RESTPostAPIGuildsMFAJSONBody

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

RESTPostAPIGuildSoundboardSoundResult

RESTPostAPIGuildSoundboardSoundResult: APISoundboardSound

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

RESTPostAPIGuildsResult

RESTPostAPIGuildsResult: APIGuild

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

RESTPostAPIGuildStickerResult

RESTPostAPIGuildStickerResult: APISticker

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

RESTPostAPIGuildTemplatesResult

RESTPostAPIGuildTemplatesResult: APITemplate

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

RESTPostAPIInteractionCallbackFormDataBody

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

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

RESTPostAPIInteractionCallbackJSONBody

RESTPostAPIInteractionCallbackJSONBody: APIInteractionResponse

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

RESTPostAPIInteractionCallbackResult

RESTPostAPIInteractionCallbackResult: never

@see: 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)

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

RESTPostAPIInteractionFollowupJSONBody

RESTPostAPIInteractionFollowupJSONBody: APIInteractionResponseCallbackData

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

RESTPostAPIInteractionFollowupResult

RESTPostAPIInteractionFollowupResult: RESTPostAPIWebhookWithTokenWaitResult

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

RESTPostAPIPollExpireResult

RESTPostAPIPollExpireResult: APIMessage

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

RESTPostAPISendSoundboardSoundResult

RESTPostAPISendSoundboardSoundResult: APISoundboardSound

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

RESTPostAPIStageInstanceResult

RESTPostAPIStageInstanceResult: APIStageInstance

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

RESTPostAPITemplateCreateGuildResult

RESTPostAPITemplateCreateGuildResult: APIGuild

@see: 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)

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

RESTPostAPIWebhookWithTokenGitHubQuery

RESTPostAPIWebhookWithTokenGitHubQuery: Pick<RESTPostAPIWebhookWithTokenQuery, thread_id | wait>

@see: https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook-query-string-params

RESTPostAPIWebhookWithTokenGitHubResult

RESTPostAPIWebhookWithTokenGitHubResult: never

@see: 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-query-string-params

RESTPostAPIWebhookWithTokenResult

RESTPostAPIWebhookWithTokenResult: never

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

RESTPostAPIWebhookWithTokenSlackQuery

RESTPostAPIWebhookWithTokenSlackQuery: Pick<RESTPostAPIWebhookWithTokenQuery, thread_id | wait>

@see: https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook-query-string-params

RESTPostAPIWebhookWithTokenSlackResult

RESTPostAPIWebhookWithTokenSlackResult: never

@see: 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-query-string-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-query-string-params

RESTPostOAuth2AccessTokenURLEncodedData

RESTPostOAuth2AccessTokenURLEncodedData: RESTOAuth2TokenOptionalClientCredentials & { code: string; grant_type: authorization_code; redirect_uri?: string }

@remarks: This endpoint requires either HTTP Basic authentication using client_id:client_secret, or the client_id and client_secret must be provided in the form body.
@see: https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-redirect-url-example

RESTPostOAuth2AccessTokenWithBotAndGuildsAndWebhookIncomingScopeResult

RESTPostOAuth2AccessTokenWithBotAndGuildsAndWebhookIncomingScopeResult: RESTPostOAuth2AccessTokenWithBotAndGuildsScopeResult & RESTPostOAuth2AccessTokenWithBotAndWebhookIncomingScopeResult

RESTPostOAuth2ClientCredentialsResult

RESTPostOAuth2ClientCredentialsResult: RESTOAuth2ImplicitAuthorizationURLFragmentResult

RESTPostOAuth2RefreshTokenResult

RESTPostOAuth2RefreshTokenResult: RESTPostOAuth2AccessTokenResult

RESTPostOAuth2RefreshTokenURLEncodedData

RESTPostOAuth2RefreshTokenURLEncodedData: RESTOAuth2TokenOptionalClientCredentials & { grant_type: refresh_token; refresh_token: string }

@remarks: This endpoint requires either HTTP Basic authentication using client_id:client_secret, or the client_id and client_secret must be provided in the form body.
@see: https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-refresh-token-exchange-example

RESTPutAPIApplicationCommandPermissionsResult

RESTPutAPIApplicationCommandPermissionsResult: APIGuildApplicationCommandPermissions

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

RESTPutAPIApplicationCommandsJSONBody

RESTPutAPIApplicationCommandsJSONBody: RESTPostAPIApplicationCommandsJSONBody[]

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

RESTPutAPIApplicationCommandsResult

RESTPutAPIApplicationCommandsResult: APIApplicationCommand[]

@see: 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>))[]

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

RESTPutAPIApplicationGuildCommandsResult

RESTPutAPIApplicationGuildCommandsResult: Omit<APIApplicationCommand, dm_permission>[]

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

RESTPutAPIApplicationRoleConnectionMetadataJSONBody

RESTPutAPIApplicationRoleConnectionMetadataJSONBody: APIApplicationRoleConnectionMetadata[]

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

RESTPutAPIApplicationRoleConnectionMetadataResult

RESTPutAPIApplicationRoleConnectionMetadataResult: APIApplicationRoleConnectionMetadata[]

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

RESTPutAPIChannelMessageReactionResult

RESTPutAPIChannelMessageReactionResult: never

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

RESTPutAPIChannelPermissionResult

RESTPutAPIChannelPermissionResult: never

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

RESTPutAPIChannelPinResult

RESTPutAPIChannelPinResult: never

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

RESTPutAPIChannelRecipientResult

RESTPutAPIChannelRecipientResult: unknown

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

RESTPutAPIChannelThreadMembersResult

RESTPutAPIChannelThreadMembersResult: never

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

RESTPutAPICurrentUserApplicationRoleConnectionResult

RESTPutAPICurrentUserApplicationRoleConnectionResult: APIApplicationRoleConnection

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

RESTPutAPIGuildApplicationCommandsPermissionsJSONBody

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

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

RESTPutAPIGuildApplicationCommandsPermissionsResult

RESTPutAPIGuildApplicationCommandsPermissionsResult: APIGuildApplicationCommandPermissions[]

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

RESTPutAPIGuildBanResult

RESTPutAPIGuildBanResult: never

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

RESTPutAPIGuildMemberResult

RESTPutAPIGuildMemberResult: APIGuildMember | undefined

RESTPutAPIGuildMemberRoleResult

RESTPutAPIGuildMemberRoleResult: never

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

RESTPutAPIGuildOnboardingJSONBody

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

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

RESTPutAPIGuildOnboardingResult

RESTPutAPIGuildOnboardingResult: APIGuildOnboarding

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

RESTPutAPIGuildTemplateSyncResult

RESTPutAPIGuildTemplateSyncResult: APITemplate

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

RoleIconFormat

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

RPCCertifiedDevice

RPCCertifiedDevice<Type>: Type extends RPCDeviceType.AudioInput ? BaseRPCCertifiedDevice<Type> & { automatic_gain_control: boolean; echo_cancellation: boolean; hardware_mute: boolean; noise_suppression: boolean } : BaseRPCCertifiedDevice<Type>

@see: https://discord.com/developers/docs/topics/rpc#setcertifieddevices-device-object

Type parameters

Type: RPCDeviceType = RPCDeviceType

RPCCommandsResult

RPCCommandSubscribePayload

RPCCommandUnsubscribePayload

RPCCommandUnsubscribePayload: RPCCommandSubscribePayload

RPCCreateChannelInviteResultData
unstable

RPCCreateChannelInviteResultData: APIInvite & { created_at: string; guild_id: Snowflake; max_age: number; max_uses: number; temporary: boolean; uses: number }

Channel invite

RPCEventsDispatch

RPCGetRelationshipsResultData
unstable

RPCGetRelationshipsResultData: Relationship[]

RPCGetSelectedVoiceChannelResultData

RPCGetSelectedVoiceChannelResultData: RPCGetChannelResultData | null

@see: https://discord.com/developers/docs/topics/rpc#getselectedvoicechannel

RPCGetSkusResultData
unstable

RPCGetSkusResultData: unknown[]

RPCGetUserResultData
unstable

RPCGetUserResultData: APIUser

RPCMessage

RPCMessage: RPCCommandsResult | RPCEventsDispatch

RPCMessagePayload

RPCSelectTextChannelResultData

RPCSelectTextChannelResultData: RPCGetChannelResultData | null

Returns the Channel response, or null if none.

RPCSelectVoiceChannelResultData

RPCSelectVoiceChannelResultData: RPCGetChannelResultData | null

@see: https://discord.com/developers/docs/topics/rpc#selectvoicechannel

RPCSetCertifiedDevicesResultData

RPCSetCertifiedDevicesResultData: null

RPCSetUserVoiceSettings2Args
unstable

RPCSetUserVoiceSettings2Args: RPCSetUserVoiceSettingsArgs

RPCSetUserVoiceSettings2ResultData
unstable

RPCSetUserVoiceSettings2ResultData: RPCSetUserVoiceSettingsResultData

RPCSetUserVoiceSettingsResultData

RPCSetUserVoiceSettingsResultData: Required<RPCSetUserVoiceSettingsArgs>

@see: https://discord.com/developers/docs/topics/rpc#setuservoicesettings-set-user-voice-settings-argument-and-response-structure

RPCSetVoiceSettings2Args
unstable

RPCSetVoiceSettings2Args: RPCSetVoiceSettingsArgs

RPCSetVoiceSettings2ResultData
unstable

RPCSetVoiceSettings2ResultData: RPCSetVoiceSettingsResultData

RPCSetVoiceSettingsArgs

RPCSetVoiceSettingsArgs: RPCGetVoiceSettingsResultData

@see: https://discord.com/developers/docs/topics/rpc#setvoicesettings-set-voice-settings-argument-and-response-structure
@remarks: Discord only supports a single modifier of voice settings at a time over RPC. If an app changes voice settings, it will lock voice settings so that other apps connected simultaneously lose the ability to change voice settings. Settings reset to what they were before being changed after the controlling app disconnects. When an app that has previously set voice settings connects, the client will swap to that app's configured voice settings and lock voice settings again.

RPCSetVoiceSettingsResultData

RPCSetVoiceSettingsResultData: RPCGetVoiceSettingsResultData

@see: https://discord.com/developers/docs/topics/rpc#setvoicesettings-set-voice-settings-argument-and-response-structure

RPCSubscribeActivityInviteArgs
unstable

RPCSubscribeActivityInviteArgs: Record<string, never>

RPCSubscribeActivityJoinArgs

RPCSubscribeActivityJoinArgs: Record<string, never>

RPCSubscribeActivityJoinRequestArgs

RPCSubscribeActivityJoinRequestArgs: Record<string, never>

RPCSubscribeActivitySpectateArgs

RPCSubscribeActivitySpectateArgs: Record<string, never>

RPCSubscribeArgs

@see: https://discord.com/developers/docs/topics/rpc#subscribe

RPCSubscribeChannelCreateArgs

RPCSubscribeChannelCreateArgs: Record<string, never>

RPCSubscribeCurrentUserUpdateArgs
unstable

RPCSubscribeCurrentUserUpdateArgs: Record<string, never>

RPCSubscribeEntitlementCreateArgs
unstable

RPCSubscribeEntitlementCreateArgs: Record<string, never>

RPCSubscribeEntitlementDeleteArgs
unstable

RPCSubscribeEntitlementDeleteArgs: Record<string, never>

RPCSubscribeGameJoinArgs
unstable

RPCSubscribeGameJoinArgs: Record<string, never>

RPCSubscribeGameSpectateArgs
unstable

RPCSubscribeGameSpectateArgs: Record<string, never>

RPCSubscribeGuildCreateArgs

RPCSubscribeGuildCreateArgs: Record<string, never>

RPCSubscribeNotificationCreateArgs

RPCSubscribeNotificationCreateArgs: Record<string, never>

RPCSubscribeOverlayArgs
unstable

RPCSubscribeOverlayArgs: Record<string, never>

RPCSubscribeOverlayUpdateArgs
unstable

RPCSubscribeOverlayUpdateArgs: Record<string, never>

RPCSubscribeRelationshipUpdateArgs
unstable

RPCSubscribeRelationshipUpdateArgs: Record<string, never>

RPCSubscribeVoiceChannelSelectArgs

RPCSubscribeVoiceChannelSelectArgs: Record<string, never>

RPCSubscribeVoiceConnectionStatusArgs
unstable

RPCSubscribeVoiceConnectionStatusArgs: Record<string, never>

RPCSubscribeVoiceSettingsUpdate2Args
unstable

RPCSubscribeVoiceSettingsUpdate2Args: Record<string, never>

RPCSubscribeVoiceSettingsUpdateArgs

RPCSubscribeVoiceSettingsUpdateArgs: Record<string, never>

RPCUnsubscribeArgs

RPCUnsubscribeArgs: RPCSubscribeArgs

@see: https://discord.com/developers/docs/topics/rpc#unsubscribe

RPCVoiceSettingsUpdateDispatchData

RPCVoiceSettingsUpdateDispatchData: RPCGetVoiceSettingsResultData

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

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

@see: 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: 10 = '10'

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(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
  Parameters
  - applicationId: string
  - achievementId: string
  - achievementIconHash: string
  - format: Format
  Returns `/app-assets/${string}/achievements/${string}/icons/${string}.${Format}`
applicationAsset: function
- applicationAsset(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
  Parameters
  - applicationId: string
  - applicationAssetId: string
  - format: Format
  Returns `/app-assets/${string}/${string}.${Format}`
applicationCover: function
- applicationCover(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
  Parameters
  - applicationId: string
  - applicationCoverImage: string
  - format: Format
  Returns `/app-icons/${string}/${string}.${Format}`
applicationIcon: function
- applicationIcon(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
  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): `/embed/avatars/${Index}.png`
- Route for:
  GET /embed/avatars/{index}.png
  
  The value for index parameter depends on whether the user is to the new username system. For users on the new username system, index will be (user.id >> 22) % 6. For users on the legacy username system, index will be user.discriminator % 5.
  
  This route supports the extension: PNG
  Parameters
  - index: Index
  Returns `/embed/avatars/${Index}.png`
emoji: function
- emoji(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
  Parameters
  - emojiId: string
  - format: Format
  Returns `/emojis/${string}.${Format}`
guildBanner: function
- guildBanner(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
  Parameters
  - guildId: string
  - guildBanner: string
  - format: Format
  Returns `/banners/${string}/${string}.${Format}`
guildDiscoverySplash: function
- guildDiscoverySplash(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
  Parameters
  - guildId: string
  - guildDiscoverySplash: string
  - format: Format
  Returns `/discovery-splashes/${string}/${string}.${Format}`
guildIcon: function
- guildIcon(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
  Parameters
  - guildId: string
  - guildIcon: string
  - format: Format
  Returns `/icons/${string}/${string}.${Format}`
guildMemberAvatar: function
- guildMemberAvatar(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
  Parameters
  - guildId: string
  - userId: string
  - memberAvatar: string
  - format: Format
  Returns `/guilds/${string}/users/${string}/avatars/${string}.${Format}`
guildMemberBanner: function
- guildMemberBanner(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
  Parameters
  - guildId: string
  - userId: string
  - guildMemberBanner: string
  - format: Format
  Returns `/guilds/${string}/users/${string}/banners/${string}.${Format}`
guildScheduledEventCover: function
- guildScheduledEventCover(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
  Parameters
  - guildScheduledEventId: string
  - guildScheduledEventCoverImage: string
  - format: Format
  Returns `/guild-events/${string}/${string}.${Format}`
guildSplash: function
- guildSplash(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
  Parameters
  - guildId: string
  - guildSplash: string
  - format: Format
  Returns `/splashes/${string}/${string}.${Format}`
roleIcon: function
- roleIcon(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
  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(stickerId: string, format: Format): `/stickers/${string}.${Format}`
- Route for:
  GET /stickers/{sticker.id}.{png|json}
  
  This route supports the extensions: PNG, Lottie, GIF
  Parameters
  - stickerId: string
  - format: Format
  Returns `/stickers/${string}.${Format}`
stickerPackBanner: function
- stickerPackBanner(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
  Parameters
  - stickerPackBannerAssetId: string
  - format: Format
  Returns `/app-assets/710982414301790216/store/${string}.${Format}`
storePageAsset: function
- storePageAsset(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
  Parameters
  - applicationId: string
  - assetId: string
  - format: Format = ...
  Returns `/app-assets/${string}/store/${string}.${Format}`
teamIcon: function
- teamIcon(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
  Parameters
  - teamId: string
  - teamIcon: string
  - format: Format
  Returns `/team-icons/${string}/${string}.${Format}`
userAvatar: function
- userAvatar(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
  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(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
  Parameters
  - userId: string
  - userBanner: string
  - format: Format
  Returns `/banners/${string}/${string}.${Format}`

constGatewayVersion

GatewayVersion: 10 = '10'

constOAuth2Routes

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

Type declaration

readonlyauthorizationURL: https://discord.com/api/v10/oauth2/authorize
readonlytokenRevocationURL: https://discord.com/api/v10/oauth2/token/revoke
@see
https://tools.ietf.org/html/rfc7009
readonlytokenURL: https://discord.com/api/v10/oauth2/token

constPermissionFlagsBits

PermissionFlagsBits: { AddReactions: bigint; Administrator: bigint; AttachFiles: bigint; BanMembers: bigint; ChangeNickname: bigint; Connect: bigint; CreateEvents: bigint; CreateGuildExpressions: bigint; CreateInstantInvite: bigint; CreatePrivateThreads: bigint; CreatePublicThreads: bigint; DeafenMembers: bigint; EmbedLinks: bigint; KickMembers: bigint; ManageChannels: bigint; ManageEmojisAndStickers: bigint; ManageEvents: bigint; ManageGuild: bigint; ManageGuildExpressions: bigint; ManageMessages: bigint; ManageNicknames: bigint; ManageRoles: bigint; ManageThreads: bigint; ManageWebhooks: bigint; MentionEveryone: bigint; ModerateMembers: bigint; MoveMembers: bigint; MuteMembers: bigint; PrioritySpeaker: bigint; ReadMessageHistory: bigint; RequestToSpeak: bigint; SendMessages: bigint; SendMessagesInThreads: bigint; SendPolls: bigint; SendTTSMessages: bigint; SendVoiceMessages: bigint; Speak: bigint; Stream: bigint; UseApplicationCommands: bigint; UseEmbeddedActivities: bigint; UseExternalApps: bigint; UseExternalEmojis: bigint; UseExternalSounds: bigint; UseExternalStickers: bigint; UseSoundboard: bigint; UseVAD: bigint; ViewAuditLog: bigint; ViewChannel: bigint; ViewCreatorMonetizationAnalytics: bigint; ViewGuildInsights: bigint } = ...

@see: https://discord.com/developers/docs/topics/permissions#permissions-bitwise-permission-flags

These flags are exported as BigInts and NOT numbers. Wrapping them in Number() may cause issues, try to use BigInts as much as possible or modules that can replicate them in some way

Type declaration

readonlyAddReactions: bigint
Allows for the addition of reactions to messages

Applies to channel types: Text, Voice, Stage
readonlyAdministrator: bigint
Allows all permissions and bypasses channel permission overwrites
readonlyAttachFiles: bigint
Allows for uploading images and files

Applies to channel types: Text, Voice, Stage
readonlyBanMembers: bigint
Allows banning members
readonlyChangeNickname: bigint
Allows for modification of own nickname
readonlyConnect: bigint
Allows for joining of a voice channel

Applies to channel types: Voice, Stage
readonlyCreateEvents: bigint
Allows for creating scheduled events, and editing and deleting those created by the current user

Applies to channel types: Voice, Stage
readonlyCreateGuildExpressions: bigint
Allows for creating emojis, stickers, and soundboard sounds, and editing and deleting those created by the current user
readonlyCreateInstantInvite: bigint
Allows creation of instant invites

Applies to channel types: Text, Voice, Stage
readonlyCreatePrivateThreads: bigint
Allows for creating private threads

Applies to channel types: Text
readonlyCreatePublicThreads: bigint
Allows for creating public and announcement threads

Applies to channel types: Text
readonlyDeafenMembers: bigint
Allows for deafening of members in a voice channel

Applies to channel types: Voice
readonlyEmbedLinks: bigint
Links sent by users with this permission will be auto-embedded

Applies to channel types: Text, Voice, Stage
readonlyKickMembers: bigint
Allows kicking members
readonlyManageChannels: bigint
Allows management and editing of channels

Applies to channel types: Text, Voice, Stage
readonlyManageEmojisAndStickers: bigint
Allows management and editing of emojis, stickers, and soundboard sounds
@deprecated
This is the old name for PermissionFlagsBits.ManageGuildExpressions
readonlyManageEvents: bigint
Allows for editing and deleting scheduled events created by all users

Applies to channel types: Voice, Stage
readonlyManageGuild: bigint
Allows management and editing of the guild
readonlyManageGuildExpressions: bigint
Allows for editing and deleting emojis, stickers, and soundboard sounds created by all users
readonlyManageMessages: bigint
Allows for deletion of other users messages

Applies to channel types: Text, Voice, Stage
readonlyManageNicknames: bigint
Allows for modification of other users nicknames
readonlyManageRoles: bigint
Allows management and editing of roles

Applies to channel types: Text, Voice, Stage
readonlyManageThreads: bigint
Allows for deleting and archiving threads, and viewing all private threads

Applies to channel types: Text
readonlyManageWebhooks: bigint
Allows management and editing of webhooks

Applies to channel types: Text, Voice, Stage
readonlyMentionEveryone: bigint
Allows for using the @everyone tag to notify all users in a channel, and the @here tag to notify all online users in a channel

Applies to channel types: Text, Voice, Stage
readonlyModerateMembers: bigint
Allows for timing out users to prevent them from sending or reacting to messages in chat and threads, and from speaking in voice and stage channels
readonlyMoveMembers: bigint
Allows for moving of members between voice channels

Applies to channel types: Voice, Stage
readonlyMuteMembers: bigint
Allows for muting members in a voice channel

Applies to channel types: Voice, Stage
readonlyPrioritySpeaker: bigint
Allows for using priority speaker in a voice channel

Applies to channel types: Voice
readonlyReadMessageHistory: bigint
Allows for reading of message history

Applies to channel types: Text, Voice, Stage
readonlyRequestToSpeak: bigint
Allows for requesting to speak in stage channels

Applies to channel types: Stage
readonlySendMessages: bigint
Allows for sending messages in a channel and creating threads in a forum (does not allow sending messages in threads)

Applies to channel types: Text, Voice, Stage
readonlySendMessagesInThreads: bigint
Allows for sending messages in threads

Applies to channel types: Text
readonlySendPolls: bigint
Allows sending polls

Applies to channel types: Text, Voice, Stage
readonlySendTTSMessages: bigint
Allows for sending of /tts messages

Applies to channel types: Text, Voice, Stage
readonlySendVoiceMessages: bigint
Allows sending voice messages

Applies to channel types: Text, Voice, Stage
readonlySpeak: bigint
Allows for speaking in a voice channel

Applies to channel types: Voice
readonlyStream: bigint
Allows the user to go live

Applies to channel types: Voice, Stage
readonlyUseApplicationCommands: bigint
Allows members to use application commands, including slash commands and context menu commands

Applies to channel types: Text, Voice, Stage
readonlyUseEmbeddedActivities: bigint
Allows for using Activities (applications with the ApplicationFlags.Embedded flag) in a voice channel

Applies to channel types: Voice
readonlyUseExternalApps: bigint
Allows user-installed apps to send public responses. When disabled, users will still be allowed to use their apps but the responses will be ephemeral. This only applies to apps not also installed to the server

Applies to channel types: Text, Voice, Stage
readonlyUseExternalEmojis: bigint
Allows the usage of custom emojis from other servers

Applies to channel types: Text, Voice, Stage
readonlyUseExternalSounds: bigint
Allows the usage of custom soundboard sounds from other servers

Applies to channel types: Voice
readonlyUseExternalStickers: bigint
Allows the usage of custom stickers from other servers

Applies to channel types: Text, Voice, Stage
readonlyUseSoundboard: bigint
Allows for using soundboard in a voice channel

Applies to channel types: Voice
readonlyUseVAD: bigint
Allows for using voice-activity-detection in a voice channel

Applies to channel types: Voice
readonlyViewAuditLog: bigint
Allows for viewing of audit logs
readonlyViewChannel: bigint
Allows guild members to view a channel, which includes reading messages in text channels and joining voice channels

Applies to channel types: Text, Voice, Stage
readonlyViewCreatorMonetizationAnalytics: bigint
Allows for viewing role subscription insights
readonlyViewGuildInsights: bigint
Allows for viewing guild insights

constRouteBases

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

Type declaration

readonlyapi: https://discord.com/api/v10
readonlycdn: https://cdn.discordapp.com
readonlygift: https://discord.gift
readonlyinvite: https://discord.gg
readonlymedia: https://media.discordapp.net
readonlyscheduledEvent: https://discord.com/events
readonlytemplate: 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; channelMessages: any; channelMessageUserReaction: 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; guildIncidentActions: any; guildIntegration: any; guildIntegrations: any; guildInvites: any; guildMember: any; guildMemberRole: any; guildMembers: any; guildMembersSearch: any; guildMemberVerification: any; guildMFA: any; guildOnboarding: any; guildPreview: any; guildPrune: any; guildRole: any; guildRoles: any; guilds: any; guildScheduledEvent: any; guildScheduledEvents: any; guildScheduledEventUsers: 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; interactionCallback: any; invite: any; nitroStickerPacks: any; oauth2Authorization: any; oauth2CurrentApplication: any; oauth2CurrentAuthorization: any; oauth2TokenExchange: any; oauth2TokenRevocation: any; pollAnswerVoters: any; sendSoundboardSound: any; skus: any; skuSubscription: any; skuSubscriptions: 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}`
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`
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}`
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, archivedStatus: private | public): `/channels/${string}/threads/archived/private` | `/channels/${string}/threads/archived/public`
- Route for:
  GET /channels/{channel.id}/threads/archived/public
  GET /channels/{channel.id}/threads/archived/private
  Parameters
  - channelId: string
  - archivedStatus: private | public
  Returns `/channels/${string}/threads/archived/private` | `/channels/${string}/threads/archived/public`
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:
  GET /applications/{application.id}/entitlements/{entitlement.id}
  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`
guildIncidentActions: function
- guildIncidentActions(guildId: string): `/guilds/${string}/incident-actions`
- Route for:
  PUT /guilds/${guild.id}/incident-actions
  Parameters
  - guildId: string
  Returns `/guilds/${string}/incident-actions`
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`
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}`
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`
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`
guildMFA: function
- guildMFA(guildId: string): `/guilds/${string}/mfa`
- Route for:
  POST /guilds/{guild.id}/mfa
  Parameters
  - guildId: string
  Returns `/guilds/${string}/mfa`
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`
guilds: function
- guilds(): /guilds
- Route for:
  POST /guilds
  Returns /guilds
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}`
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`
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`
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`
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`
skus: function
- skus(applicationId: string): `/applications/${string}/skus`
- Route for:
  GET /applications/{application.id}/skus
  Parameters
  - applicationId: string
  Returns `/applications/${string}/skus`
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`
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'
    The user ID, defaulted to @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`

constRPCVersion

RPCVersion: 1 = '1'

constStickerPackApplicationId

StickerPackApplicationId: 710982414301790216 = '710982414301790216'

consturlSafeCharacters

urlSafeCharacters: { test: any } = ...

Type declaration

test: function
- test(input: string): boolean
- Parameters
  - input: string
  Returns boolean

Index

References

Namespaces

Enumerations

Interfaces

Type Aliases

Variables

References

FormattingPatterns

Permissions

Snowflake

Type Aliases

_AddUndefinedToPossiblyUndefinedPropertiesOfInterface

Type parameters

_DistributiveKeys

Type parameters

_DistributiveOmit

Type parameters

_DistributivePick

Type parameters

_Keys

Type parameters

_NonDispatchPayload

_NonNullableFields

Type parameters

_Nullable

Type parameters

_Omit

Type parameters

_Pick

Type parameters

_StrictPartial

Type parameters

_StrictRequired

Type parameters

_UnionToIntersection

Type parameters

AchievementIconFormat

APIAnnouncementThreadChannel

APIApplicationCommandAttachmentOption

APIApplicationCommandAutocompleteDMInteraction

APIApplicationCommandAutocompleteGuildInteraction

APIApplicationCommandAutocompleteInteraction

APIApplicationCommandBasicOption

APIApplicationCommandBooleanOption

APIApplicationCommandDMInteraction

APIApplicationCommandGuildInteraction

APIApplicationCommandIntegerOption

APIApplicationCommandInteraction

APIApplicationCommandInteractionData

APIApplicationCommandInteractionDataAttachmentOption

APIApplicationCommandInteractionDataBasicOption

Type parameters

APIApplicationCommandInteractionDataBooleanOption

APIApplicationCommandInteractionDataChannelOption

APIApplicationCommandInteractionDataMentionableOption

APIApplicationCommandInteractionDataOption

Type parameters

APIApplicationCommandInteractionDataRoleOption

APIApplicationCommandInteractionDataUserOption

APIApplicationCommandInteractionWrapper

Type parameters

APIApplicationCommandMentionableOption

APIApplicationCommandNumberOption

APIApplicationCommandOption

APIApplicationCommandOptionWithAutocompleteOrChoicesWrapper

Type parameters

APIApplicationCommandRoleOption

APIApplicationCommandStringOption

APIApplicationCommandUserOption

APIApplicationEmoji

APIApplicationIntegrationTypesConfigMap

APIAuditLogChange

APIAuditLogChangeKey$Add

APIAuditLogChangeKey$Remove

APIAuditLogChangeKeyActions

APIAuditLogChangeKeyAFKChannelId

APIAuditLogChangeKeyAFKTimeout

APIAuditLogChangeKeyAllow

APIAuditLogChangeKeyApplicationId