feat(truncate): add user id for truncation (#107)

Author: peterdeme

src/Clients/IChannelClient.cs

@@ -56,7 +56,7 @@ public interface IChannelClient
 
         /// <summary>
         /// <para>Mutes a channel.</para>
-        /// Messages added to a channel will not trigger push notifications, nor change the
+        /// Messages added to a muted channel will not trigger push notifications, nor change the
         /// unread count for the users that muted it. By default, mutes stay in place indefinitely
         /// until the user removes it; however, you can optionally set an expiration time. The list
         /// of muted channels and their expiration time is returned when the user connects.
@@ -66,10 +66,11 @@ public interface IChannelClient
 
         /// <summary>
         /// <para>Unmutes a channel.</para>
-        /// Messages added to a channel will not trigger push notifications, nor change the
+        /// Messages added to a muted channel will not trigger push notifications, nor change the
         /// unread count for the users that muted it. By default, mutes stay in place indefinitely
         /// until the user removes it; however, you can optionally set an expiration time. The list
         /// of muted channels and their expiration time is returned when the user connects.
+        /// This method removes the mute which means the users will receive notifications again.
         /// </summary>
         /// <remarks>https://getstream.io/chat/docs/dotnet-csharp/muting_channels/?language=csharp</remarks>
         Task<ChannelUnmuteResponse> UnmuteChannelAsync(ChannelUnmuteRequest request);

src/Models/Channel.cs

@@ -50,6 +50,9 @@ public class Channel : CustomDataBase
 
         [JsonProperty(NullValueHandling = NullValueHandling.Ignore, PropertyName = "last_message_at")]
         public DateTimeOffset? LastMessageAt { get; set; }
+
+        [JsonProperty(NullValueHandling = NullValueHandling.Ignore, PropertyName = "truncated_by")]
+        public User TruncatedBy { get; set; }
     }
 
     public class ChannelWithConfig : Channel
@@ -137,6 +140,12 @@ public class TruncateOptions
 
         [JsonProperty(NullValueHandling = NullValueHandling.Ignore, PropertyName = "truncated_at")]
         public DateTimeOffset? TruncatedAt { get; set; }
+
+        [JsonProperty(NullValueHandling = NullValueHandling.Ignore, PropertyName = "user_id")]
+        public string UserId { get; set; }
+
+        [JsonProperty(NullValueHandling = NullValueHandling.Ignore, PropertyName = "user")]
+        public User User { get; set; }
     }
 
     public class TruncateResponse : ApiResponse

tests/ChannelClientTests.cs

@@ -151,10 +151,13 @@ public async Task TestChannelTruncateAsync()
             var originalChannel = await _channelClient.GetOrCreateAsync(_channel.Type, _channel.Id, new ChannelGetRequest { State = true });
             originalChannel.Messages.Should().NotBeEmpty();
 
-            await _channelClient.TruncateAsync(_channel.Type, _channel.Id);
+            await _channelClient.TruncateAsync(_channel.Type, _channel.Id, new TruncateOptions { UserId = _user2.Id });
 
             var afterTruncateChannel = await _channelClient.GetOrCreateAsync(_channel.Type, _channel.Id, new ChannelGetRequest { State = true });
             afterTruncateChannel.Messages.Should().BeEmpty();
+
+            // this isn't deployed to the test environment, so uncomment it a bit later:
+            // afterTruncateChannel.Channel.TruncatedBy.Id.Should().Be(_user2.Id);
         }
 
         [Test]