Update API Scheme to Layer 201 from TDLib

* Add BusinessBotRights
* Add get_business_account_star_balance
* Add PaidMessagePriceChanged
* Rename paid_message_star_count to paid_star_count, in Message
* Add paid_messages_refunded

Author: SpEcHiDe

compiler/api/source/main_api.tl

@@ -409,6 +409,7 @@ def get_title_list(s: str) -> list:
             send_gift
             toggle_gift_is_saved
             get_owned_star_count
+            get_business_account_star_balance
         """,
         advanced="""
         Advanced
@@ -481,6 +482,8 @@ def get_title_list(s: str) -> list:
             VideoChatStarted
             VideoChatEnded
             VideoChatParticipantsInvited
+            PaidMessagePriceChanged
+            PaidMessagesRefunded
             Dialog
             EmojiStatus
             GroupCallParticipant
@@ -666,6 +669,7 @@ def get_title_list(s: str) -> list:
         """,
         payments="""
         Payments
+            BusinessBotRights
             BusinessConnection
             BusinessIntro
             BusinessLocation

compiler/docs/compiler.py

@@ -30,6 +30,16 @@ Breaking Changes in this Fork
 Changes in this Fork
 =====================
 
++------------------------+
+| Scheme layer used: 201 |
++------------------------+
+
+- Renamed the field ``paid_message_star_count`` to ``paid_star_count`` in the :obj:`~pyrogram.types.Message`, containing the number of Telegram Stars that were paid to send the message.
+- Added the classes :obj:`~pyrogram.types.PaidMessagePriceChanged` and :obj:`~pyrogram.types.PaidMessagesRefunded` and the fields ``paid_message_price_changed`` and ``paid_messages_refunded`` to the :obj:`~pyrogram.types.Message`, describing the appropriate service message.
+- Added the :meth:`~pyrogram.Client.get_business_account_star_balance`, allowing bots to check the current Telegram Star balance of a managed business account.
+- Added the :obj:`~pyrogram.types.BusinessBotRights` and replaced the field ``can_reply`` with the field ``rights`` of the type :obj:`~pyrogram.types.BusinessBotRights` in the :obj:`~pyrogram.types.BusinessConnection`.
+- View `new and changed <https://telegramplayground.github.io/TG-APIs/TL/diff/tdlib.html?from=200&to=201>`__ `raw API methods <https://telegramplayground.github.io/TG-APIs/TL/diff/tdesktop.html?from=200&to=201>`__.
+
 +------------------------+
 | Scheme layer used: 200 |
 +------------------------+

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

@@ -144,5 +144,11 @@ class MessageServiceType(AutoName):
     RECEIVED_GIFT = auto()
     "Owner Received gift"
 
+    PAID_MESSAGE_PRICE_CHANGED = auto()
+    "The price for paid messages has changed in the chat"
+
+    PAID_MESSAGES_REFUNDED = auto()
+    "Refunded paid messages"
+
     UNKNOWN = auto()
     "This service message is unsupported by the current version of Pyrogram"

pyrogram/enums/message_service_type.py

@@ -62,3 +62,38 @@ async def get_owned_star_count(
         )
 
         return types.StarAmount._parse(self, r)
+
+
+    async def get_business_account_star_balance(
+        self: "pyrogram.Client",
+        business_connection_id: str,
+    ) -> "types.StarAmount":
+        """Returns the amount of Telegram Stars owned by a managed business account. Requires the can_view_gifts_and_stars business bot right.
+
+        .. include:: /_includes/usable-by/bots.rst
+
+        Parameters:
+            business_connection_id (``str``):
+                Unique identifier of the business connection
+        
+        Returns:
+            :obj:`~pyrogram.types.StarAmount`: On success, the current stars balance is returned.
+        
+        """
+        if not business_connection_id:
+            raise ValueError("business_connection_id is required")
+
+        business_connection = self.business_user_connection_cache[business_connection_id]
+        if not business_connection:
+            business_connection = await self.get_business_connection(business_connection_id)
+        r = await self.invoke(
+            raw.functions.InvokeWithBusinessConnection(
+                query=raw.functions.payments.GetStarsStatus(
+                    peer=await self.resolve_peer(
+                        business_connection.user_chat_id
+                    )
+                ),
+                connection_id=business_connection_id
+            )
+        )
+        return types.StarAmount._parse(self, r)

pyrogram/methods/business/get_owned_star_count.py

@@ -26,6 +26,7 @@
 
 
 class SetChatPhoto:
+    # TODO: FIXME!
     async def set_chat_photo(
         self: "pyrogram.Client",
         chat_id: Union[int, str],

pyrogram/methods/chats/set_chat_photo.py

@@ -16,6 +16,7 @@
 #  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 .business_bot_rights import BusinessBotRights
 from .business_connection import BusinessConnection
 from .business_intro import BusinessIntro
 from .business_location import BusinessLocation
@@ -40,6 +41,7 @@
 from .refunded_payment import RefundedPayment
 
 __all__ = [
+    "BusinessBotRights",
     "BusinessConnection",
     "BusinessIntro",
     "BusinessLocation",

pyrogram/types/business/__init__.py

@@ -0,0 +1,133 @@
+#  Pyrogram - Telegram MTProto API Client Library for Python
+#  Copyright (C) 2017-present <https://github.com/TelegramPlayGround>
+#
+#  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
+
+import pyrogram
+from pyrogram import raw
+
+from ..object import Object
+
+
+class BusinessBotRights(Object):
+    """Represents the rights of a business bot.
+
+    Parameters:
+        can_reply (``bool``, *optional*):
+            True, if the bot can send and edit messages in the private chats that had incoming messages in the last 24 hours.
+
+        can_read_messages (``bool``, *optional*):
+            True, if the bot can mark incoming private messages as read.
+
+        can_delete_outgoing_messages (``bool``, *optional*):
+            True, if the bot can delete messages sent by the bot.
+
+        can_delete_all_messages (``bool``, *optional*):
+            True, if the bot can delete all private messages in managed chats.
+
+        can_edit_name (``bool``, *optional*):
+            True, if the bot can edit the first and last name of the business account.
+
+        can_edit_bio (``bool``, *optional*):
+            True, if the bot can edit the bio of the business account.
+
+        can_edit_profile_photo (``bool``, *optional*):
+            True, if the bot can edit the profile photo of the business account.
+
+        can_edit_username (``bool``, *optional*):
+            True, if the bot can edit the username of the business account.
+
+        can_change_gift_settings (``bool``, *optional*):
+            True, if the bot can change the privacy settings pertaining to gifts for the business account.
+
+        can_view_gifts_and_stars (``bool``, *optional*):
+            True, if the bot can view gifts and the amount of Telegram Stars owned by the business account.
+
+        can_convert_gifts_to_stars (``bool``, *optional*):
+            True, if the bot can convert regular gifts owned by the business account to Telegram Stars.
+        
+        can_transfer_and_upgrade_gifts (``bool``, *optional*):
+            True, if the bot can transfer and upgrade gifts owned by the business account.
+
+        can_transfer_stars (``bool``, *optional*):
+            True, if the bot can transfer Telegram Stars received by the business account to its own account, or use them to upgrade and transfer gifts.
+
+        can_manage_stories (``bool``, *optional*):
+            True, if the bot can post, edit and delete stories on behalf of the business account.
+
+    """
+
+    def __init__(
+        self,
+        *,
+        can_reply: Optional[bool] = None,
+        can_read_messages: Optional[bool] = None,
+        can_delete_outgoing_messages: Optional[bool] = None,
+        can_delete_all_messages: Optional[bool] = None,
+        can_edit_name: Optional[bool] = None,
+        can_edit_bio: Optional[bool] = None,
+        can_edit_profile_photo: Optional[bool] = None,
+        can_edit_username: Optional[bool] = None,
+        can_change_gift_settings: Optional[bool] = None,
+        can_view_gifts_and_stars: Optional[bool] = None,
+        can_convert_gifts_to_stars: Optional[bool] = None,
+        can_transfer_and_upgrade_gifts: Optional[bool] = None,
+        can_transfer_stars: Optional[bool] = None,
+        can_manage_stories: Optional[bool] = None,
+    ):
+        super().__init__()
+
+        self.can_reply = can_reply
+        self.can_read_messages = can_read_messages
+        self.can_delete_outgoing_messages = can_delete_outgoing_messages
+        self.can_delete_all_messages = can_delete_all_messages
+        self.can_edit_name = can_edit_name
+        self.can_edit_bio = can_edit_bio
+        self.can_edit_profile_photo = can_edit_profile_photo
+        self.can_edit_username = can_edit_username
+        self.can_change_gift_settings = can_change_gift_settings
+        self.can_view_gifts_and_stars = can_view_gifts_and_stars
+        self.can_convert_gifts_to_stars = can_convert_gifts_to_stars
+        self.can_transfer_and_upgrade_gifts = can_transfer_and_upgrade_gifts
+        self.can_transfer_stars = can_transfer_stars
+        self.can_manage_stories = can_manage_stories
+
+
+    @staticmethod
+    def _parse(
+        client,
+        business_bot_rights: "raw.types.BusinessBotRights"
+    ) -> "BusinessBotRights":
+        if not business_bot_rights:
+            return None
+        return BusinessBotRights(
+            can_reply=business_bot_rights.reply,
+            can_read_messages=business_bot_rights.read_messages,
+            can_delete_outgoing_messages=business_bot_rights.delete_sent_messages,
+            can_delete_all_messages=business_bot_rights.delete_received_messages,
+            can_edit_name=business_bot_rights.edit_name,
+            can_edit_bio=business_bot_rights.edit_bio,
+            can_edit_profile_photo=business_bot_rights.edit_profile_photo,
+            can_edit_username=business_bot_rights.edit_username,
+            can_change_gift_settings=business_bot_rights.change_gift_settings,
+            can_view_gifts_and_stars=business_bot_rights.view_gifts,
+            can_convert_gifts_to_stars=business_bot_rights.sell_gifts,
+            can_transfer_and_upgrade_gifts=business_bot_rights.transfer_and_upgrade_gifts,
+            can_transfer_stars=business_bot_rights.transfer_stars,
+            can_manage_stories=business_bot_rights.manage_stories,
+        )

pyrogram/types/business/business_bot_rights.py

@@ -1,5 +1,5 @@
 #  Pyrogram - Telegram MTProto API Client Library for Python
-#  Copyright (C) 2017-present Dan <https://github.com/delivrance>
+#  Copyright (C) 2017-present <https://github.com/TelegramPlayGround>
 #
 #  This file is part of Pyrogram.
 #
@@ -16,14 +16,19 @@
 #  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 datetime import datetime
+from typing import Optional
 
 import pyrogram
 from pyrogram import raw, types, utils
 
 from ..object import Object
 
 
+log = logging.getLogger(__name__)
+
+
 class BusinessConnection(Object):
     """Describes the connection of the bot with a business account.
 
@@ -40,8 +45,8 @@ class BusinessConnection(Object):
         date (:py:obj:`~datetime.datetime`):
             Date the connection was established in Unix time
 
-        can_reply (``bool``):
-            True, if the bot can act on behalf of the business account in chats that were active in the last 24 hours
+        rights (:obj:`~pyrogram.types.BusinessBotRights`, *optional*):
+            Rights of the business bot.
 
         is_enabled (``bool``):
             True, if the connection is active
@@ -55,17 +60,17 @@ def __init__(
         user: "types.User" = None,
         user_chat_id: int = None,
         date: datetime,
-        can_reply: bool = None,
+        rights: Optional["types.BusinessBotRights"] = None,
         is_enabled: bool = None,
-        _raw: "raw.types.UpdateBotBusinessConnect" = None
+        _raw: "raw.types.UpdateBotBusinessConnect" = None,
     ):
         super().__init__()
 
         self.id = id
         self.user = user
         self.user_chat_id = user_chat_id
         self.date = date
-        self.can_reply = can_reply
+        self.rights = rights
         self.is_enabled = is_enabled
         self._raw = _raw
 
@@ -88,6 +93,20 @@ def _parse(
             ),
             user_chat_id=business_connect_update.connection.user_id,
             date=utils.timestamp_to_datetime(business_connect_update.connection.date),
-            can_reply=getattr(business_connect_update.connection, "can_reply", False),
+            rights=types.BusinessBotRights._parse(
+                client,
+                business_connect_update.connection.rights
+            ),
             is_enabled=not bool(getattr(business_connect_update.connection, "disabled", None))
         )
+
+
+    @property
+    def can_reply(self) -> str:
+        log.warning(
+            "This property is deprecated. "
+            "Please use rights instead"
+        )
+        if self.rights:
+            return self.rights.can_reply
+        return False

pyrogram/types/business/business_connection.py

@@ -70,6 +70,8 @@
 from .translated_text import TranslatedText
 from .message_auto_delete_timer_changed import MessageAutoDeleteTimerChanged
 from .write_access_allowed import WriteAccessAllowed
+from .paid_message_price_changed import PaidMessagePriceChanged
+from .paid_messages_refunded import PaidMessagesRefunded
 
 __all__ = [
     "AlternativeVideo",
@@ -124,4 +126,6 @@
     "WriteAccessAllowed",
     "ScreenshotTaken",
     "TranslatedText",
+    "PaidMessagePriceChanged",
+    "PaidMessagesRefunded",
 ]