feat: moderation apis (#163)

* feat: moderation apis

* refactor: lint fixes

* Revert obsolete changes

* Revert obsolete change

* Fix failing tests. The `api/v2/moderation/check` endpoint returns 201 (Created) HTTP status code on success.

---------

Co-authored-by: Daniel Sierpiński <33436839+sierpinskid@users.noreply.github.com>

Author: vishalnarkhede

samples/DocsExamples/ChannelUpdate.cs

@@ -33,7 +33,7 @@ public async Task ArchivingAChannel()
             },
             UserId = "user-id",
         });
-        
+
         // Unarchive
         var unarchiveResponse = await _channelClient.UnarchiveAsync("messaging", "channel-id", "user-id");
     }
@@ -55,7 +55,7 @@ public async Task PinningAChannel()
             },
             UserId = "user-id",
         });
-        
+
         // Unpin
         var unpinResponse = await _channelClient.UnpinAsync("messaging", "channel-id", "user-id");
     }

samples/DocsExamples/ExportingChannels.cs

@@ -27,7 +27,7 @@ public async Task ExportUsersAsync()
     public async Task RetrievingTaskStatusAsync()
     {
         var taskId = string.Empty;
-        
+
         // ITaskClient can provide the status of the export operation
         var taskStatus = await _taskClient.GetTaskStatusAsync(taskId);
         if (taskStatus.Status == AsyncTaskStatus.Completed)

samples/DocsExamples/UserPermissions.cs

@@ -13,7 +13,7 @@ internal class UserPermissions
     private readonly IPermissionClient _permissionClient;
     private readonly IChannelTypeClient _channelTypeClient;
     private readonly IAppClient _appClient;
-    
+
     public UserPermissions()
     {
         var factory = new StreamClientFactory("{{ api_key }}", "{{ api_secret }}");

src/Clients/AppClient.cs

@@ -12,12 +12,16 @@ namespace StreamChat.Clients
     public class AppClient : ClientBase, IAppClient
     {
         private readonly string _apiSecret;
+        private readonly Lazy<IModerationClient> _moderationClient;
 
         internal AppClient(IRestClient client, string apiSecret) : base(client)
         {
             _apiSecret = apiSecret;
+            _moderationClient = new Lazy<IModerationClient>(() => new ModerationClient(client));
         }
 
+        public IModerationClient Moderation => _moderationClient.Value;
+
         public async Task<GetAppResponse> GetAppSettingsAsync()
             => await ExecuteRequestAsync<GetAppResponse>("app",
                 HttpMethod.GET,

src/Clients/IAppClient.cs

@@ -10,6 +10,11 @@ namespace StreamChat.Clients
     /// <remarks>https://getstream.io/chat/docs/dotnet-csharp/app_setting_overview/?language=csharp</remarks>
     public interface IAppClient
     {
+        /// <summary>
+        /// Gets the moderation client that can be used to access moderation endpoints.
+        /// </summary>
+        IModerationClient Moderation { get; }
+
         /// <summary>
         /// <para>Returns the application settings.</para>
         /// Application level settings allow you to configure settings that impact all the channel types in your app.

src/Clients/IModerationClient.cs

@@ -0,0 +1,37 @@
+using System.Threading.Tasks;
+using StreamChat.Models;
+
+namespace StreamChat.Clients
+{
+    /// <summary>
+    /// A client that can be used to access moderation endpoints of a Stream Chat application.
+    /// </summary>
+    public interface IModerationClient
+    {
+        /// <summary>
+        /// Check content for moderation.
+        /// </summary>
+        /// <param name="entityType">Type of entity to be checked E.g., stream:user, stream:chat:v1:message, or any custom string. Predefined values are listed in <see cref="ModerationEntityTypes"/></param>
+        /// <param name="entityId">ID of the entity to be checked. This is mainly for tracking purposes</param>
+        /// <param name="entityCreatorId">ID of the entity creator</param>
+        /// <param name="moderationPayload">Content to be checked for moderation. E.g., texts, images, videos</param>
+        /// <param name="configKey">Configuration key for moderation</param>
+        /// <param name="options">Additional options for moderation check</param>
+        Task<ModerationCheckResponse> CheckAsync(
+            string entityType,
+            string entityId,
+            string entityCreatorId,
+            ModerationPayload moderationPayload,
+            string configKey,
+            ModerationCheckOptions options = null);
+
+        /// <summary>
+        /// Experimental: Check user profile for moderation.
+        /// This will not create any review queue items for the user profile.
+        /// You can use this to check whether to allow certain user profile to be created or not.
+        /// </summary>
+        /// <param name="userId">ID of the user</param>
+        /// <param name="profile">User profile data containing username and/or profile image</param>
+        Task<ModerationCheckResponse> CheckUserProfileAsync(string userId, UserProfileCheckRequest profile);
+    }
+}

src/Clients/IStreamClientFactory.cs

@@ -89,5 +89,11 @@ public interface IStreamClientFactory
         /// </summary>
         /// <remarks>https://getstream.io/chat/docs/dotnet-csharp/tokens_and_authentication/?language=csharp</remarks>
         IUserClient GetUserClient();
+
+        /// <summary>
+        /// Gets a client that can be used to access moderation endpoints.
+        /// </summary>
+        /// <remarks>https://getstream.io/chat/docs/dotnet-csharp/moderation/?language=csharp</remarks>
+        IModerationClient GetModerationClient();
     }
 }

src/Clients/ModerationClient.cs

@@ -0,0 +1,67 @@
+using System;
+using System.Collections.Generic;
+using System.Net;
+using System.Threading.Tasks;
+using StreamChat.Models;
+using StreamChat.Rest;
+
+namespace StreamChat.Clients
+{
+    public class ModerationClient : ClientBase, IModerationClient
+    {
+        internal ModerationClient(IRestClient client) : base(client)
+        {
+        }
+
+        public async Task<ModerationCheckResponse> CheckAsync(
+            string entityType,
+            string entityId,
+            string entityCreatorId,
+            ModerationPayload moderationPayload,
+            string configKey,
+            ModerationCheckOptions options = null)
+        {
+            var request = new
+            {
+                entity_type = entityType,
+                entity_id = entityId,
+                entity_creator_id = entityCreatorId,
+                moderation_payload = moderationPayload,
+                config_key = configKey,
+                options,
+            };
+
+            return await ExecuteRequestAsync<ModerationCheckResponse>(
+                "api/v2/moderation/check",
+                HttpMethod.POST,
+                HttpStatusCode.Created,
+                request);
+        }
+
+        public Task<ModerationCheckResponse> CheckUserProfileAsync(string userId, UserProfileCheckRequest profile)
+        {
+            if (string.IsNullOrEmpty(profile?.Username) && string.IsNullOrEmpty(profile?.Image))
+            {
+                throw new ArgumentException($"Either `{nameof(profile.Username)}` or `{nameof(profile.Image)}` must be provided", nameof(profile));
+            }
+
+            var payload = new ModerationPayload
+            {
+                Texts = !string.IsNullOrEmpty(profile.Username) ? new List<string> { profile.Username } : null,
+                Images = !string.IsNullOrEmpty(profile.Image) ? new List<string> { profile.Image } : null,
+            };
+
+            return CheckAsync(
+                ModerationEntityTypes.UserProfile,
+                userId,
+                userId,
+                payload,
+                "user_profile:default",
+                new ModerationCheckOptions
+                {
+                    ForceSync = true,
+                    TestMode = true,
+                });
+        }
+    }
+}

src/Clients/StreamClientFactory.cs

@@ -25,6 +25,7 @@ public class StreamClientFactory : IStreamClientFactory
         private readonly IPermissionClient _permissionClient;
         private readonly IReactionClient _reactionClient;
         private readonly ITaskClient _taskClient;
+        private readonly IModerationClient _moderationClient;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="StreamClientFactory"/> class.
@@ -90,6 +91,7 @@ public StreamClientFactory(string apiKey, string apiSecret, Action<ClientOptions
             _reactionClient = new ReactionClient(restClient);
             _taskClient = new TaskClient(restClient);
             _userClient = new UserClient(restClient, jwtGeneratorClient, apiSecret);
+            _moderationClient = new ModerationClient(restClient);
         }
 
         public IAppClient GetAppClient() => _appClient;
@@ -106,5 +108,6 @@ public StreamClientFactory(string apiKey, string apiSecret, Action<ClientOptions
         public IReactionClient GetReactionClient() => _reactionClient;
         public ITaskClient GetTaskClient() => _taskClient;
         public IUserClient GetUserClient() => _userClient;
+        public IModerationClient GetModerationClient() => _moderationClient;
     }
 }

src/Models/ModerationModels.cs

@@ -0,0 +1,37 @@
+using System.Collections.Generic;
+
+namespace StreamChat.Models
+{
+    public class ModerationPayload
+    {
+        public List<string> Texts { get; set; }
+        public List<string> Images { get; set; }
+        public List<string> Videos { get; set; }
+        public Dictionary<string, object> Custom { get; set; }
+    }
+
+    public class ModerationCheckOptions
+    {
+        public bool? ForceSync { get; set; }
+        public bool? TestMode { get; set; }
+    }
+
+    public class UserProfileCheckRequest
+    {
+        public string Username { get; set; }
+        public string Image { get; set; }
+    }
+
+    public class ModerationCheckResponse : ApiResponse
+    {
+        public string RecommendedAction { get; set; }
+        public string Status { get; set; }
+    }
+
+    public static class ModerationEntityTypes
+    {
+        public const string User = "stream:user";
+        public const string Message = "stream:chat:v1:message";
+        public const string UserProfile = "stream:v1:user_profile";
+    }
+}