Add can_be_transferred, transfer_star_count, export_date to UserGift

Author: SpEcHiDe

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

@@ -26,7 +26,7 @@ Changes in this Fork
 +------------------------+
 
 - 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`.
+- Added the parameters ``can_be_upgraded``, ``was_refunded``, ``prepaid_upgrade_star_count``, ``can_be_transferred``, ``transfer_star_count``, ``export_date`` 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`.
 - View `new and changed <https://telegramplayground.github.io/TG-APIs/TL/diff/tdlib.html?from=195&to=196>`__ `raw API methods <https://telegramplayground.github.io/TG-APIs/TL/diff/tdesktop.html?from=195&to=196>`__.

pyrogram/types/messages_and_media/message.py

@@ -1002,7 +1002,10 @@ async def _parse(
                     write_access_allowed = types.WriteAccessAllowed._parse(action)
                     service_type = enums.MessageServiceType.WRITE_ACCESS_ALLOWED
 
-            elif isinstance(action, raw.types.MessageActionStarGift):
+            elif (
+                isinstance(action, raw.types.MessageActionStarGift) or
+                isinstance(action, raw.types.MessageActionStarGiftUnique)
+            ):
                 user_gift = await types.UserGift._parse_action(client, message, users)
                 service_type = enums.MessageServiceType.USER_GIFT
 

pyrogram/types/messages_and_media/user_gift.py

@@ -44,7 +44,7 @@ class UserGift(Object):
         is_saved (``bool``, *optional*):
             True, if the gift is displayed on the user's profile page; may be False only for the receiver of the gift.
 
-        date (``datetime``):
+        date (:py:obj:`~datetime.datetime`, *optional*):
             Date when the gift was sent.
 
         gift (:obj:`~pyrogram.types.Gift`, *optional*):
@@ -68,6 +68,15 @@ class UserGift(Object):
         prepaid_upgrade_star_count (``int``, *optional*):
             Number of Telegram Stars that were paid by the sender for the ability to upgrade the gift.
 
+        can_be_transferred (``bool``, *optional*):
+            True, if the gift is an upgraded gift that can be transferred to another user; only for the receiver of the gift.
+
+        transfer_star_count (``int``, *optional*):
+            Number of Telegram Stars that must be paid to transfer the upgraded gift; only for the receiver of the gift.
+
+        export_date (:py:obj:`~datetime.datetime`, *optional*):
+            Point in time (Unix timestamp) when the upgraded gift can be transferred to TON blockchain as an NFT; None if NFT export isn't possible; only for the receiver of the gift.
+
     """
 
     def __init__(
@@ -87,6 +96,9 @@ def __init__(
         can_be_upgraded: Optional[bool] = None,
         was_refunded: Optional[bool] = None,
         prepaid_upgrade_star_count: Optional[int] = None,
+        can_be_transferred: Optional[bool] = None,
+        transfer_star_count: Optional[int] = None,
+        export_date: datetime = None,
     ):
         super().__init__(client)
 
@@ -103,6 +115,10 @@ def __init__(
         self.can_be_upgraded = can_be_upgraded
         self.was_refunded = was_refunded
         self.prepaid_upgrade_star_count = prepaid_upgrade_star_count
+        self.can_be_transferred = can_be_transferred
+        self.transfer_star_count = transfer_star_count
+        self.export_date = export_date
+
 
     @staticmethod
     async def _parse(
@@ -135,7 +151,7 @@ async def _parse_action(
         message: "raw.base.Message",
         users: dict
     ) -> "UserGift":
-        action = message.action  # raw.types.MessageActionStarGift
+        action = message.action
 
         doc = action.gift.sticker
         attributes = {type(i): i for i in doc.attributes}
@@ -146,30 +162,55 @@ async def _parse_action(
             entities = [types.MessageEntity._parse(client, entity, users) for entity in action.message.entities]
             entities = types.List(filter(lambda x: x is not None, entities))
 
-        return UserGift(
-            gift=types.Gift(
-                id=action.gift.id,
-                sticker=await types.Sticker._parse(client, doc, attributes),
-                star_count=action.gift.stars,
-                total_count=getattr(action.gift, "availability_total", None),
-                remaining_count=getattr(action.gift, "availability_remains", None),
-                default_sell_star_count=action.gift.convert_stars,
-                is_limited=getattr(action.gift, "limited", None),
-            ),
-            date=utils.timestamp_to_datetime(message.date),
-            is_private=getattr(action, "name_hidden", None),
-            is_saved=getattr(action, "saved", None),
-            sender_user=types.User._parse(client, users.get(utils.get_raw_peer_id(message.peer_id))),
-            message_id=message.id,
-            text=Str(text).init(entities) if text else None,
-            entities=entities,
-            sell_star_count=getattr(action, "convert_stars", None),
-            was_converted=getattr(action, "converted", None),
-            can_be_upgraded=getattr(action, "can_upgrade", None),
-            was_refunded=getattr(action, "refunded", None),
-            prepaid_upgrade_star_count=getattr(action, "upgrade_stars", None),
-            client=client
-        )
+        if isinstance(action, raw.types.MessageActionStarGift):
+            return UserGift(
+                gift=types.Gift(
+                    id=action.gift.id,
+                    sticker=await types.Sticker._parse(client, doc, attributes),
+                    star_count=action.gift.stars,
+                    total_count=getattr(action.gift, "availability_total", None),
+                    remaining_count=getattr(action.gift, "availability_remains", None),
+                    default_sell_star_count=action.gift.convert_stars,
+                    is_limited=getattr(action.gift, "limited", None),
+                ),
+                date=utils.timestamp_to_datetime(message.date),
+                is_private=getattr(action, "name_hidden", None),
+                is_saved=getattr(action, "saved", None),
+                sender_user=types.User._parse(client, users.get(utils.get_raw_peer_id(message.peer_id))),
+                message_id=message.id,
+                text=Str(text).init(entities) if text else None,
+                entities=entities,
+                sell_star_count=getattr(action, "convert_stars", None),
+                was_converted=getattr(action, "converted", None),
+                can_be_upgraded=getattr(action, "can_upgrade", None),
+                was_refunded=getattr(action, "refunded", None),
+                prepaid_upgrade_star_count=getattr(action, "upgrade_stars", None),
+                client=client
+            )
+
+        if isinstance(action, raw.types.MessageActionStarGiftUnique):
+            return UserGift(
+                gift=types.Gift(
+                    id=action.gift.id,
+                    sticker=await types.Sticker._parse(client, doc, attributes),
+                    star_count=action.gift.stars,
+                    total_count=getattr(action.gift, "availability_total", None),
+                    remaining_count=getattr(action.gift, "availability_remains", None),
+                    default_sell_star_count=action.gift.convert_stars,
+                    is_limited=getattr(action.gift, "limited", None),
+                ),
+                date=utils.timestamp_to_datetime(message.date),
+                sender_user=types.User._parse(client, users.get(utils.get_raw_peer_id(message.peer_id))),
+                message_id=message.id,
+                text=Str(text).init(entities) if text else None,
+                entities=entities,
+                can_be_transferred=getattr(action, "transferred", None),
+                was_refunded=getattr(action, "refunded", None),
+                prepaid_upgrade_star_count=getattr(action, "upgrade_stars", None),
+                export_date=utils.timestamp_to_datetime(action.can_export_at) if action.can_export_at else None,
+                transfer_star_count=getattr(action, "transfer_stars", None),
+                client=client
+            )
 
     async def toggle(self, is_saved: bool) -> bool:
         """Bound method *toggle* of :obj:`~pyrogram.types.UserGift`.