Update add_chat_members method return type

Closes #242

Author: KurimuzonAkuma

compiler/docs/compiler.py

@@ -655,6 +655,7 @@ def get_title_list(s: str) -> list:
             Dialog
             Restriction
             EmojiStatus
+            FailedToAddMember
             Folder
             GroupCallMember
             ChatColor

pyrogram/methods/chats/add_chat_members.py

@@ -19,7 +19,7 @@
 from typing import Union, List
 
 import pyrogram
-from pyrogram import raw
+from pyrogram import raw, types
 
 
 class AddChatMembers:
@@ -28,8 +28,9 @@ async def add_chat_members(
         chat_id: Union[int, str],
         user_ids: Union[Union[int, str], List[Union[int, str]]],
         forward_limit: int = 100
-    ) -> bool:
-        """Add new chat members to a group, supergroup or channel
+    ) -> List["types.FailedToAddMember"]:
+        """Add new chat members to a group, supergroup or channel.
+        This method can't be used to join a chat. Members can't be added to a channel if it has more than 200 members.
 
         .. include:: /_includes/usable-by/users.rst
 
@@ -48,7 +49,7 @@ async def add_chat_members(
                 Defaults to 100 (max amount).
 
         Returns:
-            ``bool``: On success, True is returned.
+            List of :obj:`~pyrogram.types.FailedToAddMember`: On success, an empty list is returned, otherwise a list of :obj:`~pyrogram.types.FailedToAddMember` is returned.
 
         Example:
             .. code-block:: python
@@ -67,17 +68,21 @@ async def add_chat_members(
         if not isinstance(user_ids, list):
             user_ids = [user_ids]
 
+        missing_invitees = []
+
         if isinstance(peer, raw.types.InputPeerChat):
             for user_id in user_ids:
-                await self.invoke(
+                r = await self.invoke(
                     raw.functions.messages.AddChatUser(
                         chat_id=peer.chat_id,
                         user_id=await self.resolve_peer(user_id),
                         fwd_limit=forward_limit
                     )
                 )
+
+                missing_invitees.extend(r.missing_invitees)
         else:
-            await self.invoke(
+            r = await self.invoke(
                 raw.functions.channels.InviteToChannel(
                     channel=peer,
                     users=[
@@ -87,4 +92,6 @@ async def add_chat_members(
                 )
             )
 
-        return True
+            missing_invitees.extend(r.missing_invitees)
+
+        return types.List(types.FailedToAddMember._parse(inv) for inv in missing_invitees)

pyrogram/types/messages_and_media/message.py

@@ -1882,6 +1882,7 @@ async def reply_text(
         Use as a shortcut for:
 
         .. code-block:: python
+        
             from pyrogram import types
 
             await client.send_message(

pyrogram/types/user_and_chats/__init__.py

@@ -43,6 +43,7 @@
 from .chat_settings import ChatSettings
 from .dialog import Dialog
 from .emoji_status import EmojiStatus
+from .failed_to_add_member import FailedToAddMember
 from .folder import Folder
 from .found_contacts import FoundContacts
 from .global_privacy_settings import GlobalPrivacySettings
@@ -103,6 +104,7 @@
     "ChatAdministratorRights",
     "ChatJoiner",
     "EmojiStatus",
+    "FailedToAddMember",
     "Folder",
     "FoundContacts",
     "GlobalPrivacySettings",

pyrogram/types/user_and_chats/failed_to_add_member.py

@@ -0,0 +1,55 @@
+#  Pyrogram - Telegram MTProto API Client Library for Python
+#  Copyright (C) 2017-present Dan <https://github.com/delivrance>
+#
+#  This file is part of Pyrogram.
+#
+#  Pyrogram is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU Lesser General Public License as published
+#  by the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  Pyrogram is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public License
+#  along with Pyrogram.  If not, see <http://www.gnu.org/licenses/>.
+
+from typing import Optional
+
+from pyrogram import raw
+from ..object import Object
+
+
+class FailedToAddMember(Object):
+    """Contains information about a user that has failed to be added to a chat.
+
+    Parameters:
+        user_id (``int``):
+            User identifier.
+
+        premium_would_allow_invite (``bool``, *optional*):
+            True, if subscription to Telegram Premium would have allowed to add the user to the chat.
+
+        premium_required_to_send_messages (``bool``, *optional*):
+            True, if subscription to Telegram Premium is required to send the user chat invite link.
+    """
+    def __init__(
+        self,
+        *,
+        user_id: int,
+        premium_would_allow_invite: Optional[bool] = None,
+        premium_required_to_send_messages: Optional[bool] = None,
+    ):
+        self.user_id = user_id
+        self.premium_would_allow_invite = premium_would_allow_invite
+        self.premium_required_to_send_messages = premium_required_to_send_messages
+
+    @staticmethod
+    def _parse(missing_invite: "raw.types.MissingInvitee") -> "FailedToAddMember":
+        return FailedToAddMember(
+            user_id=missing_invite.user_id,
+            premium_would_allow_invite=missing_invite.premium_would_allow_invite,
+            premium_required_to_send_messages=missing_invite.premium_required_for_pm
+        )