feat: Add support for getting sponsored messages

Adds a new `get_sponsored_messages` method to the `Client` to fetch sponsored messages from a channel.

This method uses the `messages.getSponsoredMessages` raw API function to retrieve the sponsored messages. A new `SponsoredMessage` type is also added to represent the sponsored message data in a user-friendly way.

Author: google-labs-jules[bot]

pyrogram/methods/messages/__init__.py

@@ -45,6 +45,7 @@
 from .get_messages import GetMessages
 from .get_message_read_participants import GetMessageReadParticipants
 from .get_scheduled_messages import GetScheduledMessages
+from .get_sponsored_messages import GetSponsoredMessages
 from .read_chat_history import ReadChatHistory
 from .retract_vote import RetractVote
 from .search_global import SearchGlobal
@@ -97,6 +98,7 @@ class Messages(
     GetMessages,
     GetMessageReadParticipants,
     GetScheduledMessages,
+    GetSponsoredMessages,
     SetTodoTasksCompletion,
     SendAudio,
     SendChatAction,

pyrogram/methods/messages/get_sponsored_messages.py

@@ -0,0 +1,35 @@
+
+from typing import Union, Optional, List
+
+import pyrogram
+from pyrogram import raw, types
+
+
+class GetSponsoredMessages:
+    async def get_sponsored_messages(
+        self: "pyrogram.Client",
+        chat_id: Union[int, str],
+    ) -> Optional[List["types.SponsoredMessage"]]:
+        peer = await self.resolve_peer(chat_id)
+
+        if isinstance(peer, raw.types.InputPeerChannel):
+            rpc = raw.functions.messages.GetSponsoredMessages(
+                peer=peer
+            )
+        else:
+            raise ValueError(f'The chat_id "{chat_id}" belongs to a user or chat')
+
+        result = await self.invoke(rpc, sleep_threshold=60)
+
+        sponsored_messages = []
+        for message in result.messages:
+            sponsored_messages.append(
+                types.SponsoredMessage._parse(
+                    self,
+                    message,
+                    {user.id: user for user in result.users},
+                    {chat.id: chat for chat in result.chats}
+                )
+            )
+
+        return sponsored_messages

pyrogram/types/__init__.py

@@ -30,11 +30,13 @@
 from .user_and_chats import *
 from .payments import *
 from .pyromod import *
+from .sponsored_message import SponsoredMessage
 
 __all__ = [
     "List",
     "Object",
-    "Update"
+    "Update",
+    "SponsoredMessage"
 ]
 __all__.extend(authorization.__all__)
 __all__.extend(bots_and_keyboards.__all__)

pyrogram/types/sponsored_message.py

@@ -0,0 +1,31 @@
+
+from pyrogram import raw, types
+from pyrogram.types.object import Object
+from typing import List, Optional
+
+class SponsoredMessage(Object):
+    def __init__(
+        self,
+        *,
+        url: str,
+        title: str,
+        message: str,
+        entities: Optional[List["types.MessageEntity"]] = None,
+        button_text: str
+    ):
+        super().__init__()
+        self.url = url
+        self.title = title
+        self.message = message
+        self.entities = entities
+        self.button_text = button_text
+
+    @staticmethod
+    def _parse(client, sponsored_message: "raw.types.SponsoredMessage", users, chats) -> "SponsoredMessage":
+        return SponsoredMessage(
+            url=sponsored_message.url,
+            title=sponsored_message.title,
+            message=sponsored_message.message,
+            entities=[types.MessageEntity._parse(client, entity, users) for entity in sponsored_message.entities] if sponsored_message.entities else None,
+            button_text=sponsored_message.button_text
+        )

tests/test_get_sponsored_messages.py

@@ -0,0 +1,37 @@
+
+import pytest
+from unittest.mock import AsyncMock
+from pyrogram import Client
+from pyrogram import raw
+from pyrogram import types
+
+@pytest.mark.asyncio
+async def test_get_sponsored_messages():
+    client = Client(":memory:")
+    client.resolve_peer = AsyncMock(
+        return_value=raw.types.InputPeerChannel(channel_id=123, access_hash=456)
+    )
+
+    mock_sponsored_message = raw.types.SponsoredMessage(
+        random_id=b'123',
+        url="https://example.com",
+        title="Sponsored",
+        message="This is a sponsored message",
+        button_text="Click me",
+        entities=[]
+    )
+
+    mock_response = raw.types.messages.SponsoredMessages(
+        messages=[mock_sponsored_message],
+        chats=[],
+        users=[]
+    )
+
+    client.invoke = AsyncMock(return_value=mock_response)
+
+    sponsored_messages = await client.get_sponsored_messages(chat_id="test_channel")
+
+    assert len(sponsored_messages) == 1
+    assert sponsored_messages[0].message == "This is a sponsored message"
+    assert sponsored_messages[0].url == "https://example.com"
+    assert sponsored_messages[0].title == "Sponsored"