Rename GiftCode to PremiumGiftCode, refactor and update to new layer

Author: KurimuzonAkuma

compiler/docs/compiler.py

@@ -749,7 +749,7 @@ def get_title_list(s: str) -> list:
             Invoice
             LinkPreviewOptions
             GiftCollection
-            GiftCode
+            PremiumGiftCode
             GiftPurchaseLimit
             GiftResaleParameters
             GiftResalePrice

pyrogram/types/messages_and_media/__init__.py

@@ -50,7 +50,7 @@
 from .general_forum_topic_hidden import GeneralForumTopicHidden
 from .general_forum_topic_unhidden import GeneralForumTopicUnhidden
 from .gift_collection import GiftCollection
-from .gift_code import GiftCode
+from .premium_gift_code import PremiumGiftCode
 from .gift_purchase_limit import GiftPurchaseLimit
 from .gift_resale_parameters import GiftResaleParameters
 from .gift_resale_price import GiftResalePrice, GiftResalePriceStar, GiftResalePriceTon
@@ -171,7 +171,7 @@
     "GeneralForumTopicHidden",
     "GeneralForumTopicUnhidden",
     "GiftCollection",
-    "GiftCode",
+    "PremiumGiftCode",
     "GiftPurchaseLimit",
     "GiftResaleParameters",
     "GiftResalePrice",

pyrogram/types/messages_and_media/gift_code.py

@@ -669,7 +669,7 @@ def __init__(
         direct_message_price_changed: Optional["types.DirectMessagePriceChanged"] = None,
         checklist_tasks_done: Optional[List["types.ChecklistTasksDone"]] = None,
         checklist_tasks_added: Optional[List["types.ChecklistTasksAdded"]] = None,
-        gift_code: Optional["types.GiftCode"] = None,
+        gift_code: Optional["types.PremiumGiftCode"] = None,
         gifted_premium: Optional["types.GiftedPremium"] = None,
         gifted_stars: Optional["types.GiftedStars"] = None,
         gifted_ton: Optional["types.GiftedTon"] = None,
@@ -1042,7 +1042,7 @@ async def _parse_service(
             proximity_alert_triggered = types.ProximityAlertTriggered._parse(client, action, users, chats)
         elif isinstance(action, raw.types.MessageActionGiftCode):
             service_type = enums.MessageServiceType.GIFT_CODE
-            gift_code = types.GiftCode._parse(client, action, users, chats)
+            gift_code = types.PremiumGiftCode._parse(client, action, users, chats)
         elif isinstance(action, raw.types.MessageActionGiftPremium):
             service_type = enums.MessageServiceType.GIFTED_PREMIUM
             gifted_premium = await types.GiftedPremium._parse(

pyrogram/types/messages_and_media/message.py

@@ -0,0 +1,141 @@
+#  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/>.
+
+import random
+from typing import Optional
+
+from pyrogram import raw, types, utils
+from ..object import Object
+
+
+class PremiumGiftCode(Object):
+    """A Telegram Premium gift code was created for the user.
+
+    Parameters:
+        creator (:obj:`~pyrogram.types.Chat`, *optional*):
+            Identifier of a chat or a user that created the gift code.
+
+        text (:obj:`~pyrogram.types.FormattedText`, *optional*):
+            Message added to the gift.
+
+        is_from_giveaway (``bool``, *optional*):
+            True, if the gift code was created for a giveaway.
+
+        is_unclaimed (``bool``, *optional*):
+            True, if the winner for the corresponding Telegram Premium subscription wasn't chosen.
+
+        currency (``str``, *optional*):
+            Currency for the paid amount.
+
+        amount (``int``, *optional*):
+            The paid amount, in the smallest units of the currency.
+
+        cryptocurrency (``str``, *optional*):
+            Cryptocurrency used to pay for the gift.
+
+        cryptocurrency_amount (``int``, *optional*):
+            The paid amount, in the smallest units of the cryptocurrency.
+
+        month_count (``int``):
+            Number of months the Telegram Premium subscription will be active after code activation.
+
+        day_count (``int``):
+            Number of days the Telegram Premium subscription will be active after code activation.
+
+        sticker (:obj:`~pyrogram.types.Sticker`, *optional*):
+            A sticker to be shown in the message.
+
+        code (``str``):
+            The gift code.
+
+        link (``str``, *property*):
+            Generate a link to this gift code.
+    """
+
+    def __init__(
+        self,
+        *,
+        creator: Optional["types.Chat"] = None,
+        text: Optional["types.FormattedText"] = None,
+        is_from_giveaway: Optional[bool] = None,
+        is_unclaimed: Optional[bool] = None,
+        currency: Optional[str] = None,
+        amount: Optional[int] = None,
+        cryptocurrency: Optional[str] = None,
+        cryptocurrency_amount: Optional[int] = None,
+        month_count: int,
+        day_count: int,
+        sticker: Optional["types.Sticker"] = None,
+        code: str
+    ):
+        super().__init__()
+
+        self.creator = creator
+        self.text = text
+        self.is_from_giveaway = is_from_giveaway
+        self.is_unclaimed = is_unclaimed
+        self.currency = currency
+        self.amount = amount
+        self.cryptocurrency = cryptocurrency
+        self.cryptocurrency_amount = cryptocurrency_amount
+        self.month_count = month_count
+        self.day_count = day_count
+        self.sticker = sticker
+        self.code = code
+
+    @staticmethod
+    async def _parse(client, giftcode: "raw.types.MessageActionGiftCode", users, chats):
+        raw_peer_id = utils.get_raw_peer_id(giftcode.boost_peer)
+
+        raw_stickers = await client.invoke(
+            raw.functions.messages.GetStickerSet(
+                stickerset=raw.types.InputStickerSetPremiumGifts(),
+                hash=0
+            )
+        )
+
+        return PremiumGiftCode(
+            creator=types.Chat._parse_chat(client, users.get(raw_peer_id) or chats.get(raw_peer_id)),
+            text=types.FormattedText._parse(client, giftcode.message),
+            is_from_giveaway=giftcode.via_giveaway,
+            is_unclaimed=giftcode.unclaimed,
+            currency=giftcode.currency,
+            amount=giftcode.amount,
+            cryptocurrency=giftcode.crypto_currency,
+            cryptocurrency_amount=giftcode.crypto_amount,
+            month_count=utils.get_premium_duration_month_count(giftcode.days),
+            day_count=giftcode.days,
+            sticker=random.choice(
+                types.List(
+                    [
+                        await types.Sticker._parse(
+                            client,
+                            doc,
+                            {
+                                type(i): i for i in doc.attributes
+                            }
+                        ) for doc in raw_stickers.documents
+                    ]
+                )
+            ),
+            code=giftcode.slug
+        )
+
+    @property
+    def link(self) -> str:
+        return f"https://t.me/giftcode/{self.code}"