feat(llc): added user blocking (#2033)

Co-authored-by: Sahil Kumar <[email protected]>

packages/stream_chat/CHANGELOG.md

@@ -1,3 +1,8 @@
+## Upcoming
+
+✅ Added
+- Added user blocking to the client.
+
 ## 8.1.0
 
 ✅ Added

packages/stream_chat/lib/src/client/client.dart

@@ -1277,6 +1277,18 @@ class StreamChatClient {
   Future<EmptyResponse> unmuteUser(String userId) =>
       _chatApi.moderation.unmuteUser(userId);
 
+  /// Blocks a user
+  Future<UserBlockResponse> blockUser(String userId) =>
+      _chatApi.user.blockUser(userId);
+
+  /// Unblocks a user
+  Future<EmptyResponse> unblockUser(String userId) =>
+      _chatApi.user.unblockUser(userId);
+
+  /// Requests users with a given query.
+  Future<BlockedUsersResponse> queryBlockedUsers() =>
+      _chatApi.user.queryBlockedUsers();
+
   /// Flag a message
   Future<EmptyResponse> flagMessage(String messageId) =>
       _chatApi.moderation.flagMessage(messageId);

packages/stream_chat/lib/src/core/api/responses.dart

@@ -13,6 +13,7 @@ import 'package:stream_chat/src/core/models/message.dart';
 import 'package:stream_chat/src/core/models/reaction.dart';
 import 'package:stream_chat/src/core/models/read.dart';
 import 'package:stream_chat/src/core/models/user.dart';
+import 'package:stream_chat/src/core/models/user_block.dart';
 
 part 'responses.g.dart';
 
@@ -530,3 +531,34 @@ class CreateCallPayload extends _BaseResponse {
   /// The call object.
   CallPayload? call;
 }
+
+/// Contains information about a [User] that was banned from a [Channel] or App.
+@JsonSerializable()
+class UserBlockResponse extends _BaseResponse {
+  /// User that banned the [user].
+  @JsonKey(defaultValue: '')
+  late String blockedByUserId;
+
+  /// Reason for the ban.
+  @JsonKey(defaultValue: '')
+  late String blockedUserId;
+
+  /// Timestamp when the [user] was banned.
+  late DateTime createdAt;
+
+  /// Create a new instance from a json
+  static UserBlockResponse fromJson(Map<String, dynamic> json) =>
+      _$UserBlockResponseFromJson(json);
+}
+
+/// Model response for [StreamChatClient.queryBlockedUsers] api call
+@JsonSerializable(createToJson: false)
+class BlockedUsersResponse extends _BaseResponse {
+  /// Updated users
+  @JsonKey(defaultValue: [])
+  late List<UserBlock> blocks;
+
+  /// Create a new instance from a json
+  static BlockedUsersResponse fromJson(Map<String, dynamic> json) =>
+      _$BlockedUsersResponseFromJson(json);
+}

packages/stream_chat/lib/src/core/api/user_api.dart

@@ -59,4 +59,32 @@ class UserApi {
     );
     return UpdateUsersResponse.fromJson(response.data);
   }
+
+  /// Blocks a user
+  Future<UserBlockResponse> blockUser(String userId) async {
+    final response = await _client.post(
+      '/users/block',
+      data: {'blocked_user_id': userId},
+    );
+
+    return UserBlockResponse.fromJson(response.data);
+  }
+
+  /// Unblocks a user
+  Future<EmptyResponse> unblockUser(String userId) async {
+    final response = await _client.post(
+      '/users/unblock',
+      data: {'blocked_user_id': userId},
+    );
+    return EmptyResponse.fromJson(response.data);
+  }
+
+  /// Requests blocked users.
+  Future<BlockedUsersResponse> queryBlockedUsers() async {
+    final response = await _client.get(
+      '/users/block',
+    );
+
+    return BlockedUsersResponse.fromJson(response.data);
+  }
 }