Add bulkBan to GuildManager (#640)

* add `bulkBan` to `GuildManager` * add `.toList()` to `user_ids` * make `bannedUsers`/`failedUsers` not-null, after spec update * apply abito suggestion Co-authored-by: Abitofevrything <[email protected]> * export BulkBanResponse --------- Co-authored-by: Abitofevrything <[email protected]>
nyxx-discord · Mar 29, 2024 · 6adc5ff · 6adc5ff
1 parent 10181ac
commit 6adc5ff
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 3 deletions.
diff --git a/lib/nyxx.dart b/lib/nyxx.dart
@@ -164,7 +164,7 @@ export 'src/models/message/component.dart'
 export 'src/models/invite/invite.dart' show Invite, TargetType;
 export 'src/models/invite/invite_metadata.dart' show InviteWithMetadata;
 export 'src/models/webhook.dart' show PartialWebhook, Webhook, WebhookType, WebhookAuthor;
-export 'src/models/guild/ban.dart' show Ban;
+export 'src/models/guild/ban.dart' show Ban, BulkBanResponse;
 export 'src/models/guild/guild_preview.dart' show GuildPreview;
 export 'src/models/guild/guild_widget.dart' show GuildWidget, WidgetSettings, WidgetImageStyle;
 export 'src/models/guild/guild.dart'

diff --git a/lib/src/http/managers/guild_manager.dart b/lib/src/http/managers/guild_manager.dart
@@ -210,6 +210,14 @@ class GuildManager extends Manager<Guild> {
     );
   }
 
+  /// Parse a [BulkBanResponse] from [raw].
+  BulkBanResponse parseBulkBanResponse(Map<String, Object?> raw) {
+    return BulkBanResponse(
+      bannedUsers: parseMany(raw['banned_users'] as List, Snowflake.parse),
+      failedUsers: parseMany(raw['failed_users'] as List, Snowflake.parse),
+    );
+  }
+
   /// Parse a [WidgetSettings] from [raw].
   WidgetSettings parseWidgetSettings(Map<String, Object?> raw) {
     return WidgetSettings(
@@ -485,6 +493,24 @@ class GuildManager extends Manager<Guild> {
     await client.httpHandler.executeSafe(request);
   }
 
+  /// Ban up to 200 users from a guild, and optionally delete previous messages sent by the banned users.
+  Future<BulkBanResponse> bulkBan(Snowflake id, List<Snowflake> userIds, {Duration? deleteMessages, String? auditLogReason}) async {
+    final route = HttpRoute()
+      ..guilds(id: id.toString())
+      ..bulkBan();
+    final request = BasicRequest(
+      route,
+      method: 'POST',
+      auditLogReason: auditLogReason,
+      body: jsonEncode({
+        'user_ids': userIds.map((s) => s.toString()).toList(),
+        if (deleteMessages != null) 'delete_message_seconds': deleteMessages.inSeconds,
+      }),
+    );
+    final response = await client.httpHandler.executeSafe(request);
+    return parseBulkBanResponse(response.jsonBody as Map<String, Object?>);
+  }
+
   /// Delete a ban in a guild.
   Future<void> deleteBan(Snowflake id, Snowflake userId, {String? auditLogReason}) async {
     final route = HttpRoute()

diff --git a/lib/src/http/route.dart b/lib/src/http/route.dart
@@ -314,4 +314,7 @@ extension RouteHelpers on HttpRoute {
 
   /// Adds the [`recipients`](https://discord.com/developers/docs/resources/channel#group-dm-add-recipient) part to this [HttpRoute].
   void recipients({String? id}) => add(HttpRoutePart('recipients', [if (id != null) HttpRouteParam(id)]));
+
+  /// Adds the [`bulk-ban`](https://discord.com/developers/docs/resources/guild#bulk-guild-ban) part to this [HttpRoute].
+  void bulkBan() => add(HttpRoutePart('bulk-ban'));
 }
diff --git a/lib/src/models/guild/ban.dart b/lib/src/models/guild/ban.dart
@@ -1,3 +1,4 @@
+import 'package:nyxx/src/models/snowflake.dart';
 import 'package:nyxx/src/models/user/user.dart';
 import 'package:nyxx/src/utils/to_string_helper/to_string_helper.dart';
 
@@ -15,3 +16,14 @@ class Ban with ToStringHelper {
   /// @nodoc
   Ban({required this.reason, required this.user});
 }
+
+class BulkBanResponse with ToStringHelper {
+  /// A list of user IDs, that were succesfully banned.
+  final List<Snowflake> bannedUsers;
+
+  /// A list of user IDs, that were not banned.
+  final List<Snowflake> failedUsers;
+
+  /// @nodoc
+  BulkBanResponse({required this.bannedUsers, required this.failedUsers});
+}
diff --git a/lib/src/models/guild/guild.dart b/lib/src/models/guild/guild.dart
@@ -111,11 +111,15 @@ class PartialGuild extends WritableSnowflakeEntity<Guild> {
   /// List the bans in this guild.
   Future<List<Ban>> listBans({int? limit, Snowflake? after, Snowflake? before}) => manager.listBans(id, limit: limit, after: after, before: before);
 
-  /// Ban a member in this guild.
+  /// Ban a user in this guild.
   Future<void> createBan(Snowflake userId, {Duration? deleteMessages, String? auditLogReason}) =>
       manager.createBan(id, userId, auditLogReason: auditLogReason, deleteMessages: deleteMessages);
 
-  /// Unban a member in this guild.
+  /// Ban up to 200 users from a guild, and optionally delete previous messages sent by the banned users.
+  Future<BulkBanResponse> bulkBan(List<Snowflake> userIds, {Duration? deleteMessages, String? auditLogReason}) =>
+      manager.bulkBan(id, userIds, deleteMessages: deleteMessages, auditLogReason: auditLogReason);
+
+  /// Unban a user in this guild.
   Future<void> deleteBan(Snowflake userId, {String? auditLogReason}) => manager.deleteBan(id, userId, auditLogReason: auditLogReason);
 
   /// Update a guild's MFA level.