Add support for bulk banning members

2025-09-05 17:36:15 +00:00 · 2024-03-15 18:05:35 -04:00
parent 82d13e7b49
commit ded9c5d87b
4 changed files with 96 additions and 0 deletions
--- a/docs/api.rst
+++ b/docs/api.rst
@ -4491,6 +4491,25 @@ Guild

        :type: :class:`User`

+.. class:: BulkBanResult
+
+    A namedtuple which represents the result returned from :meth:`~Guild.bulk_ban`.
+
+    .. versionadded:: 2.4
+
+    .. attribute:: banned
+
+        The list of users that were banned. The type of the list is a :class:`Object`
+        representing the user.
+
+        :type: List[:class:`Object`]
+    .. attribute:: failed
+
+        The list of users that could not be banned. The type of the list is a :class:`Object`
+        representing the user.
+
+        :type: List[:class:`Object`]
+

 ScheduledEvent
 ~~~~~~~~~~~~~~