Variable RoutesConst

Type declaration

• applicationCommand:function

  • applicationCommand(applicationId, commandId): `/applications/${string}/commands/${string}`

  • Route for:

    • GET /applications/{application.id}/commands/{command.id}
    • PATCH /applications/{application.id}/commands/{command.id}
    • DELETE /applications/{application.id}/commands/{command.id}

    Parameters

    • applicationId: string

    • commandId: string

    Returns `/applications/${string}/commands/${string}`

• applicationCommandPermissions:function

  • applicationCommandPermissions(applicationId, guildId, commandId): `/applications/${string}/guilds/${string}/commands/${string}/permissions`

  • Route for:

    • GET /applications/{application.id}/guilds/{guild.id}/commands/{command.id}/permissions
    • PUT /applications/{application.id}/guilds/{guild.id}/commands/{command.id}/permissions

    Parameters

    • applicationId: string

    • guildId: string

    • commandId: string

    Returns `/applications/${string}/guilds/${string}/commands/${string}/permissions`

• applicationCommands:function

  • applicationCommands(applicationId): `/applications/${string}/commands`

  • Route for:

    • GET /applications/{application.id}/commands
    • PUT /applications/{application.id}/commands
    • POST /applications/{application.id}/commands

    Parameters

    • applicationId: string

    Returns `/applications/${string}/commands`

• applicationEmoji:function

  • applicationEmoji(applicationId, emojiId): `/applications/${string}/emojis/${string}`

  • Route for:

    • GET /applications/{application.id}/emojis/{emoji.id}
    • PATCH /applications/{application.id}/emojis/{emoji.id}
    • DELETE /applications/{application.id}/emojis/{emoji.id}

    Parameters

    • applicationId: string

    • emojiId: string

    Returns `/applications/${string}/emojis/${string}`

• applicationEmojis:function

  • applicationEmojis(applicationId): `/applications/${string}/emojis`

  • Route for:

    • GET /applications/{application.id}/emojis
    • POST /applications/{application.id}/emojis

    Parameters

    • applicationId: string

    Returns `/applications/${string}/emojis`

• applicationGuildCommand:function

  • applicationGuildCommand(applicationId, guildId, commandId): `/applications/${string}/guilds/${string}/commands/${string}`

  • Route for:

    • GET /applications/{application.id}/guilds/{guild.id}/commands/{command.id}
    • PATCH /applications/{application.id}/guilds/{guild.id}/commands/{command.id}
    • DELETE /applications/{application.id}/guilds/{guild.id}/commands/{command.id}

    Parameters

    • applicationId: string

    • guildId: string

    • commandId: string

    Returns `/applications/${string}/guilds/${string}/commands/${string}`

• applicationGuildCommands:function

  • applicationGuildCommands(applicationId, guildId): `/applications/${string}/guilds/${string}/commands`

  • Route for:

    • GET /applications/{application.id}/guilds/{guild.id}/commands
    • PUT /applications/{application.id}/guilds/{guild.id}/commands
    • POST /applications/{application.id}/guilds/{guild.id}/commands

    Parameters

    • applicationId: string

    • guildId: string

    Returns `/applications/${string}/guilds/${string}/commands`

• applicationRoleConnectionMetadata:function

  • applicationRoleConnectionMetadata(applicationId): `/applications/${string}/role-connections/metadata`

  • Route for:

    • GET /applications/{application.id}/role-connections/metadata
    • PUT /applications/{application.id}/role-connections/metadata

    Parameters

    • applicationId: string

    Returns `/applications/${string}/role-connections/metadata`

• channel:function

  • channel(channelId): `/channels/${string}`

  • Route for:

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

    Parameters

    • channelId: string

    Returns `/channels/${string}`

• channelBulkDelete:function

  • channelBulkDelete(channelId): `/channels/${string}/messages/bulk-delete`

  • Route for:

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

    Parameters

    • channelId: string

    Returns `/channels/${string}/messages/bulk-delete`

• channelFollowers:function

  • channelFollowers(channelId): `/channels/${string}/followers`

  • Route for:

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

    Parameters

    • channelId: string

    Returns `/channels/${string}/followers`

• channelInvites:function

  • channelInvites(channelId): `/channels/${string}/invites`

  • Route for:

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

    Parameters

    • channelId: string

    Returns `/channels/${string}/invites`

• channelJoinedArchivedThreads:function

  • channelJoinedArchivedThreads(channelId): `/channels/${string}/users/@me/threads/archived/private`

  • Route for:

    • GET /channels/{channel.id}/users/@me/threads/archived/private

    Parameters

    • channelId: string

    Returns `/channels/${string}/users/@me/threads/archived/private`

• channelMessage:function

  • channelMessage(channelId, messageId): `/channels/${string}/messages/${string}`

  • Route for:

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

    Parameters

    • channelId: string

    • messageId: string

    Returns `/channels/${string}/messages/${string}`

• channelMessageAllReactions:function

  • channelMessageAllReactions(channelId, messageId): `/channels/${string}/messages/${string}/reactions`

  • Route for:

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

    Parameters

    • channelId: string

    • messageId: string

    Returns `/channels/${string}/messages/${string}/reactions`

• channelMessageCrosspost:function

  • channelMessageCrosspost(channelId, messageId): `/channels/${string}/messages/${string}/crosspost`

  • Route for:

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

    Parameters

    • channelId: string

    • messageId: string

    Returns `/channels/${string}/messages/${string}/crosspost`

• channelMessageOwnReaction:function

  • channelMessageOwnReaction(channelId, messageId, emoji): `/channels/${string}/messages/${string}/reactions/${string}/@me`

  • Route for:

    • PUT /channels/{channel.id}/messages/{message.id}/reactions/{emoji}/@me
    • DELETE /channels/{channel.id}/messages/{message.id}/reactions/{emoji}/@me

    Note: You need to URL encode the emoji yourself

    Parameters

    • channelId: string

    • messageId: string

    • emoji: string

    Returns `/channels/${string}/messages/${string}/reactions/${string}/@me`

• channelMessageReaction:function

  • channelMessageReaction(channelId, messageId, emoji): `/channels/${string}/messages/${string}/reactions/${string}`

  • Route for:

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

    Note: You need to URL encode the emoji yourself

    Parameters

    • channelId: string

    • messageId: string

    • emoji: string

    Returns `/channels/${string}/messages/${string}/reactions/${string}`

• channelMessageUserReaction:function

  • channelMessageUserReaction(channelId, messageId, emoji, userId): `/channels/${string}/messages/${string}/reactions/${string}/${string}`

  • Route for:

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

    Note: You need to URL encode the emoji yourself

    Parameters

    • channelId: string

    • messageId: string

    • emoji: string

    • userId: string

    Returns `/channels/${string}/messages/${string}/reactions/${string}/${string}`

• channelMessages:function

  • channelMessages(channelId): `/channels/${string}/messages`

  • Route for:

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

    Parameters

    • channelId: string

    Returns `/channels/${string}/messages`

• channelPermission:function

  • channelPermission(channelId, overwriteId): `/channels/${string}/permissions/${string}`

  • Route for:

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

    Parameters

    • channelId: string

    • overwriteId: string

    Returns `/channels/${string}/permissions/${string}`

• channelPin:function

  • channelPin(channelId, messageId): `/channels/${string}/pins/${string}`

  • Route for:

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

    Parameters

    • channelId: string

    • messageId: string

    Returns `/channels/${string}/pins/${string}`

• channelPins:function

  • channelPins(channelId): `/channels/${string}/pins`

  • Route for:

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

    Parameters

    • channelId: string

    Returns `/channels/${string}/pins`

• channelRecipient:function

  • channelRecipient(channelId, userId): `/channels/${string}/recipients/${string}`

  • Route for:

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

    Parameters

    • channelId: string

    • userId: string

    Returns `/channels/${string}/recipients/${string}`

• channelThreads:function

  • channelThreads(channelId, archivedStatus): `/channels/${string}/threads/archived/private` | `/channels/${string}/threads/archived/public`

  • Route for:

    • GET /channels/{channel.id}/threads/archived/public
    • GET /channels/{channel.id}/threads/archived/private

    Parameters

    • channelId: string

    • archivedStatus: "public" | "private"

    Returns `/channels/${string}/threads/archived/private` | `/channels/${string}/threads/archived/public`

• channelTyping:function

  • channelTyping(channelId): `/channels/${string}/typing`

  • Route for:

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

    Parameters

    • channelId: string

    Returns `/channels/${string}/typing`

• channelWebhooks:function

  • channelWebhooks(channelId): `/channels/${string}/webhooks`

  • Route for:

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

    Parameters

    • channelId: string

    Returns `/channels/${string}/webhooks`

• consumeEntitlement:function

  • consumeEntitlement(applicationId, entitlementId): `/applications/${string}/entitlements/${string}/consume`

  • Route for:

    • POST /applications/{application.id}/entitlements/{entitlement.id}/consume

    Parameters

    • applicationId: string

    • entitlementId: string

    Returns `/applications/${string}/entitlements/${string}/consume`

• currentApplication:function

  • currentApplication(): "/applications/@me"

  • Route for:

    • GET /applications/@me
    • PATCH /applications/@me

    Returns "/applications/@me"

• entitlement:function

  • entitlement(applicationId, entitlementId): `/applications/${string}/entitlements/${string}`

  • Route for:

    • DELETE /applications/{application.id}/entitlements/{entitlement.id}

    Parameters

    • applicationId: string

    • entitlementId: string

    Returns `/applications/${string}/entitlements/${string}`

• entitlements:function

  • entitlements(applicationId): `/applications/${string}/entitlements`

  • Route for:

    • GET /applications/{application.id}/entitlements
    • POST /applications/{application.id}/entitlements

    Parameters

    • applicationId: string

    Returns `/applications/${string}/entitlements`

• expirePoll:function

  • expirePoll(channelId, messageId): `/channels/${string}/polls/${string}/expire`

  • Route for:

    • POST /channels/{channel.id}/polls/{message.id}/expire

    Parameters

    • channelId: string

    • messageId: string

    Returns `/channels/${string}/polls/${string}/expire`

• gateway:function

  • gateway(): "/gateway"

  • Route for:

    • GET /gateway

    Returns "/gateway"

• gatewayBot:function

  • gatewayBot(): "/gateway/bot"

  • Route for:

    • GET /gateway/bot

    Returns "/gateway/bot"

• guild:function

  • guild(guildId): `/guilds/${string}`

  • Route for:

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

    Parameters

    • guildId: string

    Returns `/guilds/${string}`

• guildActiveThreads:function

  • guildActiveThreads(guildId): `/guilds/${string}/threads/active`

  • Route for:

    • GET /guilds/{guild.id}/threads/active

    Parameters

    • guildId: string

    Returns `/guilds/${string}/threads/active`

• guildApplicationCommandsPermissions:function

  • guildApplicationCommandsPermissions(applicationId, guildId): `/applications/${string}/guilds/${string}/commands/permissions`

  • Route for:

    • GET /applications/{application.id}/guilds/{guild.id}/commands/permissions
    • PUT /applications/{application.id}/guilds/{guild.id}/commands/permissions

    Parameters

    • applicationId: string

    • guildId: string

    Returns `/applications/${string}/guilds/${string}/commands/permissions`

• guildAuditLog:function

  • guildAuditLog(guildId): `/guilds/${string}/audit-logs`

  • Route for:

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

    Parameters

    • guildId: string

    Returns `/guilds/${string}/audit-logs`

• guildAutoModerationRule:function

  • guildAutoModerationRule(guildId, ruleId): `/guilds/${string}/auto-moderation/rules/${string}`

  • Routes for:

    • GET /guilds/{guild.id}/auto-moderation/rules/{rule.id}
    • PATCH /guilds/{guild.id}/auto-moderation/rules/{rule.id}
    • DELETE /guilds/{guild.id}/auto-moderation/rules/{rule.id}

    Parameters

    • guildId: string

    • ruleId: string

    Returns `/guilds/${string}/auto-moderation/rules/${string}`

• guildAutoModerationRules:function

  • guildAutoModerationRules(guildId): `/guilds/${string}/auto-moderation/rules`

  • Route for:

    • GET /guilds/{guild.id}/auto-moderation/rules
    • POST /guilds/{guild.id}/auto-moderation/rules

    Parameters

    • guildId: string

    Returns `/guilds/${string}/auto-moderation/rules`

• guildBan:function

  • guildBan(guildId, userId): `/guilds/${string}/bans/${string}`

  • Route for:

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

    Parameters

    • guildId: string

    • userId: string

    Returns `/guilds/${string}/bans/${string}`

• guildBans:function

  • guildBans(guildId): `/guilds/${string}/bans`

  • Route for:

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

    Parameters

    • guildId: string

    Returns `/guilds/${string}/bans`

• guildBulkBan:function

  • guildBulkBan(guildId): `/guilds/${string}/bulk-ban`

  • Route for:

    • POST /guilds/{guild.id}/bulk-ban

    Parameters

    • guildId: string

    Returns `/guilds/${string}/bulk-ban`

• guildChannels:function

  • guildChannels(guildId): `/guilds/${string}/channels`

  • Route for:

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

    Parameters

    • guildId: string

    Returns `/guilds/${string}/channels`

• guildCurrentMemberNickname:function

  • guildCurrentMemberNickname(guildId): `/guilds/${string}/members/@me/nick`

  • Route for:

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

    Parameters

    • guildId: string

    Returns `/guilds/${string}/members/@me/nick`

    Deprecated

    Use guildMember instead.

• guildEmoji:function

  • guildEmoji(guildId, emojiId): `/guilds/${string}/emojis/${string}`

  • Route for:

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

    Parameters

    • guildId: string

    • emojiId: string

    Returns `/guilds/${string}/emojis/${string}`

• guildEmojis:function

  • guildEmojis(guildId): `/guilds/${string}/emojis`

  • Route for:

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

    Parameters

    • guildId: string

    Returns `/guilds/${string}/emojis`

• guildIntegration:function

  • guildIntegration(guildId, integrationId): `/guilds/${string}/integrations/${string}`

  • Route for:

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

    Parameters

    • guildId: string

    • integrationId: string

    Returns `/guilds/${string}/integrations/${string}`

• guildIntegrations:function

  • guildIntegrations(guildId): `/guilds/${string}/integrations`

  • Route for:

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

    Parameters

    • guildId: string

    Returns `/guilds/${string}/integrations`

• guildInvites:function

  • guildInvites(guildId): `/guilds/${string}/invites`

  • Route for:

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

    Parameters

    • guildId: string

    Returns `/guilds/${string}/invites`

• guildMFA:function

  • guildMFA(guildId): `/guilds/${string}/mfa`

  • Route for:

    • POST /guilds/{guild.id}/mfa

    Parameters

    • guildId: string

    Returns `/guilds/${string}/mfa`

• guildMember:function

  • guildMember(guildId, userId?): `/guilds/${string}/members/${string}`

  • Route for:

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

    Parameters

    • guildId: string

    • Optional userId: string

    Returns `/guilds/${string}/members/${string}`

• guildMemberRole:function

  • guildMemberRole(guildId, memberId, roleId): `/guilds/${string}/members/${string}/roles/${string}`

  • Route for:

    • PUT /guilds/{guild.id}/members/{user.id}/roles/{role.id}
    • DELETE /guilds/{guild.id}/members/{user.id}/roles/{role.id}

    Parameters

    • guildId: string

    • memberId: string

    • roleId: string

    Returns `/guilds/${string}/members/${string}/roles/${string}`

• guildMemberVerification:function

  • guildMemberVerification(guildId): `/guilds/${string}/member-verification`

  • Route for:

    • GET /guilds/{guild.id}/member-verification
    • PATCH /guilds/{guild.id}/member-verification

    Parameters

    • guildId: string

    Returns `/guilds/${string}/member-verification`

• guildMembers:function

  • guildMembers(guildId): `/guilds/${string}/members`

  • Route for:

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

    Parameters

    • guildId: string

    Returns `/guilds/${string}/members`

• guildMembersSearch:function

  • guildMembersSearch(guildId): `/guilds/${string}/members/search`

  • Route for:

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

    Parameters

    • guildId: string

    Returns `/guilds/${string}/members/search`

• guildOnboarding:function

  • guildOnboarding(guildId): `/guilds/${string}/onboarding`

  • Route for:

    • GET /guilds/{guild.id}/onboarding
    • PUT /guilds/{guild.id}/onboarding

    Parameters

    • guildId: string

    Returns `/guilds/${string}/onboarding`

• guildPreview:function

  • guildPreview(guildId): `/guilds/${string}/preview`

  • Route for:

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

    Parameters

    • guildId: string

    Returns `/guilds/${string}/preview`

• guildPrune:function

  • guildPrune(guildId): `/guilds/${string}/prune`

  • Route for:

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

    Parameters

    • guildId: string

    Returns `/guilds/${string}/prune`

• guildRole:function

  • guildRole(guildId, roleId): `/guilds/${string}/roles/${string}`

  • Route for:

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

    Parameters

    • guildId: string

    • roleId: string

    Returns `/guilds/${string}/roles/${string}`

• guildRoles:function

  • guildRoles(guildId): `/guilds/${string}/roles`

  • Route for:

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

    Parameters

    • guildId: string

    Returns `/guilds/${string}/roles`

• guildScheduledEvent:function

  • guildScheduledEvent(guildId, guildScheduledEventId): `/guilds/${string}/scheduled-events/${string}`

  • Route for:

    • GET /guilds/{guild.id}/scheduled-events/{guildScheduledEvent.id}
    • PATCH /guilds/{guild.id}/scheduled-events/{guildScheduledEvent.id}
    • DELETE /guilds/{guild.id}/scheduled-events/{guildScheduledEvent.id}

    Parameters

    • guildId: string

    • guildScheduledEventId: string

    Returns `/guilds/${string}/scheduled-events/${string}`

• guildScheduledEventUsers:function

  • guildScheduledEventUsers(guildId, guildScheduledEventId): `/guilds/${string}/scheduled-events/${string}/users`

  • Route for:

    • GET /guilds/{guild.id}/scheduled-events/{guildScheduledEvent.id}/users

    Parameters

    • guildId: string

    • guildScheduledEventId: string

    Returns `/guilds/${string}/scheduled-events/${string}/users`

• guildScheduledEvents:function

  • guildScheduledEvents(guildId): `/guilds/${string}/scheduled-events`

  • Route for:

    • GET /guilds/{guild.id}/scheduled-events
    • POST /guilds/{guild.id}/scheduled-events

    Parameters

    • guildId: string

    Returns `/guilds/${string}/scheduled-events`

• guildSticker:function

  • guildSticker(guildId, stickerId): `/guilds/${string}/stickers/${string}`

  • Route for:

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

    Parameters

    • guildId: string

    • stickerId: string

    Returns `/guilds/${string}/stickers/${string}`

• guildStickers:function

  • guildStickers(guildId): `/guilds/${string}/stickers`

  • Route for:

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

    Parameters

    • guildId: string

    Returns `/guilds/${string}/stickers`

• guildTemplate:function

  • guildTemplate(guildId, code): `/guilds/${string}/templates/${string}`

  • Route for:

    • PUT /guilds/{guild.id}/templates/{template.code}
    • PATCH /guilds/{guild.id}/templates/{template.code}
    • DELETE /guilds/{guild.id}/templates/{template.code}

    Parameters

    • guildId: string

    • code: string

    Returns `/guilds/${string}/templates/${string}`

• guildTemplates:function

  • guildTemplates(guildId): `/guilds/${string}/templates`

  • Route for:

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

    Parameters

    • guildId: string

    Returns `/guilds/${string}/templates`

• guildVanityUrl:function

  • guildVanityUrl(guildId): `/guilds/${string}/vanity-url`

  • Route for:

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

    Parameters

    • guildId: string

    Returns `/guilds/${string}/vanity-url`

• guildVoiceRegions:function

  • guildVoiceRegions(guildId): `/guilds/${string}/regions`

  • Route for:

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

    Parameters

    • guildId: string

    Returns `/guilds/${string}/regions`

• guildVoiceState:function

  • guildVoiceState(guildId, userId?): `/guilds/${string}/voice-states/${string}`

  • Route for:

    • GET /guilds/{guild.id}/voice-states/@me
    • GET /guilds/{guild.id}/voice-states/{user.id}
    • PATCH /guilds/{guild.id}/voice-states/@me
    • PATCH /guilds/{guild.id}/voice-states/{user.id}

    Parameters

    • guildId: string

    • Optional userId: string

    Returns `/guilds/${string}/voice-states/${string}`

• guildWebhooks:function

  • guildWebhooks(guildId): `/guilds/${string}/webhooks`

  • Route for:

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

    Parameters

    • guildId: string

    Returns `/guilds/${string}/webhooks`

• guildWelcomeScreen:function

  • guildWelcomeScreen(guildId): `/guilds/${string}/welcome-screen`

  • Route for:

    • GET /guilds/{guild.id}/welcome-screen
    • PATCH /guilds/{guild.id}/welcome-screen

    Parameters

    • guildId: string

    Returns `/guilds/${string}/welcome-screen`

• guildWidgetImage:function

  • guildWidgetImage(guildId): `/guilds/${string}/widget.png`

  • Route for:

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

    Parameters

    • guildId: string

    Returns `/guilds/${string}/widget.png`

• guildWidgetJSON:function

  • guildWidgetJSON(guildId): `/guilds/${string}/widget.json`

  • Route for:

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

    Parameters

    • guildId: string

    Returns `/guilds/${string}/widget.json`

• guildWidgetSettings:function

  • guildWidgetSettings(guildId): `/guilds/${string}/widget`

  • Route for:

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

    Parameters

    • guildId: string

    Returns `/guilds/${string}/widget`

• guilds:function

  • guilds(): "/guilds"

  • Route for:

    • POST /guilds

    Returns "/guilds"

• interactionCallback:function

  • interactionCallback(interactionId, interactionToken): `/interactions/${string}/${string}/callback`

  • Route for:

    • POST /interactions/{interaction.id}/{interaction.token}/callback

    Parameters

    • interactionId: string

    • interactionToken: string

    Returns `/interactions/${string}/${string}/callback`

• invite:function

  • invite(code): `/invites/${string}`

  • Route for:

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

    Parameters

    • code: string

    Returns `/invites/${string}`

• nitroStickerPacks:function

  • nitroStickerPacks(): "/sticker-packs"

  • Route for:

    • GET /sticker-packs

    Returns "/sticker-packs"

    Deprecated

    Use stickerPacks instead.

• oauth2Authorization:function

  • oauth2Authorization(): "/oauth2/authorize"

  • Route for:

    • GET /oauth2/authorize

    Returns "/oauth2/authorize"

• oauth2CurrentApplication:function

  • oauth2CurrentApplication(): "/oauth2/applications/@me"

  • Route for:

    • GET /oauth2/applications/@me

    Returns "/oauth2/applications/@me"

• oauth2CurrentAuthorization:function

  • oauth2CurrentAuthorization(): "/oauth2/@me"

  • Route for:

    • GET /oauth2/@me

    Returns "/oauth2/@me"

• oauth2TokenExchange:function

  • oauth2TokenExchange(): "/oauth2/token"

  • Route for:

    • POST /oauth2/token

    Returns "/oauth2/token"

• oauth2TokenRevocation:function

  • oauth2TokenRevocation(): "/oauth2/token/revoke"

  • Route for:

    • POST /oauth2/token/revoke

    Returns "/oauth2/token/revoke"

• pollAnswerVoters:function

  • pollAnswerVoters(channelId, messageId, answerId): `/channels/${string}/polls/${string}/answers/${number}`

  • Route for:

    • GET /channels/{channel.id}/polls/{message.id}/answers/{answer_id}

    Parameters

    • channelId: string

    • messageId: string

    • answerId: number

    Returns `/channels/${string}/polls/${string}/answers/${number}`

• skus:function

  • skus(applicationId): `/applications/${string}/skus`

  • Route for:

    • GET /applications/{application.id}/skus

    Parameters

    • applicationId: string

    Returns `/applications/${string}/skus`

• stageInstance:function

  • stageInstance(channelId): `/stage-instances/${string}`

  • Route for:

    • GET /stage-instances/{channel.id}
    • PATCH /stage-instances/{channel.id}
    • DELETE /stage-instances/{channel.id}

    Parameters

    • channelId: string

    Returns `/stage-instances/${string}`

• stageInstances:function

  • stageInstances(): "/stage-instances"

  • Route for:

    • POST /stage-instances

    Returns "/stage-instances"

• sticker:function

  • sticker(stickerId): `/stickers/${string}`

  • Route for:

    • GET /stickers/{sticker.id}

    Parameters

    • stickerId: string

    Returns `/stickers/${string}`

• stickerPack:function

  • stickerPack(packId): `/sticker-packs/${string}`

  • Route for:

    • GET /sticker-packs/{pack.id}

    Parameters

    • packId: string

    Returns `/sticker-packs/${string}`

• stickerPacks:function

  • stickerPacks(): "/sticker-packs"

  • Route for:

    • GET /sticker-packs

    Returns "/sticker-packs"

• template:function

  • template(code): `/guilds/templates/${string}`

  • Route for:

    • GET /guilds/templates/{template.code}
    • POST /guilds/templates/{template.code}

    Parameters

    • code: string

    Returns `/guilds/templates/${string}`

• threadMembers:function

  • threadMembers(threadId, userId?): `/channels/${string}/thread-members/${string}` | `/channels/${string}/thread-members`

  • Route for:

    • GET /channels/{thread.id}/thread-members
    • GET /channels/{thread.id}/thread-members/{user.id}
    • PUT /channels/{thread.id}/thread-members/@me
    • PUT /channels/{thread.id}/thread-members/{user.id}
    • DELETE /channels/{thread.id}/thread-members/@me
    • DELETE /channels/{thread.id}/thread-members/{user.id}

    Parameters

    • threadId: string

    • Optional userId: string

    Returns `/channels/${string}/thread-members/${string}` | `/channels/${string}/thread-members`

• threads:function

  • threads(parentId, messageId?): `/channels/${string}/messages/${string}/threads` | `/channels/${string}/threads`

  • Route for:

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

    Parameters

    • parentId: string

    • Optional messageId: string

    Returns `/channels/${string}/messages/${string}/threads` | `/channels/${string}/threads`

• user:function

  • user(userId?): `/users/${string}`

  • Route for:

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

    Parameters

    • Optional userId: string

      The user ID, defaulted to @me

    Returns `/users/${string}`

• userApplicationRoleConnection:function

  • userApplicationRoleConnection(applicationId): `/users/@me/applications/${string}/role-connection`

  • Route for:

    • GET /users/@me/applications/{application.id}/role-connection
    • PUT /users/@me/applications/{application.id}/role-connection

    Parameters

    • applicationId: string

    Returns `/users/@me/applications/${string}/role-connection`

• userChannels:function

  • userChannels(): "/users/@me/channels"

  • Route for:

    • POST /users/@me/channels

    Returns "/users/@me/channels"

• userConnections:function

  • userConnections(): "/users/@me/connections"

  • Route for:

    • GET /users/@me/connections

    Returns "/users/@me/connections"

• userGuild:function

  • userGuild(guildId): `/users/@me/guilds/${string}`

  • Route for:

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

    Parameters

    • guildId: string

    Returns `/users/@me/guilds/${string}`

• userGuildMember:function

  • userGuildMember(guildId): `/users/@me/guilds/${string}/member`

  • Route for:

    • GET /users/@me/guilds/{guild.id}/member

    Parameters

    • guildId: string

    Returns `/users/@me/guilds/${string}/member`

• userGuilds:function

  • userGuilds(): "/users/@me/guilds"

  • Route for:

    • GET /users/@me/guilds

    Returns "/users/@me/guilds"

• voiceRegions:function

  • voiceRegions(): "/voice/regions"

  • Route for:

    • GET /voice/regions

    Returns "/voice/regions"

• webhook:function

  • webhook(webhookId, webhookToken?): `/webhooks/${string}/${string}` | `/webhooks/${string}`

  • Route for:

    • GET /webhooks/{webhook.id}

    • GET /webhooks/{webhook.id}/{webhook.token}

    • PATCH /webhooks/{webhook.id}

    • PATCH /webhooks/{webhook.id}/{webhook.token}

    • DELETE /webhooks/{webhook.id}

    • DELETE /webhooks/{webhook.id}/{webhook.token}

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

    • POST /webhooks/{application.id}/{interaction.token}

    Parameters

    • webhookId: string

    • Optional webhookToken: string

    Returns `/webhooks/${string}/${string}` | `/webhooks/${string}`

• webhookMessage:function

  • webhookMessage(webhookId, webhookToken, messageId?): `/webhooks/${string}/${string}/messages/${string}`

  • Route for:

    • GET /webhooks/{webhook.id}/{webhook.token}/messages/@original

    • GET /webhooks/{webhook.id}/{webhook.token}/messages/{message.id}

    • PATCH /webhooks/{webhook.id}/{webhook.token}/messages/@original

    • PATCH /webhooks/{webhook.id}/{webhook.token}/messages/{message.id}

    • DELETE /webhooks/{webhook.id}/{webhook.token}/messages/@original

    • DELETE /webhooks/{webhook.id}/{webhook.token}/messages/{message.id}

    • PATCH /webhooks/{application.id}/{interaction.token}/messages/@original

    • PATCH /webhooks/{application.id}/{interaction.token}/messages/{message.id}

    • DELETE /webhooks/{application.id}/{interaction.token}/messages/{message.id}

    Parameters

    • webhookId: string

    • webhookToken: string

    • Optional messageId: string

    Returns `/webhooks/${string}/${string}/messages/${string}`

• webhookPlatform:function

  • webhookPlatform(webhookId, webhookToken, platform): `/webhooks/${string}/${string}/github` | `/webhooks/${string}/${string}/slack`

  • Route for:

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

    Parameters

    • webhookId: string

    • webhookToken: string

    • platform: "github" | "slack"

    Returns `/webhooks/${string}/${string}/github` | `/webhooks/${string}/${string}/slack`