Class Rest

The rest manager. Used for making rest requests to the Discord API.

Hierarchy

RestRequests
- Rest

Index

Constructors

constructor

new Rest(token, options?, logCallback?, logThisArg?): Rest
Create a rest manager.
Parameters
- token: string
  
  The bot's token.
- options: RestOptions & RestRequestOptions = {}
  
  Rest options.
- logCallback: LogCallback = ...
  
  A callback to be used for logging events internally in the rest manager.
- Optional logThisArg: any
  
  A value to use as this in the logCallback.
Returns Rest
Overrides RestRequests.constructor
- Defined in src/rest/Rest.ts:109

Properties

bucketSweepInterval

bucketSweepInterval: null | Timer = null

The interval used for sweeping inactive buckets.

buckets

buckets: null | ExtendedMap<`${string}(${string})`, RestBucket> = null

Rate limit buckets. Each bucket's key is it's ID.

globalLeft

globalLeft: null | number = null

The amount of requests left in the global rate limit bucket.

globalResetAt

globalResetAt: null | number = null

A unix millisecond timestamp at which the global rate limit resets.

`Readonly` options

options: Required<RestOptions> & RestRequestOptions

Options for the rest manager.

responseCodeTally

responseCodeTally: Record<string, number> = {}

A tally of the number of responses that returned a specific response code. Note that response codes aren't included if they were never received.

routeHashCache

routeHashCache: null | ExtendedMap<`GET;${string}` | `POST;${string}` | `DELETE;${string}` | `PATCH;${string}` | `PUT;${string}`, string> = null

Cached route rate limit bucket hashes. Keys are cached route hashes, with their values being their corresponding RestBucketHash bucket hash.

`Readonly` system

system: "Rest" = ...

The system string used for logging.

Accessors

responseCodeRatio

get responseCodeRatio(): Record<string, number>
Get the ratio of response codes. Each code's value is the percentage it was received (0 to 100). Note that response codes aren't included if they were never received.

Returns Record<string, number>
- Defined in src/rest/Rest.ts:152

Methods

addGuildMember

addGuildMember(guildId, userId, body, options?): Promise<APIGuildMember>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- userId: string
  
  The user ID.
- body: RESTPutAPIGuildMemberJSONBody
  
  Request body.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIGuildMember>
Inherited from RestRequests.addGuildMember
- Defined in src/rest/RestRequests.ts:991

addGuildMemberRole

addGuildMemberRole(guildId, userId, roleId, reason?, options?): Promise<never>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- userId: string
  
  The user ID.
- roleId: string
  
  The role ID.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.addGuildMemberRole
- Defined in src/rest/RestRequests.ts:1032

addThreadMember

addThreadMember(threadId, userId, options?): Promise<never>
See
Discord API Reference
Parameters
- threadId: string
  
  The thread ID.
- userId: string
  
  The user ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.addThreadMember
- Defined in src/rest/RestRequests.ts:729

beginGuildPrune

beginGuildPrune(guildId, body, reason?, options?): Promise<RESTPostAPIGuildPruneResult>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- body: RESTPostAPIGuildPruneJSONBody
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTPostAPIGuildPruneResult>
Inherited from RestRequests.beginGuildPrune
- Defined in src/rest/RestRequests.ts:1207

bulkDeleteMessages

bulkDeleteMessages(channelId, body, reason?, options?): Promise<never>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- body: RESTPostAPIChannelMessagesBulkDeleteJSONBody
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.bulkDeleteMessages
- Defined in src/rest/RestRequests.ts:539

bulkOverwriteGlobalApplicationCommands

bulkOverwriteGlobalApplicationCommands(applicationId, body, options?): Promise<RESTPutAPIApplicationCommandsResult>
See
Discord API Reference
Parameters
- applicationId: string
  
  The application ID.
- body: RESTPutAPIApplicationCommandsJSONBody
  
  Request body.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTPutAPIApplicationCommandsResult>
Inherited from RestRequests.bulkOverwriteGlobalApplicationCommands
- Defined in src/rest/RestRequests.ts:77

bulkOverwriteGuildApplicationCommands

bulkOverwriteGuildApplicationCommands(applicationId, guildId, body, options?): Promise<RESTPutAPIApplicationGuildCommandsResult>
See
Discord API Reference
Parameters
- applicationId: string
  
  The application ID.
- guildId: string
  
  The guild ID.
- body: RESTPutAPIApplicationGuildCommandsJSONBody
  
  Request body.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTPutAPIApplicationGuildCommandsResult>
Inherited from RestRequests.bulkOverwriteGuildApplicationCommands
- Defined in src/rest/RestRequests.ts:152

createAutoModerationRule

createAutoModerationRule(guildId, body, reason?, options?): Promise<APIAutoModerationRule>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- body: RESTPostAPIAutoModerationRuleJSONBody
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIAutoModerationRule>
Inherited from RestRequests.createAutoModerationRule
- Defined in src/rest/RestRequests.ts:326

createChannelInvite

createChannelInvite(channelId, body, reason?, options?): Promise<APIExtendedInvite>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- body: RESTPostAPIChannelInviteJSONBody
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIExtendedInvite>
Inherited from RestRequests.createChannelInvite
- Defined in src/rest/RestRequests.ts:575

createDM

createDM(body, options?): Promise<APIChannel>
See
Discord API Reference
Parameters
- body: RESTPostAPICurrentUserCreateDMChannelJSONBody
  
  Request body.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIChannel>
Inherited from RestRequests.createDM
- Defined in src/rest/RestRequests.ts:1623

createFollowupMessage

createFollowupMessage(applicationId, interactionToken, body, options?): Promise<APIMessage>
See
Discord API Reference
Parameters
- applicationId: string
  
  The application ID.
- interactionToken: string
  
  The interaction token.
- body: FormData | APIInteractionResponseCallbackData
  
  Request body.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIMessage>
Inherited from RestRequests.createFollowupMessage
- Defined in src/rest/RestRequests.ts:246

createGlobalApplicationCommand

createGlobalApplicationCommand(applicationId, body, options?): Promise<APIApplicationCommand>
See
Discord API Reference
Parameters
- applicationId: string
  
  The application ID.
- body: RESTPostAPIApplicationCommandsJSONBody
  
  Request body.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIApplicationCommand>
Inherited from RestRequests.createGlobalApplicationCommand
- Defined in src/rest/RestRequests.ts:32

createGuild

createGuild(body, options?): Promise<APIGuild>
See
Discord API Reference
Parameters
- body: RESTPostAPIGuildsJSONBody
  
  Request body.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIGuild>
Inherited from RestRequests.createGuild
- Defined in src/rest/RestRequests.ts:860

createGuildApplicationCommand

createGuildApplicationCommand(applicationId, guildId, body, options?): Promise<RESTPostAPIApplicationGuildCommandsResult>
See
Discord API Reference
Parameters
- applicationId: string
  
  The application ID.
- guildId: string
  
  The guild ID.
- body: RESTPostAPIApplicationGuildCommandsJSONBody
  
  Request body.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTPostAPIApplicationGuildCommandsResult>
Inherited from RestRequests.createGuildApplicationCommand
- Defined in src/rest/RestRequests.ts:103

createGuildBan

createGuildBan(guildId, userId, body, reason?, options?): Promise<never>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- userId: string
  
  The user ID.
- body: RESTPutAPIGuildBanJSONBody
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.createGuildBan
- Defined in src/rest/RestRequests.ts:1095

createGuildChannel

createGuildChannel(guildId, body, reason?, options?): Promise<APIChannel>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- body: RESTPostAPIGuildChannelJSONBody
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIChannel>
Inherited from RestRequests.createGuildChannel
- Defined in src/rest/RestRequests.ts:922

createGuildEmoji

createGuildEmoji(guildId, body, reason?, options?): Promise<APIEmoji>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- body: RESTPostAPIGuildEmojiJSONBody
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIEmoji>
Inherited from RestRequests.createGuildEmoji
- Defined in src/rest/RestRequests.ts:823

createGuildRole

createGuildRole(guildId, body, reason?, options?): Promise<APIRole>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- body: RESTPostAPIGuildRoleJSONBody
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIRole>
Inherited from RestRequests.createGuildRole
- Defined in src/rest/RestRequests.ts:1130

createGuildScheduledEvent

createGuildScheduledEvent(guildId, body, reason?, options?): Promise<APIGuildScheduledEvent>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- body: RESTPostAPIGuildScheduledEventJSONBody
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIGuildScheduledEvent>
Inherited from RestRequests.createGuildScheduledEvent
- Defined in src/rest/RestRequests.ts:1359

createGuildSticker

createGuildSticker(guildId, body, reason?, options?): Promise<APISticker>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- body: FormData
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APISticker>
Inherited from RestRequests.createGuildSticker
- Defined in src/rest/RestRequests.ts:1528

createInteractionResponse

createInteractionResponse(interactionId, interactionToken, body, options?): Promise<never>
See
Discord API Reference
Parameters
- interactionId: string
  
  The interaction ID.
- interactionToken: string
  
  The interaction token.
- body: FormData | APIInteractionResponse
  
  Request body.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.createInteractionResponse
- Defined in src/rest/RestRequests.ts:200

createMessage

createMessage(channelId, body, options?): Promise<APIMessage>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- body: FormData | RESTPostAPIChannelMessageJSONBody
  
  Request body.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIMessage>
Inherited from RestRequests.createMessage
- Defined in src/rest/RestRequests.ts:421

createReaction

createReaction(channelId, messageId, emoji, options?): Promise<never>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- messageId: string
  
  The message ID.
- emoji: string
  
  The emoji's identifier.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.createReaction
- Defined in src/rest/RestRequests.ts:444

createStageInstance

createStageInstance(body, reason?, options?): Promise<APIStageInstance>
See
Discord API Reference
Parameters
- body: RESTPostAPIStageInstanceJSONBody
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIStageInstance>
Inherited from RestRequests.createStageInstance
- Defined in src/rest/RestRequests.ts:1445

createWebhook

createWebhook(channelId, body, reason?, options?): Promise<APIWebhook>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- body: RESTPostAPIChannelWebhookJSONBody
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIWebhook>
Inherited from RestRequests.createWebhook
- Defined in src/rest/RestRequests.ts:1652

crosspostMessage

crosspostMessage(channelId, messageId, options?): Promise<APIMessage>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- messageId: string
  
  The message ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIMessage>
Inherited from RestRequests.crosspostMessage
- Defined in src/rest/RestRequests.ts:433

deleteAllReactions

deleteAllReactions(channelId, messageId, options?): Promise<never>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- messageId: string
  
  The message ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.deleteAllReactions
- Defined in src/rest/RestRequests.ts:491

deleteAllReactionsForEmoji

deleteAllReactionsForEmoji(channelId, messageId, emoji, options?): Promise<never>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- messageId: string
  
  The message ID.
- emoji: string
  
  The emoji's identifier.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.deleteAllReactionsForEmoji
- Defined in src/rest/RestRequests.ts:502

deleteAutoModerationRule

deleteAutoModerationRule(guildId, autoModerationRuleId, reason?, options?): Promise<never>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- autoModerationRuleId: string
  
  The auto moderation rule ID.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.deleteAutoModerationRule
- Defined in src/rest/RestRequests.ts:353

deleteChannel

deleteChannel(channelId, reason?, options?): Promise<APIChannel>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIChannel>
Inherited from RestRequests.deleteChannel
- Defined in src/rest/RestRequests.ts:387

deleteChannelPermission

deleteChannelPermission(channelId, overwriteId, reason?, options?): Promise<never>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- overwriteId: string
  
  The overwrite's ID.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.deleteChannelPermission
- Defined in src/rest/RestRequests.ts:588

deleteFollowupMessage

deleteFollowupMessage(applicationId, interactionToken, messageId, options?): Promise<never>
See
Discord API Reference
Parameters
- applicationId: string
  
  The application ID.
- interactionToken: string
  
  The interaction token.
- messageId: string
  
  The message ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.deleteFollowupMessage
- Defined in src/rest/RestRequests.ts:284

deleteGlobalApplicationCommand

deleteGlobalApplicationCommand(applicationId, commandId, options?): Promise<never>
See
Discord API Reference
Parameters
- applicationId: string
  
  The application ID.
- commandId: string
  
  The command ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.deleteGlobalApplicationCommand
- Defined in src/rest/RestRequests.ts:67

deleteGuild

deleteGuild(guildId, options?): Promise<never>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.deleteGuild
- Defined in src/rest/RestRequests.ts:902

deleteGuildApplicationCommand

deleteGuildApplicationCommand(applicationId, guildId, commandId, options?): Promise<never>
See
Discord API Reference
Parameters
- applicationId: string
  
  The application ID.
- guildId: string
  
  The guild ID.
- commandId: string
  
  The command ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.deleteGuildApplicationCommand
- Defined in src/rest/RestRequests.ts:141

deleteGuildEmoji

deleteGuildEmoji(guildId, emoji, reason?, options?): Promise<never>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- emoji: string
  
  The emoji's identifier.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.deleteGuildEmoji
- Defined in src/rest/RestRequests.ts:849

deleteGuildIntegration

deleteGuildIntegration(guildId, integrationId, reason?, options?): Promise<never>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- integrationId: string
  
  The integration ID.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.deleteGuildIntegration
- Defined in src/rest/RestRequests.ts:1247

deleteGuildRole

deleteGuildRole(guildId, roleId, reason?, options?): Promise<never>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- roleId: string
  
  The role ID.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.deleteGuildRole
- Defined in src/rest/RestRequests.ts:1182

deleteGuildScheduledEvent

deleteGuildScheduledEvent(guildId, eventId, options?): Promise<never>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- eventId: string
  
  The event ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.deleteGuildScheduledEvent
- Defined in src/rest/RestRequests.ts:1398

deleteGuildSticker

deleteGuildSticker(guildId, stickerId, reason?, options?): Promise<never>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- stickerId: string
  
  The sticker ID.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.deleteGuildSticker
- Defined in src/rest/RestRequests.ts:1555

deleteInvite

deleteInvite(inviteCode, reason?, options?): Promise<APIInvite>
See
Discord API Reference
Parameters
- inviteCode: string
  
  The invite code.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIInvite>
Inherited from RestRequests.deleteInvite
- Defined in src/rest/RestRequests.ts:1433

deleteMessage

deleteMessage(channelId, messageId, reason?, options?): Promise<never>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- messageId: string
  
  The message ID.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.deleteMessage
- Defined in src/rest/RestRequests.ts:526

deleteOriginalInteractionResponse

deleteOriginalInteractionResponse(applicationId, interactionToken, options?): Promise<never>
See
Discord API Reference
Parameters
- applicationId: string
  
  The application ID.
- interactionToken: string
  
  The interaction token.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.deleteOriginalInteractionResponse
- Defined in src/rest/RestRequests.ts:235

deleteOwnReaction

deleteOwnReaction(channelId, messageId, emoji, options?): Promise<never>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- messageId: string
  
  The message ID.
- emoji: string
  
  The emoji's identifier.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.deleteOwnReaction
- Defined in src/rest/RestRequests.ts:455

deleteStageInstance

deleteStageInstance(channelId, reason?, options?): Promise<never>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.deleteStageInstance
- Defined in src/rest/RestRequests.ts:1479

deleteUserReaction

deleteUserReaction(channelId, messageId, emoji, userId, options?): Promise<never>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- messageId: string
  
  The message ID.
- emoji: string
  
  The emoji's identifier.
- userId: string
  
  The user ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.deleteUserReaction
- Defined in src/rest/RestRequests.ts:467

deleteWebhook

deleteWebhook(webhookId, reason?, options?): Promise<never>
See
Discord API Reference
Parameters
- webhookId: string
  
  The webhook ID.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.deleteWebhook
- Defined in src/rest/RestRequests.ts:1728

deleteWebhookMessage

deleteWebhookMessage(webhookId, token, messageId, threadId?, options?): Promise<never>
See
Discord API Reference
Parameters
- webhookId: string
  
  The webhook ID.
- token: string
  
  The webhook's token.
- messageId: string
  
  The message ID.
- Optional threadId: string
  
  The thread ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.deleteWebhookMessage
- Defined in src/rest/RestRequests.ts:1805

deleteWebhookWithToken

deleteWebhookWithToken(webhookId, token, reason?, options?): Promise<never>
See
Discord API Reference
Parameters
- webhookId: string
  
  The webhook ID.
- token: string
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.deleteWebhookWithToken
- Defined in src/rest/RestRequests.ts:1740

editApplicationCommandPermissions

editApplicationCommandPermissions(applicationId, guildId, commandId, body, options?): Promise<APIGuildApplicationCommandPermissions>
See
Discord API Reference
Parameters
- applicationId: string
  
  The application ID.
- guildId: string
  
  The guild ID.
- commandId: string
  
  The command ID.
- body: RESTPutAPIApplicationCommandPermissionsJSONBody
  
  Request body.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIGuildApplicationCommandPermissions>
Inherited from RestRequests.editApplicationCommandPermissions
- Defined in src/rest/RestRequests.ts:187

editChannelPermissions

editChannelPermissions(channelId, overwriteId, body, reason?, options?): Promise<never>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- overwriteId: string
  
  The overwrite ID.
- body: RESTPutAPIChannelPermissionJSONBody
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.editChannelPermissions
- Defined in src/rest/RestRequests.ts:553

editFollowupMessage

editFollowupMessage(applicationId, interactionToken, messageId, body, options?): Promise<APIMessage>
See
Discord API Reference
Parameters
- applicationId: string
  
  The application ID.
- interactionToken: string
  
  The interaction token.
- messageId: string
  
  The message ID.
- body: FormData | RESTPatchAPIWebhookWithTokenMessageJSONBody
  
  Request body.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIMessage>
Inherited from RestRequests.editFollowupMessage
- Defined in src/rest/RestRequests.ts:271

editGlobalApplicationCommand

editGlobalApplicationCommand(applicationId, commandId, body, options?): Promise<APIApplicationCommand>
See
Discord API Reference
Parameters
- applicationId: string
  
  The application ID.
- commandId: string
  
  The command ID.
- body: RESTPatchAPIApplicationCommandJSONBody
  
  Request body.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIApplicationCommand>
Inherited from RestRequests.editGlobalApplicationCommand
- Defined in src/rest/RestRequests.ts:55

editGuildApplicationCommand

editGuildApplicationCommand(applicationId, guildId, commandId, body, options?): Promise<RESTPatchAPIApplicationGuildCommandResult>
See
Discord API Reference
Parameters
- applicationId: string
  
  The application ID.
- guildId: string
  
  The guild ID.
- commandId: string
  
  The command ID.
- body: RESTPatchAPIApplicationGuildCommandJSONBody
  
  Request body.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTPatchAPIApplicationGuildCommandResult>
Inherited from RestRequests.editGuildApplicationCommand
- Defined in src/rest/RestRequests.ts:128

editMessage

editMessage(channelId, messageId, body, options?): Promise<APIMessage>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- messageId: string
  
  The message ID.
- body: FormData | RESTPatchAPIChannelMessageJSONBody
  
  Request body.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIMessage>
Inherited from RestRequests.editMessage
- Defined in src/rest/RestRequests.ts:513

editOriginalInteractionResponse

editOriginalInteractionResponse(applicationId, interactionToken, body, options?): Promise<APIMessage>
See
Discord API Reference
Parameters
- applicationId: string
  
  The application ID.
- interactionToken: string
  
  The interaction token.
- body: FormData | RESTPatchAPIWebhookWithTokenMessageJSONBody
  
  Request body.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIMessage>
Inherited from RestRequests.editOriginalInteractionResponse
- Defined in src/rest/RestRequests.ts:223

editWebhookMessage

editWebhookMessage(webhookId, token, messageId, body, threadId?, options?): Promise<APIMessage>
See
Discord API Reference
Parameters
- webhookId: string
  
  The webhook ID.
- token: string
  
  The webhook's token.
- messageId: string
  
  The message ID.
- body: FormData | RESTPatchAPIWebhookWithTokenMessageJSONBody
- Optional threadId: string
  
  The thread ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIMessage>
Inherited from RestRequests.editWebhookMessage
- Defined in src/rest/RestRequests.ts:1789

executeWebhook

executeWebhook<T>(webhookId, token, body, wait?, threadId?, options?): Promise<T extends true
? APIMessage
: never>
See
Discord API Reference
Type Parameters
- T extends boolean = false
Parameters
- webhookId: string
  
  The webhook ID.
- token: string
  
  The webhook's token.
- body: FormData | RESTPostAPIWebhookWithTokenJSONBody
  
  Request body.
- Optional wait: T
  
  If the response should wait until server confirmation.
- Optional threadId: string
  
  The thread ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<T extends true
? APIMessage
: never>
Inherited from RestRequests.executeWebhook
- Defined in src/rest/RestRequests.ts:1755

followNewsChannel

followNewsChannel(channelId, body, options?): Promise<APIFollowedChannel>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- body: RESTPostAPIChannelFollowersJSONBody
  
  Request body.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIFollowedChannel>
Inherited from RestRequests.followNewsChannel
- Defined in src/rest/RestRequests.ts:600

getApplicationCommandPermissions

getApplicationCommandPermissions(applicationId, guildId, commandId, options?): Promise<APIGuildApplicationCommandPermissions>
See
Discord API Reference
Parameters
- applicationId: string
  
  The application ID.
- guildId: string
  
  The guild ID.
- commandId: string
  
  The command ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIGuildApplicationCommandPermissions>
Inherited from RestRequests.getApplicationCommandPermissions
- Defined in src/rest/RestRequests.ts:175

getAutoModerationRule

getAutoModerationRule(guildId, autoModerationRuleId, options?): Promise<APIAutoModerationRule>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- autoModerationRuleId: string
  
  The auto moderation rule ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIAutoModerationRule>
Inherited from RestRequests.getAutoModerationRule
- Defined in src/rest/RestRequests.ts:315

getChannel

getChannel(channelId, options?): Promise<APIChannel>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIChannel>
Inherited from RestRequests.getChannel
- Defined in src/rest/RestRequests.ts:364

getChannelInvites

getChannelInvites(channelId, options?): Promise<RESTGetAPIChannelInvitesResult>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIChannelInvitesResult>
Inherited from RestRequests.getChannelInvites
- Defined in src/rest/RestRequests.ts:564

getChannelMessage

getChannelMessage(channelId, messageId, options?): Promise<APIMessage>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- messageId: string
  
  The message ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIMessage>
Inherited from RestRequests.getChannelMessage
- Defined in src/rest/RestRequests.ts:411

getChannelMessages

getChannelMessages(channelId, query, options?): Promise<RESTGetAPIChannelMessagesResult>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- query: RESTGetAPIChannelMessagesQuery
  
  Request query.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIChannelMessagesResult>
Inherited from RestRequests.getChannelMessages
- Defined in src/rest/RestRequests.ts:399

getChannelWebhooks

getChannelWebhooks(channelId, options?): Promise<RESTGetAPIChannelWebhooksResult>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIChannelWebhooksResult>
Inherited from RestRequests.getChannelWebhooks
- Defined in src/rest/RestRequests.ts:1663

getCurrentAuthorizationInformation

getCurrentAuthorizationInformation(options?): Promise<RESTGetAPIOAuth2CurrentAuthorizationResult>
See
Discord API Reference
Parameters
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIOAuth2CurrentAuthorizationResult>
Inherited from RestRequests.getCurrentAuthorizationInformation
- Defined in src/rest/RestRequests.ts:1840

getCurrentBotApplicationInformation

getCurrentBotApplicationInformation(options?): Promise<RESTGetAPIOAuth2CurrentApplicationResult>
See
Discord API Reference
Parameters
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIOAuth2CurrentApplicationResult>
Inherited from RestRequests.getCurrentBotApplicationInformation
- Defined in src/rest/RestRequests.ts:1832

getCurrentUser

getCurrentUser(options?): Promise<APIUser>
See
Discord API Reference
Parameters
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIUser>
Inherited from RestRequests.getCurrentUser
- Defined in src/rest/RestRequests.ts:1565

getCurrentUserGuildMember

getCurrentUserGuildMember(guildId, options?): Promise<APIGuildMember>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIGuildMember>
Inherited from RestRequests.getCurrentUserGuildMember
- Defined in src/rest/RestRequests.ts:1605

getCurrentUserGuilds

getCurrentUserGuilds(query, options?): Promise<RESTGetAPICurrentUserGuildsResult>
See
Discord API Reference
Parameters
- query: RESTGetAPICurrentUserGuildsQuery
  
  Request query.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPICurrentUserGuildsResult>
Inherited from RestRequests.getCurrentUserGuilds
- Defined in src/rest/RestRequests.ts:1594

getFollowupMessage

getFollowupMessage(applicationId, interactionToken, messageId, options?): Promise<APIMessage>
See
Discord API Reference
Parameters
- applicationId: string
  
  The application ID.
- interactionToken: string
  
  The interaction token.
- messageId: string
  
  The message ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIMessage>
Inherited from RestRequests.getFollowupMessage
- Defined in src/rest/RestRequests.ts:259

getGateway

getGateway(options?): Promise<APIGatewayInfo>
See
Discord API Reference
Parameters
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIGatewayInfo>
Inherited from RestRequests.getGateway
- Defined in src/rest/RestRequests.ts:1816

getGatewayBot

getGatewayBot(options?): Promise<APIGatewayBotInfo>
See
Discord API Reference
Parameters
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIGatewayBotInfo>
Inherited from RestRequests.getGatewayBot
- Defined in src/rest/RestRequests.ts:1824

getGlobalApplicationCommand

getGlobalApplicationCommand(applicationId, commandId, options?): Promise<APIApplicationCommand>
See
Discord API Reference
Parameters
- applicationId: string
  
  The application ID.
- commandId: string
  
  The command ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIApplicationCommand>
Inherited from RestRequests.getGlobalApplicationCommand
- Defined in src/rest/RestRequests.ts:44

getGlobalApplicationCommands

getGlobalApplicationCommands(applicationId, query, options?): Promise<RESTGetAPIApplicationCommandsResult>
See
Discord API Reference
Parameters
- applicationId: string
  
  The application ID.
- query: RESTGetAPIApplicationCommandsQuery
  
  Request query.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIApplicationCommandsResult>
Inherited from RestRequests.getGlobalApplicationCommands
- Defined in src/rest/RestRequests.ts:20

getGuild

getGuild(guildId, options?): Promise<APIGuild>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIGuild>
Inherited from RestRequests.getGuild
- Defined in src/rest/RestRequests.ts:871

getGuildApplicationCommand

getGuildApplicationCommand(applicationId, guildId, commandId, options?): Promise<RESTGetAPIApplicationGuildCommandResult>
See
Discord API Reference
Parameters
- applicationId: string
  
  The application ID.
- guildId: string
  
  The guild ID.
- commandId: string
  
  The command ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIApplicationGuildCommandResult>
Inherited from RestRequests.getGuildApplicationCommand
- Defined in src/rest/RestRequests.ts:116

getGuildApplicationCommandPermissions

getGuildApplicationCommandPermissions(applicationId, guildId, options?): Promise<RESTGetAPIGuildApplicationCommandsPermissionsResult>
See
Discord API Reference
Parameters
- applicationId: string
  
  The application ID.
- guildId: string
  
  The guild ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIGuildApplicationCommandsPermissionsResult>
Inherited from RestRequests.getGuildApplicationCommandPermissions
- Defined in src/rest/RestRequests.ts:164

getGuildApplicationCommands

getGuildApplicationCommands(applicationId, guildId, query, options?): Promise<RESTGetAPIApplicationGuildCommandsResult>
See
Discord API Reference
Parameters
- applicationId: string
  
  The application ID.
- guildId: string
  
  The guild ID.
- query: RESTGetAPIApplicationCommandsQuery
  
  Request query.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIApplicationGuildCommandsResult>
Inherited from RestRequests.getGuildApplicationCommands
- Defined in src/rest/RestRequests.ts:90

getGuildAuditLog

getGuildAuditLog(guildId, query, options?): Promise<APIAuditLog>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- query: RESTGetAPIAuditLogQuery
  
  Request query.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIAuditLog>
Inherited from RestRequests.getGuildAuditLog
- Defined in src/rest/RestRequests.ts:294

getGuildBan

getGuildBan(guildId, userId, options?): Promise<APIBan>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- userId: string
  
  The user ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIBan>
Inherited from RestRequests.getGuildBan
- Defined in src/rest/RestRequests.ts:1083

getGuildBans

getGuildBans(guildId, query, options?): Promise<RESTGetAPIGuildBansResult>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- query: RESTGetAPIGuildBansQuery
  
  Request query.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIGuildBansResult>
Inherited from RestRequests.getGuildBans
- Defined in src/rest/RestRequests.ts:1071

getGuildChannels

getGuildChannels(guildId, options?): Promise<RESTGetAPIGuildChannelsResult>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIGuildChannelsResult>
Inherited from RestRequests.getGuildChannels
- Defined in src/rest/RestRequests.ts:911

getGuildEmoji

getGuildEmoji(guildId, emoji, options?): Promise<APIEmoji>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- emoji: string
  
  The emoji's identifier.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIEmoji>
Inherited from RestRequests.getGuildEmoji
- Defined in src/rest/RestRequests.ts:812

getGuildIntegrations

getGuildIntegrations(guildId, options?): Promise<RESTGetAPIGuildIntegrationsResult>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIGuildIntegrationsResult>
Inherited from RestRequests.getGuildIntegrations
- Defined in src/rest/RestRequests.ts:1236

getGuildInvites

getGuildInvites(guildId, options?): Promise<RESTGetAPIGuildInvitesResult>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIGuildInvitesResult>
Inherited from RestRequests.getGuildInvites
- Defined in src/rest/RestRequests.ts:1227

getGuildMember

getGuildMember(guildId, userId, options?): Promise<APIGuildMember>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- userId: string
  
  The user ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIGuildMember>
Inherited from RestRequests.getGuildMember
- Defined in src/rest/RestRequests.ts:956

getGuildPreview

getGuildPreview(guildId, options?): Promise<APIGuildPreview>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIGuildPreview>
Inherited from RestRequests.getGuildPreview
- Defined in src/rest/RestRequests.ts:880

getGuildPruneCount

getGuildPruneCount(guildId, query, options?): Promise<RESTGetAPIGuildPruneCountResult>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- query: RESTGetAPIGuildPruneCountQuery
  
  Request query.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIGuildPruneCountResult>
Inherited from RestRequests.getGuildPruneCount
- Defined in src/rest/RestRequests.ts:1194

getGuildRoles

getGuildRoles(guildId, options?): Promise<RESTGetAPIGuildRolesResult>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIGuildRolesResult>
Inherited from RestRequests.getGuildRoles
- Defined in src/rest/RestRequests.ts:1119

getGuildScheduledEvent

getGuildScheduledEvent(guildId, eventId, query, options?): Promise<APIGuildScheduledEvent>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- eventId: string
  
  The event ID.
- query: RESTGetAPIGuildScheduledEventQuery
  
  Request query.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIGuildScheduledEvent>
Inherited from RestRequests.getGuildScheduledEvent
- Defined in src/rest/RestRequests.ts:1372

getGuildScheduledEventUsers

getGuildScheduledEventUsers(guildId, eventId, query, options?): Promise<RESTGetAPIGuildScheduledEventUsersResult>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- eventId: string
  
  The event ID.
- query: RESTGetAPIGuildScheduledEventUsersQuery
  
  Request query.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIGuildScheduledEventUsersResult>
Inherited from RestRequests.getGuildScheduledEventUsers
- Defined in src/rest/RestRequests.ts:1409

getGuildSticker

getGuildSticker(guildId, stickerId, options?): Promise<APISticker>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- stickerId: string
  
  The sticker ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APISticker>
Inherited from RestRequests.getGuildSticker
- Defined in src/rest/RestRequests.ts:1517

getGuildVanityURL

getGuildVanityURL(guildId, options?): Promise<RESTGetAPIGuildVanityUrlResult>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIGuildVanityUrlResult>
Inherited from RestRequests.getGuildVanityURL
- Defined in src/rest/RestRequests.ts:1289

getGuildVoiceRegions

getGuildVoiceRegions(guildId, options?): Promise<RESTGetAPIGuildVoiceRegionsResult>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIGuildVoiceRegionsResult>
Inherited from RestRequests.getGuildVoiceRegions
- Defined in src/rest/RestRequests.ts:1218

getGuildWebhooks

getGuildWebhooks(guildId, options?): Promise<RESTGetAPIGuildWebhooksResult>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIGuildWebhooksResult>
Inherited from RestRequests.getGuildWebhooks
- Defined in src/rest/RestRequests.ts:1672

getGuildWelcomeScreen

getGuildWelcomeScreen(guildId, options?): Promise<APIGuildWelcomeScreen>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIGuildWelcomeScreen>
Inherited from RestRequests.getGuildWelcomeScreen
- Defined in src/rest/RestRequests.ts:1298

getGuildWidget

getGuildWidget(guildId, options?): Promise<APIGuildWidget>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIGuildWidget>
Inherited from RestRequests.getGuildWidget
- Defined in src/rest/RestRequests.ts:1280

getGuildWidgetSettings

getGuildWidgetSettings(guildId, options?): Promise<APIGuildWidgetSettings>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIGuildWidgetSettings>
Inherited from RestRequests.getGuildWidgetSettings
- Defined in src/rest/RestRequests.ts:1258

getInvite

getInvite(inviteCode, query, options?): Promise<APIInvite>
See
Discord API Reference
Parameters
- inviteCode: string
  
  The invite code.
- query: RESTGetAPIInviteQuery
  
  Request query.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIInvite>
Inherited from RestRequests.getInvite
- Defined in src/rest/RestRequests.ts:1421

getOriginalInteractionResponse

getOriginalInteractionResponse(applicationId, interactionToken, options?): Promise<APIMessage>
See
Discord API Reference
Parameters
- applicationId: string
  
  The application ID.
- interactionToken: string
  
  The interaction token.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIMessage>
Inherited from RestRequests.getOriginalInteractionResponse
- Defined in src/rest/RestRequests.ts:212

getPinnedMessages

getPinnedMessages(channelId, options?): Promise<RESTGetAPIChannelPinsResult>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIChannelPinsResult>
Inherited from RestRequests.getPinnedMessages
- Defined in src/rest/RestRequests.ts:620

getReactions

getReactions(channelId, messageId, emoji, query, options?): Promise<RESTGetAPIChannelMessageReactionUsersResult>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- messageId: string
  
  The message ID.
- emoji: string
  
  The emoji's identifier.
- query: RESTGetAPIChannelMessageReactionUsersQuery
  
  Request query.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIChannelMessageReactionUsersResult>
Inherited from RestRequests.getReactions
- Defined in src/rest/RestRequests.ts:479

getStageInstance

getStageInstance(channelId, options?): Promise<APIStageInstance>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIStageInstance>
Inherited from RestRequests.getStageInstance
- Defined in src/rest/RestRequests.ts:1456

getSticker

getSticker(stickerId, options?): Promise<APISticker>
See
Discord API Reference
Parameters
- stickerId: string
  
  The sticker ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APISticker>
Inherited from RestRequests.getSticker
- Defined in src/rest/RestRequests.ts:1490

getUser

getUser(userId, options?): Promise<APIUser>
See
Discord API Reference
Parameters
- userId: string
  
  The user ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIUser>
Inherited from RestRequests.getUser
- Defined in src/rest/RestRequests.ts:1574

getUserConnections

getUserConnections(options?): Promise<RESTGetAPICurrentUserConnectionsResult>
See
Discord API Reference
Parameters
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPICurrentUserConnectionsResult>
Inherited from RestRequests.getUserConnections
- Defined in src/rest/RestRequests.ts:1633

getWebhook

getWebhook(webhookId, options?): Promise<APIWebhook>
See
Discord API Reference
Parameters
- webhookId: string
  
  The webhook ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIWebhook>
Inherited from RestRequests.getWebhook
- Defined in src/rest/RestRequests.ts:1681

getWebhookMessage

getWebhookMessage(webhookId, token, messageId, threadId?, options?): Promise<APIMessage>
See
Discord API Reference
Parameters
- webhookId: string
  
  The webhook ID.
- token: string
  
  The webhook's token.
- messageId: string
  
  The message ID.
- Optional threadId: string
  
  The thread ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIMessage>
Inherited from RestRequests.getWebhookMessage
- Defined in src/rest/RestRequests.ts:1774

getWebhookWithToken

getWebhookWithToken(webhookId, token, options?): Promise<RESTGetAPIWebhookWithTokenResult>
See
Discord API Reference
Parameters
- webhookId: string
  
  The webhook ID.
- token: string
  
  The webhook's token.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIWebhookWithTokenResult>
Inherited from RestRequests.getWebhookWithToken
- Defined in src/rest/RestRequests.ts:1691

groupDMAddRecipient

groupDMAddRecipient(channelId, userId, body, options?): Promise<unknown>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- userId: string
  
  The user ID.
- body: RESTPutAPIChannelRecipientJSONBody
  
  Request body.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<unknown>
Inherited from RestRequests.groupDMAddRecipient
- Defined in src/rest/RestRequests.ts:657

groupDMRemoveRecipient

groupDMRemoveRecipient(channelId, userId, options?): Promise<unknown>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- userId: string
  
  The user ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<unknown>
Inherited from RestRequests.groupDMRemoveRecipient
- Defined in src/rest/RestRequests.ts:669

joinThread

joinThread(threadId, options?): Promise<never>
See
Discord API Reference
Parameters
- threadId: string
  
  The thread ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.joinThread
- Defined in src/rest/RestRequests.ts:719

leaveGuild

leaveGuild(guildId, options?): Promise<never>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.leaveGuild
- Defined in src/rest/RestRequests.ts:1614

leaveThread

leaveThread(threadId, options?): Promise<never>
See
Discord API Reference
Parameters
- threadId: string
  
  The thread ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.leaveThread
- Defined in src/rest/RestRequests.ts:738

listActiveThreads

listActiveThreads(guildId, options?): Promise<APIThreadList>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIThreadList>
Inherited from RestRequests.listActiveThreads
- Defined in src/rest/RestRequests.ts:946

listAutoModerationRulesForGuild

listAutoModerationRulesForGuild(guildId, options?): Promise<RESTGetAPIAutoModerationRulesResult>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIAutoModerationRulesResult>
Inherited from RestRequests.listAutoModerationRulesForGuild
- Defined in src/rest/RestRequests.ts:305

listGuildEmojis

listGuildEmojis(guildId, options?): Promise<RESTGetAPIGuildEmojisResult>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIGuildEmojisResult>
Inherited from RestRequests.listGuildEmojis
- Defined in src/rest/RestRequests.ts:802

listGuildMembers

listGuildMembers(guildId, query, options?): Promise<RESTGetAPIGuildMembersResult>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- query: RESTGetAPIGuildMembersQuery
  
  Request query.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIGuildMembersResult>
Inherited from RestRequests.listGuildMembers
- Defined in src/rest/RestRequests.ts:966

listGuildStickers

listGuildStickers(guildId, options?): Promise<RESTGetAPIGuildStickersResult>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIGuildStickersResult>
Inherited from RestRequests.listGuildStickers
- Defined in src/rest/RestRequests.ts:1507

listJoinedPrivateArchivedThreads

listJoinedPrivateArchivedThreads(channelId, query, options?): Promise<RESTGetAPIChannelUsersThreadsArchivedResult>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- query: RESTGetAPIChannelThreadsArchivedQuery
  
  Request query.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIChannelUsersThreadsArchivedResult>
Inherited from RestRequests.listJoinedPrivateArchivedThreads
- Defined in src/rest/RestRequests.ts:791

listNitroStickerPacks

listNitroStickerPacks(options?): Promise<RESTGetNitroStickerPacksResult>
See
Discord API Reference
Parameters
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetNitroStickerPacksResult>
Inherited from RestRequests.listNitroStickerPacks
- Defined in src/rest/RestRequests.ts:1498

listPrivateArchivedThreads

listPrivateArchivedThreads(channelId, query, options?): Promise<RESTGetAPIChannelUsersThreadsArchivedResult>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- query: RESTGetAPIChannelThreadsArchivedQuery
  
  Request query.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIChannelUsersThreadsArchivedResult>
Inherited from RestRequests.listPrivateArchivedThreads
- Defined in src/rest/RestRequests.ts:779

listPublicArchivedThreads

listPublicArchivedThreads(channelId, query, options?): Promise<RESTGetAPIChannelUsersThreadsArchivedResult>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- query: RESTGetAPIChannelThreadsArchivedQuery
  
  Request query.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIChannelUsersThreadsArchivedResult>
Inherited from RestRequests.listPublicArchivedThreads
- Defined in src/rest/RestRequests.ts:767

listScheduledEventsForGuild

listScheduledEventsForGuild(guildId, query, options?): Promise<RESTGetAPIGuildScheduledEventsResult>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- query: RESTGetAPIGuildScheduledEventsQuery
  
  Request query.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIGuildScheduledEventsResult>
Inherited from RestRequests.listScheduledEventsForGuild
- Defined in src/rest/RestRequests.ts:1346

listThreadMembers

listThreadMembers(threadId, options?): Promise<RESTGetAPIChannelThreadMembersResult>
See
Discord API Reference
Parameters
- threadId: string
  
  The thread ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIChannelThreadMembersResult>
Inherited from RestRequests.listThreadMembers
- Defined in src/rest/RestRequests.ts:757

listVoiceRegions

listVoiceRegions(options?): Promise<RESTGetAPIVoiceRegionsResult>
See
Discord API Reference
Parameters
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIVoiceRegionsResult>
Inherited from RestRequests.listVoiceRegions
- Defined in src/rest/RestRequests.ts:1641

make

make(method, route, options): Promise<RestInternalRestResponse>
Internal
The internal rest make method. Used by rest buckets, and the Rest#request() method if rate limits are turned off. Only use this method if you know exactly what you are doing.
Parameters
- method: RestMethod
  
  The request's method.
- route: `/${string}`
  
  The requests's route, relative to the base Discord API URL. (Example: /channels/123456789000000000)
- options: RestRequestData
  
  Request options.
Returns Promise<RestInternalRestResponse>
The full undici response.
- Defined in src/rest/Rest.ts:194

modifyAutoModerationRule

modifyAutoModerationRule(guildId, autoModerationRuleId, body, reason?, options?): Promise<APIAutoModerationRule>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- autoModerationRuleId: string
  
  The auto moderation rule ID.
- body: RESTPatchAPIAutoModerationRuleJSONBody
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIAutoModerationRule>
Inherited from RestRequests.modifyAutoModerationRule
- Defined in src/rest/RestRequests.ts:340

modifyChannel

modifyChannel(channelId, body, reason?, options?): Promise<APIChannel>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- body: RESTPatchAPIChannelJSONBody
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIChannel>
Inherited from RestRequests.modifyChannel
- Defined in src/rest/RestRequests.ts:375

modifyCurrentMember

modifyCurrentMember(guildId, body, reason?, options?): Promise<APIGuildMember>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- body: RESTPatchAPICurrentGuildMemberJSONBody
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIGuildMember>
Inherited from RestRequests.modifyCurrentMember
- Defined in src/rest/RestRequests.ts:1018

modifyCurrentUser

modifyCurrentUser(body, options?): Promise<APIUser>
See
Discord API Reference
Parameters
- body: RESTPatchAPICurrentUserJSONBody
  
  Request body.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIUser>
Inherited from RestRequests.modifyCurrentUser
- Defined in src/rest/RestRequests.ts:1583

modifyCurrentUserVoiceState

modifyCurrentUserVoiceState(guildId, body, options?): Promise<never>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- body: RESTPatchAPIGuildVoiceStateCurrentMemberJSONBody
  
  Request body.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.modifyCurrentUserVoiceState
- Defined in src/rest/RestRequests.ts:1321

modifyGuild

modifyGuild(guildId, body, reason?, options?): Promise<APIGuild>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- body: RESTPatchAPIGuildJSONBody
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIGuild>
Inherited from RestRequests.modifyGuild
- Defined in src/rest/RestRequests.ts:891

modifyGuildChannelPositions

modifyGuildChannelPositions(guildId, body, reason?, options?): Promise<never>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- body: RESTPatchAPIGuildChannelPositionsJSONBody
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.modifyGuildChannelPositions
- Defined in src/rest/RestRequests.ts:935

modifyGuildEmoji

modifyGuildEmoji(guildId, body, reason?, options?): Promise<APIEmoji>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- body: RESTPatchAPIGuildEmojiJSONBody
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIEmoji>
Inherited from RestRequests.modifyGuildEmoji
- Defined in src/rest/RestRequests.ts:836

modifyGuildMFALevel

modifyGuildMFALevel(guildId, body, options?): Promise<RESTPostAPIGuildsMFAJSONBody>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- body: RESTPostAPIGuildsMFAJSONBody
  
  Request body.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTPostAPIGuildsMFAJSONBody>
Inherited from RestRequests.modifyGuildMFALevel
- Defined in src/rest/RestRequests.ts:1169

modifyGuildMember

modifyGuildMember(guildId, userId, body, reason?, options?): Promise<APIGuildMember>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- userId: string
  
  The user ID.
- body: RESTPatchAPIGuildMemberJSONBody
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIGuildMember>
Inherited from RestRequests.modifyGuildMember
- Defined in src/rest/RestRequests.ts:1005

modifyGuildRole

modifyGuildRole(guildId, roleId, body, reason?, options?): Promise<APIRole>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- roleId: string
  
  The role ID.
- body: RESTPatchAPIGuildRoleJSONBody
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIRole>
Inherited from RestRequests.modifyGuildRole
- Defined in src/rest/RestRequests.ts:1157

modifyGuildRolePositions

modifyGuildRolePositions(guildId, body, reason?, options?): Promise<RESTPatchAPIGuildRolePositionsResult>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- body: RESTPatchAPIGuildRolePositionsJSONBody
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTPatchAPIGuildRolePositionsResult>
Inherited from RestRequests.modifyGuildRolePositions
- Defined in src/rest/RestRequests.ts:1143

modifyGuildScheduledEvent

modifyGuildScheduledEvent(guildId, eventId, body, reason?, options?): Promise<APIGuildScheduledEvent>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- eventId: string
  
  The event ID.
- body: RESTPatchAPIGuildScheduledEventJSONBody
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIGuildScheduledEvent>
Inherited from RestRequests.modifyGuildScheduledEvent
- Defined in src/rest/RestRequests.ts:1386

modifyGuildSticker

modifyGuildSticker(guildId, stickerId, body, reason?, options?): Promise<APISticker>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- stickerId: string
  
  The sticker ID.
- body: RESTPatchAPIGuildStickerJSONBody
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APISticker>
Inherited from RestRequests.modifyGuildSticker
- Defined in src/rest/RestRequests.ts:1542

modifyGuildWelcomeScreen

modifyGuildWelcomeScreen(guildId, body, reason?, options?): Promise<APIGuildWelcomeScreen>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- body: RESTPatchAPIGuildWelcomeScreenJSONBody
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIGuildWelcomeScreen>
Inherited from RestRequests.modifyGuildWelcomeScreen
- Defined in src/rest/RestRequests.ts:1309

modifyGuildWidget

modifyGuildWidget(guildId, body, reason?, options?): Promise<APIGuildWidgetSettings>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- body: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<Partial<APIGuildWidgetSettings>>
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIGuildWidgetSettings>
Inherited from RestRequests.modifyGuildWidget
- Defined in src/rest/RestRequests.ts:1269

modifyStageInstance

modifyStageInstance(channelId, body, reason?, options?): Promise<APIStageInstance>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- body: RESTPatchAPIStageInstanceJSONBody
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIStageInstance>
Inherited from RestRequests.modifyStageInstance
- Defined in src/rest/RestRequests.ts:1467

modifyUserVoiceState

modifyUserVoiceState(guildId, userId, body, options?): Promise<never>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- userId: string
  
  The user ID.
- body: RESTPatchAPIGuildVoiceStateUserJSONBody
  
  Request body.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.modifyUserVoiceState
- Defined in src/rest/RestRequests.ts:1334

modifyWebhook

modifyWebhook(webhookId, body, reason?, options?): Promise<APIWebhook>
See
Discord API Reference
Parameters
- webhookId: string
  
  The webhook ID.
- body: RESTPatchAPIWebhookJSONBody
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIWebhook>
Inherited from RestRequests.modifyWebhook
- Defined in src/rest/RestRequests.ts:1702

modifyWebhookWithToken

modifyWebhookWithToken(webhookId, token, body, reason?, options?): Promise<RESTGetAPIWebhookWithTokenResult>
See
Discord API Reference
Parameters
- webhookId: string
  
  The webhook ID.
- token: string
  
  The webhook's token.
- body: RESTPatchAPIWebhookWithTokenJSONBody
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIWebhookWithTokenResult>
Inherited from RestRequests.modifyWebhookWithToken
- Defined in src/rest/RestRequests.ts:1716

pinMessage

pinMessage(channelId, messageId, reason?, options?): Promise<never>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- messageId: string
  
  The message ID.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.pinMessage
- Defined in src/rest/RestRequests.ts:631

removeGuildBan

removeGuildBan(guildId, userId, reason?, options?): Promise<never>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- userId: string
  
  The user ID.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.removeGuildBan
- Defined in src/rest/RestRequests.ts:1108

removeGuildMember

removeGuildMember(guildId, userId, reason?, options?): Promise<never>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- userId: string
  
  The user ID.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.removeGuildMember
- Defined in src/rest/RestRequests.ts:1059

removeGuildMemberRole

removeGuildMemberRole(guildId, userId, roleId, reason?, options?): Promise<never>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- userId: string
  
  The user ID.
- roleId: string
  
  The role ID.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.removeGuildMemberRole
- Defined in src/rest/RestRequests.ts:1046

removeThreadMember

removeThreadMember(threadId, userId, options?): Promise<never>
See
Discord API Reference
Parameters
- threadId: string
  
  The thread ID.
- userId: string
  
  The user ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.removeThreadMember
- Defined in src/rest/RestRequests.ts:748

request

request(method, route, options?): Promise<any>
Make a rest request.
Parameters
- method: RestMethod
  
  The request's method.
- route: `/${string}`
  
  The requests's route, relative to the base Discord API URL. (Example: /channels/123456789000000000)
- options: RestRequestData = {}
  
  Request options.
Returns Promise<any>
Response body.
Overrides RestRequests.request
- Defined in src/rest/Rest.ts:168

searchGuildMembers

searchGuildMembers(guildId, query, options?): Promise<RESTGetAPIGuildMembersSearchResult>
See
Discord API Reference
Parameters
- guildId: string
  
  The guild ID.
- query: RESTGetAPIGuildMembersSearchQuery
  
  Request query.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<RESTGetAPIGuildMembersSearchResult>
Inherited from RestRequests.searchGuildMembers
- Defined in src/rest/RestRequests.ts:978

startThreadFromMessage

startThreadFromMessage(channelId, messageId, body, reason?, options?): Promise<APIChannel>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- messageId: string
  
  The message ID.
- body: RESTPostAPIChannelMessagesThreadsJSONBody
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIChannel>
Inherited from RestRequests.startThreadFromMessage
- Defined in src/rest/RestRequests.ts:681

startThreadInForumChannel

startThreadInForumChannel(channelId, body, reason?, options?): Promise<APIChannel>
See
Discord API Reference

Todo
PR in discord-api-types for proper return type.
Parameters
- channelId: string
  
  The channel ID.
- body: FormData | RESTPostAPIGuildForumThreadsJSONBody
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIChannel>
Inherited from RestRequests.startThreadInForumChannel
- Defined in src/rest/RestRequests.ts:708

startThreadWithoutMessage

startThreadWithoutMessage(channelId, body, reason?, options?): Promise<APIChannel>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- body: RESTPostAPIChannelThreadsJSONBody
  
  Request body.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<APIChannel>
Inherited from RestRequests.startThreadWithoutMessage
- Defined in src/rest/RestRequests.ts:694

sweepBuckets

sweepBuckets(): void
Cleans up inactive buckets without active local rate limits. Useful for manually preventing potentially fatal memory leaks in large bots.

Returns void
- Defined in src/rest/Rest.ts:236

triggerTypingIndicator

triggerTypingIndicator(channelId, options?): Promise<never>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.triggerTypingIndicator
- Defined in src/rest/RestRequests.ts:611

unpinMessage

unpinMessage(channelId, messageId, reason?, options?): Promise<never>
See
Discord API Reference
Parameters
- channelId: string
  
  The channel ID.
- messageId: string
  
  The message ID.
- Optional reason: string
  
  The value for the X-Audit-Log-Reason header.
- Optional options: RestRequestOptions
  
  Request options.
Returns Promise<never>
Inherited from RestRequests.unpinMessage
- Defined in src/rest/RestRequests.ts:644

Class Rest

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

token: string

options: RestOptions & RestRequestOptions = {}

logCallback: LogCallback = ...

Optional logThisArg: any

Returns Rest

Properties

bucketSweepInterval

buckets

globalLeft

globalResetAt

Readonly options

responseCodeTally

routeHashCache

Readonly system

Accessors

responseCodeRatio

Returns Record<string, number>

Methods

addGuildMember

See

Parameters

guildId: string

userId: string

body: RESTPutAPIGuildMemberJSONBody

Optional options: RestRequestOptions

Returns Promise<APIGuildMember>

addGuildMemberRole

See

Parameters

guildId: string

userId: string

roleId: string

Optional reason: string

Optional options: RestRequestOptions

Returns Promise<never>

addThreadMember

See

Parameters

threadId: string

userId: string

Optional options: RestRequestOptions

Returns Promise<never>

beginGuildPrune

See

Parameters

guildId: string

body: RESTPostAPIGuildPruneJSONBody

Optional reason: string

Optional options: RestRequestOptions

Returns Promise<RESTPostAPIGuildPruneResult>

bulkDeleteMessages

See

Parameters

channelId: string

body: RESTPostAPIChannelMessagesBulkDeleteJSONBody

Optional reason: string

Optional options: RestRequestOptions

Returns Promise<never>

bulkOverwriteGlobalApplicationCommands

See

Parameters

applicationId: string

body: RESTPutAPIApplicationCommandsJSONBody

Optional options: RestRequestOptions

Returns Promise<RESTPutAPIApplicationCommandsResult>

bulkOverwriteGuildApplicationCommands

See

Parameters

applicationId: string

guildId: string

`Optional` logThisArg: any

`Readonly` options

`Readonly` system

`Optional` options: RestRequestOptions

`Optional` reason: string

`Optional` options: RestRequestOptions

`Optional` options: RestRequestOptions

`Optional` reason: string

`Optional` options: RestRequestOptions

`Optional` reason: string

`Optional` options: RestRequestOptions

`Optional` options: RestRequestOptions

`Optional` options: RestRequestOptions

`Optional` reason: string

`Optional` options: RestRequestOptions

`Optional` reason: string

`Optional` options: RestRequestOptions

`Optional` options: RestRequestOptions

`Optional` options: RestRequestOptions

`Optional` options: RestRequestOptions

`Optional` options: RestRequestOptions

`Optional` options: RestRequestOptions

`Optional` reason: string

`Optional` options: RestRequestOptions

`Optional` reason: string

`Optional` options: RestRequestOptions