feat(model): constants for scope values

twilight-model/src/guild/integration.rs

@@ -36,7 +36,7 @@ pub struct GuildIntegration {
     pub role_id: Option<Id<RoleMarker>>,
     /// An array of [OAuth2 scopes] which the application has been authorized for.
     ///
-    /// [OAuth2 scopes]: https://discord.com/developers/docs/topics/oauth2#shared-resources-oauth2-scopes
+    /// [OAuth2 scopes]: crate::oauth::scope
     #[serde(skip_serializing_if = "Option::is_none")]
     pub scopes: Option<Vec<String>>,
     #[serde(skip_serializing_if = "Option::is_none")]
@@ -57,6 +57,7 @@ mod tests {
     };
     use crate::{
         id::Id,
+        oauth::scope,
         test::image_hash,
         util::datetime::{Timestamp, TimestampParseError},
     };
@@ -85,8 +86,8 @@ mod tests {
             revoked: Some(false),
             role_id: Some(Id::new(3)),
             scopes: Some(Vec::from([
-                "applications.commands".to_owned(),
-                "bot".to_owned(),
+                scope::APPLICATIONS_COMMANDS.to_owned(),
+                scope::BOT.to_owned(),
             ])),
             subscriber_count: Some(1337),
             synced_at: Some(synced_at),
@@ -156,8 +157,8 @@ mod tests {
                 Token::Str("scopes"),
                 Token::Some,
                 Token::Seq { len: Some(2) },
-                Token::Str("applications.commands"),
-                Token::Str("bot"),
+                Token::Str(scope::APPLICATIONS_COMMANDS),
+                Token::Str(scope::BOT),
                 Token::SeqEnd,
                 Token::Str("subscriber_count"),
                 Token::Some,
@@ -226,8 +227,8 @@ mod tests {
             revoked: Some(false),
             role_id: Some(Id::new(3)),
             scopes: Some(Vec::from([
-                "applications.commands".to_owned(),
-                "bot".to_owned(),
+                scope::APPLICATIONS_COMMANDS.to_owned(),
+                scope::BOT.to_owned(),
             ])),
             subscriber_count: Some(1337),
             synced_at: Some(synced_at),
@@ -312,8 +313,8 @@ mod tests {
                 Token::Str("scopes"),
                 Token::Some,
                 Token::Seq { len: Some(2) },
-                Token::Str("applications.commands"),
-                Token::Str("bot"),
+                Token::Str(scope::APPLICATIONS_COMMANDS),
+                Token::Str(scope::BOT),
                 Token::SeqEnd,
                 Token::Str("subscriber_count"),
                 Token::Some,

twilight-model/src/oauth/install_params.rs

@@ -10,14 +10,16 @@ use serde::{Deserialize, Serialize};
 pub struct InstallParams {
     /// Permissions to request for the bot role.
     pub permissions: Permissions,
-    /// Scopes to add the application to the guild with.
+    /// List of [scopes] to add the application to the guild with.
+    ///
+    /// [scopes]: crate::oauth::scope
     pub scopes: Vec<String>,
 }
 
 #[cfg(test)]
 mod tests {
     use super::InstallParams;
-    use crate::guild::Permissions;
+    use crate::{guild::Permissions, oauth::scope};
     use serde::{Deserialize, Serialize};
     use serde_test::Token;
     use static_assertions::assert_impl_all;
@@ -39,9 +41,9 @@ mod tests {
         let value = InstallParams {
             permissions: Permissions::empty(),
             scopes: Vec::from([
-                "applications.commands".to_owned(),
-                "applications.commands.permissions.update".to_owned(),
-                "identify".to_owned(),
+                scope::APPLICATIONS_COMMANDS.to_owned(),
+                scope::APPLICATIONS_COMMANDS_PERMISSIONS_UPDATE.to_owned(),
+                scope::IDENTIFY.to_owned(),
             ]),
         };
 
@@ -56,9 +58,9 @@ mod tests {
                 Token::String("0"),
                 Token::String("scopes"),
                 Token::Seq { len: Some(3) },
-                Token::String("applications.commands"),
-                Token::String("applications.commands.permissions.update"),
-                Token::String("identify"),
+                Token::String(scope::APPLICATIONS_COMMANDS),
+                Token::String(scope::APPLICATIONS_COMMANDS_PERMISSIONS_UPDATE),
+                Token::String(scope::IDENTIFY),
                 Token::SeqEnd,
                 Token::StructEnd,
             ],

twilight-model/src/oauth/mod.rs

@@ -1,3 +1,4 @@
+pub mod scope;
 pub mod team;
 
 pub mod current_application_info {

twilight-model/src/oauth/scope.rs

@@ -0,0 +1,128 @@
+//! Known list of available OAuth 2 scopes.
+//!
+//! Refer to [Discord Docs/OAuth 2 Scopes] for a complete up-to-date list.
+//!
+//! [Discord Docs/OAuth 2 Scopes]: https://discord.com/developers/docs/topics/oauth2#shared-resources-oauth2-scopes
+
+/// Allows your app to fetch data from a user's "Now Playing/Recently Played"
+/// list.
+///
+/// Requires approval from Discord.
+pub const ACTIVITIES_READ: &str = "activities.read";
+
+/// Allows your app to update a user's activity
+///
+/// Requires approval from Discord, but is not required for the Game SDK
+/// activity manager.
+pub const ACTIVITIES_WRITE: &str = "activities.write";
+
+/// Allows your app to read build data for a user's applications.
+pub const APPLICATIONS_BUILDS_READ: &str = "applications.builds.read";
+
+/// Allows your app to upload/update builds for a user's applications.
+///
+/// Requires approval from Discord.
+pub const APPLICATIONS_BUILDS_UPLOAD: &str = "applications.builds.upload";
+
+/// Allows your app to use commands in a guild.
+pub const APPLICATIONS_COMMANDS: &str = "applications.commands";
+
+/// Allows your app to update its commands using a Bearer token.
+///
+/// This is a client credentials grant only.
+pub const APPLICATIONS_COMMANDS_UPDATE: &str = "applications.commands.update";
+
+/// Allows your app to update permissions for its commands in a guild a user has
+/// permissions to.
+pub const APPLICATIONS_COMMANDS_PERMISSIONS_UPDATE: &str =
+    "applications.commands.permissions.update";
+
+/// Allows your app to read entitlements for a user's applications
+pub const APPLICATIONS_ENTITLEMENTS: &str = "applications.entitlements";
+
+/// Allows your app to read and update store data (SKUs, store listings,
+/// achievements, etc.) for a user's applications.
+pub const APPLICATIONS_STORE_UPDATE: &str = "applications.store.update";
+
+/// For oauth2 bots, this puts the bot in the user's selected guild by default
+pub const BOT: &str = "bot";
+
+/// Allows /users/@me/connections to return linked third-party accounts
+pub const CONNECTIONS: &str = "connections";
+
+/// Allows your app to see information about the user's DMs and group DMs
+///
+/// Requires approval from Discord.
+pub const DM_CHANNELS_READ: &str = "dm_channels.read";
+
+/// Enables `GET /users/@me` returning an email.
+pub const EMAIL: &str = "email";
+
+/// Allows your app to join users to a group DM.
+pub const GDM_JOIN: &str = "gdm.join";
+
+/// Allows `GET /users/@me/guilds` to return basic information about all of a
+/// user's guilds.
+pub const GUILDS: &str = "guilds";
+
+/// Allows `GET /guilds/{guild.id}/members/{user.id}` to be used for joining
+/// users to a guild.
+pub const GUILDS_JOIN: &str = "guilds.join";
+
+/// Allows `GET /users/@me/guilds/{guild.id}/member` to return a user's member
+/// information in a guild.
+pub const GUILDS_MEMBERS_READ: &str = "guilds.members.read";
+
+/// Allows `GET /users/@me`, but without the user's email.
+pub const IDENTIFY: &str = "identify";
+
+/// For local RPC server API access, this allows you to read messages from all
+/// client channels (otherwise restricted to channels/guilds your app creates).
+pub const MESSAGES_READ: &str = "messages.read";
+
+/// Allows your app to know a user's friends and implicit relationships.
+///
+/// Requires approval from Discord.
+pub const RELATIONSHIPS_READ: &str = "relationships.read";
+
+/// Allows your app to update a user's connection and metadata for the app.
+pub const ROLE_CONNECTIONS_WRITE: &str = "role_connections.write";
+
+/// For local RPC server access, this allows you to control a user's local
+/// Discord client.
+///
+/// Requires approval from Discord.
+pub const RPC: &str = "rpc";
+
+/// For local rpc server access, this allows you to update a user's activity
+///
+/// Requires approval from Discord.
+pub const RPC_ACTIVITIES_WRITE: &str = "rpc.activities.write";
+
+/// For local RPC server access, this allows you to receive notifications pushed
+/// out to the user.
+///
+/// Requires approval from Discord.
+pub const RPC_NOTIFICATIONS_READ: &str = "rpc.notifications.read";
+
+/// For local RPC server access, this allows you to read a user's voice settings
+/// and listen for voice events.
+///
+/// Requires approval from Discord.
+pub const RPC_VOICE_READ: &str = "rpc.voice.read";
+
+/// For local RPC server access, this allows you to update a user's voice
+/// settings.
+///
+/// Requires approval from Discord.
+pub const RPC_VOICE_WRITE: &str = "rpc.voice.write";
+
+/// Allows your app to connect to voice on the user's behalf and see all the
+/// voice members.
+///
+/// Requires approval from Discord.
+pub const VOICE: &str = "voice";
+
+/// This generates a webhook that is returned in the oauth token response for
+/// authorization code grants.
+pub const WEBHOOK_INCOMING: &str = "webhook.incoming";