Add on_bot_purchased_paid_media and on_bot_business_connection. (#131)

Author: SpEcHiDe

compiler/docs/compiler.py

@@ -644,6 +644,7 @@ def get_title_list(s: str) -> list:
             InputPaidMedia
             InputPaidMediaPhoto
             InputPaidMediaVideo
+            PaidMediaPurchased
         """,
         input_message_content="""
         InputMessageContent

docs/source/api/decorators.rst

@@ -33,17 +33,17 @@ Index
 
     - :meth:`~Client.on_message`
     - :meth:`~Client.on_edited_message`
-
+    - :meth:`~Client.on_bot_business_connection`
     - :meth:`~Client.on_message_reaction_updated`
     - :meth:`~Client.on_message_reaction_count_updated`
     - :meth:`~Client.on_inline_query`
     - :meth:`~Client.on_chosen_inline_result`
     - :meth:`~Client.on_callback_query`
-
-
+    - :meth:`~Client.on_shipping_query`
+    - :meth:`~Client.on_pre_checkout_query`
+    - :meth:`~Client.on_bot_purchased_paid_media`
     - :meth:`~Client.on_poll`
 
-
     - :meth:`~Client.on_chat_member_updated`
     - :meth:`~Client.on_chat_join_request`
 
@@ -62,17 +62,17 @@ Details
 .. Decorators
 .. autodecorator:: pyrogram.Client.on_message()
 .. autodecorator:: pyrogram.Client.on_edited_message()
-
+.. autodecorator:: pyrogram.Client.on_bot_business_connection()
 .. autodecorator:: pyrogram.Client.on_message_reaction_updated()
 .. autodecorator:: pyrogram.Client.on_message_reaction_count_updated()
 .. autodecorator:: pyrogram.Client.on_inline_query()
 .. autodecorator:: pyrogram.Client.on_chosen_inline_result()
 .. autodecorator:: pyrogram.Client.on_callback_query()
 .. autodecorator:: pyrogram.Client.on_shipping_query()
 .. autodecorator:: pyrogram.Client.on_pre_checkout_query()
+.. autodecorator:: pyrogram.Client.on_bot_purchased_paid_media()
 .. autodecorator:: pyrogram.Client.on_poll()
 
-
 .. autodecorator:: pyrogram.Client.on_chat_member_updated()
 .. autodecorator:: pyrogram.Client.on_chat_join_request()
 

docs/source/api/handlers.rst

@@ -33,24 +33,23 @@ Index
 
     - :class:`MessageHandler`
     - :class:`EditedMessageHandler`
-
+    - :class:`BusinessBotConnectionHandler`
     - :class:`MessageReactionUpdatedHandler`
     - :class:`MessageReactionCountUpdatedHandler`
     - :class:`InlineQueryHandler`
     - :class:`ChosenInlineResultHandler`
     - :class:`CallbackQueryHandler`
-
-
+    - :class:`ShippingQueryHandler`
+    - :class:`PreCheckoutQueryHandler`
+    - :class:`PurchasedPaidMediaHandler`
     - :class:`PollHandler`
 
-
     - :class:`ChatMemberUpdatedHandler`
     - :class:`ChatJoinRequestHandler`
 
 
     - :class:`DeletedMessagesHandler`
     - :class:`UserStatusHandler`
-
     - :class:`DisconnectHandler`
     - :class:`StoryHandler`
     - :class:`RawUpdateHandler`
@@ -63,17 +62,17 @@ Details
 .. Handlers
 .. autoclass:: MessageHandler()
 .. autoclass:: EditedMessageHandler()
-
+.. autoclass:: BusinessBotConnectionHandler()
 .. autoclass:: MessageReactionUpdatedHandler()
 .. autoclass:: MessageReactionCountUpdatedHandler()
 .. autoclass:: InlineQueryHandler()
 .. autoclass:: ChosenInlineResultHandler()
 .. autoclass:: CallbackQueryHandler()
 .. autoclass:: ShippingQueryHandler()
 .. autoclass:: PreCheckoutQueryHandler()
+.. autoclass:: PurchasedPaidMediaHandler()
 .. autoclass:: PollHandler()
 
-
 .. autoclass:: ChatMemberUpdatedHandler()
 .. autoclass:: ChatJoinRequestHandler()
 

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

@@ -25,6 +25,7 @@ Changes in this Fork
 | Scheme layer used: 196 |
 +------------------------+
 
+- Added the :meth:`~pyrogram.Client.on_bot_purchased_paid_media` and :meth:`~pyrogram.Client.on_bot_business_connection`.
 - Added the parameters ``can_be_upgraded``, ``was_refunded``, ``prepaid_upgrade_star_count`` in :obj:`~pyrogram.types.UserGift`.
 - Renamed the parameter ``only_in_channels`` to ``chat_type_filter`` in the :meth:`~pyrogram.Client.search_global_count` and :meth:`~pyrogram.Client.search_global`.
 - Removed ``sender_user_id`` parameter from :meth:`~pyrogram.Client.sell_gift` and :meth:`~pyrogram.Client.toggle_gift_is_saved`.

pyrogram/dispatcher.py

@@ -25,15 +25,15 @@
 from pyrogram import errors, utils, raw
 from pyrogram.handlers import (
     MessageHandler, EditedMessageHandler,
-
-    
+    BusinessBotConnectionHandler,
     MessageReactionUpdatedHandler,
     MessageReactionCountUpdatedHandler,
     InlineQueryHandler,
     ChosenInlineResultHandler,
     CallbackQueryHandler,
     ShippingQueryHandler,
     PreCheckoutQueryHandler,
+    PurchasedPaidMediaHandler,
     PollHandler,
 
 
@@ -64,6 +64,8 @@
     UpdateBotShippingQuery,
     UpdateStory,
     UpdateBusinessBotCallbackQuery,
+    UpdateBotBusinessConnect,
+    UpdateBotPurchasedPaidMedia,
 )
 
 log = logging.getLogger(__name__)
@@ -86,6 +88,8 @@ class Dispatcher:
     PRE_CHECKOUT_QUERY_UPDATES = (UpdateBotPrecheckoutQuery,)
     SHIPPING_QUERY_UPDATES = (UpdateBotShippingQuery,)
     NEW_STORY_UPDATES = (UpdateStory,)
+    BOT_BUSINESS_CONNECT_UPDATES = (UpdateBotBusinessConnect,)
+    PURCHASED_PAID_MEDIA_UPDATES = (UpdateBotPurchasedPaidMedia,)
 
     def __init__(self, client: "pyrogram.Client"):
         self.client = client
@@ -218,6 +222,18 @@ async def story_parser(update, users, chats):
                 StoryHandler
             )
 
+        async def bot_business_connect_parser(update, users, chats):
+            return (
+                await pyrogram.types.BusinessConnection._parse(self.client, update, users, chats),
+                BusinessBotConnectionHandler
+            )
+
+        async def purchased_paid_media_parser(update, users, chats):
+            return (
+                pyrogram.types.PaidMediaPurchased._parse(self.client, update, users),
+                PurchasedPaidMediaHandler
+            )
+
         self.update_parsers = {
             Dispatcher.NEW_MESSAGE_UPDATES: message_parser,
             Dispatcher.EDIT_MESSAGE_UPDATES: edited_message_parser,
@@ -235,6 +251,8 @@ async def story_parser(update, users, chats):
             Dispatcher.SHIPPING_QUERY_UPDATES: shipping_query_parser,
             Dispatcher.PRE_CHECKOUT_QUERY_UPDATES: pre_checkout_query_parser,
             Dispatcher.NEW_STORY_UPDATES: story_parser,
+            Dispatcher.BOT_BUSINESS_CONNECT_UPDATES: bot_business_connect_parser,
+            Dispatcher.PURCHASED_PAID_MEDIA_UPDATES: purchased_paid_media_parser,
         }
 
         self.update_parsers = {key: value for key_tuple, value in self.update_parsers.items() for key in key_tuple}

pyrogram/handlers/__init__.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_connection_handler import BusinessBotConnectionHandler
 from .callback_query_handler import CallbackQueryHandler
 from .chat_join_request_handler import ChatJoinRequestHandler
 from .chat_member_updated_handler import ChatMemberUpdatedHandler
@@ -31,5 +32,6 @@
 from .message_reaction_updated_handler import MessageReactionUpdatedHandler
 from .message_reaction_count_updated_handler import MessageReactionCountUpdatedHandler
 from .pre_checkout_query_handler import PreCheckoutQueryHandler
+from .purchased_paid_media_handler import PurchasedPaidMediaHandler
 from .shipping_query_handler import ShippingQueryHandler
 from .story_handler import StoryHandler

pyrogram/handlers/business_bot_connection_handler.py

@@ -0,0 +1,51 @@
+#  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 Callable
+
+from .handler import Handler
+
+
+class BusinessBotConnectionHandler(Handler):
+    """The Bot Business Connection handler class. Used to handle new bot business connection.
+    It is intended to be used with :meth:`~pyrogram.Client.add_handler`
+
+    For a nicer way to register this handler, have a look at the
+    :meth:`~pyrogram.Client.on_bot_business_connection` decorator.
+
+    Parameters:
+        callback (``Callable``):
+            Pass a function that will be called when a new BusinessConnection arrives. It takes *(client, business_connection)*
+            as positional arguments (look at the section below for a detailed description).
+
+        filters (:obj:`Filters`):
+            Pass one or more filters to allow only a subset of callback queries to be passed
+            in your callback function.
+
+    Other parameters:
+        client (:obj:`~pyrogram.Client`):
+            The Client itself, useful when you want to call other API methods inside the message handler.
+
+        business_connection (:obj:`~pyrogram.types.BusinessConnection`):
+            The bot was connected or disconnected from a business account, or a user edited
+            an existing connection with the bot.
+
+    """
+
+    def __init__(self, callback: Callable, filters=None):
+        super().__init__(callback, filters)

pyrogram/handlers/purchased_paid_media_handler.py

@@ -0,0 +1,50 @@
+#  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 Callable
+
+from .handler import Handler
+
+
+class PurchasedPaidMediaHandler(Handler):
+    """The Bot Business Connection handler class. Used to handle new bot business connection.
+    It is intended to be used with :meth:`~pyrogram.Client.add_handler`
+
+    For a nicer way to register this handler, have a look at the
+    :meth:`~pyrogram.Client.on_bot_purchased_paid_media` decorator.
+
+    Parameters:
+        callback (``Callable``):
+            Pass a function that will be called when a new PaidMediaPurchased arrives. It takes *(client, purchased_paid_media)*
+            as positional arguments (look at the section below for a detailed description).
+
+        filters (:obj:`Filters`):
+            Pass one or more filters to allow only a subset of callback queries to be passed
+            in your callback function.
+
+    Other parameters:
+        client (:obj:`~pyrogram.Client`):
+            The Client itself, useful when you want to call other API methods inside the message handler.
+
+        purchased_paid_media (:obj:`~pyrogram.types.PaidMediaPurchased`):
+            A user purchased paid media with a non-empty payload sent by the bot in a non-channel chat.
+
+    """
+
+    def __init__(self, callback: Callable, filters=None):
+        super().__init__(callback, filters)

pyrogram/methods/decorators/__init__.py

@@ -16,6 +16,8 @@
 #  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 .on_bot_business_connection import OnBotBusinessConnection
+from .on_bot_purchased_paid_media import OnBotPurchasedPaidMedia
 from .on_callback_query import OnCallbackQuery
 from .on_chat_join_request import OnChatJoinRequest
 from .on_chat_member_updated import OnChatMemberUpdated
@@ -39,13 +41,15 @@ class Decorators(
     OnMessage,
     OnEditedMessage,
     OnDeletedMessages,
+    OnBotBusinessConnection,
     OnMessageReactionUpdated,
     OnMessageReactionCountUpdated,
     OnInlineQuery,
     OnChosenInlineResult,
     OnCallbackQuery,
     OnShippingQuery,
     OnPreCheckoutQuery,
+    OnBotPurchasedPaidMedia,
     OnPoll,
 
     OnChatMemberUpdated,

pyrogram/methods/decorators/on_bot_business_connection.py

@@ -0,0 +1,64 @@
+#  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 Callable
+
+import pyrogram
+from pyrogram.filters import Filter
+
+
+class OnBotBusinessConnection:
+    def on_bot_business_connection(
+        self=None,
+        filters=None,
+        group: int = 0
+    ) -> Callable:
+        """Decorator for handling bot business connection.
+
+        This does the same thing as :meth:`~pyrogram.Client.add_handler` using the
+        :obj:`~pyrogram.handlers.BusinessBotConnectionHandler`.
+
+        .. include:: /_includes/usable-by/bots.rst
+
+        Parameters:
+            filters (:obj:`~pyrogram.filters`, *optional*):
+                Pass one or more filters to allow only a subset of callback queries to be passed
+                in your function.
+
+            group (``int``, *optional*):
+                The group identifier, defaults to 0.
+
+        """
+
+        def decorator(func: Callable) -> Callable:
+            if isinstance(self, pyrogram.Client):
+                self.add_handler(pyrogram.handlers.BusinessBotConnectionHandler(func, filters), group)
+            elif isinstance(self, Filter) or self is None:
+                if not hasattr(func, "handlers"):
+                    func.handlers = []
+
+                func.handlers.append(
+                    (
+                        pyrogram.handlers.BusinessBotConnectionHandler(func, self),
+                        group if filters is None else filters
+                    )
+                )
+
+            return func
+
+        return decorator