discord-api-types
Version:
Discord API typings that are kept up to date for use in bot library creation.
148 lines • 6.68 kB
JavaScript
"use strict";
/**
* Types extracted from https://discord.com/developers/docs/topics/oauth2
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.OAuth2Scopes = void 0;
var OAuth2Scopes;
(function (OAuth2Scopes) {
/**
* For oauth2 bots, this puts the bot in the user's selected guild by default
*/
OAuth2Scopes["Bot"] = "bot";
/**
* Allows {@link https://discord.com/developers/docs/resources/user#get-user-connections | `/users/@me/connections`}
* to return linked third-party accounts
*
* @see {@link https://discord.com/developers/docs/resources/user#get-user-connections}
*/
OAuth2Scopes["Connections"] = "connections";
/**
* Allows your app to see information about the user's DMs and group DMs - requires Discord approval
*/
OAuth2Scopes["DMChannelsRead"] = "dm_channels.read";
/**
* Enables {@link https://discord.com/developers/docs/resources/user#get-current-user | `/users/@me`} to return an `email`
*
* @see {@link https://discord.com/developers/docs/resources/user#get-current-user}
*/
OAuth2Scopes["Email"] = "email";
/**
* Allows {@link https://discord.com/developers/docs/resources/user#get-current-user | `/users/@me`} without `email`
*
* @see {@link https://discord.com/developers/docs/resources/user#get-current-user}
*/
OAuth2Scopes["Identify"] = "identify";
/**
* Allows {@link https://discord.com/developers/docs/resources/user#get-current-user-guilds | `/users/@me/guilds`}
* to return basic information about all of a user's guilds
*
* @see {@link https://discord.com/developers/docs/resources/user#get-current-user-guilds}
*/
OAuth2Scopes["Guilds"] = "guilds";
/**
* Allows {@link https://discord.com/developers/docs/resources/guild#add-guild-member | `/guilds/[guild.id]/members/[user.id]`}
* to be used for joining users to a guild
*
* @see {@link https://discord.com/developers/docs/resources/guild#add-guild-member}
*/
OAuth2Scopes["GuildsJoin"] = "guilds.join";
/**
* Allows /users/\@me/guilds/\{guild.id\}/member to return a user's member information in a guild
*
* @see {@link https://discord.com/developers/docs/resources/user#get-current-user-guild-member}
*/
OAuth2Scopes["GuildsMembersRead"] = "guilds.members.read";
/**
* Allows your app to join users to a group dm
*
* @see {@link https://discord.com/developers/docs/resources/channel#group-dm-add-recipient}
*/
OAuth2Scopes["GroupDMJoins"] = "gdm.join";
/**
* For local rpc server api access, this allows you to read messages from all client channels
* (otherwise restricted to channels/guilds your app creates)
*/
OAuth2Scopes["MessagesRead"] = "messages.read";
/**
* Allows your app to update a user's connection and metadata for the app
*/
OAuth2Scopes["RoleConnectionsWrite"] = "role_connections.write";
/**
* For local rpc server access, this allows you to control a user's local Discord client - requires Discord approval
*/
OAuth2Scopes["RPC"] = "rpc";
/**
* For local rpc server access, this allows you to update a user's activity - requires Discord approval
*/
OAuth2Scopes["RPCActivitiesWrite"] = "rpc.activities.write";
/**
* For local rpc server access, this allows you to read a user's voice settings and listen for voice events - requires Discord approval
*/
OAuth2Scopes["RPCVoiceRead"] = "rpc.voice.read";
/**
* For local rpc server access, this allows you to update a user's voice settings - requires Discord approval
*/
OAuth2Scopes["RPCVoiceWrite"] = "rpc.voice.write";
/**
* For local rpc server api access, this allows you to receive notifications pushed out to the user - requires Discord approval
*/
OAuth2Scopes["RPCNotificationsRead"] = "rpc.notifications.read";
/**
* This generates a webhook that is returned in the oauth token response for authorization code grants
*/
OAuth2Scopes["WebhookIncoming"] = "webhook.incoming";
/**
* Allows your app to connect to voice on user's behalf and see all the voice members - requires Discord approval
*/
OAuth2Scopes["Voice"] = "voice";
/**
* Allows your app to upload/update builds for a user's applications - requires Discord approval
*/
OAuth2Scopes["ApplicationsBuildsUpload"] = "applications.builds.upload";
/**
* Allows your app to read build data for a user's applications
*/
OAuth2Scopes["ApplicationsBuildsRead"] = "applications.builds.read";
/**
* Allows your app to read and update store data (SKUs, store listings, achievements, etc.) for a user's applications
*/
OAuth2Scopes["ApplicationsStoreUpdate"] = "applications.store.update";
/**
* Allows your app to read entitlements for a user's applications
*/
OAuth2Scopes["ApplicationsEntitlements"] = "applications.entitlements";
/**
* Allows your app to know a user's friends and implicit relationships - requires Discord approval
*/
OAuth2Scopes["RelationshipsRead"] = "relationships.read";
/**
* Allows your app to fetch data from a user's "Now Playing/Recently Played" list - requires Discord approval
*/
OAuth2Scopes["ActivitiesRead"] = "activities.read";
/**
* Allows your app to update a user's activity - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER)
*
* @see {@link https://discord.com/developers/docs/game-sdk/activities}
*/
OAuth2Scopes["ActivitiesWrite"] = "activities.write";
/**
* Allows your app to use Application Commands in a guild
*
* @see {@link https://discord.com/developers/docs/interactions/application-commands}
*/
OAuth2Scopes["ApplicationsCommands"] = "applications.commands";
/**
* Allows your app to update its Application Commands via this bearer token - client credentials grant only
*
* @see {@link https://discord.com/developers/docs/interactions/application-commands}
*/
OAuth2Scopes["ApplicationsCommandsUpdate"] = "applications.commands.update";
/**
* Allows your app to update permissions for its commands using a Bearer token - client credentials grant only
*
* @see {@link https://discord.com/developers/docs/interactions/application-commands}
*/
OAuth2Scopes["ApplicationCommandsPermissionsUpdate"] = "applications.commands.permissions.update";
})(OAuth2Scopes || (exports.OAuth2Scopes = OAuth2Scopes = {}));
//# sourceMappingURL=oauth2.js.map