API 9.2 (#191)

* Rename direct_message_topic_id to direct_messages_topic_id
* Added the field checklist_task_id to the class ReplyParameters, allowing bots to reply to a specific checklist task.
* Added the field reply_to_checklist_task_id to the class Message.
* Added the field can_manage_direct_messages to ChatPrivileges
* Added the field is_direct_messages to the class Chat which can be used to identify supergroups that are used as channel direct messages chats.
* Added the field parent_chat and direct_messages_chat_idto the class Chat which indicates the parent channel chat for a channel direct messages chat.
* Fix direct_messages_chat_id similar to BOT API 9.2
* Added the class DirectMessagesTopic and the field direct_messages_topic to the class Message, describing a topic of a direct messages chat.
* Add get_direct_messages_topics_by_id, get_direct_messages_topics, set_chat_direct_messages_group

Co-authored-by: KurimuzonAkuma <[email protected]>

Author: SpEcHiDe

compiler/docs/compiler.py

@@ -255,7 +255,9 @@ def get_title_list(s: str) -> list:
             get_chat_members
             get_chat_members_count
             get_chat_member
-            
+            get_direct_messages_topics_by_id
+            get_direct_messages_topics
+            set_chat_direct_messages_group
             get_dialogs
             get_dialogs_count
             set_chat_username
@@ -505,6 +507,7 @@ def get_title_list(s: str) -> list:
             InviteLinkImporter
             Restriction
             RtmpUrl
+            DirectMessagesTopic
         """,
         messages_media="""
         Messages & Media

docs/source/releases/changes-in-this-fork.rst

@@ -35,6 +35,14 @@ Changes in this Fork
 | Scheme layer used: 211 |
 +------------------------+
 
+- Rename direct_message_topic_id to ``direct_messages_topic_id`` in :obj:`~pyrogram.types.ReplyParameters`. This parameter can be used to send a message to a direct messages chat topic.
+- Added the field ``checklist_task_id`` to the class :obj:`~pyrogram.types.ReplyParameters`, allowing bots to reply to a specific checklist task.
+- Added the field ``reply_to_checklist_task_id`` to the class :obj:`~pyrogram.types.Message`.
+- Added the field ``can_manage_direct_messages`` to :obj:`~pyrogram.types.ChatPrivileges`.
+- Added the field ``is_direct_messages`` to the classes :obj:`~pyrogram.types.Chat` which can be used to identify supergroups that are used as channel direct messages chats.
+- Added the fields ``parent_chat`` and ``direct_messages_chat_id`` to the class :obj:`~pyrogram.types.Chat` which indicates the parent channel chat for a channel direct messages chat.
+- Added the class :obj:`~pyrogram.types.DirectMessagesTopic` and the field ``direct_messages_topic`` to the class :obj:`~pyrogram.types.Message`, describing a topic of a direct messages chat.
+- Added :meth:`~pyrogram.Client.get_direct_messages_topics_by_id`, :meth:`~pyrogram.Client.get_direct_messages_topics`, :meth:`~pyrogram.Client.set_chat_direct_messages_group`.
 - View `new and changed <https://telegramplayground.github.io/TG-APIs/TL/diff/tdlib.html?from=205&to=211>`__ `raw API methods <https://telegramplayground.github.io/TG-APIs/TL/diff/tdesktop.html?from=205&to=211>`__.
 
 +------------------------+

pyrogram/methods/chats/__init__.py

@@ -33,6 +33,8 @@
 from .get_chat_members_count import GetChatMembersCount
 from .get_chat_online_count import GetChatOnlineCount
 from .get_dialogs import GetDialogs
+from .get_direct_messages_topics_by_id import GetDirectMessagesTopicsByID
+from .get_direct_messages_topics import GetDirectMessagesTopics
 from .get_dialogs_count import GetDialogsCount
 from .get_nearby_chats import GetNearbyChats
 from .get_send_as_chats import GetSendAsChats
@@ -45,6 +47,7 @@
 from .search_chats import SearchChats
 from .set_administrator_title import SetAdministratorTitle
 from .set_chat_description import SetChatDescription
+from .set_chat_direct_messages_group import SetChatDirectMessagesGroup
 from .set_chat_permissions import SetChatPermissions
 from .set_chat_photo import SetChatPhoto
 from .set_chat_protected_content import SetChatProtectedContent
@@ -76,10 +79,13 @@ class Chats(
     DeleteChatPhoto,
     SetChatTitle,
     SetChatDescription,
+    SetChatDirectMessagesGroup,
     SetChatMessageAutoDeleteTime,
     PinChatMessage,
     UnpinChatMessage,
     GetDialogs,
+    GetDirectMessagesTopicsByID,
+    GetDirectMessagesTopics,
     GetChatMembersCount,
     SetChatUsername,
     SetChatPermissions,

pyrogram/methods/chats/get_direct_messages_topics.py

@@ -0,0 +1,123 @@
+#  Pyrogram - Telegram MTProto API Client Library for Python
+#  Copyright (C) 2017-present <https://github.com/KurimuzonAkuma>
+#
+#  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 asyncio import sleep
+from typing import AsyncGenerator, Optional, Union
+
+import pyrogram
+from pyrogram import raw, types, utils
+
+
+class GetDirectMessagesTopics:
+    async def get_direct_messages_topics(
+        self: "pyrogram.Client",
+        chat_id: Union[int, str],
+        limit: int = 0
+    ) -> AsyncGenerator["types.DirectMessagesTopic", None]:
+        """Get one or more topic from a direct messages channel chat.
+
+        .. include:: /_includes/usable-by/users.rst
+
+        Parameters:
+            chat_id (``int`` | ``str``):
+                Unique identifier (int) or username (str) of the target chat.
+
+            limit (``int``, *optional*):
+                Limits the number of topics to be retrieved.
+                By default, no limit is applied and all topics are returned.
+
+        Returns:
+            ``Generator``: A generator yielding :obj:`~pyrogram.types.DirectMessagesTopic` objects.
+
+        Example:
+            .. code-block:: python
+
+                # Iterate through all topics
+                async for topic in app.get_direct_messages_topics(chat_id):
+                    print(topic)
+
+        """
+        current = 0
+        total = limit or (1 << 31) - 1
+        limit = min(100, total)
+
+        offset_date = 0
+        offset_id = 0
+        offset_peer = raw.types.InputPeerEmpty()
+
+        while True:
+            r = await self.invoke(
+                raw.functions.messages.GetSavedDialogs(
+                    offset_date=offset_date,
+                    offset_id=offset_id,
+                    offset_peer=offset_peer,
+                    limit=limit,
+                    hash=0,
+                    exclude_pinned=None,
+                    parent_peer=await self.resolve_peer(chat_id)
+                )
+            )
+
+            users = {i.id: i for i in r.users}
+            chats = {i.id: i for i in r.chats}
+
+            messages = {}
+
+            for message in r.messages:
+                if isinstance(message, raw.types.MessageEmpty):
+                    continue
+
+                messages[message.id] = await types.Message._parse(
+                    self,
+                    message,
+                    users,
+                    chats,
+                    replies=self.fetch_replies
+                )
+
+            topics = []
+
+            for topic in r.dialogs:
+                topics.append(
+                    types.DirectMessagesTopic._parse_dialog(
+                        client=self,
+                        topic=topic,
+                        messages=messages,
+                        users=users,
+                        chats=chats
+                    )
+                )
+
+            if not topics:
+                return
+
+            last = topics[-1]
+
+            offset_id = last.last_message.id
+            offset_date = utils.datetime_to_timestamp(last.last_message.date)
+            offset_peer = await self.resolve_peer(last.topic_id)
+
+            for topic in topics:
+                await sleep(0)
+
+                yield topic
+
+                current += 1
+
+                if current >= total:
+                    return

pyrogram/methods/chats/get_direct_messages_topics_by_id.py

@@ -0,0 +1,89 @@
+#  Pyrogram - Telegram MTProto API Client Library for Python
+#  Copyright (C) 2017-present <https://github.com/KurimuzonAkuma>
+#
+#  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/>.
+
+import logging
+from typing import Iterable, Union
+
+import pyrogram
+from pyrogram import raw, types, utils
+
+log = logging.getLogger(__name__)
+
+
+class GetDirectMessagesTopicsByID:
+    async def get_direct_messages_topics_by_id(
+        self: "pyrogram.Client",
+        chat_id: Union[int, str],
+        topic_ids: Union[int, Iterable[int]]
+    ) -> Union[
+        "types.DirectMessagesTopic",
+        list["types.DirectMessagesTopic"]
+    ]:
+        """Get one or more direct message topic from a chat by using topic identifiers.
+
+        .. include:: /_includes/usable-by/users.rst
+
+        Parameters:
+            chat_id (``int`` | ``str``):
+                Unique identifier (int) or username (str) of the target chat.
+
+            topic_ids (``int`` | Iterable of ``int``, *optional*):
+                Pass a single topic identifier or an iterable of topic ids (as integers) to get the information of the
+                topic themselves.
+
+        Returns:
+            :obj:`~pyrogram.types.DirectMessagesTopic` | List of :obj:`~pyrogram.types.DirectMessagesTopic`: In case *topic_ids* was not
+            a list, a single topic is returned, otherwise a list of topics is returned.
+
+        Example:
+            .. code-block:: python
+
+                # Get one topic
+                await app.get_direct_messages_topics_by_id(chat_id, 12345)
+
+                # Get more than one topic (list of topics)
+                await app.get_direct_messages_topics_by_id(chat_id, [12345, 12346])
+
+        """
+
+        is_iterable = utils.is_list_like(topic_ids)
+        ids = list(topic_ids) if is_iterable else [topic_ids]
+
+        r = await self.invoke(
+            raw.functions.messages.GetSavedDialogsByID(
+                ids=[await self.resolve_peer(i) for i in ids],
+                parent_peer=await self.resolve_peer(chat_id)
+            )
+        )
+
+        users = {i.id: i for i in r.users}
+        chats = {i.id: i for i in r.chats}
+
+        topics = types.List()
+
+        for i in r.dialogs:
+            topics.append(
+                types.DirectMessagesTopic._parse_dialog(
+                    client=self,
+                    topic=i,
+                    users=users,
+                    chats=chats
+                )
+            )
+
+        return topics if is_iterable else topics[0] if topics else None

pyrogram/methods/chats/set_chat_direct_messages_group.py

@@ -0,0 +1,82 @@
+#  Pyrogram - Telegram MTProto API Client Library for Python
+#  Copyright (C) 2017-present <https://github.com/KurimuzonAkuma>
+#
+#  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, Union
+
+import pyrogram
+from pyrogram import types, raw
+
+
+class SetChatDirectMessagesGroup:
+    async def set_chat_direct_messages_group(
+        self: "pyrogram.Client",
+        chat_id: Union[int, str],
+        is_enabled: bool = Optional[None],
+        paid_message_star_count: int = 0,
+    ) -> Union["types.Message", bool]:
+        """Change direct messages group settings for a channel chat.
+
+        .. include:: /_includes/usable-by/users.rst
+
+        Requires owner privileges in the chat.
+
+        Parameters:
+            chat_id (``int`` | ``str``):
+                Unique identifier (int) or username (str) of the target chat.
+
+            is_enabled (``bool``, *optional*):
+                Pass True if the direct messages group is enabled for the channel chat. Pass False otherwise.
+
+            paid_message_star_count (``bool``):
+                The new number of Telegram Stars that must be paid for each message that is sent to the direct messages chat unless the sender is an administrator of the channel chat, 0-``stars_paid_message_amount_max``.
+
+        Returns:
+            :obj:`~pyrogram.types.Message` | ``bool``: On success, a service message will be returned (when applicable),
+            otherwise, in case a message object couldn't be returned, True is returned.
+        
+        Raises:
+            RPCError: In case of a Telegram RPC error.
+
+        Example:
+            .. code-block:: python
+
+                # Enable direct messages
+                await app.set_chat_direct_messages_group(chat_id, is_enabled=True)
+
+        """
+
+        r = await self.invoke(
+            raw.functions.channels.UpdatePaidMessagesPrice(
+                channel=await self.resolve_peer(chat_id),
+                send_paid_messages_stars=paid_message_star_count,
+                broadcast_messages_allowed=is_enabled
+            )
+        )
+        users = {i.id: i for i in r.users}
+        chats = {i.id: i for i in r.chats}
+        for i in r.updates:
+            if isinstance(i, (raw.types.UpdateNewMessage, raw.types.UpdateNewChannelMessage)):
+                return await types.Message._parse(
+                    self,
+                    i.message,
+                    users,
+                    chats,
+                    replies=self.fetch_replies
+                )
+        else:
+            return True

pyrogram/types/input_message_content/reply_parameters.py

@@ -56,9 +56,11 @@ class ReplyParameters(Object):
         quote_position (``int``, *optional*):
             Position of the quote in the original message in UTF-16 code units
         
-        direct_message_topic_id (``int``, *optional*):
-            TEMPORARY till the NEXT update.
-            Unique identifier of the topic in a channel direct messages chat administered by the current user; pass None if the chat is not a channel direct messages chat administered by the current user.
+        checklist_task_id (``int``, *optional*):
+            Identifier of the specific checklist task to be replied to.
+        
+        direct_messages_topic_id (``int``, *optional*):
+            Identifier of the direct messages topic to which the message will be sent; **required** if the message is sent to a direct messages chat; pass None if the chat is not a channel direct messages chat administered by the current user.
 
     """
 
@@ -73,7 +75,8 @@ def __init__(
         quote_parse_mode: Optional["enums.ParseMode"] = None,
         quote_entities: list["types.MessageEntity"] = None,
         quote_position: int = None,
-        direct_message_topic_id: int = None,
+        checklist_task_id: int = None,
+        direct_messages_topic_id: int = None,
     ):
         super().__init__()
 
@@ -84,4 +87,5 @@ def __init__(
         self.quote_parse_mode = quote_parse_mode
         self.quote_entities = quote_entities
         self.quote_position = quote_position
-        self.direct_message_topic_id = direct_message_topic_id
+        self.checklist_task_id = checklist_task_id
+        self.direct_messages_topic_id = direct_messages_topic_id