Skip to main content
Version: 0.37.12

discord-api-types/v6

Index

Enumerations

Interfaces

References

Type Aliases

Variables

References

FormattingPatterns

Re-exports FormattingPatterns

GatewayURLQuery

Re-exports GatewayURLQuery

Locale

Re-exports Locale

LocaleString

Re-exports LocaleString

RESTJSONErrorCodes

Re-exports RESTJSONErrorCodes

Snowflake

Re-exports Snowflake

Type Aliases

APIAuditLogChange

APIAuditLogChange: APIAuditLogChangeKeyName | APIAuditLogChangeKeyIconHash | APIAuditLogChangeKeySplashHash | APIAuditLogChangeKeyOwnerID | APIAuditLogChangeKeyRegion | APIAuditLogChangeKeyAFKChannelID | APIAuditLogChangeKeyAFKTimeout | APIAuditLogChangeKeyMFALevel | APIAuditLogChangeKeyVerificationLevel | APIAuditLogChangeKeyExplicitContentFilter | APIAuditLogChangeKeyDefaultMessageNotifications | APIAuditLogChangeKeyVanityURLCode | APIAuditLogChangeKey$Add | APIAuditLogChangeKey$Remove | APIAuditLogChangeKeyPruneDeleteDays | APIAuditLogChangeKeyWidgetEnabled | APIAuditLogChangeKeyWidgetChannelID | APIAuditLogChangeKeySystemChannelID | APIAuditLogChangeKeyPosition | APIAuditLogChangeKeyTopic | APIAuditLogChangeKeyBitrate | APIAuditLogChangeKeyPermissionOverwrites | APIAuditLogChangeKeyNSFW | APIAuditLogChangeKeyApplicationID | APIAuditLogChangeKeyRateLimitPerUser | APIAuditLogChangeKeyPermissions | APIAuditLogChangeKeyPermissionsNew | APIAuditLogChangeKeyColor | APIAuditLogChangeKeyHoist | APIAuditLogChangeKeyMentionable | APIAuditLogChangeKeyAllow | APIAuditLogChangeKeyAllowNew | APIAuditLogChangeKeyDeny | APIAuditLogChangeKeyDenyNew | APIAuditLogChangeKeyCode | APIAuditLogChangeKeyChannelID | APIAuditLogChangeKeyInviterID | APIAuditLogChangeKeyMaxUses | APIAuditLogChangeKeyUses | APIAuditLogChangeKeyMaxAge | APIAuditLogChangeKeyTemporary | APIAuditLogChangeKeyDeaf | APIAuditLogChangeKeyMute | APIAuditLogChangeKeyNick | APIAuditLogChangeKeyAvatarHash | APIAuditLogChangeKeyID | APIAuditLogChangeKeyType | APIAuditLogChangeKeyEnableEmoticons | APIAuditLogChangeKeyExpireBehavior | APIAuditLogChangeKeyExpireGracePeriod

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

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKey$Add

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

Returned when new role(s) are added

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKey$Remove

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

Returned when role(s) are removed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyAFKChannelID

APIAuditLogChangeKeyAFKChannelID: AuditLogChangeData<afk_channel_id, string>

Returned when a guild’s afk_channel_id is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyAFKTimeout

APIAuditLogChangeKeyAFKTimeout: AuditLogChangeData<afk_timeout, number>

Returned when a guild’s afk_timeout is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyAllow

APIAuditLogChangeKeyAllow: AuditLogChangeData<allow, number>

Returned when an overwrite’s allowed permissions bitfield is changed

@deprecated

Use allow_new instead

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyAllowNew

APIAuditLogChangeKeyAllowNew: AuditLogChangeData<allow_new, string>

Returned when an overwrite’s allowed permissions bitfield is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyApplicationID

APIAuditLogChangeKeyApplicationID: AuditLogChangeData<application_id, string>

The application ID of the added or removed Webhook or Bot

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyAvatarHash

APIAuditLogChangeKeyAvatarHash: AuditLogChangeData<avatar_hash, string>

Returned when a user’s avatar_hash is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyBitrate

APIAuditLogChangeKeyBitrate: AuditLogChangeData<bitrate, number>

Returned when a voice channel’s bitrate is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyChannelID

APIAuditLogChangeKeyChannelID: AuditLogChangeData<channel_id, string>

Returned when an invite’s channel_id is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyCode

APIAuditLogChangeKeyCode: AuditLogChangeData<code, string>

Returned when an invite’s code is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyColor

APIAuditLogChangeKeyColor: AuditLogChangeData<color, number>

Returned when a role’s color is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyDeaf

APIAuditLogChangeKeyDeaf: AuditLogChangeData<deaf, boolean>

Returned when a user’s deaf status is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyDefaultMessageNotifications

APIAuditLogChangeKeyDefaultMessageNotifications: AuditLogChangeData<default_message_notifications, GuildDefaultMessageNotifications>

Returned when a guild’s default_message_notifications is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyDeny

APIAuditLogChangeKeyDeny: AuditLogChangeData<deny, number>

Returned when an overwrite’s denied permissions bitfield is changed

@deprecated

Use deny_new instead

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyDenyNew

APIAuditLogChangeKeyDenyNew: AuditLogChangeData<deny_new, string>

Returned when an overwrite’s denied permissions bitfield is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyEnableEmoticons

APIAuditLogChangeKeyEnableEmoticons: AuditLogChangeData<enable_emoticons, boolean>

Returned when an integration’s enable_emoticons is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyExpireBehavior

APIAuditLogChangeKeyExpireBehavior: AuditLogChangeData<expire_behavior, IntegrationExpireBehavior>

Returned when an integration’s expire_behavior is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyExpireGracePeriod

APIAuditLogChangeKeyExpireGracePeriod: AuditLogChangeData<expire_grace_period, number>

Returned when an integration’s expire_grace_period is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyExplicitContentFilter

APIAuditLogChangeKeyExplicitContentFilter: AuditLogChangeData<explicit_content_filter, GuildExplicitContentFilter>

Returned when a guild’s explicit_content_filter is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyHoist

APIAuditLogChangeKeyHoist: AuditLogChangeData<hoist, boolean>

Returned when a role’s hoist status is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyIconHash

APIAuditLogChangeKeyIconHash: AuditLogChangeData<icon_hash, string>

Returned when a guild’s icon is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyInviterID

APIAuditLogChangeKeyInviterID: AuditLogChangeData<inviter_id, string>

Returned when an invite’s inviter_id is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyMFALevel

APIAuditLogChangeKeyMFALevel: AuditLogChangeData<mfa_level, GuildMFALevel>

Returned when a guild’s mfa_level is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyMaxAge

APIAuditLogChangeKeyMaxAge: AuditLogChangeData<max_age, number>

Returned when an invite’s max_age is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyMaxUses

APIAuditLogChangeKeyMaxUses: AuditLogChangeData<max_uses, number>

Returned when an invite’s max_uses is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyMentionable

APIAuditLogChangeKeyMentionable: AuditLogChangeData<mentionable, boolean>

Returned when a role’s mentionable status is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyMute

APIAuditLogChangeKeyMute: AuditLogChangeData<mute, boolean>

Returned when a user’s mute status is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyNSFW

APIAuditLogChangeKeyNSFW: AuditLogChangeData<nsfw, boolean>

Returned when a channel’s NSFW restriction is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyName

APIAuditLogChangeKeyName: AuditLogChangeData<name, string>

Returned when a guild’s name is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyNick

APIAuditLogChangeKeyNick: AuditLogChangeData<mute, boolean>

Returned when a user’s nick is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyOwnerID

APIAuditLogChangeKeyOwnerID: AuditLogChangeData<owner_id, string>

Returned when a guild’s owner ID is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyPermissionOverwrites

APIAuditLogChangeKeyPermissionOverwrites: AuditLogChangeData<permission_overwrites, APIOverwrite[]>

Returned when a channel’s permission overwrites is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyPermissions

APIAuditLogChangeKeyPermissions: AuditLogChangeData<permissions, number>

Returned when a permission bitfield is changed

@deprecated

Use permissions_new instead

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyPermissionsNew

APIAuditLogChangeKeyPermissionsNew: AuditLogChangeData<permissions_new, string>

Returned when a permission bitfield is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyPosition

APIAuditLogChangeKeyPosition: AuditLogChangeData<position, number>

Returned when a channel’s position is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

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

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

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

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyRegion

APIAuditLogChangeKeyRegion: AuditLogChangeData<region, string>

Returned when a guild’s region is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeySplashHash

APIAuditLogChangeKeySplashHash: AuditLogChangeData<splash_hash, string>

Returned when a guild’s splash is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeySystemChannelID

APIAuditLogChangeKeySystemChannelID: AuditLogChangeData<system_channel_id, string>

Returned when a guild’s system_channel_id is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyTemporary

APIAuditLogChangeKeyTemporary: AuditLogChangeData<temporary, boolean>

Returned when an invite’s temporary status is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyTopic

APIAuditLogChangeKeyTopic: AuditLogChangeData<topic, string>

Returned when a channel’s topic is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyType

APIAuditLogChangeKeyType: AuditLogChangeData<type, ChannelType | string>

The type of entity created

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyUses

APIAuditLogChangeKeyUses: AuditLogChangeData<uses, number>

Returned when an invite’s uses is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyVanityURLCode

APIAuditLogChangeKeyVanityURLCode: AuditLogChangeData<vanity_url_code, string>

Returned when a guild’s vanity_url_code is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyVerificationLevel

APIAuditLogChangeKeyVerificationLevel: AuditLogChangeData<verification_level, GuildVerificationLevel>

Returned when a guild’s verification_level is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyWidgetChannelID

APIAuditLogChangeKeyWidgetChannelID: AuditLogChangeData<widget_channel_id, string>

Returned when a guild’s widget_channel_id is changed

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIAuditLogChangeKeyWidgetEnabled

APIAuditLogChangeKeyWidgetEnabled: AuditLogChangeData<widget_enabled, boolean>

Returned when a guild’s widget is enabled

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

APIGuildCreatePartialChannel

APIGuildCreatePartialChannel: Partial<Pick<APIChannel, type | topic | nsfw | bitrate | user_limit | rate_limit_per_user>> & { id?: number | string; name: string; parent_id?: number | string; permission_overwrites?: APIGuildCreateOverwrite[] }
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

APIGuildWidget

APIGuildWidget: APIGuildWidgetSettings
@deprecated

Use APIGuildWidgetSettings instead

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

GatewayActivityAssets

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

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

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

GatewayActivityEmoji

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

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

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

GatewayActivitySecrets

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

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

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

GatewayChannelCreateDispatch

GatewayChannelCreateDispatch: GatewayChannelModifyDispatch
@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayChannelDeleteDispatch

GatewayChannelDeleteDispatch: GatewayChannelModifyDispatch
@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayChannelModifyDispatch

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

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

@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayChannelPinsUpdateDispatch

GatewayChannelPinsUpdateDispatch: DataPayload<GatewayDispatchEvents.ChannelPinsUpdate, { channel_id: string; guild_id?: string; last_pin_timestamp?: string }>

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

@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayChannelUpdateDispatch

GatewayChannelUpdateDispatch: GatewayChannelModifyDispatch
@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayDispatchPayload

GatewayDispatchPayload: GatewayReadyDispatch | GatewayResumedDispatch | GatewayChannelModifyDispatch | GatewayChannelPinsUpdateDispatch | GatewayGuildModifyDispatch | GatewayGuildDeleteDispatch | GatewayGuildBanModifyDispatch | GatewayGuildEmojisUpdateDispatch | GatewayGuildIntegrationsUpdateDispatch | GatewayGuildMemberAddDispatch | GatewayGuildMemberRemoveDispatch | GatewayGuildMemberUpdateDispatch | GatewayGuildMembersChunkDispatch | GatewayGuildRoleModifyDispatch | GatewayGuildRoleDeleteDispatch | GatewayInviteCreateDispatch | GatewayInviteDeleteDispatch | GatewayMessageCreateDispatch | GatewayMessageUpdateDispatch | GatewayMessageDeleteDispatch | GatewayMessageDeleteBulkDispatch | GatewayMessageReactionAddDispatch | GatewayMessageReactionRemoveDispatch | GatewayMessageReactionRemoveAllDispatch | GatewayMessageReactionRemoveEmojiDispatch | GatewayPresenceUpdateDispatch | GatewayTypingStartDispatch | GatewayUserUpdateDispatch | GatewayVoiceStateUpdateDispatch | GatewayVoiceServerUpdateDispatch | GatewayWebhooksUpdateDispatch
@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayGuildBanAddDispatch

GatewayGuildBanAddDispatch: GatewayGuildBanModifyDispatch
@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayGuildBanModifyDispatch

GatewayGuildBanModifyDispatch: DataPayload<GatewayDispatchEvents.GuildBanAdd | GatewayDispatchEvents.GuildBanRemove, { guild_id: string; user: APIUser }>

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

@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayGuildBanRemoveDispatch

GatewayGuildBanRemoveDispatch: GatewayGuildBanModifyDispatch
@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayGuildCreateDispatch

GatewayGuildCreateDispatch: GatewayGuildModifyDispatch
@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayGuildDeleteDispatch

GatewayGuildDeleteDispatch: DataPayload<GatewayDispatchEvents.GuildDelete, APIUnavailableGuild>

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

@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayGuildEmojisUpdateDispatch

GatewayGuildEmojisUpdateDispatch: DataPayload<GatewayDispatchEvents.GuildEmojisUpdate, { emojis: APIEmoji[]; guild_id: string }>

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

@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayGuildIntegrationsUpdateDispatch

GatewayGuildIntegrationsUpdateDispatch: DataPayload<GatewayDispatchEvents.GuildIntegrationsUpdate, { guild_id: string }>

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

@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayGuildMemberAddDispatch

GatewayGuildMemberAddDispatch: DataPayload<GatewayDispatchEvents.GuildMemberAdd, APIGuildMember & { guild_id: string }>

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

@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayGuildMemberRemoveDispatch

GatewayGuildMemberRemoveDispatch: DataPayload<GatewayDispatchEvents.GuildMemberRemove, { guild_id: string; user: APIUser }>

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

@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayGuildMemberUpdateDispatch

GatewayGuildMemberUpdateDispatch: DataPayload<GatewayDispatchEvents.GuildMemberUpdate, Omit<APIGuildMember, deaf | mute> & { guild_id: string }>

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

@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayGuildMembersChunkDispatch

GatewayGuildMembersChunkDispatch: DataPayload<GatewayDispatchEvents.GuildMembersChunk, { chunk_count?: number; chunk_index?: number; guild_id: string; members: APIGuildMember[]; nonce?: string; not_found?: unknown[]; presences?: RawGatewayPresenceUpdate[] }>

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

@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayGuildModifyDispatch

GatewayGuildModifyDispatch: DataPayload<GatewayDispatchEvents.GuildCreate | GatewayDispatchEvents.GuildUpdate, APIGuild>

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

@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayGuildRoleCreateDispatch

GatewayGuildRoleCreateDispatch: GatewayGuildRoleModifyDispatch
@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayGuildRoleDeleteDispatch

GatewayGuildRoleDeleteDispatch: DataPayload<GatewayDispatchEvents.GuildRoleDelete, { guild_id: string; role_id: string }>

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

@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayGuildRoleModifyDispatch

GatewayGuildRoleModifyDispatch: DataPayload<GatewayDispatchEvents.GuildRoleCreate | GatewayDispatchEvents.GuildRoleUpdate, { guild_id: string; role: APIRole }>

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

@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayGuildRoleUpdateDispatch

GatewayGuildRoleUpdateDispatch: GatewayGuildRoleModifyDispatch
@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayGuildUpdateDispatch

GatewayGuildUpdateDispatch: GatewayGuildModifyDispatch
@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayInviteCreateDispatch

GatewayInviteCreateDispatch: DataPayload<GatewayDispatchEvents.InviteCreate, { channel_id: string; code: string; created_at: number; guild_id?: string; inviter?: APIUser; max_age: number; max_uses: number; target_user?: APIUser; target_user_type?: InviteTargetUserType; temporary: boolean; uses: 0 }>

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

@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayInviteDeleteDispatch

GatewayInviteDeleteDispatch: DataPayload<GatewayDispatchEvents.InviteDelete, { channel_id: string; code: string; guild_id?: string }>

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

@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayMessageCreateDispatch

GatewayMessageCreateDispatch: DataPayload<GatewayDispatchEvents.MessageCreate, APIMessage>

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

@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayMessageDeleteBulkDispatch

GatewayMessageDeleteBulkDispatch: DataPayload<GatewayDispatchEvents.MessageDeleteBulk, { channel_id: string; guild_id?: string; ids: string[] }>

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

@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayMessageDeleteDispatch

GatewayMessageDeleteDispatch: DataPayload<GatewayDispatchEvents.MessageDelete, { channel_id: string; guild_id?: string; id: string }>

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

@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayMessageReactionAddDispatch

GatewayMessageReactionAddDispatch: ReactionData<GatewayDispatchEvents.MessageReactionAdd>

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

@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayMessageReactionRemoveAllDispatch

GatewayMessageReactionRemoveAllDispatch: DataPayload<GatewayDispatchEvents.MessageReactionRemoveAll, MessageReactionRemoveData>

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

@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayMessageReactionRemoveDispatch

GatewayMessageReactionRemoveDispatch: ReactionData<GatewayDispatchEvents.MessageReactionRemove, member>

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

@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayMessageReactionRemoveEmojiDispatch

GatewayMessageReactionRemoveEmojiDispatch: DataPayload<GatewayDispatchEvents.MessageReactionRemoveEmoji, MessageReactionRemoveData & { emoji: APIEmoji }>

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

@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayMessageUpdateDispatch

GatewayMessageUpdateDispatch: DataPayload<GatewayDispatchEvents.MessageUpdate, { channel_id: string; id: string } & Partial<APIMessage>>

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

@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayPresenceClientStatus

GatewayPresenceClientStatus: Partial<Record<desktop | mobile | web, PresenceUpdateStatus>>

https://discord.com/developers/docs/topics/gateway#client-status-object

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

GatewayPresenceUpdateDispatch

GatewayPresenceUpdateDispatch: DataPayload<GatewayDispatchEvents.PresenceUpdate, RawGatewayPresenceUpdate>

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

@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayReadyDispatch

GatewayReadyDispatch: DataPayload<GatewayDispatchEvents.Ready, { guilds: APIUnavailableGuild[]; private_channels: []; session_id: string; shard?: [number, number]; user: APIUser; v: number }>

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

@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayReceivePayload

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

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayResumedDispatch

GatewayResumedDispatch: DataPayload<GatewayDispatchEvents.Resumed, never>

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

@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewaySendPayload

GatewaySendPayload: GatewayHeartbeat | GatewayIdentify | GatewayUpdatePresence | GatewayVoiceStateUpdate | GatewayResume | GatewayRequestGuildMembers
@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayTypingStartDispatch

GatewayTypingStartDispatch: DataPayload<GatewayDispatchEvents.TypingStart, { channel_id: string; guild_id?: string; member?: APIGuildMember; timestamp: number; user_id: string }>

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

@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayUserUpdateDispatch

GatewayUserUpdateDispatch: DataPayload<GatewayDispatchEvents.UserUpdate, APIUser>

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

@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayVoiceServerUpdateDispatch

GatewayVoiceServerUpdateDispatch: DataPayload<GatewayDispatchEvents.VoiceServerUpdate, { endpoint: string; guild_id: string; token: string }>

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

@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayVoiceStateUpdateDispatch

GatewayVoiceStateUpdateDispatch: DataPayload<GatewayDispatchEvents.VoiceStateUpdate, GatewayVoiceState>

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

@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GatewayWebhooksUpdateDispatch

GatewayWebhooksUpdateDispatch: DataPayload<GatewayDispatchEvents.WebhooksUpdate, { channel_id: string; guild_id: string }>

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

@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

GetAPIVoiceRegionsResult

GetAPIVoiceRegionsResult: APIVoiceRegion[]

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTDeleteAPIChannelAllMessageReactionsResult

RESTDeleteAPIChannelAllMessageReactionsResult: never
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTDeleteAPIChannelMessageReactionResult

RESTDeleteAPIChannelMessageReactionResult: never
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTDeleteAPIChannelMessageResult

RESTDeleteAPIChannelMessageResult: never
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTDeleteAPIChannelPermissionsResult

RESTDeleteAPIChannelPermissionsResult: never
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTDeleteAPIChannelPinResult

RESTDeleteAPIChannelPinResult: never
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTDeleteAPIChannelRecipientResult

RESTDeleteAPIChannelRecipientResult: unknown
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTDeleteAPIChannelResult

RESTDeleteAPIChannelResult: APIChannel
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTDeleteAPICurrentUserGuildResult

RESTDeleteAPICurrentUserGuildResult: never

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTDeleteAPIGuildBanResult

RESTDeleteAPIGuildBanResult: never

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTDeleteAPIGuildEmojiResult

RESTDeleteAPIGuildEmojiResult: never

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTDeleteAPIGuildIntegrationResult

RESTDeleteAPIGuildIntegrationResult: never

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTDeleteAPIGuildMemberResult

RESTDeleteAPIGuildMemberResult: never

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTDeleteAPIGuildMemberRoleResult

RESTDeleteAPIGuildMemberRoleResult: never

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTDeleteAPIGuildResult

RESTDeleteAPIGuildResult: never

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTDeleteAPIGuildRoleResult

RESTDeleteAPIGuildRoleResult: never

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTDeleteAPIInviteResult

RESTDeleteAPIInviteResult: APIInvite

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTDeleteAPIWebhookResult

RESTDeleteAPIWebhookResult: never

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTDeleteAPIWebhookWithTokenResult

RESTDeleteAPIWebhookWithTokenResult: never
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIAuditLogResult

RESTGetAPIAuditLogResult: APIAuditLog
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIChannelInvitesResult

RESTGetAPIChannelInvitesResult: APIInvite[]

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIChannelMessageReactionsResult

RESTGetAPIChannelMessageReactionsResult: APIUser[]
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIChannelMessageResult

RESTGetAPIChannelMessageResult: APIMessage
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIChannelMessagesResult

RESTGetAPIChannelMessagesResult: APIMessage[]
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIChannelPinsResult

RESTGetAPIChannelPinsResult: APIMessage[]

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIChannelResult

RESTGetAPIChannelResult: APIChannel
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIChannelWebhooksResult

RESTGetAPIChannelWebhooksResult: APIWebhook[]

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPICurrentUserConnectionsResult

RESTGetAPICurrentUserConnectionsResult: APIConnection[]

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPICurrentUserGuildsResult

RESTGetAPICurrentUserGuildsResult: RESTAPIPartialCurrentUserGuild[]
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPICurrentUserResult

RESTGetAPICurrentUserResult: APIUser

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIGatewayBotResult

RESTGetAPIGatewayBotResult: APIGatewayBotInfo

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIGatewayResult

RESTGetAPIGatewayResult: APIGatewayInfo

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIGuildBanResult

RESTGetAPIGuildBanResult: APIBan

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIGuildBansResult

RESTGetAPIGuildBansResult: APIBan[]

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIGuildChannelsResult

RESTGetAPIGuildChannelsResult: APIChannel[]

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIGuildEmojiResult

RESTGetAPIGuildEmojiResult: APIEmoji

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIGuildEmojisResult

RESTGetAPIGuildEmojisResult: APIEmoji[]

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIGuildIntegrationsResult

RESTGetAPIGuildIntegrationsResult: APIGuildIntegration[]
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIGuildInvitesResult

RESTGetAPIGuildInvitesResult: APIInvite[]

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIGuildMemberResult

RESTGetAPIGuildMemberResult: APIGuildMember

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIGuildMembersResult

RESTGetAPIGuildMembersResult: APIGuildMember[]
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIGuildMembersSearchResult

RESTGetAPIGuildMembersSearchResult: APIGuildMember[]
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIGuildPreviewResult

RESTGetAPIGuildPreviewResult: APIGuildPreview

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIGuildResult

RESTGetAPIGuildResult: APIGuild
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIGuildRolesResult

RESTGetAPIGuildRolesResult: APIRole[]

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIGuildVoiceRegionsResult

RESTGetAPIGuildVoiceRegionsResult: APIVoiceRegion[]

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIGuildWebhooksResult

RESTGetAPIGuildWebhooksResult: APIWebhook[]

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIGuildWidgetResult

RESTGetAPIGuildWidgetResult: APIGuildWidgetSettings
@deprecated

Renamed to RESTGetAPIGuildWidgetSettingsResult

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIGuildWidgetSettingsResult

RESTGetAPIGuildWidgetSettingsResult: APIGuildWidgetSettings

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIInviteResult

RESTGetAPIInviteResult: APIInvite
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIOauth2CurrentApplicationResult

RESTGetAPIOauth2CurrentApplicationResult: APIApplication

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIUserResult

RESTGetAPIUserResult: APIUser

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIWebhookResult

RESTGetAPIWebhookResult: APIWebhook

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTGetAPIWebhookWithTokenResult

RESTGetAPIWebhookWithTokenResult: Omit<APIWebhook, user>

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTOAuth2ImplicitAuthorizationURIFragmentResult

RESTOAuth2ImplicitAuthorizationURIFragmentResult: Omit<RESTPostOAuth2AccessTokenResult, refresh_token>

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPatchAPIChannelMessageResult

RESTPatchAPIChannelMessageResult: APIMessage
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPatchAPIChannelResult

RESTPatchAPIChannelResult: APIChannel
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPatchAPICurrentGuildMemberNicknameResult

RESTPatchAPICurrentGuildMemberNicknameResult: Required<RESTPatchAPICurrentGuildMemberNicknameJSONBody>
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPatchAPICurrentUserResult

RESTPatchAPICurrentUserResult: APIUser
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPatchAPIGuildChannelPositionsJSONBody

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

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPatchAPIGuildChannelPositionsResult

RESTPatchAPIGuildChannelPositionsResult: never
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPatchAPIGuildEmojiResult

RESTPatchAPIGuildEmojiResult: APIEmoji
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPatchAPIGuildIntegrationResult

RESTPatchAPIGuildIntegrationResult: never
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPatchAPIGuildMemberResult

RESTPatchAPIGuildMemberResult: never
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPatchAPIGuildResult

RESTPatchAPIGuildResult: APIGuild
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPatchAPIGuildRolePositionsJSONBody

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

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPatchAPIGuildRolePositionsResult

RESTPatchAPIGuildRolePositionsResult: APIRole[]
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPatchAPIGuildRoleResult

RESTPatchAPIGuildRoleResult: APIRole
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPatchAPIGuildWidgetJSONBody

RESTPatchAPIGuildWidgetJSONBody: Partial<APIGuildWidgetSettings>
@deprecated

Renamed to RESTPatchAPIGuildWidgetSettingsJSONBody

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPatchAPIGuildWidgetResult

RESTPatchAPIGuildWidgetResult: APIGuildWidgetSettings
@deprecated

Use RESTPatchAPIGuildWidgetSettingsResult instead

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPatchAPIGuildWidgetSettingsJSONBody

RESTPatchAPIGuildWidgetSettingsJSONBody: Partial<APIGuildWidgetSettings>

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPatchAPIGuildWidgetSettingsResult

RESTPatchAPIGuildWidgetSettingsResult: APIGuildWidgetSettings
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPatchAPIWebhookResult

RESTPatchAPIWebhookResult: APIWebhook
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPatchAPIWebhookWithTokenJSONBody

RESTPatchAPIWebhookWithTokenJSONBody: Omit<RESTPatchAPIWebhookJSONBody, channel_id>

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPatchAPIWebhookWithTokenResult

RESTPatchAPIWebhookWithTokenResult: Omit<APIWebhook, user>
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPostAPIChannelFollowersResult

RESTPostAPIChannelFollowersResult: APIFollowedChannel
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPostAPIChannelMessageCrosspostResult

RESTPostAPIChannelMessageCrosspostResult: APIMessage
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPostAPIChannelMessageFormDataBody

RESTPostAPIChannelMessageFormDataBody: { file: unknown; payload_json?: string } | { allowed_mentions?: APIAllowedMentionsSend; content?: string; embed?: APIEmbed; file: unknown; message_reference?: APIMessageReference; nonce?: number | string; tts?: boolean }

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPostAPIChannelMessageResult

RESTPostAPIChannelMessageResult: APIMessage
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPostAPIChannelMessagesBulkDeleteResult

RESTPostAPIChannelMessagesBulkDeleteResult: never
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPostAPIChannelTypingResult

RESTPostAPIChannelTypingResult: never

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPostAPIChannelWebhookResult

RESTPostAPIChannelWebhookResult: APIWebhook
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPostAPICurrentUserCreateDMChannelResult

RESTPostAPICurrentUserCreateDMChannelResult: APIChannel
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPostAPIGuildChannelJSONBody

RESTPostAPIGuildChannelJSONBody: Partial<Pick<APIChannel, type | permission_overwrites | topic | nsfw | bitrate | user_limit | rate_limit_per_user | parent_id>> & Required<Pick<APIChannel, name>>

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPostAPIGuildChannelResult

RESTPostAPIGuildChannelResult: APIChannel
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPostAPIGuildEmojiResult

RESTPostAPIGuildEmojiResult: APIEmoji
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPostAPIGuildIntegrationResult

RESTPostAPIGuildIntegrationResult: never
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPostAPIGuildIntegrationSyncResult

RESTPostAPIGuildIntegrationSyncResult: never

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPostAPIGuildRoleResult

RESTPostAPIGuildRoleResult: APIRole
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPostAPIGuildsResult

RESTPostAPIGuildsResult: APIGuild
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPostAPIWebhookWithTokenFormDataBody

RESTPostAPIWebhookWithTokenFormDataBody: { file: unknown; payload_json?: string } | (RESTPostAPIWebhookWithTokenJSONBody & { file: unknown })

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPostAPIWebhookWithTokenGitHubQuery

RESTPostAPIWebhookWithTokenGitHubQuery: RESTPostAPIWebhookWithTokenQuery

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPostAPIWebhookWithTokenResult

RESTPostAPIWebhookWithTokenResult: never
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPostAPIWebhookWithTokenSlackQuery

RESTPostAPIWebhookWithTokenSlackQuery: RESTPostAPIWebhookWithTokenQuery

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPostAPIWebhookWithTokenWaitResult

RESTPostAPIWebhookWithTokenWaitResult: APIMessage

Received when a call to POST /webhooks/{webhook.id}/{webhook.token} receives the wait query parameter set to true

@see

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPostOAuth2AccessTokenWithBotAndGuildsAndWebhookIncomingScopeResult

RESTPostOAuth2AccessTokenWithBotAndGuildsAndWebhookIncomingScopeResult: RESTPostOAuth2AccessTokenWithBotAndGuildsScopeResult & RESTPostOAuth2AccessTokenWithBotAndWebhookIncomingScopeResult
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPostOAuth2ClientCredentialsResult

RESTPostOAuth2ClientCredentialsResult: RESTOAuth2ImplicitAuthorizationURIFragmentResult
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPostOAuth2RefreshTokenResult

RESTPostOAuth2RefreshTokenResult: RESTPostOAuth2AccessTokenResult

RESTPutAPIChannelMessageReactionResult

RESTPutAPIChannelMessageReactionResult: never
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPutAPIChannelPermissionsResult

RESTPutAPIChannelPermissionsResult: never
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPutAPIChannelPinResult

RESTPutAPIChannelPinResult: never

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPutAPIChannelRecipientResult

RESTPutAPIChannelRecipientResult: unknown
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPutAPIGuildBanResult

RESTPutAPIGuildBanResult: never
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPutAPIGuildMemberResult

RESTPutAPIGuildMemberResult: APIGuildMember | undefined
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

RESTPutAPIGuildMemberRoleResult

RESTPutAPIGuildMemberRoleResult: never

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

@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

Variables

constAPIVersion

APIVersion: 6 = '6'
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

constGatewayVersion

GatewayVersion: 6 = '6'
@deprecated

Gateway v6 is deprecated and the types will not receive further updates, please update to v8.

constPermissionFlagsBits

PermissionFlagsBits: { ADD_REACTIONS: [object Object]; ADMINISTRATOR: [object Object]; ATTACH_FILES: [object Object]; BAN_MEMBERS: [object Object]; CHANGE_NICKNAME: [object Object]; CONNECT: [object Object]; CREATE_INSTANT_INVITE: [object Object]; DEAFEN_MEMBERS: [object Object]; EMBED_LINKS: [object Object]; KICK_MEMBERS: [object Object]; MANAGE_CHANNELS: [object Object]; MANAGE_EMOJIS: [object Object]; MANAGE_GUILD: [object Object]; MANAGE_MESSAGES: [object Object]; MANAGE_NICKNAMES: [object Object]; MANAGE_ROLES: [object Object]; MANAGE_WEBHOOKS: [object Object]; MENTION_EVERYONE: [object Object]; MOVE_MEMBERS: [object Object]; MUTE_MEMBERS: [object Object]; PRIORITY_SPEAKER: [object Object]; READ_MESSAGE_HISTORY: [object Object]; SEND_MESSAGES: [object Object]; SEND_TTS_MESSAGES: [object Object]; SPEAK: [object Object]; STREAM: [object Object]; USE_EXTERNAL_EMOJIS: [object Object]; USE_VAD: [object Object]; VIEW_AUDIT_LOG: [object Object]; VIEW_CHANNEL: [object Object]; VIEW_GUILD_INSIGHTS: [object Object] } = ...

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

These flags are exported as BigInts and NOT numbers. For most of them, you can convert them in a number by wrapping it in Number(), however be careful as any further bits added may cause issues if done so. Try to use BigInts as much as possible or modules that can replicate them in some way.

@deprecated

API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8.

Type declaration

  • ADD_REACTIONS: [object Object]
  • ADMINISTRATOR: [object Object]
  • ATTACH_FILES: [object Object]
  • BAN_MEMBERS: [object Object]
  • CHANGE_NICKNAME: [object Object]
  • CONNECT: [object Object]
  • CREATE_INSTANT_INVITE: [object Object]
  • DEAFEN_MEMBERS: [object Object]
  • EMBED_LINKS: [object Object]
  • KICK_MEMBERS: [object Object]
  • MANAGE_CHANNELS: [object Object]
  • MANAGE_EMOJIS: [object Object]
  • MANAGE_GUILD: [object Object]
  • MANAGE_MESSAGES: [object Object]
  • MANAGE_NICKNAMES: [object Object]
  • MANAGE_ROLES: [object Object]
  • MANAGE_WEBHOOKS: [object Object]
  • MENTION_EVERYONE: [object Object]
  • MOVE_MEMBERS: [object Object]
  • MUTE_MEMBERS: [object Object]
  • PRIORITY_SPEAKER: [object Object]
  • READ_MESSAGE_HISTORY: [object Object]
  • SEND_MESSAGES: [object Object]
  • SEND_TTS_MESSAGES: [object Object]
  • SPEAK: [object Object]
  • STREAM: [object Object]
  • USE_EXTERNAL_EMOJIS: [object Object]
  • USE_VAD: [object Object]
  • VIEW_AUDIT_LOG: [object Object]
  • VIEW_CHANNEL: [object Object]
  • VIEW_GUILD_INSIGHTS: [object Object]

constRoutes

Routes: { channel: any; channelBulkDelete: any; channelCrosspost: any; channelFollowers: any; channelInvite: any; channelMessage: any; channelMessageAllReactions: any; channelMessageOwnReaction: any; channelMessageSpecificReaction: any; channelMessageUserReaction: any; channelMessages: any; channelPermissions: any; channelPin: any; channelPins: any; channelRecipient: any; channelTyping: any; channelWebhook: any; gateway: any; gatewayBot: any; guild: any; guildAuditLog: any; guildBan: any; guildBans: any; guildChannels: any; guildCurrentMemberNickname: any; guildEmoji: any; guildEmojis: any; guildIntegration: any; guildIntegrationSync: any; guildIntegrations: any; guildInvites: any; guildMember: any; guildMemberRole: any; guildMembers: any; guildMembersSearch: any; guildPreview: any; guildPrune: any; guildRole: any; guildRoles: any; guildVanityUrl: any; guildVoiceRegions: any; guildWebhooks: any; guildWidget: any; guildWidgetImage: any; guildWidgetSettings: any; guilds: any; invite: any; oauth2CurrentApplication: any; user: any; userChannels: any; userConnections: any; userGuild: any; userGuilds: any; voiceRegions: any; webhook: any; webhookPlatform: any } = ...
@deprecated

API v6 is deprecated and the types will not receive further updates, please update to v8.

Type declaration

  • channel: function
    • channel(channelID: string): string

    • Route for:

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

      Parameters

      • channelID: string

      Returns string

  • channelBulkDelete: function
    • channelBulkDelete(channelID: string): string

    • Route for:

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

      Parameters

      • channelID: string

      Returns string

  • channelCrosspost: function
    • channelCrosspost(channelID: string, messageID: string): string

    • Route for:

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

      Parameters

      • channelID: string
      • messageID: string

      Returns string

  • channelFollowers: function
    • channelFollowers(channelID: string): string

    • Route for:

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

      Parameters

      • channelID: string

      Returns string

  • channelInvite: function
    • channelInvite(channelID: string): string

    • Route for:

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

      Parameters

      • channelID: string

      Returns string

  • channelMessage: function
    • channelMessage(channelID: string, messageID: string): 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 string

  • channelMessageAllReactions: function
    • channelMessageAllReactions(channelID: string, messageID: string): string

    • Route for:

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

      Parameters

      • channelID: string
      • messageID: string

      Returns string

  • channelMessageOwnReaction: function
    • channelMessageOwnReaction(channelID: string, messageID: string, emoji: string): string

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

  • channelMessageSpecificReaction: function
    • channelMessageSpecificReaction(channelID: string, messageID: string, emoji: string): 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 string

  • channelMessageUserReaction: function
    • channelMessageUserReaction(channelID: string, messageID: string, emoji: string, userID: 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 string

  • channelMessages: function
    • channelMessages(channelID: string): string

    • Route for:

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

      Parameters

      • channelID: string

      Returns string

  • channelPermissions: function
    • channelPermissions(channelID: string, overwriteID: string): string

    • Route for:

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

      Parameters

      • channelID: string
      • overwriteID: string

      Returns string

  • channelPin: function
    • channelPin(channelID: string, messageID: string): string

    • Route for:

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

      Parameters

      • channelID: string
      • messageID: string

      Returns string

  • channelPins: function
    • channelPins(channelID: string): string

    • Route for:

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

      Parameters

      • channelID: string

      Returns string

  • channelRecipient: function
    • channelRecipient(channelID: string, userID: string): string

    • Route for:

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

      Parameters

      • channelID: string
      • userID: string

      Returns string

  • channelTyping: function
    • channelTyping(channelID: string): string

    • Route for:

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

      Parameters

      • channelID: string

      Returns string

  • channelWebhook: function
    • channelWebhook(channelID: string): string

    • Route for:

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

      Parameters

      • channelID: string

      Returns string

  • gateway: function
    • gateway(): string

    • Route for:

      • GET /gateway

      Returns string

  • gatewayBot: function
    • gatewayBot(): string

    • Route for:

      • GET /gateway/bot

      Returns string

  • guild: function
    • guild(guildID: string): string

    • Route for:

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

      Parameters

      • guildID: string

      Returns string

  • guildAuditLog: function
    • guildAuditLog(guildID: string): string

    • Route for:

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

      Parameters

      • guildID: string

      Returns string

  • guildBan: function
    • guildBan(guildID: string, userID: string): 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 string

  • guildBans: function
    • guildBans(guildID: string): string

    • Route for:

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

      Parameters

      • guildID: string

      Returns string

  • guildChannels: function
    • guildChannels(guildID: string): string

    • Route for:

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

      Parameters

      • guildID: string

      Returns string

  • guildCurrentMemberNickname: function
    • guildCurrentMemberNickname(guildID: string): string

    • Route for:

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

      Parameters

      • guildID: string

      Returns string

  • guildEmoji: function
    • guildEmoji(guildID: string, emojiID: string): 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 string

  • guildEmojis: function
    • guildEmojis(guildID: string): string

    • Route for:

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

      Parameters

      • guildID: string

      Returns string

  • guildIntegration: function
    • guildIntegration(guildID: string, integrationID: string): string

    • Route for:

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

      Parameters

      • guildID: string
      • integrationID: string

      Returns string

  • guildIntegrationSync: function
    • guildIntegrationSync(guildID: string, integrationID: string): string

    • Route for:

      • POST /guilds/{guild.id}/integrations/{integration.id}/sync

      Parameters

      • guildID: string
      • integrationID: string

      Returns string

  • guildIntegrations: function
    • guildIntegrations(guildID: string): string

    • Route for:

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

      Parameters

      • guildID: string

      Returns string

  • guildInvites: function
    • guildInvites(guildID: string): string

    • Route for:

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

      Parameters

      • guildID: string

      Returns string

  • guildMember: function
    • guildMember(guildID: string, userID: string): string

    • Route for:

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

      Parameters

      • guildID: string
      • userID: string

      Returns string

  • guildMemberRole: function
    • guildMemberRole(guildID: string, memberID: string, roleID: string): 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 string

  • guildMembers: function
    • guildMembers(guildID: string): string

    • Route for:

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

      Parameters

      • guildID: string

      Returns string

  • guildMembersSearch: function
    • guildMembersSearch(guildID: string): string

    • Route for:

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

      Parameters

      • guildID: string

      Returns string

  • guildPreview: function
    • guildPreview(guildID: string): string

    • Route for:

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

      Parameters

      • guildID: string

      Returns string

  • guildPrune: function
    • guildPrune(guildID: string): string

    • Route for:

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

      Parameters

      • guildID: string

      Returns string

  • guildRole: function
    • guildRole(guildID: string, roleID: string): string

    • Route for:

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

      Parameters

      • guildID: string
      • roleID: string

      Returns string

  • guildRoles: function
    • guildRoles(guildID: string): string

    • Route for:

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

      Parameters

      • guildID: string

      Returns string

  • guildVanityUrl: function
    • guildVanityUrl(guildID: string): string

    • Route for:

      • GET /guilds/{guild.id}/vanity-url

      Parameters

      • guildID: string

      Returns string

  • guildVoiceRegions: function
    • guildVoiceRegions(guildID: string): string

    • Route for:

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

      Parameters

      • guildID: string

      Returns string

  • guildWebhooks: function
    • guildWebhooks(guildID: string): string

    • Route for:

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

      Parameters

      • guildID: string

      Returns string

  • guildWidget: function
    • guildWidget(guildID: string): string
    • @deprecated

      Use guildWidgetSettings instead

      Parameters

      • guildID: string

      Returns string

  • guildWidgetImage: function
    • guildWidgetImage(guildID: string): string

    • Route for:

      • GET /guilds/{guild.id}/widget.png

      Parameters

      • guildID: string

      Returns string

  • guildWidgetSettings: function
    • guildWidgetSettings(guildID: string): string

    • Route for:

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

      Parameters

      • guildID: string

      Returns string

  • guilds: function
    • guilds(): string

    • Route for:

      • POST /guilds

      Returns string

  • invite: function
    • invite(code: string): string

    • Route for:

      • GET /invites/{invite.code}
      • DELETE /invites/{invite.code}

      Parameters

      • code: string

      Returns string

  • oauth2CurrentApplication: function
    • oauth2CurrentApplication(): string

    • Route for:

      • GET /oauth2/applications/@me

      Returns string

  • user: function
    • user(userID?: string): string

    • Route for:

      • GET /users/@me
      • GET /users/{user.id}
      • PATCH /users/@me

      Parameters

      • userID: string = '@me'

      Returns string

  • userChannels: function
    • userChannels(): string

    • Route for:

      • POST /users/@me/channels

      Returns string

  • userConnections: function
    • userConnections(): string

    • Route for:

      • GET /users/@me/connections

      Returns string

  • userGuild: function
    • userGuild(guildID: string): string

    • Route for:

      • DELETE /users/@me/guilds/{guild.id}

      Parameters

      • guildID: string

      Returns string

  • userGuilds: function
    • userGuilds(): string

    • Route for:

      • GET /users/@me/guilds

      Returns string

  • voiceRegions: function
    • voiceRegions(): string

    • Route for:

      • GET /voice/regions

      Returns string

  • webhook: function
    • webhook(webhookID: string, webhookToken?: string): 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}

      Parameters

      • webhookID: string
      • optionalwebhookToken: string

      Returns string

  • webhookPlatform: function
    • webhookPlatform(webhookID: string, webhookToken: string, platform: github | slack): string

    • Route for:

      • POST /webhooks/{webhook.id}/{webhook.token}/slack
      • POST /webhooks/{webhook.id}/{webhook.token}/github

      Parameters

      • webhookID: string
      • webhookToken: string
      • platform: github | slack

      Returns string