Class Rest

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

Hierarchy

RestRequests
- Rest

Index

Constructors

Constructors

constructor

new Rest(
    token: string,
    options?: RestOptions & RestRequestOptions,
    logCallback?: LogCallback,
    logThisArg?: any,
): 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.
- OptionallogThisArg: any
  A value to use as this in the logCallback.
Returns Rest
Overrides RestRequests.constructor
- Defined in src/rest/Rest.ts:125

Properties

buckets

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

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

bucketSweepInterval

bucketSweepInterval: null | Timer = null

The interval used for sweeping inactive buckets.

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 & { version: number }

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}`
        | `PUT;${string}`
        | `DELETE;${string}`
        | `PATCH;${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.

`Static` `Readonly`API_VERSION

API_VERSION: 10

The default REST API version used.

`Static` `Readonly`BASE_URL

BASE_URL: "https://discord.com/api" = ...

Discord's base API URL.

See

Discord API Reference

`Static` `Readonly`ERROR_KEY

ERROR_KEY: "_errors" = ...

The ending key where an error array is defined on a rest error.

`Static` `Readonly`OLD_MESSAGE_THRESHOLD

OLD_MESSAGE_THRESHOLD: 1209600000

The amount of milliseconds after a message is created where it causes issues with rate limiting.

See

GitHub Issue

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

Methods

addGuildMember

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

addGuildMemberRole

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

addThreadMember

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

beginGuildPrune

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

bulkDeleteMessages

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

bulkOverwriteGlobalApplicationCommands

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

bulkOverwriteGuildApplicationCommands

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

createAutoModerationRule

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

createChannelInvite

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

createDM

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

createFollowupMessage

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

createGlobalApplicationCommand

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

createGuild

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

createGuildApplicationCommand

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

createGuildBan

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

createGuildChannel

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

createGuildEmoji

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

createGuildRole

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

createGuildScheduledEvent

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

createGuildSticker

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

createInteractionResponse

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

createMessage

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

createReaction

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

createStageInstance

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

createWebhook

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

crosspostMessage

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

deleteAllReactions

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

deleteAllReactionsForEmoji

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

deleteAutoModerationRule

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

deleteChannel

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

deleteChannelPermission

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

deleteFollowupMessage

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

deleteGlobalApplicationCommand

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

deleteGuild

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

deleteGuildApplicationCommand

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

deleteGuildEmoji

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

deleteGuildIntegration

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

deleteGuildRole

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

deleteGuildScheduledEvent

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

deleteGuildSticker

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

deleteInvite

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

deleteMessage

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

deleteOriginalInteractionResponse

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

deleteOwnReaction

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

deleteStageInstance

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

deleteUserReaction

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

deleteWebhook

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

deleteWebhookMessage

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

deleteWebhookWithToken

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

editApplicationCommandPermissions

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

editChannelPermissions

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

editFollowupMessage

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

editGlobalApplicationCommand

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

editGuildApplicationCommand

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

editMessage

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

editOriginalInteractionResponse

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

editWebhookMessage

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

executeWebhook

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

followNewsChannel

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

getApplicationCommandPermissions

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

getAutoModerationRule

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

getChannel

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

getChannelInvites

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

getChannelMessage

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

getChannelMessages

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

getChannelWebhooks

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

getCurrentAuthorizationInformation

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

getCurrentBotApplicationInformation

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

getCurrentUser

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

getCurrentUserGuildMember

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

getCurrentUserGuilds

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

getFollowupMessage

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

getGateway

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

getGatewayBot

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

getGlobalApplicationCommand

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

getGlobalApplicationCommands

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

getGuild

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

getGuildApplicationCommand

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

getGuildApplicationCommandPermissions

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

getGuildApplicationCommands

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

getGuildAuditLog

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

getGuildBan

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

getGuildBans

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

getGuildChannels

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

getGuildEmoji

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

getGuildIntegrations

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

getGuildInvites

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

getGuildMember

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

getGuildPreview

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

getGuildPruneCount

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

getGuildRoles

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

getGuildScheduledEvent

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

getGuildScheduledEventUsers

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

getGuildSticker

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

getGuildVanityURL

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

getGuildVoiceRegions

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

getGuildWebhooks

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

getGuildWelcomeScreen

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

getGuildWidget

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

getGuildWidgetSettings

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

getInvite

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

getOriginalInteractionResponse

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

getPinnedMessages

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

getReactions

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

getStageInstance

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

getSticker

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

getUser

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

getUserConnections

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

getWebhook

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

getWebhookMessage

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

getWebhookWithToken

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

groupDMAddRecipient

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

groupDMRemoveRecipient

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

joinThread

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

leaveGuild

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

leaveThread

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

listActiveThreads

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

listAutoModerationRulesForGuild

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

listGuildEmojis

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

listGuildMembers

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

listGuildStickers

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

listJoinedPrivateArchivedThreads

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

listNitroStickerPacks

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

listPrivateArchivedThreads

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

listPublicArchivedThreads

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

listScheduledEventsForGuild

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

listThreadMembers

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

listVoiceRegions

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

make

make(
    method: RestMethod,
    route: `/${string}`,
    options: RestRequestData,
): Promise<RestMakeResponse>
Low level 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<RestMakeResponse>
The full response.
- Defined in src/rest/Rest.ts:230

modifyAutoModerationRule

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

modifyChannel

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

modifyCurrentMember

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

modifyCurrentUser

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

modifyCurrentUserVoiceState

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

modifyGuild

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

modifyGuildChannelPositions

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

modifyGuildEmoji

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

modifyGuildMember

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

modifyGuildMFALevel

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

modifyGuildRole

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

modifyGuildRolePositions

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

modifyGuildScheduledEvent

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

modifyGuildSticker

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

modifyGuildWelcomeScreen

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

modifyGuildWidget

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

modifyStageInstance

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

modifyUserVoiceState

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

modifyWebhook

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

modifyWebhookWithToken

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

pinMessage

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

removeGuildBan

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

removeGuildMember

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

removeGuildMemberRole

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

removeThreadMember

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

request

request(
    method: RestMethod,
    route: `/${string}`,
    options?: RestRequestData,
): 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:199

searchGuildMembers

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

startThreadFromMessage

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

startThreadInForumChannel

startThreadInForumChannel(
    channelId: string,
    body: FormData | RESTPostAPIGuildForumThreadsJSONBody,
    reason?: string,
    options?: RestRequestOptions,
): Promise<APIChannel>
Parameters
- channelId: string
  The channel ID.
- body: FormData | RESTPostAPIGuildForumThreadsJSONBody
  Request body.
- Optionalreason: string
  The value for the X-Audit-Log-Reason header.
- Optionaloptions: RestRequestOptions
  Request options.
Returns Promise<APIChannel>
See
Discord API Reference

Todo
PR in discord-api-types for proper return type.
Inherited from RestRequests.startThreadInForumChannel
- Defined in src/rest/RestRequests.ts:1075

startThreadWithoutMessage

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

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

triggerTypingIndicator

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

unpinMessage

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

Class Rest

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Rest

Properties

buckets

bucketSweepInterval

globalLeft

globalResetAt

Readonlyoptions

responseCodeTally

routeHashCache

Readonlysystem

Static ReadonlyAPI_VERSION

Static ReadonlyBASE_URL

See

Static ReadonlyERROR_KEY

Static ReadonlyOLD_MESSAGE_THRESHOLD

See

Accessors

responseCodeRatio

Returns Record<string, number>

Methods

addGuildMember

Parameters

Returns Promise<RESTPutAPIGuildMemberResult>

See

addGuildMemberRole

Parameters

Returns Promise<never>

See

addThreadMember

Parameters

Returns Promise<never>

See

beginGuildPrune

Parameters

Returns Promise<RESTPostAPIGuildPruneResult>

See

bulkDeleteMessages

Parameters

Returns Promise<never>

See

bulkOverwriteGlobalApplicationCommands

Parameters

Returns Promise<RESTPutAPIApplicationCommandsResult>

See

bulkOverwriteGuildApplicationCommands

Parameters

Returns Promise<RESTPutAPIApplicationGuildCommandsResult>

See

createAutoModerationRule

Parameters

Returns Promise<APIAutoModerationRule>

See

createChannelInvite

Parameters

Returns Promise<APIExtendedInvite>

See

createDM

Parameters

Returns Promise<APIChannel>

See

createFollowupMessage

Parameters

Returns Promise<APIMessage>

See

createGlobalApplicationCommand

Parameters

Returns Promise<APIApplicationCommand>

See

createGuild

Parameters

`Readonly`options

`Readonly`system

`Static` `Readonly`API_VERSION

`Static` `Readonly`BASE_URL

`Static` `Readonly`ERROR_KEY

`Static` `Readonly`OLD_MESSAGE_THRESHOLD