Fix PaymentForm parsing

Author: KurimuzonAkuma

compiler/docs/compiler.py

@@ -1070,6 +1070,7 @@ def get_title_list(s: str) -> list:
             MediaAreaType
             PrivacyRuleType
             GiftForResaleOrder
+            PaymentFormType
         """,
     )
 

pyrogram/enums/__init__.py

@@ -33,6 +33,7 @@
 from .next_code_type import NextCodeType
 from .paid_reaction_privacy import PaidReactionPrivacy
 from .parse_mode import ParseMode
+from .payment_form_type import PaymentFormType
 from .phone_call_discard_reason import PhoneCallDiscardReason
 from .poll_type import PollType
 from .privacy_key import PrivacyKey
@@ -64,6 +65,7 @@
     'NextCodeType',
     'PaidReactionPrivacy',
     'ParseMode',
+    'PaymentFormType',
     'PhoneCallDiscardReason',
     'PollType',
     'PrivacyKey',

pyrogram/enums/payment_form_type.py

@@ -0,0 +1,34 @@
+#  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 enum import auto
+
+from .auto_name import AutoName
+
+
+class PaymentFormType(AutoName):
+    """Describes type of payment form."""
+
+    REGULAR = auto()
+    "The payment form is for a regular payment"
+
+    STARS = auto()
+    "The payment form is for a payment in Telegram Stars"
+
+    STAR_SUBSCRIPTION = auto()
+    "The payment form is for a payment in Telegram Stars for subscription"

pyrogram/types/messages_and_media/payment_form.py

@@ -19,42 +19,53 @@
 from typing import Optional
 
 import pyrogram
-from pyrogram import types, raw
+from pyrogram import enums, raw, types
+
 from ..object import Object
 
 
 class PaymentForm(Object):
-    """This object contains basic information about an payment form.
+    """Contains information about an invoice payment form.
 
     Parameters:
         id (``int``):
             Form id.
 
-        bot (``str``):
-            Bot.
+        type (:obj:`~pyrogram.enums.PaymentFormType`):
+            Type of the payment form.
 
-        title (``str``):
+        title (``str``, *optional*):
             Form title.
 
-        description (``str``):
+        description (``str``, *optional*):
             Form description.
 
-        invoice (``str``):
-            Invoice.
+        photo (:obj:`~pyrogram.types.Photo`, *optional*):
+            Product photo.
+
+        seller_bot_user_id (``int``, *optional*):
+            User identifier of the seller bot.
+
+        seller_bot (:obj:`~pyrogram.types.User`, *optional*):
+            Information about the seller bot.
 
-        provider (``str``, *optional*):
-            Payment provider.
+        payment_provider_user_id (``int``, *optional*):
+            User identifier of the payment provider bot.
+
+        payment_provider (:obj:`~pyrogram.types.User`, *optional*):
+            Information about the payment provider.
+
+        invoice (``str``, *optional*):
+            Invoice.
 
         url (``str``, *optional*):
             Payment form URL.
 
         can_save_credentials (``str``, *optional*):
-            Whether the user can choose to save credentials.
+            True, if the user can choose to save credentials.
 
-        is_password_missing (``str``, *optional*):
-            Indicates that the user can save payment credentials,
-            but only after setting up a 2FA password
-            (currently the account doesn't have a 2FA password).
+        need_password (``str``, *optional*):
+            True, if the user will be able to save credentials, if sets up a 2-step verification password.
 
         native_provider (``str``, *optional*):
             Payment provider name.
@@ -68,50 +79,81 @@ def __init__(
         *,
         client: "pyrogram.Client" = None,
         id: int,
-        bot: "types.User",
-        title: str,
-        description: str,
-        invoice: "types.Invoice",
-        provider: Optional["types.User"] = None,
+        type: "enums.PaymentFormType",
+        title: Optional[str] = None,
+        description: Optional[str] = None,
+        photo: Optional["types.Photo"] = None,
+        seller_bot_user_id: Optional[int] = None,
+        seller_bot: Optional["types.User"] = None,
+        payment_provider_user_id: Optional[int] = None,
+        payment_provider: Optional["types.User"] = None,
+        invoice: Optional["types.Invoice"] = None,
         url: Optional[str] = None,
         can_save_credentials: Optional[bool] = None,
-        is_password_missing: Optional[bool] = None,
+        need_password: Optional[bool] = None,
         native_provider: Optional[str] = None,
         raw: "raw.base.payments.PaymentForm" = None,
-        # TODO: Add support for other params:
-        # native_params
-        # additional_params
-        # saved_info
-        # saved_credentials
     ):
         super().__init__(client)
 
         self.id = id
-        self.bot = bot
+        self.type = type
+        self.seller_bot_user_id = seller_bot_user_id
+        self.seller_bot = seller_bot
+        self.payment_provider_user_id = payment_provider_user_id
+        self.payment_provider = payment_provider
         self.title = title
         self.description = description
+        self.photo = photo
         self.invoice = invoice
-        self.provider = provider
         self.url = url
         self.can_save_credentials = can_save_credentials
-        self.is_password_missing = is_password_missing
+        self.need_password = need_password
         self.native_provider = native_provider
         self.raw = raw
 
     @staticmethod
-    def _parse(client, payment_form: "raw.base.payments.PaymentForm") -> "PaymentForm":
-        users = {i.id: i for i in payment_form.users}
-
-        return PaymentForm(
-            id=payment_form.form_id,
-            bot=types.User._parse(client, users.get(payment_form.bot_id)),
-            title=payment_form.title,
-            description=payment_form.description,
-            invoice=types.Invoice._parse(client, payment_form.invoice),
-            provider=types.User._parse(client, users.get(getattr(payment_form, "provider_id", None))),
-            url=getattr(payment_form, "url", None),
-            can_save_credentials=getattr(payment_form, "can_save_credentials", None),
-            is_password_missing=getattr(payment_form, "password_missing", None),
-            native_provider=getattr(payment_form, "native_provider", None),
-            raw=payment_form
-        )
+    def _parse(client, form: "raw.base.payments.PaymentForm") -> "PaymentForm":
+        users = {i.id: i for i in getattr(form, "users", [])}
+
+        if isinstance(form, raw.types.payments.PaymentForm):
+            return PaymentForm(
+                id=form.form_id,
+                type=enums.PaymentFormType.REGULAR,
+                title=form.title,
+                description=form.description,
+                photo=types.Photo._parse(client, form.photo),
+                seller_bot_user_id=form.bot_id,
+                seller_bot=types.User._parse(client, users.get(form.bot_id)),
+                payment_provider_user_id=form.provider_id,
+                payment_provider=types.User._parse(client, users.get(form.provider_id)),
+                invoice=types.Invoice._parse(client, form.invoice),
+                url=form.url,
+                can_save_credentials=form.can_save_credentials,
+                need_password=form.password_missing,
+                native_provider=form.native_provider,
+                # native_params,
+                # additional_methods,
+                # saved_info,
+                # saved_credentials,
+                raw=form
+            )
+        elif isinstance(form, raw.types.payments.PaymentFormStarGift):
+            return PaymentForm(
+                id=form.form_id,
+                type=enums.PaymentFormType.STAR_SUBSCRIPTION,
+                invoice=types.Invoice._parse(client, form.invoice),
+                raw=form
+            )
+        elif isinstance(form, raw.types.payments.PaymentFormStars):
+            return PaymentForm(
+                id=form.form_id,
+                type=enums.PaymentFormType.STARS,
+                title=form.title,
+                description=form.description,
+                photo=types.Photo._parse(client, form.photo),
+                seller_bot_user_id=form.bot_id,
+                seller_bot=types.User._parse(client, users.get(form.bot_id)),
+                invoice=types.Invoice._parse(client, form.invoice),
+                raw=form
+            )