feature: update audit log models (#1373)

* Fix bugs

* Add missing properties

* Add missing properties to ChannelInfo

Remove UserLimit property

* Add missing properties to GuildInfo

Change ContentFilterLevel of type int? to ExplicitContentFilter of type ExplicitContentFilterLevel?

* Remove AvatarHash from MemberInfo

* Add missing doc comments

* Make ExplicitContentFilter public

* Add ChannelId property to overwrite audits

* Update doc comments based on feedback

Author: NeKzor

src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelCreateAuditLogData.cs

@@ -11,11 +11,14 @@ namespace Discord.Rest
     /// </summary>
     public class ChannelCreateAuditLogData : IAuditLogData
     {
-        private ChannelCreateAuditLogData(ulong id, string name, ChannelType type, IReadOnlyCollection<Overwrite> overwrites)
+        private ChannelCreateAuditLogData(ulong id, string name, ChannelType type, int? rateLimit, bool? nsfw, int? bitrate, IReadOnlyCollection<Overwrite> overwrites)
         {
             ChannelId = id;
             ChannelName = name;
             ChannelType = type;
+            SlowModeInterval = rateLimit;
+            IsNsfw = nsfw;
+            Bitrate = bitrate;
             Overwrites = overwrites;
         }
 
@@ -27,9 +30,15 @@ internal static ChannelCreateAuditLogData Create(BaseDiscordClient discord, Mode
             var overwritesModel = changes.FirstOrDefault(x => x.ChangedProperty == "permission_overwrites");
             var typeModel = changes.FirstOrDefault(x => x.ChangedProperty == "type");
             var nameModel = changes.FirstOrDefault(x => x.ChangedProperty == "name");
+            var rateLimitPerUserModel = changes.FirstOrDefault(x => x.ChangedProperty == "rate_limit_per_user");
+            var nsfwModel = changes.FirstOrDefault(x => x.ChangedProperty == "nsfw");
+            var bitrateModel = changes.FirstOrDefault(x => x.ChangedProperty == "bitrate");
 
             var type = typeModel.NewValue.ToObject<ChannelType>(discord.ApiClient.Serializer);
             var name = nameModel.NewValue.ToObject<string>(discord.ApiClient.Serializer);
+            int? rateLimitPerUser = rateLimitPerUserModel?.NewValue?.ToObject<int>(discord.ApiClient.Serializer);
+            bool? nsfw = nsfwModel?.NewValue?.ToObject<bool>(discord.ApiClient.Serializer);
+            int? bitrate = bitrateModel?.NewValue?.ToObject<int>(discord.ApiClient.Serializer);
 
             foreach (var overwrite in overwritesModel.NewValue)
             {
@@ -41,7 +50,7 @@ internal static ChannelCreateAuditLogData Create(BaseDiscordClient discord, Mode
                 overwrites.Add(new Overwrite(id, permType, new OverwritePermissions(allow, deny)));
             }
 
-            return new ChannelCreateAuditLogData(entry.TargetId.Value, name, type, overwrites.ToReadOnlyCollection());
+            return new ChannelCreateAuditLogData(entry.TargetId.Value, name, type, rateLimitPerUser, nsfw, bitrate, overwrites.ToReadOnlyCollection());
         }
 
         /// <summary>
@@ -66,6 +75,32 @@ internal static ChannelCreateAuditLogData Create(BaseDiscordClient discord, Mode
         /// </returns>
         public ChannelType ChannelType { get; }
         /// <summary>
+        ///     Gets the current slow-mode delay of the created channel.
+        /// </summary>
+        /// <returns>
+        ///     An <see cref="Int32"/> representing the time in seconds required before the user can send another
+        ///     message; <c>0</c> if disabled.
+        ///     <c>null</c> if this is not mentioned in this entry.
+        /// </returns>
+        public int? SlowModeInterval { get; }
+        /// <summary>
+        ///     Gets the value that indicates whether the created channel is NSFW.
+        /// </summary>
+        /// <returns>
+        ///     <c>true</c> if the created channel has the NSFW flag enabled; otherwise <c>false</c>.
+        ///     <c>null</c> if this is not mentioned in this entry.
+        /// </returns>
+        public bool? IsNsfw { get; }
+        /// <summary>
+        ///     Gets the bit-rate that the clients in the created voice channel are requested to use.
+        /// </summary>
+        /// <returns>
+        ///     An <see cref="Int32"/> representing the bit-rate (bps) that the created voice channel defines and requests the
+        ///     client(s) to use.
+        ///     <c>null</c> if this is not mentioned in this entry.
+        /// </returns>
+        public int? Bitrate { get; }
+        /// <summary>
         ///     Gets a collection of permission overwrites that was assigned to the created channel.
         /// </summary>
         /// <returns>

src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelDeleteAuditLogData.cs

@@ -11,11 +11,14 @@ namespace Discord.Rest
     /// </summary>
     public class ChannelDeleteAuditLogData : IAuditLogData
     {
-        private ChannelDeleteAuditLogData(ulong id, string name, ChannelType type, IReadOnlyCollection<Overwrite> overwrites)
+        private ChannelDeleteAuditLogData(ulong id, string name, ChannelType type, int? rateLimit, bool? nsfw, int? bitrate, IReadOnlyCollection<Overwrite> overwrites)
         {
             ChannelId = id;
             ChannelName = name;
             ChannelType = type;
+            SlowModeInterval = rateLimit;
+            IsNsfw = nsfw;
+            Bitrate = bitrate;
             Overwrites = overwrites;
         }
 
@@ -26,15 +29,21 @@ internal static ChannelDeleteAuditLogData Create(BaseDiscordClient discord, Mode
             var overwritesModel = changes.FirstOrDefault(x => x.ChangedProperty == "permission_overwrites");
             var typeModel = changes.FirstOrDefault(x => x.ChangedProperty == "type");
             var nameModel = changes.FirstOrDefault(x => x.ChangedProperty == "name");
+            var rateLimitPerUserModel = changes.FirstOrDefault(x => x.ChangedProperty == "rate_limit_per_user");
+            var nsfwModel = changes.FirstOrDefault(x => x.ChangedProperty == "nsfw");
+            var bitrateModel = changes.FirstOrDefault(x => x.ChangedProperty == "bitrate");
 
             var overwrites = overwritesModel.OldValue.ToObject<API.Overwrite[]>(discord.ApiClient.Serializer)
                 .Select(x => new Overwrite(x.TargetId, x.TargetType, new OverwritePermissions(x.Allow, x.Deny)))
                 .ToList();
             var type = typeModel.OldValue.ToObject<ChannelType>(discord.ApiClient.Serializer);
             var name = nameModel.OldValue.ToObject<string>(discord.ApiClient.Serializer);
+            int? rateLimitPerUser = rateLimitPerUserModel?.OldValue?.ToObject<int>(discord.ApiClient.Serializer);
+            bool? nsfw = nsfwModel?.OldValue?.ToObject<bool>(discord.ApiClient.Serializer);
+            int? bitrate = bitrateModel?.OldValue?.ToObject<int>(discord.ApiClient.Serializer);
             var id = entry.TargetId.Value;
 
-            return new ChannelDeleteAuditLogData(id, name, type, overwrites.ToReadOnlyCollection());
+            return new ChannelDeleteAuditLogData(id, name, type, rateLimitPerUser, nsfw, bitrate, overwrites.ToReadOnlyCollection());
         }
 
         /// <summary>
@@ -59,6 +68,31 @@ internal static ChannelDeleteAuditLogData Create(BaseDiscordClient discord, Mode
         /// </returns>
         public ChannelType ChannelType { get; }
         /// <summary>
+        ///     Gets the slow-mode delay of the deleted channel.
+        /// </summary>
+        /// <returns>
+        ///     An <see cref="Int32"/> representing the time in seconds required before the user can send another
+        ///     message; <c>0</c> if disabled.
+        ///     <c>null</c> if this is not mentioned in this entry.
+        /// </returns>
+        public int? SlowModeInterval { get; }
+        /// <summary>
+        ///     Gets the value that indicates whether the deleted channel was NSFW.
+        /// </summary>
+        /// <returns>
+        ///     <c>true</c> if this channel had the NSFW flag enabled; otherwise <c>false</c>.
+        ///     <c>null</c> if this is not mentioned in this entry.
+        /// </returns>
+        public bool? IsNsfw { get; }
+        /// <summary>
+        ///     Gets the bit-rate of this channel if applicable.
+        /// </summary>
+        /// <returns>
+        ///     An <see cref="Int32"/> representing the bit-rate set of the voice channel.
+        ///     <c>null</c> if this is not mentioned in this entry.
+        /// </returns>
+        public int? Bitrate { get; }
+        /// <summary>
         ///     Gets a collection of permission overwrites that was assigned to the deleted channel.
         /// </summary>
         /// <returns>

src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelInfo.cs

@@ -5,12 +5,13 @@ namespace Discord.Rest
     /// </summary>
     public struct ChannelInfo
     {
-        internal ChannelInfo(string name, string topic, int? bitrate, int? limit)
+        internal ChannelInfo(string name, string topic, int? rateLimit, bool? nsfw, int? bitrate)
         {
             Name = name;
             Topic = topic;
+            SlowModeInterval = rateLimit;
+            IsNsfw = nsfw;
             Bitrate = bitrate;
-            UserLimit = limit;
         }
 
         /// <summary>
@@ -28,20 +29,29 @@ internal ChannelInfo(string name, string topic, int? bitrate, int? limit)
         /// </returns>
         public string Topic { get; }
         /// <summary>
-        ///     Gets the bit-rate of this channel if applicable.
+        ///     Gets the current slow-mode delay of this channel.
         /// </summary>
         /// <returns>
-        ///     An <see cref="System.Int32"/> representing the bit-rate set for the voice channel; <c>null</c> if not
-        ///     applicable.
+        ///     An <see cref="Int32"/> representing the time in seconds required before the user can send another
+        ///     message; <c>0</c> if disabled.
+        ///     <c>null</c> if this is not mentioned in this entry.
         /// </returns>
-        public int? Bitrate { get; }
+        public int? SlowModeInterval { get; }
+        /// <summary>
+        ///     Gets the value that indicates whether this channel is NSFW.
+        /// </summary>
+        /// <returns>
+        ///     <c>true</c> if this channel has the NSFW flag enabled; otherwise <c>false</c>.
+        ///     <c>null</c> if this is not mentioned in this entry.
+        /// </returns>
+        public bool? IsNsfw { get; }
         /// <summary>
-        ///     Gets the number of users allowed to be in this channel if applicable.
+        ///     Gets the bit-rate of this channel if applicable.
         /// </summary>
         /// <returns>
-        ///     An <see cref="System.Int32" /> representing the number of users allowed to be in this voice channel; 
-        ///     <c>null</c> if not applicable.
+        ///     An <see cref="Int32"/> representing the bit-rate set for the voice channel;
+        ///     <c>null</c> if this is not mentioned in this entry.
         /// </returns>
-        public int? UserLimit { get; }
+        public int? Bitrate { get; }
     }
 }

src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelUpdateAuditLogData.cs

@@ -23,20 +23,23 @@ internal static ChannelUpdateAuditLogData Create(BaseDiscordClient discord, Mode
 
             var nameModel = changes.FirstOrDefault(x => x.ChangedProperty == "name");
             var topicModel = changes.FirstOrDefault(x => x.ChangedProperty == "topic");
+            var rateLimitPerUserModel = changes.FirstOrDefault(x => x.ChangedProperty == "rate_limit_per_user");
+            var nsfwModel = changes.FirstOrDefault(x => x.ChangedProperty == "nsfw");
             var bitrateModel = changes.FirstOrDefault(x => x.ChangedProperty == "bitrate");
-            var userLimitModel = changes.FirstOrDefault(x => x.ChangedProperty == "user_limit");
 
             string oldName = nameModel?.OldValue?.ToObject<string>(discord.ApiClient.Serializer),
                 newName = nameModel?.NewValue?.ToObject<string>(discord.ApiClient.Serializer);
             string oldTopic = topicModel?.OldValue?.ToObject<string>(discord.ApiClient.Serializer),
                 newTopic = topicModel?.NewValue?.ToObject<string>(discord.ApiClient.Serializer);
+            int? oldRateLimitPerUser = rateLimitPerUserModel?.OldValue?.ToObject<int>(discord.ApiClient.Serializer),
+                newRateLimitPerUser = rateLimitPerUserModel?.NewValue?.ToObject<int>(discord.ApiClient.Serializer);
+            bool? oldNsfw = nsfwModel?.OldValue?.ToObject<bool>(discord.ApiClient.Serializer),
+                newNsfw = nsfwModel?.NewValue?.ToObject<bool>(discord.ApiClient.Serializer);
             int? oldBitrate = bitrateModel?.OldValue?.ToObject<int>(discord.ApiClient.Serializer),
                 newBitrate = bitrateModel?.NewValue?.ToObject<int>(discord.ApiClient.Serializer);
-            int? oldLimit = userLimitModel?.OldValue?.ToObject<int>(discord.ApiClient.Serializer),
-                newLimit = userLimitModel?.NewValue?.ToObject<int>(discord.ApiClient.Serializer);
 
-            var before = new ChannelInfo(oldName, oldTopic, oldBitrate, oldLimit);
-            var after = new ChannelInfo(newName, newTopic, newBitrate, newLimit);
+            var before = new ChannelInfo(oldName, oldTopic, oldRateLimitPerUser, oldNsfw, oldBitrate);
+            var after = new ChannelInfo(newName, newTopic, newRateLimitPerUser, newNsfw, newBitrate);
 
             return new ChannelUpdateAuditLogData(entry.TargetId.Value, before, after);
         }

src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/GuildInfo.cs

@@ -7,7 +7,8 @@ public struct GuildInfo
     {
         internal GuildInfo(int? afkTimeout, DefaultMessageNotifications? defaultNotifs,
             ulong? afkChannel, string name, string region, string icon,
-            VerificationLevel? verification, IUser owner, MfaLevel? mfa, int? filter)
+            VerificationLevel? verification, IUser owner, MfaLevel? mfa, ExplicitContentFilterLevel? filter,
+            ulong? systemChannel, ulong? widgetChannel, bool? widget)
         {
             AfkTimeout = afkTimeout;
             DefaultMessageNotifications = defaultNotifs;
@@ -18,7 +19,10 @@ internal GuildInfo(int? afkTimeout, DefaultMessageNotifications? defaultNotifs,
             VerificationLevel = verification;
             Owner = owner;
             MfaLevel = mfa;
-            ContentFilterLevel = filter;
+            ExplicitContentFilter = filter;
+            SystemChannelId = systemChannel;
+            EmbedChannelId = widgetChannel;
+            IsEmbeddable = widget;
         }
 
         /// <summary>
@@ -28,11 +32,16 @@ internal GuildInfo(int? afkTimeout, DefaultMessageNotifications? defaultNotifs,
         /// <returns>
         ///     An <see cref="int"/> representing the amount of time in seconds for a user to be marked as inactive
         ///     and moved into the AFK voice channel.
+        ///     <c>null</c> if this is not mentioned in this entry.
         /// </returns>
         public int? AfkTimeout { get; }
         /// <summary>
         ///     Gets the default message notifications for users who haven't explicitly set their notification settings.
         /// </summary>
+        /// <returns>
+        ///     The default message notifications setting of this guild.
+        ///     <c>null</c> if this is not mentioned in this entry.
+        /// </returns>
         public DefaultMessageNotifications? DefaultMessageNotifications { get; }
         /// <summary>
         ///     Gets the ID of the AFK voice channel for this guild.
@@ -65,6 +74,7 @@ internal GuildInfo(int? afkTimeout, DefaultMessageNotifications? defaultNotifs,
         /// </summary>
         /// <returns>
         ///     The level of requirements.
+        ///     <c>null</c> if this is not mentioned in this entry.
         /// </returns>
         public VerificationLevel? VerificationLevel { get; }
         /// <summary>
@@ -80,8 +90,39 @@ internal GuildInfo(int? afkTimeout, DefaultMessageNotifications? defaultNotifs,
         /// </summary>
         /// <returns>
         ///     The level of MFA requirement.
+        ///     <c>null</c> if this is not mentioned in this entry.
         /// </returns>
         public MfaLevel? MfaLevel { get; }
-        public int? ContentFilterLevel { get; }
+        /// <summary>
+        ///     Gets the level of content filtering applied to user's content in a Guild.
+        /// </summary>
+        /// <returns>
+        ///     The level of explicit content filtering.
+        /// </returns>
+        public ExplicitContentFilterLevel? ExplicitContentFilter { get; }
+        /// <summary>
+        ///     Gets the ID of the channel where system messages are sent.
+        /// </summary>
+        /// <returns>
+        ///     A <see cref="ulong"/> representing the snowflake identifier of the channel where system
+        ///     messages are sent; <c>null</c> if none is set.
+        /// </returns>
+        public ulong? SystemChannelId { get; }
+        /// <summary>
+        ///     Gets the ID of the widget embed channel of this guild.
+        /// </summary>
+        /// <returns>
+        ///     A <see cref="ulong"/> representing the snowflake identifier of the embedded channel found within the
+        ///     widget settings of this guild; <c>null</c> if none is set.
+        /// </returns>
+        public ulong? EmbedChannelId { get; }
+        /// <summary>
+        ///     Gets a value that indicates whether this guild is embeddable (i.e. can use widget).
+        /// </summary>
+        /// <returns>
+        ///     <c>true</c> if this guild can be embedded via widgets; otherwise <c>false</c>.
+        ///     <c>null</c> if this is not mentioned in this entry.
+        /// </returns>
+        public bool? IsEmbeddable { get; }
     }
 }