Add support for incident actions (#3424)

Rebase of #3079 now that this feature is stable and documented.

---------

Co-authored-by: jamesbt365 <[email protected]>

Author: mkrasnitski

src/builder/edit_guild_incident_actions.rs

@@ -0,0 +1,47 @@
+#[cfg(feature = "http")]
+use crate::http::Http;
+#[cfg(feature = "http")]
+use crate::internal::prelude::*;
+use crate::model::prelude::*;
+
+/// A builder for editing guild incident actions.
+///
+/// [Discord's docs]: https://discord.com/developers/docs/resources/guild#modify-guild-incident-actions
+#[derive(Clone, Debug, Default, Serialize)]
+#[must_use]
+pub struct EditGuildIncidentActions {
+    invites_disabled_until: Option<Timestamp>,
+    dms_disabled_until: Option<Timestamp>,
+}
+
+impl EditGuildIncidentActions {
+    pub fn new() -> Self {
+        Self::default()
+    }
+
+    /// Sets the time until which guild invites will remain disabled, which can be at most 24 hours
+    /// in the future.
+    pub fn invites_disabled_until(mut self, timestamp: Timestamp) -> Self {
+        self.invites_disabled_until = Some(timestamp);
+        self
+    }
+
+    /// Sets the time at which direct messages for users within the guild will remain disabled,
+    /// which can be at most 24 hours in the future.
+    pub fn dms_disabled_until(mut self, timestamp: Timestamp) -> Self {
+        self.dms_disabled_until = Some(timestamp);
+        self
+    }
+
+    /// Modifies the guild's incident actions.
+    ///
+    /// # Errors
+    ///
+    /// Returns [`Error::Http`] if invalid data is given. See [Discord's docs] for more details.
+    ///
+    /// May also return [`Error::Json`] if there is an error in deserializing the API response.
+    #[cfg(feature = "http")]
+    pub async fn execute(self, http: &Http, guild_id: GuildId) -> Result<IncidentsData> {
+        http.edit_guild_incident_actions(guild_id, &self).await
+    }
+}

src/builder/mod.rs

@@ -61,6 +61,7 @@ mod create_webhook;
 mod edit_automod_rule;
 mod edit_channel;
 mod edit_guild;
+mod edit_guild_incident_actions;
 mod edit_guild_welcome_screen;
 mod edit_guild_widget;
 mod edit_interaction_response;
@@ -105,6 +106,7 @@ pub use create_webhook::*;
 pub use edit_automod_rule::*;
 pub use edit_channel::*;
 pub use edit_guild::*;
+pub use edit_guild_incident_actions::*;
 pub use edit_guild_welcome_screen::*;
 pub use edit_guild_widget::*;
 pub use edit_interaction_response::*;

src/http/client.rs

@@ -4871,6 +4871,29 @@ impl Http {
         .await
     }
 
+    /// Modify the guild's incident actions.
+    ///
+    /// **Note**: Requires the [Manage Guild] permission.
+    ///
+    /// [Manage Guild]: Permissions::MANAGE_GUILD
+    pub async fn edit_guild_incident_actions(
+        &self,
+        guild_id: GuildId,
+        map: &impl serde::Serialize,
+    ) -> Result<IncidentsData> {
+        self.fire(Request {
+            body: Some(to_vec(map)?),
+            multipart: None,
+            headers: None,
+            method: LightMethod::Put,
+            route: Route::GuildIncidentActions {
+                guild_id,
+            },
+            params: None,
+        })
+        .await
+    }
+
     /// Starts typing in the specified [`Channel`] for an indefinite period of time.
     ///
     /// Returns [`Typing`] that is used to trigger the typing. [`Typing::stop`] must be called on

src/http/routing.rs

@@ -354,6 +354,10 @@ routes! ('a, {
     api!("/guilds/{}/threads/active", guild_id),
     Some(RatelimitingKind::PathAndId(guild_id.into()));
 
+    GuildIncidentActions { guild_id: GuildId },
+    api!("/guilds/{}/incident-actions", guild_id),
+    Some(RatelimitingKind::PathAndId(guild_id.into()));
+
     Guilds,
     api!("/guilds"),
     Some(RatelimitingKind::Path);

src/model/guild/guild_id.rs

@@ -15,6 +15,7 @@ use crate::builder::{
     EditAutoModRule,
     EditCommandPermissions,
     EditGuild,
+    EditGuildIncidentActions,
     EditGuildWelcomeScreen,
     EditGuildWidget,
     EditMember,
@@ -1787,6 +1788,28 @@ impl GuildId {
     ) -> Result<()> {
         http.as_ref().delete_guild_soundboard(self, sound_id, audit_log_reason).await
     }
+
+    /// Edits the guild incident actions
+    ///
+    /// **Note**: Requires the [Manage Guild] permission.
+    ///
+    /// [Manage Guild]: Permissions::MANAGE_GUILD
+    ///
+    /// # Errors
+    ///
+    /// Returns [`Error::Http`] if invalid data is given. See [Discord's docs] for more details.
+    ///
+    /// May also return [`Error::Json`] if there is an error in deserializing the API response.
+    ///
+    /// [Discord's docs]: https://discord.com/developers/docs/resources/guild#modify-guild-incident-actions
+    pub async fn edit_guild_incident_actions(
+        self,
+        http: &Http,
+        guild_id: GuildId,
+        builder: EditGuildIncidentActions,
+    ) -> Result<IncidentsData> {
+        builder.execute(http, guild_id).await
+    }
 }
 
 impl From<PartialGuild> for GuildId {

src/model/guild/mod.rs

@@ -42,6 +42,7 @@ use crate::builder::{
     EditAutoModRule,
     EditCommandPermissions,
     EditGuild,
+    EditGuildIncidentActions,
     EditGuildWelcomeScreen,
     EditGuildWidget,
     EditMember,
@@ -263,6 +264,10 @@ pub struct Guild {
     /// The stage instances in this guild.
     #[serde(rename = "guild_scheduled_events")]
     pub scheduled_events: Vec<ScheduledEvent>,
+    /// The id of the channel where this guild will recieve safety alerts.
+    pub safety_alerts_channel_id: Option<ChannelId>,
+    /// The incidents data for this guild, if any.
+    pub incidents_data: Option<IncidentsData>,
 }
 
 #[cfg(feature = "model")]
@@ -2618,6 +2623,28 @@ impl Guild {
     ) -> Result<()> {
         self.id.delete_soundboard(http, sound_id, audit_log_reason).await
     }
+
+    /// Edits the guild incident actions
+    ///
+    /// **Note**: Requires the [Manage Guild] permission.
+    ///
+    /// [Manage Guild]: Permissions::MANAGE_GUILD
+    ///
+    /// # Errors
+    ///
+    /// Returns [`Error::Http`] if invalid data is given. See [Discord's docs] for more details.
+    ///
+    /// May also return [`Error::Json`] if there is an error in deserializing the API response.
+    ///
+    /// [Discord's docs]: https://discord.com/developers/docs/resources/guild#modify-guild-incident-actions
+    pub async fn edit_guild_incident_actions(
+        self,
+        http: &Http,
+        guild_id: GuildId,
+        builder: EditGuildIncidentActions,
+    ) -> Result<IncidentsData> {
+        builder.execute(http, guild_id).await
+    }
 }
 
 #[cfg(feature = "model")]
@@ -2939,6 +2966,23 @@ enum_number! {
     }
 }
 
+/// The [`Guild`]'s incident's data.
+///
+/// [Discord docs](https://discord.com/developers/docs/resources/guild#incidents-data-object).
+#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
+#[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
+#[non_exhaustive]
+pub struct IncidentsData {
+    /// The time that invites get enabled again.
+    pub invites_disabled_until: Option<Timestamp>,
+    /// The time that dms get enabled again.
+    pub dms_disabled_until: Option<Timestamp>,
+    /// The time when elevated dm activity was triggered.
+    pub dm_spam_detected_at: Option<Timestamp>,
+    /// The time when raid alerts were triggered.
+    pub raid_detected_at: Option<Timestamp>,
+}
+
 #[cfg(test)]
 mod test {
     #[cfg(feature = "model")]

src/model/guild/partial_guild.rs

@@ -1,5 +1,6 @@
 use serde::Serialize;
 
+use super::IncidentsData;
 #[cfg(feature = "model")]
 use crate::builder::{
     CreateChannel,
@@ -176,6 +177,10 @@ pub struct PartialGuild {
     pub stickers: HashMap<StickerId, Sticker>,
     /// Whether the guild has the boost progress bar enabled
     pub premium_progress_bar_enabled: bool,
+    /// The id of the channel where this guild will recieve safety alerts.
+    pub safety_alerts_channel_id: Option<ChannelId>,
+    /// The incidents data for this guild, if any.
+    pub incidents_data: Option<IncidentsData>,
 }
 
 #[cfg(feature = "model")]
@@ -1708,6 +1713,8 @@ impl From<Guild> for PartialGuild {
             preferred_locale: guild.preferred_locale,
             max_stage_video_channel_users: guild.max_stage_video_channel_users,
             premium_progress_bar_enabled: guild.premium_progress_bar_enabled,
+            safety_alerts_channel_id: guild.safety_alerts_channel_id,
+            incidents_data: guild.incidents_data,
         }
     }
 }