Skip to main content
Version: Next

discord-api-types/v10

Index

References

Namespaces

Enumerations

Interfaces

Type Aliases

Variables

References

FormattingPatterns

Snowflake

Re-exports Snowflake

Type Aliases

AchievementIconFormat

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

APIActionRowComponentTypes

APIApplicationCommandAttachmentOption

APIApplicationCommandAttachmentOption: APIApplicationCommandOptionBase<ApplicationCommandOptionType.Attachment>

APIApplicationCommandAutocompleteDMInteraction

APIApplicationCommandAutocompleteDMInteraction: APIDMInteractionWrapper<APIApplicationCommandAutocompleteInteraction>

APIApplicationCommandAutocompleteGuildInteraction

APIApplicationCommandAutocompleteGuildInteraction: APIGuildInteractionWrapper<APIApplicationCommandAutocompleteInteraction>

APIApplicationCommandAutocompleteInteraction

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

APIApplicationCommandBasicOption

APIApplicationCommandBooleanOption

APIApplicationCommandBooleanOption: APIApplicationCommandOptionBase<ApplicationCommandOptionType.Boolean>

APIApplicationCommandDMInteraction

APIApplicationCommandGuildInteraction

APIApplicationCommandIntegerOption

APIApplicationCommandIntegerOption: APIApplicationCommandOptionWithAutocompleteOrChoicesWrapper<APIApplicationCommandIntegerOptionBase, APIApplicationCommandOptionChoice<number>>

APIApplicationCommandInteraction

APIApplicationCommandInteractionData

APIApplicationCommandInteractionDataAttachmentOption

APIApplicationCommandInteractionDataAttachmentOption: APIInteractionDataOptionBase<ApplicationCommandOptionType.Attachment, Snowflake>

APIApplicationCommandInteractionDataBasicOption

APIApplicationCommandInteractionDataBooleanOption

APIApplicationCommandInteractionDataBooleanOption: APIInteractionDataOptionBase<ApplicationCommandOptionType.Boolean, boolean>

APIApplicationCommandInteractionDataChannelOption

APIApplicationCommandInteractionDataChannelOption: APIInteractionDataOptionBase<ApplicationCommandOptionType.Channel, Snowflake>

APIApplicationCommandInteractionDataMentionableOption

APIApplicationCommandInteractionDataMentionableOption: APIInteractionDataOptionBase<ApplicationCommandOptionType.Mentionable, Snowflake>

APIApplicationCommandInteractionDataOption

APIApplicationCommandInteractionDataRoleOption

APIApplicationCommandInteractionDataRoleOption: APIInteractionDataOptionBase<ApplicationCommandOptionType.Role, Snowflake>

APIApplicationCommandInteractionDataUserOption

APIApplicationCommandInteractionDataUserOption: APIInteractionDataOptionBase<ApplicationCommandOptionType.User, Snowflake>

APIApplicationCommandInteractionWrapper

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

APIApplicationCommandMentionableOption

APIApplicationCommandMentionableOption: APIApplicationCommandOptionBase<ApplicationCommandOptionType.Mentionable>

APIApplicationCommandNumberOption

APIApplicationCommandNumberOption: APIApplicationCommandOptionWithAutocompleteOrChoicesWrapper<APIApplicationCommandNumberOptionBase, APIApplicationCommandOptionChoice<number>>

APIApplicationCommandOption

APIApplicationCommandOptionWithAutocompleteOrChoicesWrapper

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

APIApplicationCommandRoleOption

APIApplicationCommandRoleOption: APIApplicationCommandOptionBase<ApplicationCommandOptionType.Role>

APIApplicationCommandStringOption

APIApplicationCommandStringOption: APIApplicationCommandOptionWithAutocompleteOrChoicesWrapper<APIApplicationCommandStringOptionBase, APIApplicationCommandOptionChoice<string>>

APIApplicationCommandUserOption

APIApplicationCommandUserOption: APIApplicationCommandOptionBase<ApplicationCommandOptionType.User>

APIApplicationIntegrationTypesConfigMap

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

APIAuditLogChange

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

APIAuditLogChangeKey$Add

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

Returned when new role(s) are added

APIAuditLogChangeKey$Remove

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

Returned when role(s) are removed

APIAuditLogChangeKeyActions

APIAuditLogChangeKeyActions: AuditLogChangeData<actions, APIAutoModerationAction[]>

Returned when an auto moderation rule's actions is changed

APIAuditLogChangeKeyAFKChannelId

APIAuditLogChangeKeyAFKChannelId: AuditLogChangeData<afk_channel_id, Snowflake>

Returned when a guild's afk_channel_id is changed

APIAuditLogChangeKeyAFKTimeout

APIAuditLogChangeKeyAFKTimeout: AuditLogChangeData<afk_timeout, number>

Returned when a guild's afk_timeout is changed

APIAuditLogChangeKeyAllow

APIAuditLogChangeKeyAllow: AuditLogChangeData<allow, string>

Returned when an overwrite's allowed permissions bitfield is changed

APIAuditLogChangeKeyApplicationId

APIAuditLogChangeKeyApplicationId: AuditLogChangeData<application_id, Snowflake>

The application ID of the added or removed Webhook or Bot

APIAuditLogChangeKeyArchived

APIAuditLogChangeKeyArchived: AuditLogChangeData<archived, boolean>

Returned when a thread's archive status is changed

APIAuditLogChangeKeyAsset

APIAuditLogChangeKeyAsset: AuditLogChangeData<asset, >

Empty string

APIAuditLogChangeKeyAutoArchiveDuration

APIAuditLogChangeKeyAutoArchiveDuration: AuditLogChangeData<auto_archive_duration, number>

Returned when a thread's auto archive duration is changed

APIAuditLogChangeKeyAvailable

APIAuditLogChangeKeyAvailable: AuditLogChangeData<available, boolean>

Returned when a sticker's availability is changed

APIAuditLogChangeKeyAvailableTags

APIAuditLogChangeKeyAvailableTags: AuditLogChangeData<available_tags, APIGuildForumTag[]>

Returned when a guild forum's available tags gets changed

APIAuditLogChangeKeyAvatarHash

APIAuditLogChangeKeyAvatarHash: AuditLogChangeData<avatar_hash, string>

Returned when a user's avatar_hash is changed

APIAuditLogChangeKeyBannerHash

APIAuditLogChangeKeyBannerHash: AuditLogChangeData<banner_hash, string>

Returned when a guild's banner hash is changed

APIAuditLogChangeKeyBitrate

APIAuditLogChangeKeyBitrate: AuditLogChangeData<bitrate, number>

Returned when a voice channel's bitrate is changed

APIAuditLogChangeKeyChannelId

APIAuditLogChangeKeyChannelId: AuditLogChangeData<channel_id, Snowflake>

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

APIAuditLogChangeKeyCode

APIAuditLogChangeKeyCode: AuditLogChangeData<code, string>

Returned when an invite's code is changed

APIAuditLogChangeKeyColor

APIAuditLogChangeKeyColor: AuditLogChangeData<color, number>

Returned when a role's color is changed

APIAuditLogChangeKeyCommunicationDisabledUntil

APIAuditLogChangeKeyCommunicationDisabledUntil: AuditLogChangeData<communication_disabled_until, string>

Returned when a user's timeout is changed

APIAuditLogChangeKeyDeaf

APIAuditLogChangeKeyDeaf: AuditLogChangeData<deaf, boolean>

Returned when a user's deaf status is changed

APIAuditLogChangeKeyDefaultAutoArchiveDuration

APIAuditLogChangeKeyDefaultAutoArchiveDuration: AuditLogChangeData<default_auto_archive_duration, number>

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

APIAuditLogChangeKeyDefaultMessageNotifications

APIAuditLogChangeKeyDefaultMessageNotifications: AuditLogChangeData<default_message_notifications, GuildDefaultMessageNotifications>

Returned when a guild's default_message_notifications is changed

APIAuditLogChangeKeyDefaultReactionEmoji

APIAuditLogChangeKeyDefaultReactionEmoji: AuditLogChangeData<default_reaction_emoji, APIGuildForumDefaultReactionEmoji>

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

APIAuditLogChangeKeyDefaultThreadRateLimitPerUser

APIAuditLogChangeKeyDefaultThreadRateLimitPerUser: AuditLogChangeData<default_thread_rate_limit_per_user, number>

Returned when a thread's amount of seconds a user has to wait before creating another thread gets changed

APIAuditLogChangeKeyDeny

APIAuditLogChangeKeyDeny: AuditLogChangeData<deny, string>

Returned when an overwrite's denied permissions bitfield is changed

APIAuditLogChangeKeyDescription

APIAuditLogChangeKeyDescription: AuditLogChangeData<description, string>

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

APIAuditLogChangeKeyDiscoverySplashHash

APIAuditLogChangeKeyDiscoverySplashHash: AuditLogChangeData<discovery_splash_hash, string>

Returned when a guild's discovery splash is changed

APIAuditLogChangeKeyEmojiId

APIAuditLogChangeKeyEmojiId: AuditLogChangeData<emoji_id, Snowflake>

Returned when a soundboard's custom emoji is changed

APIAuditLogChangeKeyEmojiName

APIAuditLogChangeKeyEmojiName: AuditLogChangeData<emoji_name, string>

Returned when a soundboard's unicode emoji is changed

APIAuditLogChangeKeyEnabled

APIAuditLogChangeKeyEnabled: AuditLogChangeData<enabled, boolean>

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

APIAuditLogChangeKeyEnableEmoticons

APIAuditLogChangeKeyEnableEmoticons: AuditLogChangeData<enable_emoticons, boolean>

Returned when an integration's enable_emoticons is changed

APIAuditLogChangeKeyEntityType

APIAuditLogChangeKeyEntityType: AuditLogChangeData<entity_type, GuildScheduledEventEntityType>

Returned when entity type of a guild scheduled event is changed

APIAuditLogChangeKeyEventType

APIAuditLogChangeKeyEventType: AuditLogChangeData<event_type, AutoModerationRuleEventType>

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

APIAuditLogChangeKeyExemptChannels

APIAuditLogChangeKeyExemptChannels: AuditLogChangeData<exempt_channels, Snowflake[]>

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

APIAuditLogChangeKeyExemptRoles

APIAuditLogChangeKeyExemptRoles: AuditLogChangeData<exempt_roles, Snowflake[]>

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

APIAuditLogChangeKeyExpireBehavior

APIAuditLogChangeKeyExpireBehavior: AuditLogChangeData<expire_behavior, IntegrationExpireBehavior>

Returned when an integration's expire_behavior is changed

APIAuditLogChangeKeyExpireGracePeriod

APIAuditLogChangeKeyExpireGracePeriod: AuditLogChangeData<expire_grace_period, number>

Returned when an integration's expire_grace_period is changed

APIAuditLogChangeKeyExplicitContentFilter

APIAuditLogChangeKeyExplicitContentFilter: AuditLogChangeData<explicit_content_filter, GuildExplicitContentFilter>

Returned when a guild's explicit_content_filter is changed

APIAuditLogChangeKeyFlags

APIAuditLogChangeKeyFlags: AuditLogChangeData<flags, number>

Returned when a channel flag gets changed

APIAuditLogChangeKeyFormatType

APIAuditLogChangeKeyFormatType: AuditLogChangeData<format_type, StickerFormatType>

Returned when a sticker's format_type is changed

APIAuditLogChangeKeyGuildId

APIAuditLogChangeKeyGuildId: AuditLogChangeData<guild_id, Snowflake>

Returned when a sticker's guild_id is changed

APIAuditLogChangeKeyHoist

APIAuditLogChangeKeyHoist: AuditLogChangeData<hoist, boolean>

Returned when a role's hoist status is changed

APIAuditLogChangeKeyIconHash

APIAuditLogChangeKeyIconHash: AuditLogChangeData<icon_hash, string>

Returned when a guild's icon is changed

APIAuditLogChangeKeyId

APIAuditLogChangeKeyId: AuditLogChangeData<id, Snowflake>

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

APIAuditLogChangeKeyImageHash

APIAuditLogChangeKeyImageHash: AuditLogChangeData<image_hash, string>

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

APIAuditLogChangeKeyInviterId

APIAuditLogChangeKeyInviterId: AuditLogChangeData<inviter_id, Snowflake>

Returned when an invite's inviter_id is changed

APIAuditLogChangeKeyLocation

APIAuditLogChangeKeyLocation: AuditLogChangeData<location, string>

Returned when location of a guild scheduled event is changed

APIAuditLogChangeKeyLocked

APIAuditLogChangeKeyLocked: AuditLogChangeData<locked, boolean>

Returned when a thread's lock status is changed

APIAuditLogChangeKeyMaxAge

APIAuditLogChangeKeyMaxAge: AuditLogChangeData<max_age, number>

Returned when an invite's max_age is changed

APIAuditLogChangeKeyMaxUses

APIAuditLogChangeKeyMaxUses: AuditLogChangeData<max_uses, number>

Returned when an invite's max_uses is changed

APIAuditLogChangeKeyMentionable

APIAuditLogChangeKeyMentionable: AuditLogChangeData<mentionable, boolean>

Returned when a role's mentionable status is changed

APIAuditLogChangeKeyMFALevel

APIAuditLogChangeKeyMFALevel: AuditLogChangeData<mfa_level, GuildMFALevel>

Returned when a guild's mfa_level is changed

APIAuditLogChangeKeyMute

APIAuditLogChangeKeyMute: AuditLogChangeData<mute, boolean>

Returned when a user's mute status is changed

APIAuditLogChangeKeyName

APIAuditLogChangeKeyName: AuditLogChangeData<name, string>

Returned when an entity's name is changed

APIAuditLogChangeKeyNick

APIAuditLogChangeKeyNick: AuditLogChangeData<nick, string>

Returned when a user's nick is changed

APIAuditLogChangeKeyNSFW

APIAuditLogChangeKeyNSFW: AuditLogChangeData<nsfw, boolean>

Returned when a channel's NSFW restriction is changed

APIAuditLogChangeKeyOwnerId

APIAuditLogChangeKeyOwnerId: AuditLogChangeData<owner_id, Snowflake>

Returned when a guild's owner_id is changed

APIAuditLogChangeKeyPermissionOverwrites

APIAuditLogChangeKeyPermissionOverwrites: AuditLogChangeData<permission_overwrites, APIOverwrite[]>

Returned when a channel's permission overwrites is changed

APIAuditLogChangeKeyPermissions

APIAuditLogChangeKeyPermissions: AuditLogChangeData<permissions, string>

Returned when a permission bitfield is changed

APIAuditLogChangeKeyPosition

APIAuditLogChangeKeyPosition: AuditLogChangeData<position, number>

Returned when a channel's position is changed

APIAuditLogChangeKeyPreferredLocale

APIAuditLogChangeKeyPreferredLocale: AuditLogChangeData<preferred_locale, string>

Returned when a guild's preferred_locale is changed

APIAuditLogChangeKeyPremiumProgressBarEnabled

APIAuditLogChangeKeyPremiumProgressBarEnabled: AuditLogChangeData<premium_progress_bar_enabled, boolean>

Returned when a guild's boost progress bar is enabled

APIAuditLogChangeKeyPrivacyLevel

APIAuditLogChangeKeyPrivacyLevel: AuditLogChangeData<privacy_level, StageInstancePrivacyLevel>

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

APIAuditLogChangeKeyPruneDeleteDays

APIAuditLogChangeKeyPruneDeleteDays: AuditLogChangeData<prune_delete_days, number>

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

APIAuditLogChangeKeyPublicUpdatesChannelId

APIAuditLogChangeKeyPublicUpdatesChannelId: AuditLogChangeData<public_updates_channel_id, string>

Returned when a guild's public_updates_channel_id is changed

APIAuditLogChangeKeyRateLimitPerUser

APIAuditLogChangeKeyRateLimitPerUser: AuditLogChangeData<rate_limit_per_user, number>

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

APIAuditLogChangeKeyRecurrenceRule

APIAuditLogChangeKeyRecurrenceRule: AuditLogChangeData<recurrence_rule, APIGuildScheduledEventRecurrenceRule>

Returned when a guild scheduled event's recurrence_rule is changed

APIAuditLogChangeKeyRegion

APIAuditLogChangeKeyRegion: AuditLogChangeData<region, string>

Returned when a guild's region is changed

APIAuditLogChangeKeyRulesChannelId

APIAuditLogChangeKeyRulesChannelId: AuditLogChangeData<rules_channel_id, string>

Returned when a guild's rules_channel_id is changed

APIAuditLogChangeKeySafetyAlertsChannelId

APIAuditLogChangeKeySafetyAlertsChannelId: AuditLogChangeData<safety_alerts_channel_id, string>

Returned when a guild's safety_alerts_channel_id is changed

APIAuditLogChangeKeySnowflake

APIAuditLogChangeKeySnowflake: AuditLogChangeData<Snowflake, unknown>

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

<insert name of object here>
)

APIAuditLogChangeKeySoundId

APIAuditLogChangeKeySoundId: AuditLogChangeData<sound_id, Snowflake>

Returned when a soundboard is create or deleted

APIAuditLogChangeKeySplashHash

APIAuditLogChangeKeySplashHash: AuditLogChangeData<splash_hash, string>

Returned when a guild's splash is changed

APIAuditLogChangeKeyStatus

APIAuditLogChangeKeyStatus: AuditLogChangeData<status, GuildScheduledEventStatus>

Returned when status of a guild scheduled event is changed

APIAuditLogChangeKeySystemChannelFlags

APIAuditLogChangeKeySystemChannelFlags: AuditLogChangeData<system_channel_flags, GuildSystemChannelFlags>

Returned when a guild's system_channel_flags is changed

APIAuditLogChangeKeySystemChannelId

APIAuditLogChangeKeySystemChannelId: AuditLogChangeData<system_channel_id, Snowflake>

Returned when a guild's system_channel_id is changed

APIAuditLogChangeKeyTags

APIAuditLogChangeKeyTags: AuditLogChangeData<tags, string>

Returned when a sticker's related emoji is changed

APIAuditLogChangeKeyTemporary

APIAuditLogChangeKeyTemporary: AuditLogChangeData<temporary, boolean>

Returned when an invite's temporary status is changed

APIAuditLogChangeKeyTopic

APIAuditLogChangeKeyTopic: AuditLogChangeData<topic, string>

Returned when a channel's topic is changed

APIAuditLogChangeKeyTriggerMetadata

APIAuditLogChangeKeyTriggerMetadata: AuditLogChangeData<trigger_metadata, APIAutoModerationRuleTriggerMetadata>

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

APIAuditLogChangeKeyTriggerType

APIAuditLogChangeKeyTriggerType: AuditLogChangeData<trigger_type, AutoModerationRuleTriggerType>

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

APIAuditLogChangeKeyType

APIAuditLogChangeKeyType: AuditLogChangeData<type, number | string>

The type of entity created

APIAuditLogChangeKeyUserId

APIAuditLogChangeKeyUserId: AuditLogChangeData<user_id, Snowflake>

Returned when a sounboard is created

APIAuditLogChangeKeyUserLimit

APIAuditLogChangeKeyUserLimit: AuditLogChangeData<user_limit, number>

Returned when a voice channel's user_limit is changed

APIAuditLogChangeKeyUses

APIAuditLogChangeKeyUses: AuditLogChangeData<uses, number>

Returned when an invite's uses is changed

APIAuditLogChangeKeyVanityURLCode

APIAuditLogChangeKeyVanityURLCode: AuditLogChangeData<vanity_url_code, string>

Returned when a guild's vanity_url_code is changed

APIAuditLogChangeKeyVerificationLevel

APIAuditLogChangeKeyVerificationLevel: AuditLogChangeData<verification_level, GuildVerificationLevel>

Returned when a guild's verification_level is changed

APIAuditLogChangeKeyVolume

APIAuditLogChangeKeyVolume: AuditLogChangeData<volume, number>

Returned when a soundboard's volume is changed

APIAuditLogChangeKeyWidgetChannelId

APIAuditLogChangeKeyWidgetChannelId: AuditLogChangeData<widget_channel_id, Snowflake>

Returned when a guild's widget_channel_id is changed

APIAuditLogChangeKeyWidgetEnabled

APIAuditLogChangeKeyWidgetEnabled: AuditLogChangeData<widget_enabled, boolean>

Returned when a guild's widget is enabled

APIAuthorizingIntegrationOwnersMap

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

APIAutoPopulatedSelectMenuComponent

APIButtonComponent

APIChannel

APIChannelPatchOverwrite

APIChannelPatchOverwrite: RESTAPIChannelPatchOverwrite
@deprecated

APIChatInputApplicationCommandDMInteraction

APIChatInputApplicationCommandDMInteraction: APIDMInteractionWrapper<APIChatInputApplicationCommandInteraction>

APIChatInputApplicationCommandGuildInteraction

APIChatInputApplicationCommandGuildInteraction: APIGuildInteractionWrapper<APIChatInputApplicationCommandInteraction>

APIChatInputApplicationCommandInteraction

APIChatInputApplicationCommandInteractionDataResolved

APIChatInputApplicationCommandInteractionDataResolved: APIInteractionDataResolved
@deprecated

Renamed to APIInteractionDataResolved

APIContextMenuDMInteraction

APIContextMenuGuildInteraction

APIContextMenuInteraction

APIContextMenuInteractionData

APIDMInteraction

APIDMInteractionWrapper

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

Type parameters

APIGuildCategoryChannel

APIGuildCategoryChannel: APIGuildChannel<ChannelType.GuildCategory>

APIGuildChannelResolvable

APIGuildChannelResolvable: RESTAPIGuildChannelResolvable
@deprecated

APIGuildCreateOverwrite

APIGuildCreateOverwrite: RESTAPIGuildCreateOverwrite
@deprecated

APIGuildCreatePartialChannel

APIGuildCreatePartialChannel: RESTAPIGuildCreatePartialChannel
@deprecated

APIGuildCreateRole

APIGuildCreateRole: RESTAPIGuildCreateRole
@deprecated

APIGuildIntegrationType

APIGuildIntegrationType: discord | guild_subscription | twitch | youtube

APIGuildInteraction

APIGuildInteractionWrapper

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

Type parameters

APIGuildMediaChannel

APIGuildMediaChannel: APIThreadOnlyChannel<ChannelType.GuildMedia>

APIGuildScheduledEvent

APIGuildStageVoiceChannel

APIGuildStageVoiceChannel: APIVoiceChannelBase<ChannelType.GuildStageVoice>

APIGuildVoiceChannel

APIGuildVoiceChannel: APIVoiceChannelBase<ChannelType.GuildVoice>

APIInteraction

APIInteractionDataResolvedChannel

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

APIInteractionResponse

APIInteractionResponseCallbackData

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

APIInviteGuild

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

APIMentionableSelectComponent

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

APIMessageActionRowComponent

APIMessageActionRowComponent: APIButtonComponent | APISelectMenuComponent

APIMessageApplicationCommandDMInteraction

APIMessageApplicationCommandDMInteraction: APIDMInteractionWrapper<APIMessageApplicationCommandInteraction>

APIMessageApplicationCommandGuildInteraction

APIMessageApplicationCommandGuildInteraction: APIGuildInteractionWrapper<APIMessageApplicationCommandInteraction>

APIMessageApplicationCommandInteraction

APIMessageButtonInteractionData

APIMessageButtonInteractionData: APIMessageComponentBaseInteractionData<ComponentType.Button>

APIMessageComponent

APIMessageComponentButtonInteraction

APIMessageComponentButtonInteraction: APIBaseInteraction<InteractionType.MessageComponent, APIMessageButtonInteractionData> & Required<Pick<APIBaseInteraction<InteractionType.MessageComponent, APIMessageButtonInteractionData>, 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

APIMessageComponentSelectMenuInteraction

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

APIMessageInteractionMetadata

APIMessageReferenceSend

APIMessageReferenceSend: RESTAPIMessageReference
@deprecated

APIMessageSelectMenuInteractionData

APIMessageSnapshotFields

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

APIModalActionRowComponent

APIModalActionRowComponent: APITextInputComponent

APIModalComponent

APIModalSubmitDMInteraction

APIModalSubmitGuildInteraction

APIModalSubmitGuildInteraction: APIGuildInteractionWrapper<APIModalSubmitInteraction>

APIModalSubmitInteraction

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

APINewsChannel

APINewsChannel: APIGuildTextChannel<ChannelType.GuildAnnouncement>

APIPingInteraction

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

APIPrimaryEntryPointCommandDMInteraction

APIPrimaryEntryPointCommandDMInteraction: APIDMInteractionWrapper<APIPrimaryEntryPointCommandInteraction>

APIPrimaryEntryPointCommandGuildInteraction

APIPrimaryEntryPointCommandGuildInteraction: APIGuildInteractionWrapper<APIPrimaryEntryPointCommandInteraction>

APIPrimaryEntryPointCommandInteraction

APIPrimaryEntryPointCommandInteractionData

APIPrimaryEntryPointCommandInteractionData: APIBaseApplicationCommandInteractionData<ApplicationCommandType.PrimaryEntryPoint>

APIRoleSelectComponent

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

APISelectMenuComponent

APIStickerItem

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

APITextChannel

APITextChannel: APIGuildTextChannel<ChannelType.GuildText>

APIUserApplicationCommandDMInteraction

APIUserApplicationCommandDMInteraction: APIDMInteractionWrapper<APIUserApplicationCommandInteraction>

APIUserApplicationCommandGuildInteraction

APIUserApplicationCommandGuildInteraction: APIGuildInteractionWrapper<APIUserApplicationCommandInteraction>

APIUserApplicationCommandInteraction

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>

APIWebhookEvent

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

APIWebhookEventBody

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

APIWebhookEventEntitlementCreateData

APIWebhookEventEntitlementCreateData: APIEntitlement

APIWebhookEventQuestUserEnrollmentData

APIWebhookEventQuestUserEnrollmentData: never

ApplicationAssetFormat

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

ApplicationCoverFormat

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

ApplicationIconFormat

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

AuditLogRuleTriggerType

AuditLogRuleTriggerType: `${AutoModerationRuleTriggerType}`

DefaultUserAvatar

DefaultUserAvatar: Extract<ImageFormat, ImageFormat.PNG>

DefaultUserAvatarAssets

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

EmojiFormat

EmojiFormat: Exclude<ImageFormat, ImageFormat.Lottie>

GatewayActivityAssets

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

GatewayActivityEmoji

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

GatewayActivitySecrets

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

GatewayActivityUpdateData

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

GatewayApplicationCommandPermissionsUpdateDispatch

GatewayApplicationCommandPermissionsUpdateDispatch: DataPayload<GatewayDispatchEvents.ApplicationCommandPermissionsUpdate, GatewayApplicationCommandPermissionsUpdateDispatchData>

GatewayAutoModerationActionExecutionDispatch

GatewayAutoModerationActionExecutionDispatch: DataPayload<GatewayDispatchEvents.AutoModerationActionExecution, GatewayAutoModerationActionExecutionDispatchData>

GatewayAutoModerationRuleCreateDispatch

GatewayAutoModerationRuleCreateDispatch: GatewayAutoModerationRuleModifyDispatch

GatewayAutoModerationRuleCreateDispatchData

GatewayAutoModerationRuleCreateDispatchData: GatewayAutoModerationRuleModifyDispatchData

GatewayAutoModerationRuleDeleteDispatch

GatewayAutoModerationRuleDeleteDispatch: GatewayAutoModerationRuleModifyDispatch

GatewayAutoModerationRuleDeleteDispatchData

GatewayAutoModerationRuleDeleteDispatchData: GatewayAutoModerationRuleModifyDispatchData

GatewayAutoModerationRuleModifyDispatch

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

GatewayAutoModerationRuleModifyDispatchData

GatewayAutoModerationRuleModifyDispatchData: APIAutoModerationRule

GatewayAutoModerationRuleUpdateDispatch

GatewayAutoModerationRuleUpdateDispatch: GatewayAutoModerationRuleModifyDispatch

GatewayAutoModerationRuleUpdateDispatchData

GatewayAutoModerationRuleUpdateDispatchData: GatewayAutoModerationRuleModifyDispatchData

GatewayChannelCreateDispatch

GatewayChannelCreateDispatch: GatewayChannelModifyDispatch

GatewayChannelCreateDispatchData

GatewayChannelCreateDispatchData: GatewayChannelModifyDispatchData

GatewayChannelDeleteDispatch

GatewayChannelDeleteDispatch: GatewayChannelModifyDispatch

GatewayChannelDeleteDispatchData

GatewayChannelDeleteDispatchData: GatewayChannelModifyDispatchData

GatewayChannelModifyDispatch

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

GatewayChannelModifyDispatchData

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

GatewayChannelPinsUpdateDispatch

GatewayChannelPinsUpdateDispatch: DataPayload<GatewayDispatchEvents.ChannelPinsUpdate, GatewayChannelPinsUpdateDispatchData>

GatewayChannelUpdateDispatch

GatewayChannelUpdateDispatch: GatewayChannelModifyDispatch

GatewayChannelUpdateDispatchData

GatewayChannelUpdateDispatchData: GatewayChannelModifyDispatchData

GatewayDispatchPayload

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

GatewayEntitlementCreateDispatch

GatewayEntitlementCreateDispatch: GatewayEntitlementModifyDispatch

GatewayEntitlementCreateDispatchData

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

GatewayEntitlementDeleteDispatch

GatewayEntitlementDeleteDispatch: GatewayEntitlementModifyDispatch

GatewayEntitlementDeleteDispatchData

GatewayEntitlementDeleteDispatchData: GatewayEntitlementModifyDispatchData

GatewayEntitlementModifyDispatch

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

GatewayEntitlementModifyDispatchData

GatewayEntitlementModifyDispatchData: APIEntitlement

GatewayEntitlementUpdateDispatch

GatewayEntitlementUpdateDispatch: GatewayEntitlementModifyDispatch

GatewayEntitlementUpdateDispatchData

GatewayEntitlementUpdateDispatchData: GatewayEntitlementModifyDispatchData

GatewayGuildAuditLogEntryCreateDispatch

GatewayGuildAuditLogEntryCreateDispatch: DataPayload<GatewayDispatchEvents.GuildAuditLogEntryCreate, GatewayGuildAuditLogEntryCreateDispatchData>

GatewayGuildBanAddDispatch

GatewayGuildBanAddDispatch: GatewayGuildBanModifyDispatch

GatewayGuildBanAddDispatchData

GatewayGuildBanAddDispatchData: GatewayGuildBanModifyDispatchData

GatewayGuildBanModifyDispatch

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

GatewayGuildBanRemoveDispatch

GatewayGuildBanRemoveDispatch: GatewayGuildBanModifyDispatch

GatewayGuildBanRemoveDispatchData

GatewayGuildBanRemoveDispatchData: GatewayGuildBanModifyDispatchData

GatewayGuildCreateDispatch

GatewayGuildCreateDispatch: DataPayload<GatewayDispatchEvents.GuildCreate, GatewayGuildCreateDispatchData>

GatewayGuildDeleteDispatch

GatewayGuildDeleteDispatch: DataPayload<GatewayDispatchEvents.GuildDelete, GatewayGuildDeleteDispatchData>

GatewayGuildEmojisUpdateDispatch

GatewayGuildEmojisUpdateDispatch: DataPayload<GatewayDispatchEvents.GuildEmojisUpdate, GatewayGuildEmojisUpdateDispatchData>

GatewayGuildIntegrationsUpdateDispatch

GatewayGuildIntegrationsUpdateDispatch: DataPayload<GatewayDispatchEvents.GuildIntegrationsUpdate, GatewayGuildIntegrationsUpdateDispatchData>

GatewayGuildMemberAddDispatch

GatewayGuildMemberAddDispatch: DataPayload<GatewayDispatchEvents.GuildMemberAdd, GatewayGuildMemberAddDispatchData>

GatewayGuildMemberRemoveDispatch

GatewayGuildMemberRemoveDispatch: DataPayload<GatewayDispatchEvents.GuildMemberRemove, GatewayGuildMemberRemoveDispatchData>

GatewayGuildMembersChunkDispatch

GatewayGuildMembersChunkDispatch: DataPayload<GatewayDispatchEvents.GuildMembersChunk, GatewayGuildMembersChunkDispatchData>

GatewayGuildMembersChunkPresence

GatewayGuildMembersChunkPresence: Omit<RawGatewayPresenceUpdate, guild_id>

GatewayGuildMemberUpdateDispatch

GatewayGuildMemberUpdateDispatch: DataPayload<GatewayDispatchEvents.GuildMemberUpdate, GatewayGuildMemberUpdateDispatchData>

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 }

GatewayGuildModifyDispatch

GatewayGuildModifyDispatch: DataPayload<GatewayDispatchEvents.GuildUpdate, GatewayGuildModifyDispatchData>

GatewayGuildModifyDispatchData

GatewayGuildModifyDispatchData: APIGuild

GatewayGuildRoleCreateDispatch

GatewayGuildRoleCreateDispatch: GatewayGuildRoleModifyDispatch

GatewayGuildRoleCreateDispatchData

GatewayGuildRoleCreateDispatchData: GatewayGuildRoleModifyDispatchData

GatewayGuildRoleDeleteDispatch

GatewayGuildRoleDeleteDispatch: DataPayload<GatewayDispatchEvents.GuildRoleDelete, GatewayGuildRoleDeleteDispatchData>

GatewayGuildRoleModifyDispatch

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

GatewayGuildRoleUpdateDispatch

GatewayGuildRoleUpdateDispatch: GatewayGuildRoleModifyDispatch

GatewayGuildRoleUpdateDispatchData

GatewayGuildRoleUpdateDispatchData: GatewayGuildRoleModifyDispatchData

GatewayGuildScheduledEventCreateDispatch

GatewayGuildScheduledEventCreateDispatch: DataPayload<GatewayDispatchEvents.GuildScheduledEventCreate, GatewayGuildScheduledEventCreateDispatchData>

GatewayGuildScheduledEventCreateDispatchData

GatewayGuildScheduledEventCreateDispatchData: APIGuildScheduledEvent

GatewayGuildScheduledEventDeleteDispatch

GatewayGuildScheduledEventDeleteDispatch: DataPayload<GatewayDispatchEvents.GuildScheduledEventDelete, GatewayGuildScheduledEventDeleteDispatchData>

GatewayGuildScheduledEventDeleteDispatchData

GatewayGuildScheduledEventDeleteDispatchData: APIGuildScheduledEvent

GatewayGuildScheduledEventUpdateDispatch

GatewayGuildScheduledEventUpdateDispatch: DataPayload<GatewayDispatchEvents.GuildScheduledEventUpdate, GatewayGuildScheduledEventUpdateDispatchData>

GatewayGuildScheduledEventUpdateDispatchData

GatewayGuildScheduledEventUpdateDispatchData: APIGuildScheduledEvent

GatewayGuildScheduledEventUserAddDispatch

GatewayGuildScheduledEventUserAddDispatch: DataPayload<GatewayDispatchEvents.GuildScheduledEventUserAdd, GatewayGuildScheduledEventUserAddDispatchData>

GatewayGuildScheduledEventUserRemoveDispatch

GatewayGuildScheduledEventUserRemoveDispatch: DataPayload<GatewayDispatchEvents.GuildScheduledEventUserRemove, GatewayGuildScheduledEventUserAddDispatchData>

GatewayGuildSoundboardSoundCreateDispatch

GatewayGuildSoundboardSoundCreateDispatch: DataPayload<GatewayDispatchEvents.GuildSoundboardSoundCreate, GatewayGuildSoundboardSoundCreateDispatchData>

GatewayGuildSoundboardSoundCreateDispatchData

GatewayGuildSoundboardSoundCreateDispatchData: APISoundboardSound

GatewayGuildSoundboardSoundDeleteDispatch

GatewayGuildSoundboardSoundDeleteDispatch: DataPayload<GatewayDispatchEvents.GuildSoundboardSoundDelete, GatewayGuildSoundboardSoundDeleteDispatchData>

GatewayGuildSoundboardSoundsUpdateDispatch

GatewayGuildSoundboardSoundsUpdateDispatch: DataPayload<GatewayDispatchEvents.GuildSoundboardSoundsUpdate, GatewayGuildSoundboardSoundsUpdateDispatchData>

GatewayGuildSoundboardSoundUpdateDispatch

GatewayGuildSoundboardSoundUpdateDispatch: DataPayload<GatewayDispatchEvents.GuildSoundboardSoundUpdate, GatewayGuildSoundboardSoundUpdateDispatchData>

GatewayGuildSoundboardSoundUpdateDispatchData

GatewayGuildSoundboardSoundUpdateDispatchData: APISoundboardSound

GatewayGuildStickersUpdateDispatch

GatewayGuildStickersUpdateDispatch: DataPayload<GatewayDispatchEvents.GuildStickersUpdate, GatewayGuildStickersUpdateDispatchData>

GatewayGuildUpdateDispatch

GatewayGuildUpdateDispatch: GatewayGuildModifyDispatch

GatewayGuildUpdateDispatchData

GatewayGuildUpdateDispatchData: GatewayGuildModifyDispatchData

GatewayHeartbeatData

GatewayHeartbeatData: number | null

GatewayIntegrationCreateDispatch

GatewayIntegrationCreateDispatch: DataPayload<GatewayDispatchEvents.IntegrationCreate, GatewayIntegrationCreateDispatchData>

GatewayIntegrationCreateDispatchData

GatewayIntegrationCreateDispatchData: APIGuildIntegration & { guild_id: Snowflake }

GatewayIntegrationDeleteDispatch

GatewayIntegrationDeleteDispatch: DataPayload<GatewayDispatchEvents.IntegrationDelete, GatewayIntegrationDeleteDispatchData>

GatewayIntegrationUpdateDispatch

GatewayIntegrationUpdateDispatch: DataPayload<GatewayDispatchEvents.IntegrationUpdate, GatewayIntegrationUpdateDispatchData>

GatewayIntegrationUpdateDispatchData

GatewayIntegrationUpdateDispatchData: APIGuildIntegration & { guild_id: Snowflake }

GatewayInteractionCreateDispatch

GatewayInteractionCreateDispatch: DataPayload<GatewayDispatchEvents.InteractionCreate, GatewayInteractionCreateDispatchData>

GatewayInteractionCreateDispatchData

GatewayInteractionCreateDispatchData: APIInteraction

GatewayInvalidSessionData

GatewayInvalidSessionData: boolean

GatewayInviteCreateDispatch

GatewayInviteCreateDispatch: DataPayload<GatewayDispatchEvents.InviteCreate, GatewayInviteCreateDispatchData>

GatewayInviteDeleteDispatch

GatewayInviteDeleteDispatch: DataPayload<GatewayDispatchEvents.InviteDelete, GatewayInviteDeleteDispatchData>

GatewayMessageCreateDispatch

GatewayMessageCreateDispatch: DataPayload<GatewayDispatchEvents.MessageCreate, GatewayMessageCreateDispatchData>

GatewayMessageCreateDispatchData

GatewayMessageCreateDispatchData: GatewayMessageEventExtraFields & Omit<APIMessage, mentions>

GatewayMessageDeleteBulkDispatch

GatewayMessageDeleteBulkDispatch: DataPayload<GatewayDispatchEvents.MessageDeleteBulk, GatewayMessageDeleteBulkDispatchData>

GatewayMessageDeleteDispatch

GatewayMessageDeleteDispatch: DataPayload<GatewayDispatchEvents.MessageDelete, GatewayMessageDeleteDispatchData>

GatewayMessagePollVoteAddDispatch

GatewayMessagePollVoteAddDispatch: DataPayload<GatewayDispatchEvents.MessagePollVoteAdd, GatewayMessagePollVoteDispatchData>

GatewayMessagePollVoteRemoveDispatch

GatewayMessagePollVoteRemoveDispatch: DataPayload<GatewayDispatchEvents.MessagePollVoteRemove, GatewayMessagePollVoteDispatchData>

GatewayMessageReactionAddDispatch

GatewayMessageReactionAddDispatch: ReactionData<GatewayDispatchEvents.MessageReactionAdd>

GatewayMessageReactionAddDispatchData

GatewayMessageReactionAddDispatchData: GatewayMessageReactionAddDispatch[d]

GatewayMessageReactionRemoveAllDispatch

GatewayMessageReactionRemoveAllDispatch: DataPayload<GatewayDispatchEvents.MessageReactionRemoveAll, GatewayMessageReactionRemoveAllDispatchData>

GatewayMessageReactionRemoveAllDispatchData

GatewayMessageReactionRemoveAllDispatchData: MessageReactionRemoveData

GatewayMessageReactionRemoveDispatch

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

GatewayMessageReactionRemoveDispatchData

GatewayMessageReactionRemoveDispatchData: GatewayMessageReactionRemoveDispatch[d]

GatewayMessageReactionRemoveEmojiDispatch

GatewayMessageReactionRemoveEmojiDispatch: DataPayload<GatewayDispatchEvents.MessageReactionRemoveEmoji, GatewayMessageReactionRemoveEmojiDispatchData>

GatewayMessageUpdateDispatch

GatewayMessageUpdateDispatch: DataPayload<GatewayDispatchEvents.MessageUpdate, GatewayMessageUpdateDispatchData>

GatewayMessageUpdateDispatchData

GatewayMessageUpdateDispatchData: GatewayMessageEventExtraFields & Omit<APIMessage, mentions>

GatewayPresenceUpdateDispatch

GatewayPresenceUpdateDispatch: DataPayload<GatewayDispatchEvents.PresenceUpdate, GatewayPresenceUpdateDispatchData>

GatewayPresenceUpdateDispatchData

GatewayPresenceUpdateDispatchData: RawGatewayPresenceUpdate

GatewayReadyDispatch

GatewayReadyDispatch: DataPayload<GatewayDispatchEvents.Ready, GatewayReadyDispatchData>

GatewayReceivePayload

GatewayRequestGuildMembersData

GatewayResumedDispatch

GatewayResumedDispatch: DataPayload<GatewayDispatchEvents.Resumed, never>

GatewaySendPayload

GatewaySoundboardSoundsDispatch

GatewaySoundboardSoundsDispatch: DataPayload<GatewayDispatchEvents.SoundboardSounds, GatewaySoundboardSoundsDispatchData>

GatewayStageInstanceCreateDispatch

GatewayStageInstanceCreateDispatch: DataPayload<GatewayDispatchEvents.StageInstanceCreate, GatewayStageInstanceCreateDispatchData>

GatewayStageInstanceCreateDispatchData

GatewayStageInstanceCreateDispatchData: APIStageInstance

GatewayStageInstanceDeleteDispatch

GatewayStageInstanceDeleteDispatch: DataPayload<GatewayDispatchEvents.StageInstanceDelete, GatewayStageInstanceDeleteDispatchData>

GatewayStageInstanceDeleteDispatchData

GatewayStageInstanceDeleteDispatchData: APIStageInstance

GatewayStageInstanceUpdateDispatch

GatewayStageInstanceUpdateDispatch: DataPayload<GatewayDispatchEvents.StageInstanceUpdate, GatewayStageInstanceUpdateDispatchData>

GatewayStageInstanceUpdateDispatchData

GatewayStageInstanceUpdateDispatchData: APIStageInstance

GatewaySubscriptionCreateDispatch

GatewaySubscriptionCreateDispatch: GatewaySubscriptionModifyDispatch

GatewaySubscriptionCreateDispatchData

GatewaySubscriptionCreateDispatchData: GatewaySubscriptionModifyDispatchData

GatewaySubscriptionDeleteDispatch

GatewaySubscriptionDeleteDispatch: GatewaySubscriptionModifyDispatch

GatewaySubscriptionDeleteDispatchData

GatewaySubscriptionDeleteDispatchData: GatewaySubscriptionModifyDispatchData

GatewaySubscriptionModifyDispatch

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

GatewaySubscriptionModifyDispatchData

GatewaySubscriptionModifyDispatchData: APISubscription

GatewaySubscriptionUpdateDispatch

GatewaySubscriptionUpdateDispatch: GatewaySubscriptionModifyDispatch

GatewaySubscriptionUpdateDispatchData

GatewaySubscriptionUpdateDispatchData: GatewaySubscriptionModifyDispatchData

GatewayThreadCreateDispatch

GatewayThreadCreateDispatch: DataPayload<GatewayDispatchEvents.ThreadCreate, GatewayThreadCreateDispatchData>

GatewayThreadDeleteDispatch

GatewayThreadDeleteDispatch: DataPayload<GatewayDispatchEvents.ThreadDelete, GatewayThreadDeleteDispatchData>

GatewayThreadListSyncDispatch

GatewayThreadListSyncDispatch: DataPayload<GatewayDispatchEvents.ThreadListSync, GatewayThreadListSyncDispatchData>

GatewayThreadListSyncDispatchData

GatewayThreadListSyncDispatchData: RawGatewayThreadListSync

GatewayThreadMembersUpdateDispatch

GatewayThreadMembersUpdateDispatch: DataPayload<GatewayDispatchEvents.ThreadMembersUpdate, GatewayThreadMembersUpdateDispatchData>

GatewayThreadMembersUpdateDispatchData

GatewayThreadMembersUpdateDispatchData: RawGatewayThreadMembersUpdate

GatewayThreadMemberUpdateDispatch

GatewayThreadMemberUpdateDispatch: DataPayload<GatewayDispatchEvents.ThreadMemberUpdate, GatewayThreadMemberUpdateDispatchData>

GatewayThreadMemberUpdateDispatchData

GatewayThreadMemberUpdateDispatchData: APIThreadMember & { guild_id: Snowflake }

GatewayThreadModifyDispatch

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

GatewayThreadUpdateDispatch

GatewayThreadUpdateDispatch: DataPayload<GatewayDispatchEvents.ThreadUpdate, GatewayThreadUpdateDispatchData>

GatewayThreadUpdateDispatchData

GatewayThreadUpdateDispatchData: APIThreadChannel

GatewayTypingStartDispatch

GatewayTypingStartDispatch: DataPayload<GatewayDispatchEvents.TypingStart, GatewayTypingStartDispatchData>

GatewayUserUpdateDispatch

GatewayUserUpdateDispatch: DataPayload<GatewayDispatchEvents.UserUpdate, GatewayUserUpdateDispatchData>

GatewayUserUpdateDispatchData

GatewayUserUpdateDispatchData: APIUser

GatewayVoiceChannelEffectSendDispatch

GatewayVoiceChannelEffectSendDispatch: DataPayload<GatewayDispatchEvents.VoiceChannelEffectSend, GatewayVoiceChannelEffectSendDispatchData>

GatewayVoiceServerUpdateDispatch

GatewayVoiceServerUpdateDispatch: DataPayload<GatewayDispatchEvents.VoiceServerUpdate, GatewayVoiceServerUpdateDispatchData>

GatewayVoiceState

GatewayVoiceState: APIVoiceState

GatewayVoiceStateUpdateDispatch

GatewayVoiceStateUpdateDispatch: DataPayload<GatewayDispatchEvents.VoiceStateUpdate, GatewayVoiceStateUpdateDispatchData>

GatewayVoiceStateUpdateDispatchData

GatewayVoiceStateUpdateDispatchData: APIVoiceState

GatewayWebhooksUpdateDispatch

GatewayWebhooksUpdateDispatch: DataPayload<GatewayDispatchEvents.WebhooksUpdate, GatewayWebhooksUpdateDispatchData>

GetAPIVoiceRegionsResult

GetAPIVoiceRegionsResult: RESTGetAPIVoiceRegionsResult
@deprecated

This was exported with the wrong name, use RESTGetAPIVoiceRegionsResult instead

GuildBannerFormat

GuildBannerFormat: Exclude<ImageFormat, ImageFormat.Lottie>

GuildChannelType

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

GuildDiscoverySplashFormat

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

GuildIconFormat

GuildIconFormat: Exclude<ImageFormat, ImageFormat.Lottie>

GuildMemberAvatarFormat

GuildMemberAvatarFormat: Exclude<ImageFormat, ImageFormat.Lottie>

GuildMemberBannerFormat

GuildMemberBannerFormat: Exclude<ImageFormat, ImageFormat.Lottie>

GuildScheduledEventCoverFormat

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

GuildSplashFormat

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

GuildTextChannelType

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

LocaleString

LocaleString: `${Locale}`
@deprecated

Use Locale instead.

LocalizationMap

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

PartialAPIMessageInteractionGuildMember

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

PresenceUpdateReceiveStatus

PresenceUpdateReceiveStatus: Exclude<PresenceUpdateStatus, PresenceUpdateStatus.Invisible>

RESTAPIAttachment

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

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 }

RESTAPIModifyGuildOnboardingPromptData

RESTAPIModifyGuildOnboardingPromptData: RESTAPIGuildOnboardingPrompt
@deprecated

RESTAPIModifyGuildOnboardingPromptOptionData

RESTAPIModifyGuildOnboardingPromptOptionData: RESTAPIGuildOnboardingPromptOption
@deprecated

RESTAPIPollCreate

RESTAPIPollCreate: RESTAPIPoll
@deprecated

Use RESTAPIPoll instead

RESTDeleteAPIApplicationEmojiResult

RESTDeleteAPIApplicationEmojiResult: never

RESTDeleteAPIAutoModerationRuleResult

RESTDeleteAPIAutoModerationRuleResult: never

RESTDeleteAPIChannelAllMessageReactionsResult

RESTDeleteAPIChannelAllMessageReactionsResult: never

RESTDeleteAPIChannelMessageOwnReaction

RESTDeleteAPIChannelMessageOwnReaction: RESTDeleteAPIChannelMessageOwnReactionResult

RESTDeleteAPIChannelMessageOwnReactionResult

RESTDeleteAPIChannelMessageOwnReactionResult: never

RESTDeleteAPIChannelMessageReactionResult

RESTDeleteAPIChannelMessageReactionResult: never

RESTDeleteAPIChannelMessageResult

RESTDeleteAPIChannelMessageResult: never

RESTDeleteAPIChannelMessageUserReactionResult

RESTDeleteAPIChannelMessageUserReactionResult: never

RESTDeleteAPIChannelPermissionResult

RESTDeleteAPIChannelPermissionResult: never

RESTDeleteAPIChannelPinResult

RESTDeleteAPIChannelPinResult: never

RESTDeleteAPIChannelRecipientResult

RESTDeleteAPIChannelRecipientResult: unknown

RESTDeleteAPIChannelResult

RESTDeleteAPIChannelResult: APIChannel

RESTDeleteAPIChannelThreadMembersResult

RESTDeleteAPIChannelThreadMembersResult: never

RESTDeleteAPICurrentUserGuildResult

RESTDeleteAPICurrentUserGuildResult: never

RESTDeleteAPIEntitlementResult

RESTDeleteAPIEntitlementResult: never

RESTDeleteAPIGuildBanResult

RESTDeleteAPIGuildBanResult: never

RESTDeleteAPIGuildEmojiResult

RESTDeleteAPIGuildEmojiResult: never

RESTDeleteAPIGuildIntegrationResult

RESTDeleteAPIGuildIntegrationResult: never

RESTDeleteAPIGuildMemberResult

RESTDeleteAPIGuildMemberResult: never

RESTDeleteAPIGuildMemberRoleResult

RESTDeleteAPIGuildMemberRoleResult: never

RESTDeleteAPIGuildResult

RESTDeleteAPIGuildResult: never

RESTDeleteAPIGuildRoleResult

RESTDeleteAPIGuildRoleResult: never

RESTDeleteAPIGuildScheduledEventResult

RESTDeleteAPIGuildScheduledEventResult: never

RESTDeleteAPIGuildSoundboardSoundResult

RESTDeleteAPIGuildSoundboardSoundResult: never

RESTDeleteAPIGuildStickerResult

RESTDeleteAPIGuildStickerResult: never

RESTDeleteAPIGuildTemplateResult

RESTDeleteAPIGuildTemplateResult: APITemplate

RESTDeleteAPIInteractionFollowupResult

RESTDeleteAPIInteractionFollowupResult: RESTDeleteAPIWebhookWithTokenMessageResult

RESTDeleteAPIInteractionOriginalResponseResult

RESTDeleteAPIInteractionOriginalResponseResult: RESTDeleteAPIWebhookWithTokenMessageResult

RESTDeleteAPIInviteResult

RESTDeleteAPIInviteResult: APIInvite

RESTDeleteAPIStageInstanceResult

RESTDeleteAPIStageInstanceResult: never

RESTDeleteAPIWebhookResult

RESTDeleteAPIWebhookResult: never

RESTDeleteAPIWebhookWithTokenMessageResult

RESTDeleteAPIWebhookWithTokenMessageResult: never

RESTDeleteAPIWebhookWithTokenResult

RESTDeleteAPIWebhookWithTokenResult: never

RESTErrorData

RESTErrorData: RESTErrorFieldInformation | RESTErrorGroupWrapper | string | {}

RESTGetAPIApplicationCommandPermissionsResult

RESTGetAPIApplicationCommandPermissionsResult: APIGuildApplicationCommandPermissions

RESTGetAPIApplicationCommandResult

RESTGetAPIApplicationCommandResult: APIApplicationCommand

RESTGetAPIApplicationCommandsResult

RESTGetAPIApplicationCommandsResult: APIApplicationCommand[]

RESTGetAPIApplicationEmojiResult

RESTGetAPIApplicationEmojiResult: APIEmoji

RESTGetAPIApplicationGuildCommandResult

RESTGetAPIApplicationGuildCommandResult: Omit<APIApplicationCommand, dm_permission>

RESTGetAPIApplicationGuildCommandsQuery

RESTGetAPIApplicationGuildCommandsQuery: RESTGetAPIApplicationCommandsQuery

RESTGetAPIApplicationGuildCommandsResult

RESTGetAPIApplicationGuildCommandsResult: Omit<APIApplicationCommand, dm_permission>[]

RESTGetAPIApplicationRoleConnectionMetadataResult

RESTGetAPIApplicationRoleConnectionMetadataResult: APIApplicationRoleConnectionMetadata[]

RESTGetAPIAuditLogResult

RESTGetAPIAuditLogResult: APIAuditLog

RESTGetAPIAutoModerationRuleResult

RESTGetAPIAutoModerationRuleResult: APIAutoModerationRule

RESTGetAPIAutoModerationRulesResult

RESTGetAPIAutoModerationRulesResult: APIAutoModerationRule[]

RESTGetAPIChannelInvitesResult

RESTGetAPIChannelInvitesResult: APIExtendedInvite[]

RESTGetAPIChannelMessageReactionUsersResult

RESTGetAPIChannelMessageReactionUsersResult: APIUser[]

RESTGetAPIChannelMessageResult

RESTGetAPIChannelMessageResult: APIMessage

RESTGetAPIChannelMessagesResult

RESTGetAPIChannelMessagesResult: APIMessage[]

RESTGetAPIChannelPinsResult

RESTGetAPIChannelPinsResult: APIMessage[]

RESTGetAPIChannelResult

RESTGetAPIChannelResult: APIChannel

RESTGetAPIChannelThreadMemberResult

RESTGetAPIChannelThreadMemberResult: APIThreadMember

RESTGetAPIChannelThreadMembersResult

RESTGetAPIChannelThreadMembersResult: APIThreadMember[]

RESTGetAPIChannelThreadsArchivedPrivateResult

RESTGetAPIChannelThreadsArchivedPrivateResult: RESTGetAPIChannelUsersThreadsArchivedResult

RESTGetAPIChannelThreadsArchivedPublicResult

RESTGetAPIChannelThreadsArchivedPublicResult: RESTGetAPIChannelUsersThreadsArchivedResult

RESTGetAPIChannelWebhooksResult

RESTGetAPIChannelWebhooksResult: APIWebhook[]

RESTGetAPICurrentUserApplicationRoleConnectionResult

RESTGetAPICurrentUserApplicationRoleConnectionResult: APIApplicationRoleConnection

RESTGetAPICurrentUserConnectionsResult

RESTGetAPICurrentUserConnectionsResult: APIConnection[]

RESTGetAPICurrentUserGuildsResult

RESTGetAPICurrentUserGuildsResult: RESTAPIPartialCurrentUserGuild[]

RESTGetAPICurrentUserResult

RESTGetAPICurrentUserResult: APIUser

RESTGetAPIEntitlementResult

RESTGetAPIEntitlementResult: APIEntitlement

RESTGetAPIEntitlementsResult

RESTGetAPIEntitlementsResult: APIEntitlement[]

RESTGetAPIGatewayBotResult

RESTGetAPIGatewayBotResult: APIGatewayBotInfo

RESTGetAPIGatewayResult

RESTGetAPIGatewayResult: APIGatewayInfo

RESTGetAPIGuildApplicationCommandsPermissionsResult

RESTGetAPIGuildApplicationCommandsPermissionsResult: APIGuildApplicationCommandPermissions[]

RESTGetAPIGuildBanResult

RESTGetAPIGuildBanResult: APIBan

RESTGetAPIGuildBansResult

RESTGetAPIGuildBansResult: APIBan[]

RESTGetAPIGuildChannelsResult

RESTGetAPIGuildChannelsResult: APIChannel[]

RESTGetAPIGuildEmojiResult

RESTGetAPIGuildEmojiResult: APIEmoji

RESTGetAPIGuildEmojisResult

RESTGetAPIGuildEmojisResult: APIEmoji[]

RESTGetAPIGuildIntegrationsResult

RESTGetAPIGuildIntegrationsResult: APIGuildIntegration[]

RESTGetAPIGuildInvitesResult

RESTGetAPIGuildInvitesResult: APIExtendedInvite[]

RESTGetAPIGuildMemberResult

RESTGetAPIGuildMemberResult: APIGuildMember

RESTGetAPIGuildMembersResult

RESTGetAPIGuildMembersResult: APIGuildMember[]

RESTGetAPIGuildMembersSearchResult

RESTGetAPIGuildMembersSearchResult: APIGuildMember[]

RESTGetAPIGuildMemberVerificationResult

RESTGetAPIGuildMemberVerificationResult: APIGuildMembershipScreening

RESTGetAPIGuildOnboardingResult

RESTGetAPIGuildOnboardingResult: APIGuildOnboarding

RESTGetAPIGuildPreviewResult

RESTGetAPIGuildPreviewResult: APIGuildPreview

RESTGetAPIGuildResult

RESTGetAPIGuildResult: APIGuild

RESTGetAPIGuildRoleResult

RESTGetAPIGuildRoleResult: APIRole

RESTGetAPIGuildRolesResult

RESTGetAPIGuildRolesResult: APIRole[]

RESTGetAPIGuildScheduledEventResult

RESTGetAPIGuildScheduledEventResult: APIGuildScheduledEvent

RESTGetAPIGuildScheduledEventsResult

RESTGetAPIGuildScheduledEventsResult: APIGuildScheduledEvent[]

RESTGetAPIGuildScheduledEventUsersResult

RESTGetAPIGuildScheduledEventUsersResult: APIGuildScheduledEventUser[]

RESTGetAPIGuildSoundboardSoundResult

RESTGetAPIGuildSoundboardSoundResult: APISoundboardSound

RESTGetAPIGuildStickerResult

RESTGetAPIGuildStickerResult: APISticker

RESTGetAPIGuildStickersResult

RESTGetAPIGuildStickersResult: APISticker[]

RESTGetAPIGuildTemplatesResult

RESTGetAPIGuildTemplatesResult: APITemplate[]

RESTGetAPIGuildThreadsResult

RESTGetAPIGuildThreadsResult: APIThreadList

RESTGetAPIGuildVoiceRegionsResult

RESTGetAPIGuildVoiceRegionsResult: APIVoiceRegion[]

RESTGetAPIGuildVoiceStateCurrentMemberResult

RESTGetAPIGuildVoiceStateCurrentMemberResult: APIVoiceState

RESTGetAPIGuildVoiceStateUserResult

RESTGetAPIGuildVoiceStateUserResult: APIVoiceState

RESTGetAPIGuildWebhooksResult

RESTGetAPIGuildWebhooksResult: APIWebhook[]

RESTGetAPIGuildWelcomeScreenResult

RESTGetAPIGuildWelcomeScreenResult: APIGuildWelcomeScreen

RESTGetAPIGuildWidgetImageResult

RESTGetAPIGuildWidgetImageResult: ArrayBuffer

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

RESTGetAPIGuildWidgetJSONResult

RESTGetAPIGuildWidgetJSONResult: APIGuildWidget

RESTGetAPIGuildWidgetSettingsResult

RESTGetAPIGuildWidgetSettingsResult: APIGuildWidgetSettings

RESTGetAPIInteractionFollowupResult

RESTGetAPIInteractionFollowupResult: RESTGetAPIWebhookWithTokenMessageResult

RESTGetAPIInteractionOriginalResponseResult

RESTGetAPIInteractionOriginalResponseResult: RESTGetAPIWebhookWithTokenMessageResult

RESTGetAPIInviteResult

RESTGetAPIInviteResult: APIInvite

RESTGetAPIOAuth2CurrentApplicationResult

RESTGetAPIOAuth2CurrentApplicationResult: Omit<APIApplication, flags>

RESTGetAPISKUsResult

RESTGetAPISKUsResult: APISKU[]

RESTGetAPISKUSubscriptionResult

RESTGetAPISKUSubscriptionResult: APISubscription

RESTGetAPISKUSubscriptionsResult

RESTGetAPISKUSubscriptionsResult: APISubscription[]

RESTGetAPISoundboardDefaultSoundsResult

RESTGetAPISoundboardDefaultSoundsResult: APISoundboardSound[]

RESTGetAPIStageInstanceResult

RESTGetAPIStageInstanceResult: APIStageInstance

RESTGetAPIStickerPack

RESTGetAPIStickerPack: RESTGetAPIStickerPackResult
@deprecated

RESTGetAPIStickerPackResult

RESTGetAPIStickerPackResult: APIStickerPack

RESTGetAPIStickerResult

RESTGetAPIStickerResult: APISticker

RESTGetAPITemplateResult

RESTGetAPITemplateResult: APITemplate

RESTGetAPIUserResult

RESTGetAPIUserResult: APIUser

RESTGetAPIVoiceRegionsResult

RESTGetAPIVoiceRegionsResult: APIVoiceRegion[]

RESTGetAPIWebhookResult

RESTGetAPIWebhookResult: APIWebhook

RESTGetAPIWebhookWithTokenMessageResult

RESTGetAPIWebhookWithTokenMessageResult: APIMessage

RESTGetAPIWebhookWithTokenResult

RESTGetAPIWebhookWithTokenResult: Omit<APIWebhook, user>

RESTGetCurrentApplicationResult

RESTGetCurrentApplicationResult: APIApplication

RESTGetCurrentUserGuildMemberResult

RESTGetCurrentUserGuildMemberResult: APIGuildMember

RESTGetNitroStickerPacksResult

RESTGetNitroStickerPacksResult: RESTGetStickerPacksResult
@deprecated

Use RESTGetStickerPacksResult instead

RESTOAuth2AuthorizationQueryResult

RESTOAuth2AuthorizationQueryResult: RESTPostOAuth2AuthorizationQueryResult

RESTOAuth2ImplicitAuthorizationURLFragmentResult

RESTOAuth2ImplicitAuthorizationURLFragmentResult: Omit<RESTPostOAuth2AccessTokenResult, refresh_token>

RESTPatchAPIApplicationCommandJSONBody

RESTPatchAPIApplicationCommandJSONBody: StrictPartial<RESTPostAPIApplicationCommandsJSONBody>

RESTPatchAPIApplicationCommandResult

RESTPatchAPIApplicationCommandResult: APIApplicationCommand

RESTPatchAPIApplicationEmojiJSONBody

RESTPatchAPIApplicationEmojiJSONBody: Pick<RESTPatchAPIGuildEmojiJSONBody, name>

RESTPatchAPIApplicationEmojiResult

RESTPatchAPIApplicationEmojiResult: APIEmoji

RESTPatchAPIApplicationGuildCommandJSONBody

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

RESTPatchAPIApplicationGuildCommandResult

RESTPatchAPIApplicationGuildCommandResult: Omit<APIApplicationCommand, dm_permission>

RESTPatchAPIAutoModerationRuleJSONBody

RESTPatchAPIAutoModerationRuleJSONBody: Omit<Partial<RESTPostAPIAutoModerationRuleJSONBody>, trigger_type>

RESTPatchAPIAutoModerationRuleResult

RESTPatchAPIAutoModerationRuleResult: APIAutoModerationRule

RESTPatchAPIChannelMessageFormDataBody

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

RESTPatchAPIChannelMessageResult

RESTPatchAPIChannelMessageResult: APIMessage

RESTPatchAPIChannelResult

RESTPatchAPIChannelResult: APIChannel

RESTPatchAPICurrentGuildMemberNicknameResult

RESTPatchAPICurrentGuildMemberNicknameResult: StrictRequired<RESTPatchAPICurrentGuildMemberNicknameJSONBody>

RESTPatchAPICurrentUserResult

RESTPatchAPICurrentUserResult: APIUser

RESTPatchAPIGuildChannelPositionsJSONBody

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

RESTPatchAPIGuildChannelPositionsResult

RESTPatchAPIGuildChannelPositionsResult: never

RESTPatchAPIGuildEmojiResult

RESTPatchAPIGuildEmojiResult: APIEmoji

RESTPatchAPIGuildMemberResult

RESTPatchAPIGuildMemberResult: APIGuildMember

RESTPatchAPIGuildMemberVerificationResult

RESTPatchAPIGuildMemberVerificationResult: APIGuildMembershipScreening

RESTPatchAPIGuildResult

RESTPatchAPIGuildResult: APIGuild

RESTPatchAPIGuildRolePositionsJSONBody

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

RESTPatchAPIGuildRolePositionsResult

RESTPatchAPIGuildRolePositionsResult: APIRole[]

RESTPatchAPIGuildRoleResult

RESTPatchAPIGuildRoleResult: APIRole

RESTPatchAPIGuildScheduledEventJSONBody

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

RESTPatchAPIGuildScheduledEventResult

RESTPatchAPIGuildScheduledEventResult: APIGuildScheduledEvent

RESTPatchAPIGuildSoundboardSoundResult

RESTPatchAPIGuildSoundboardSoundResult: APISoundboardSound

RESTPatchAPIGuildStickerResult

RESTPatchAPIGuildStickerResult: APISticker

RESTPatchAPIGuildTemplateJSONBody

RESTPatchAPIGuildTemplateJSONBody: StrictPartial<RESTPostAPIGuildTemplatesJSONBody>

RESTPatchAPIGuildTemplateResult

RESTPatchAPIGuildTemplateResult: APITemplate

RESTPatchAPIGuildVoiceStateCurrentMemberResult

RESTPatchAPIGuildVoiceStateCurrentMemberResult: never

RESTPatchAPIGuildVoiceStateUserResult

RESTPatchAPIGuildVoiceStateUserResult: never

RESTPatchAPIGuildWelcomeScreenJSONBody

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

RESTPatchAPIGuildWelcomeScreenResult

RESTPatchAPIGuildWelcomeScreenResult: APIGuildWelcomeScreen

RESTPatchAPIGuildWidgetSettingsJSONBody

RESTPatchAPIGuildWidgetSettingsJSONBody: StrictPartial<APIGuildWidgetSettings>

RESTPatchAPIGuildWidgetSettingsResult

RESTPatchAPIGuildWidgetSettingsResult: APIGuildWidgetSettings

RESTPatchAPIInteractionFollowupFormDataBody

RESTPatchAPIInteractionFollowupFormDataBody: RESTPatchAPIWebhookWithTokenMessageFormDataBody

RESTPatchAPIInteractionFollowupJSONBody

RESTPatchAPIInteractionFollowupJSONBody: RESTPatchAPIWebhookWithTokenMessageJSONBody

RESTPatchAPIInteractionFollowupResult

RESTPatchAPIInteractionFollowupResult: RESTPatchAPIWebhookWithTokenMessageResult

RESTPatchAPIInteractionOriginalResponseFormDataBody

RESTPatchAPIInteractionOriginalResponseFormDataBody: RESTPatchAPIWebhookWithTokenMessageFormDataBody

RESTPatchAPIInteractionOriginalResponseJSONBody

RESTPatchAPIInteractionOriginalResponseJSONBody: RESTPatchAPIWebhookWithTokenMessageJSONBody

RESTPatchAPIInteractionOriginalResponseResult

RESTPatchAPIInteractionOriginalResponseResult: RESTPatchAPIWebhookWithTokenMessageResult

RESTPatchAPIStageInstanceResult

RESTPatchAPIStageInstanceResult: APIStageInstance

RESTPatchAPIWebhookResult

RESTPatchAPIWebhookResult: APIWebhook

RESTPatchAPIWebhookWithTokenJSONBody

RESTPatchAPIWebhookWithTokenJSONBody: Omit<RESTPatchAPIWebhookJSONBody, channel_id>

RESTPatchAPIWebhookWithTokenMessageFormDataBody

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

RESTPatchAPIWebhookWithTokenMessageJSONBody

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

RESTPatchAPIWebhookWithTokenMessageResult

RESTPatchAPIWebhookWithTokenMessageResult: APIMessage

RESTPatchAPIWebhookWithTokenResult

RESTPatchAPIWebhookWithTokenResult: RESTGetAPIWebhookWithTokenResult

RESTPatchCurrentApplicationJSONBody

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

RESTPatchCurrentApplicationResult

RESTPatchCurrentApplicationResult: APIApplication

RESTPostAPIApplicationCommandsJSONBody

RESTPostAPIApplicationCommandsResult

RESTPostAPIApplicationCommandsResult: APIApplicationCommand

RESTPostAPIApplicationEmojiJSONBody

RESTPostAPIApplicationEmojiJSONBody: Pick<RESTPostAPIGuildEmojiJSONBody, image | name>

RESTPostAPIApplicationEmojiResult

RESTPostAPIApplicationEmojiResult: APIEmoji

RESTPostAPIApplicationGuildCommandsJSONBody

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

RESTPostAPIApplicationGuildCommandsResult

RESTPostAPIApplicationGuildCommandsResult: Omit<APIApplicationCommand, dm_permission>

RESTPostAPIAutoModerationRuleResult

RESTPostAPIAutoModerationRuleResult: APIAutoModerationRule

RESTPostAPIChannelFollowersResult

RESTPostAPIChannelFollowersResult: APIFollowedChannel

RESTPostAPIChannelInviteResult

RESTPostAPIChannelInviteResult: APIExtendedInvite

RESTPostAPIChannelMessageCrosspostResult

RESTPostAPIChannelMessageCrosspostResult: APIMessage

RESTPostAPIChannelMessageFormDataBody

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

RESTPostAPIChannelMessageResult

RESTPostAPIChannelMessageResult: APIMessage

RESTPostAPIChannelMessagesBulkDeleteResult

RESTPostAPIChannelMessagesBulkDeleteResult: never

RESTPostAPIChannelMessagesThreadsResult

RESTPostAPIChannelMessagesThreadsResult: APIChannel

RESTPostAPIChannelThreadsResult

RESTPostAPIChannelThreadsResult: APIChannel

RESTPostAPIChannelTypingResult

RESTPostAPIChannelTypingResult: never

RESTPostAPIChannelWebhookResult

RESTPostAPIChannelWebhookResult: APIWebhook

RESTPostAPICurrentUserCreateDMChannelResult

RESTPostAPICurrentUserCreateDMChannelResult: APIChannel

RESTPostAPIEntitlementBody

RESTPostAPIEntitlementBody: RESTPostAPIEntitlementJSONBody
@deprecated

RESTPostAPIEntitlementConsumeResult

RESTPostAPIEntitlementConsumeResult: never

RESTPostAPIEntitlementResult

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

RESTPostAPIGuildChannelJSONBody

RESTPostAPIGuildChannelJSONBody: DistributiveOmit<RESTAPIGuildCreatePartialChannel, id>

RESTPostAPIGuildChannelResult

RESTPostAPIGuildChannelResult: APIChannel

RESTPostAPIGuildEmojiResult

RESTPostAPIGuildEmojiResult: APIEmoji

RESTPostAPIGuildForumThreadsFormDataBody

RESTPostAPIGuildForumThreadsFormDataBody: RESTPostAPIChannelMessagesThreadsJSONBody & { message: string }

RESTPostAPIGuildForumThreadsJSONBody

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

RESTPostAPIGuildRoleResult

RESTPostAPIGuildRoleResult: APIRole

RESTPostAPIGuildScheduledEventResult

RESTPostAPIGuildScheduledEventResult: APIGuildScheduledEvent

RESTPostAPIGuildsMFAResult

RESTPostAPIGuildsMFAResult: RESTPostAPIGuildsMFAJSONBody

RESTPostAPIGuildSoundboardSoundResult

RESTPostAPIGuildSoundboardSoundResult: APISoundboardSound

RESTPostAPIGuildsResult

RESTPostAPIGuildsResult: APIGuild

RESTPostAPIGuildStickerResult

RESTPostAPIGuildStickerResult: APISticker

RESTPostAPIGuildTemplatesResult

RESTPostAPIGuildTemplatesResult: APITemplate

RESTPostAPIInteractionCallbackFormDataBody

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

RESTPostAPIInteractionCallbackJSONBody

RESTPostAPIInteractionCallbackJSONBody: APIInteractionResponse

RESTPostAPIInteractionCallbackResult

RESTPostAPIInteractionCallbackResult: never

RESTPostAPIInteractionFollowupFormDataBody

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

RESTPostAPIInteractionFollowupJSONBody

RESTPostAPIInteractionFollowupJSONBody: APIInteractionResponseCallbackData

RESTPostAPIInteractionFollowupResult

RESTPostAPIInteractionFollowupResult: RESTPostAPIWebhookWithTokenWaitResult

RESTPostAPIPollExpireResult

RESTPostAPIPollExpireResult: APIMessage

RESTPostAPISendSoundboardSoundResult

RESTPostAPISendSoundboardSoundResult: APISoundboardSound

RESTPostAPIStageInstanceResult

RESTPostAPIStageInstanceResult: APIStageInstance

RESTPostAPITemplateCreateGuildResult

RESTPostAPITemplateCreateGuildResult: APIGuild

RESTPostAPIWebhookWithTokenFormDataBody

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

RESTPostAPIWebhookWithTokenGitHubQuery

RESTPostAPIWebhookWithTokenGitHubQuery: RESTPostAPIWebhookWithTokenQuery

RESTPostAPIWebhookWithTokenGitHubResult

RESTPostAPIWebhookWithTokenGitHubResult: never

RESTPostAPIWebhookWithTokenGitHubWaitResult

RESTPostAPIWebhookWithTokenGitHubWaitResult: APIMessage

RESTPostAPIWebhookWithTokenResult

RESTPostAPIWebhookWithTokenResult: never

RESTPostAPIWebhookWithTokenSlackQuery

RESTPostAPIWebhookWithTokenSlackQuery: RESTPostAPIWebhookWithTokenQuery

RESTPostAPIWebhookWithTokenSlackResult

RESTPostAPIWebhookWithTokenSlackResult: never

RESTPostAPIWebhookWithTokenSlackWaitResult

RESTPostAPIWebhookWithTokenSlackWaitResult: APIMessage

RESTPostAPIWebhookWithTokenWaitResult

RESTPostAPIWebhookWithTokenWaitResult: APIMessage

RESTPostOAuth2AccessTokenWithBotAndGuildsAndWebhookIncomingScopeResult

RESTPostOAuth2ClientCredentialsResult

RESTPostOAuth2ClientCredentialsResult: RESTOAuth2ImplicitAuthorizationURLFragmentResult

RESTPostOAuth2RefreshTokenResult

RESTPostOAuth2RefreshTokenResult: RESTPostOAuth2AccessTokenResult

RESTPutAPIApplicationCommandPermissionsResult

RESTPutAPIApplicationCommandPermissionsResult: APIGuildApplicationCommandPermissions

RESTPutAPIApplicationCommandsJSONBody

RESTPutAPIApplicationCommandsJSONBody: RESTPostAPIApplicationCommandsJSONBody[]

RESTPutAPIApplicationCommandsResult

RESTPutAPIApplicationCommandsResult: APIApplicationCommand[]

RESTPutAPIApplicationGuildCommandsJSONBody

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

RESTPutAPIApplicationGuildCommandsResult

RESTPutAPIApplicationGuildCommandsResult: Omit<APIApplicationCommand, dm_permission>[]

RESTPutAPIApplicationRoleConnectionMetadataJSONBody

RESTPutAPIApplicationRoleConnectionMetadataJSONBody: APIApplicationRoleConnectionMetadata[]

RESTPutAPIApplicationRoleConnectionMetadataResult

RESTPutAPIApplicationRoleConnectionMetadataResult: APIApplicationRoleConnectionMetadata[]

RESTPutAPIChannelMessageReactionResult

RESTPutAPIChannelMessageReactionResult: never

RESTPutAPIChannelPermissionResult

RESTPutAPIChannelPermissionResult: never

RESTPutAPIChannelPinResult

RESTPutAPIChannelPinResult: never

RESTPutAPIChannelRecipientResult

RESTPutAPIChannelRecipientResult: unknown

RESTPutAPIChannelThreadMembersResult

RESTPutAPIChannelThreadMembersResult: never

RESTPutAPICurrentUserApplicationRoleConnectionResult

RESTPutAPICurrentUserApplicationRoleConnectionResult: APIApplicationRoleConnection

RESTPutAPIGuildApplicationCommandsPermissionsJSONBody

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

RESTPutAPIGuildApplicationCommandsPermissionsResult

RESTPutAPIGuildApplicationCommandsPermissionsResult: APIGuildApplicationCommandPermissions[]

RESTPutAPIGuildBanResult

RESTPutAPIGuildBanResult: never

RESTPutAPIGuildMemberResult

RESTPutAPIGuildMemberResult: APIGuildMember | undefined

RESTPutAPIGuildMemberRoleResult

RESTPutAPIGuildMemberRoleResult: never

RESTPutAPIGuildOnboardingJSONBody

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

RESTPutAPIGuildOnboardingResult

RESTPutAPIGuildOnboardingResult: APIGuildOnboarding

RESTPutAPIGuildTemplateSyncResult

RESTPutAPIGuildTemplateSyncResult: APITemplate

RoleIconFormat

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

StickerFormat

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

StickerPackBannerFormat

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

StorePageAssetFormat

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

TeamIconFormat

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

TextChannelType

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

ThreadChannelType

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

UserAvatarFormat

UserAvatarFormat: Exclude<ImageFormat, ImageFormat.Lottie>

UserBannerFormat

UserBannerFormat: Exclude<ImageFormat, ImageFormat.Lottie>

Variables

constAPIApplicationCommandPermissionsConstant

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

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 migrated to the new username system. For users on the new username system, index will be (user.id >> 22) % 6. For users on the legacy username system, index will be user.discriminator % 5.

      This route supports the extension: PNG


      Parameters

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

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

  • 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

      • optionaluserId: 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`

constStickerPackApplicationId

StickerPackApplicationId: 710982414301790216 = '710982414301790216'
Page Options