Skip to main content
Module

x/discord_api_types/rest/v6/mod.ts

Up to date Discord API Typings, versioned by the API version
Go to Latest
File
export * from '../common.ts';
export * from './auditLog.ts';export * from './channel.ts';export * from './emoji.ts';export * from './gateway.ts';export * from './guild.ts';export * from './invite.ts';export * from './oauth2.ts';export * from './user.ts';export * from './voice.ts';export * from './webhook.ts';
/** * @deprecated API v6 is deprecated and the types will not receive further updates, please update to v8. */export const APIVersion = '6';
/** * @deprecated API v6 is deprecated and the types will not receive further updates, please update to v8. */export const Routes = { /** * Route for: * - GET `/guilds/{guild.id}/audit-logs` */ guildAuditLog(guildID: string) { return `/guilds/${guildID}/audit-logs`; },
/** * Route for: * - GET `/channels/{channel.id}` * - PATCH `/channels/{channel.id}` * - DELETE `/channels/{channel.id}` */ channel(channelID: string) { return `/channels/${channelID}`; },
/** * Route for: * - GET `/channels/{channel.id}/messages` * - POST `/channels/{channel.id}/messages` */ channelMessages(channelID: string) { return `/channels/${channelID}/messages`; },
/** * Route for: * - GET `/channels/{channel.id}/messages/{message.id}` * - PATCH `/channels/{channel.id}/messages/{message.id}` * - DELETE `/channels/{channel.id}/messages/{message.id}` */ channelMessage(channelID: string, messageID: string) { return `/channels/${channelID}/messages/${messageID}`; },
/** * Route for: * - POST `/channels/{channel.id}/messages/{message.id}/crosspost` */ channelCrosspost(channelID: string, messageID: string) { return `/channels/${channelID}/message/${messageID}/crosspost`; },
/** * 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. */ channelMessageOwnReaction(channelID: string, messageID: string, emoji: string) { return `/channels/${channelID}/messages/${messageID}/reactions/${emoji}/@me`; },
/** * Route for: * - DELETE `/channels/{channel.id}/messages/{message.id}/reactions/{emoji}/{user.id}` * * **Note**: You need to URL encode the emoji yourself. */ channelMessageUserReaction(channelID: string, messageID: string, emoji: string, userID: string) { return `/channels/${channelID}/messages/${messageID}/reactions/${emoji}/${userID}`; },
/** * 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. */ channelMessageSpecificReaction(channelID: string, messageID: string, emoji: string) { return `/channels/${channelID}/messages/${messageID}/reactions/${emoji}`; },
/** * Route for: * - DELETE `/channels/{channel.id}/messages/{message.id}/reactions` */ channelMessageAllReactions(channelID: string, messageID: string) { return `/channels/${channelID}/messages/${messageID}`; },
/** * Route for: * - POST `/channels/{channel.id}/messages/bulk-delete` */ channelBulkDelete(channelID: string) { return `/channels/${channelID}/bulk-delete`; },
/** * Route for: * - PUT `/channels/{channel.id}/permissions/{overwrite.id}` * - DELETE `/channels/{channel.id}/permissions/{overwrite.id}` */ channelPermissions(channelID: string, overwriteID: string) { return `/channels/${channelID}/permissions/${overwriteID}`; },
/** * Route for: * - GET `/channels/{channel.id}/invites` * - POST `/channels/{channel.id}/invites` */ channelInvite(channelID: string) { return `/channels/${channelID}`; },
/** * Route for: * - POST `/channels/{channel.id}/followers` */ channelFollowers(channelID: string) { return `/channels/${channelID}/followers`; },
/** * Route for: * - POST `/channels/{channel.id}/typing` */ channelTyping(channelID: string) { return `/channels/${channelID}/typing`; },
/** * Route for: * - GET `/channels/{channel.id}/pins` */ channelPins(channelID: string) { return `/channels/${channelID}/pins`; },
/** * Route for: * - PUT `/channels/{channel.id}/pins/{message.id}` * - DELETE `/channels/{channel.id}/pins/{message.id}` */ channelPin(channelID: string, messageID: string) { return `/channels/${channelID}/pins/${messageID}`; },
/** * Route for: * - PUT `/channels/{channel.id}/recipients/{user.id}` * - DELETE `/channels/{channel.id}/recipients/{user.id}` */ channelRecipient(channelID: string, userID: string) { return `/channels/${channelID}/recipients/${userID}`; },
/** * Route for: * - GET `/guilds/{guild.id}/emojis` * - POST `/guilds/{guild.id}/emojis` */ guildEmojis(guildID: string) { return `/guilds/${guildID}/emojis`; },
/** * Route for: * - GET `/guilds/{guild.id}/emojis/{emoji.id}` * - PATCH `/guilds/{guild.id}/emojis/{emoji.id}` * - DELETE `/guilds/{guild.id}/emojis/{emoji.id}` */ guildEmoji(guildID: string, emojiID: string) { return `/guilds/${guildID}/emojis/${emojiID}`; },
/** * Route for: * - POST `/guilds` */ guilds() { return '/guilds'; },
/** * Route for: * - GET `/guilds/{guild.id}` * - PATCH `/guilds/{guild.id}` * - DELETE `/guilds/{guild.id}` */ guild(guildID: string) { return `/guilds/${guildID}`; },
/** * Route for: * - GET `/guilds/{guild.id}/preview` */ guildPreview(guildID: string) { return `/guilds/${guildID}/preview`; },
/** * Route for: * - GET `/guilds/{guild.id}/channels` * - POST `/guilds/{guild.id}/channels` * - PATCH `/guilds/{guild.id}/channels` */ guildChannels(guildID: string) { return `/guilds/${guildID}/channels`; },
/** * Route for: * - GET `/guilds/{guild.id}/members/{user.id}` * - PUT `/guilds/{guild.id}/members/{user.id}` * - PATCH `/guilds/{guild.id}/members/{user.id}` * - DELETE `/guilds/{guild.id}/members/{user.id}` */ guildMember(guildID: string, userID: string) { return `/guilds/${guildID}/members/${userID}`; },
/** * Route for: * - GET `/guilds/{guild.id}/members` */ guildMembers(guildID: string) { return `/guilds/${guildID}/members`; },
/** * Route for: * - GET `/guilds/{guild.id}/members/search` */ guildMembersSearch(guildID: string) { return `/guilds/${guildID}/members/search`; },
/** * Route for: * - PATCH `/guilds/{guild.id}/members/@me/nick` */ guildCurrentMemberNickname(guildID: string) { return `/guilds/${guildID}/members/@me/nick`; },
/** * Route for: * - PUT `/guilds/{guild.id}/members/{user.id}/roles/{role.id}` * - DELETE `/guilds/{guild.id}/members/{user.id}/roles/{role.id}` */ guildMemberRole(guildID: string, memberID: string, roleID: string) { return `/guilds/${guildID}/members/${memberID}/roles/${roleID}`; },
/** * Route for: * - GET `/guilds/{guild.id}/bans` */ guildBans(guildID: string) { return `/guilds/${guildID}/bans`; },
/** * Route for: * - GET `/guilds/{guild.id}/bans/{user.id}` * - PUT `/guilds/{guild.id}/bans/{user.id}` * - DELETE `/guilds/{guild.id}/bans/{user.id}` */ guildBan(guildID: string, userID: string) { return `/guilds/${guildID}/bans/${userID}`; },
/** * Route for: * - GET `/guilds/{guild.id}/roles` * - POST `/guilds/{guild.id}/roles` * - PATCH `/guilds/{guild.id}/roles` */ guildRoles(guildID: string) { return `/guilds/${guildID}/roles`; },
/** * Route for: * - PATCH `/guilds/{guild.id}/roles/{role.id}` * - DELETE `/guilds/{guild.id}/roles/{role.id}` */ guildRole(guildID: string, roleID: string) { return `/guilds/${guildID}/roles/${roleID}`; },
/** * Route for: * - GET `/guilds/{guild.id}/prune` * - POST `/guilds/{guild.id}/prune` */ guildPrune(guildID: string) { return `/guilds/${guildID}/prune`; },
/** * Route for: * - GET `/guilds/{guild.id}/regions` */ guildVoiceRegions(guildID: string) { return `/guilds/${guildID}/regions`; },
/** * Route for: * - GET `/guilds/{guild.id}/invites` */ guildInvites(guildID: string) { return `/guilds/${guildID}/invites`; },
/** * Route for: * - GET `/guilds/{guild.id}/integrations` * - POST `/guilds/{guild.id}/integrations` */ guildIntegrations(guildID: string) { return `/guilds/${guildID}/integrations`; },
/** * Route for: * - PATCH `/guilds/{guild.id}/integrations/{integration.id}` * - DELETE `/guilds/{guild.id}/integrations/{integration.id}` */ guildIntegration(guildID: string, integrationID: string) { return `/guilds/${guildID}/integrations/${integrationID}`; },
/** * Route for: * - POST `/guilds/{guild.id}/integrations/{integration.id}/sync` */ guildIntegrationSync(guildID: string, integrationID: string) { return `/guilds/${guildID}/integrations/${integrationID}/sync`; },
/** * @deprecated Use `guildWidgetSettings` instead */ guildWidget(guildID: string) { return `/guilds/${guildID}/widget`; },
/** * Route for: * - GET `/guilds/{guild.id}/widget` * - PATCH `/guilds/{guild.id}/widget` */ guildWidgetSettings(guildID: string) { return `/guilds/${guildID}/widget`; },
/** * Route for: * - GET `/guilds/{guild.id}/vanity-url` */ guildVanityUrl(guildID: string) { return `/guilds/${guildID}/vanity-url`; },
/** * Route for: * - GET `/guilds/{guild.id}/widget.png` */ guildWidgetImage(guildID: string) { return `/guilds/${guildID}/widget.png`; },
/** * Route for: * - GET `/invites/{invite.code}` * - DELETE `/invites/{invite.code}` */ invite(code: string) { return `/invites/${code}`; },
/** * Route for: * - GET `/users/@me` * - GET `/users/{user.id}` * - PATCH `/users/@me` */ user(userID = '@me') { return `/users/${userID}`; },
/** * Route for: * - GET `/users/@me/guilds` */ userGuilds() { return `/users/@me/guilds`; },
/** * Route for: * - DELETE `/users/@me/guilds/{guild.id}` */ userGuild(guildID: string) { return `/users/@me/guilds/${guildID}`; },
/** * Route for: * - POST `/users/@me/channels` */ userChannels() { return `/users/@me/channels`; },
/** * Route for: * - GET `/users/@me/connections` */ userConnections() { return `/users/@me/connections`; },
/** * Route for: * - GET `/voice/regions` */ voiceRegions() { return `/voice/regions`; },
/** * Route for: * - POST `/channels/{channel.id}/webhooks` * - GET `/channels/{channel.id}/webhooks` */ channelWebhook(channelID: string) { return `/channels/${channelID}/webhooks`; },
/** * Route for: * - GET `/guilds/{guild.id}/webhooks` */ guildWebhooks(guildID: string) { return `/guilds/${guildID}/webhooks`; },
/** * 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}` */ webhook(webhookID: string, webhookToken?: string) { const parts = ['', 'webhooks', webhookID];
if (webhookToken) parts.push(webhookToken);
return parts.join('/'); },
/** * Route for: * - POST `/webhooks/{webhook.id}/{webhook.token}/slack` * - POST `/webhooks/{webhook.id}/{webhook.token}/github` */ webhookPlatform(webhookID: string, webhookToken: string, platform: 'github' | 'slack') { return `/${webhookID}/${webhookToken}/${platform}`; },
/** * Route for: * - GET `/gateway` */ gateway() { return `/gateway`; },
/** * Route for: * - GET `/gateway/bot` */ gatewayBot() { return `/gateway/bot`; },
/** * Route for: * - GET `/oauth2/applications/@me` */ oauth2CurrentApplication() { return `/oauth2/applications/@me`; },};