Bot API v8.2

README.md

@@ -2,7 +2,7 @@
 
 <br>
 
-<div align="center"> <a href="https://core.telegram.org/bots/api-changelog#november-17-2024"> <img src="https://img.shields.io/badge/Bot%20API-8.0-blue?logo=telegram" alt="Supported Bot API version"> </a> <a href="https://pypi.org/project/tgram/"> <img src="https://img.shields.io/pypi/v/tgram.svg?logo=python&logoColor=%23959DA5&label=pypi&labelColor=%23282f37" alt="PyPI"> </a> <a href="https://pepy.tech/project/tgram"> <img src="https://static.pepy.tech/badge/tgram" alt="Downloads"> </a> <a href="https://t.me/tgbot_channel"> <img src="https://img.shields.io/badge/Telegram-Channel-blue.svg?logo=telegram" alt="Telegram Channel"> </a> <a href="https://t.me/tgbot_chat"> <img src="https://img.shields.io/badge/Telegram-Group-blue.svg?logo=telegram" alt="Telegram Group"> </a> </div>
+<div align="center"> <a href="https://core.telegram.org/bots/api-changelog#november-17-2024"> <img src="https://img.shields.io/badge/Bot%20API-8.2-blue?logo=telegram" alt="Supported Bot API version"> </a> <a href="https://pypi.org/project/tgram/"> <img src="https://img.shields.io/pypi/v/tgram.svg?logo=python&logoColor=%23959DA5&label=pypi&labelColor=%23282f37" alt="PyPI"> </a> <a href="https://pepy.tech/project/tgram"> <img src="https://static.pepy.tech/badge/tgram" alt="Downloads"> </a> <a href="https://t.me/tgbot_channel"> <img src="https://img.shields.io/badge/Telegram-Channel-blue.svg?logo=telegram" alt="Telegram Channel"> </a> <a href="https://t.me/tgbot_chat"> <img src="https://img.shields.io/badge/Telegram-Group-blue.svg?logo=telegram" alt="Telegram Group"> </a> </div>
 
 ## 🚀 Quick Start
 Here's a basic example to get started with tgram:

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "tgram"
-version = "1.12.4"
+version = "1.12.5"
 description = "Tgram is a user-friendly and lightweight Python library that simplifies interaction with the Telegram Bot API. It allows developers to easily create, manage, and automate Telegram bots."
 authors = ["Zaid <[email protected]>"]
 license = "MIT"

tgram/__init__.py

@@ -9,7 +9,7 @@
     "storage",
 ]
 
-__version__ = "1.12.4"
+__version__ = "1.12.5"
 
 from . import (
     filters,

tgram/methods/__init__.py

@@ -142,6 +142,11 @@
 
 from .bot.runner import Runner
 
+from .chats.verify_chat import VerifyChat
+from .chats.verify_user import VerifyUser
+from .chats.remove_chat_verification import RemoveChatVerification
+from .chats.remove_user_verification import RemoveUserVerification
+
 
 class TelegramBotMethods(
     AddStickerToSet,
@@ -282,5 +287,9 @@ class TelegramBotMethods(
     UnRestrictChatMember,
     UploadStickerFile,
     Runner,
+    VerifyChat,
+    VerifyUser,
+    RemoveUserVerification,
+    RemoveChatVerification,
 ):
     pass

tgram/methods/chats/remove_chat_verification.py

@@ -0,0 +1,26 @@
+import tgram
+
+from typing import Union
+
+
+class RemoveChatVerification:
+    async def remove_chat_verification(
+        self: "tgram.TgBot",
+        chat_id: Union[str, int],
+    ) -> bool:
+        """
+        Removes verification from a chat that is currently verified on behalf of the organization represented by the bot. Returns True on success.
+        Telegram documentation: https://core.telegram.org/bots/api#removechatverification
+
+        :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
+        :type chat_id: :obj:`int` or :obj:`str`
+
+        :return: True on success
+        :rtype: :obj:`bool`
+        """
+
+        result = await self(
+            "removeChatVerification",
+            chat_id=chat_id,
+        )
+        return result["result"]

tgram/methods/chats/remove_user_verification.py

@@ -0,0 +1,24 @@
+import tgram
+
+
+class RemoveUserVerification:
+    async def remove_user_verification(
+        self: "tgram.TgBot",
+        user_id: int,
+    ) -> bool:
+        """
+        Removes verification from a user who is currently verified on behalf of the organization represented by the bot. Returns True on success.
+        Telegram documentation: https://core.telegram.org/bots/api#removeuserverification
+
+        :param user_id: Unique identifier of the target user
+        :type user_id: :obj:`int`
+
+        :return: True on success
+        :rtype: :obj:`bool`
+        """
+
+        result = await self(
+            "removeUserVerification",
+            user_id=user_id,
+        )
+        return result["result"]

tgram/methods/chats/verify_chat.py

@@ -0,0 +1,28 @@
+import tgram
+
+from typing import Union
+
+
+class VerifyChat:
+    async def verify_chat(
+        self: "tgram.TgBot", chat_id: Union[str, int], custom_description: str = None
+    ) -> bool:
+        """
+        Verifies a chat on behalf of the organization which is represented by the bot. Returns True on success.
+        Telegram documentation: https://core.telegram.org/bots/api#verifychat
+
+        :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
+        :type chat_id: :obj:`int` or :obj:`str`
+
+        :param custom_description: UCustom description for the verification; 0-70 characters.
+            Must be empty if the organization isn't allowed to provide a custom verification description.
+        :type custom_description: :obj:`str`
+
+        :return: True on success
+        :rtype: :obj:`bool`
+        """
+
+        result = await self(
+            "verifyChat", chat_id=chat_id, custom_description=custom_description
+        )
+        return result["result"]

tgram/methods/chats/verify_user.py

@@ -0,0 +1,26 @@
+import tgram
+
+
+class VerifyUser:
+    async def verify_user(
+        self: "tgram.TgBot", user_id: int, custom_description: str = None
+    ) -> bool:
+        """
+        Verifies a user on behalf of the organization which is represented by the bot. Returns True on success.
+        Telegram documentation: https://core.telegram.org/bots/api#verifyuser
+
+        :param user_id: Unique identifier of the target user
+        :type user_id: :obj:`int`
+
+        :param custom_description: UCustom description for the verification; 0-70 characters.
+            Must be empty if the organization isn't allowed to provide a custom verification description.
+        :type custom_description: :obj:`str`
+
+        :return: True on success
+        :rtype: :obj:`bool`
+        """
+
+        result = await self(
+            "verifyUser", user_id=user_id, custom_description=custom_description
+        )
+        return result["result"]

tgram/methods/messages/send_gift.py

@@ -9,6 +9,7 @@ async def send_gift(
         self: "tgram.TgBot",
         user_id: int,
         gift_id: str,
+        pay_for_upgrade: bool = None,
         text: str = None,
         text_parse_mode: ParseMode = None,
         text_entities: List[MessageEntity] = None,
@@ -24,6 +25,10 @@ async def send_gift(
         :param gift_id: Identifier of the gift
         :type gift_id: :obj:`str`
 
+        :param pay_for_upgrade: Pass True to pay for the gift upgrade from the bot's balance,
+            thereby making the upgrade free for the receiver
+        :type pay_for_upgrade: :obj:`bool`
+
         :param text: Text that will be shown along with the gift; 0-255 characters
         :type text: :obj:`str`
 
@@ -41,6 +46,7 @@ async def send_gift(
             "sendGift",
             user_id=user_id,
             gift_id=gift_id,
+            pay_for_upgrade=pay_for_upgrade,
             text=text,
             text_parse_mode=text_parse_mode,
             text_entities=text_entities,

tgram/types/_gift.py

@@ -19,6 +19,9 @@ class Gift(Type_):
     :param star_count: The number of Telegram Stars that must be paid to send the sticker
     :type star_count: :obj:`int`
 
+    :param upgrade_star_count: Optional. The number of Telegram Stars that must be paid to upgrade the gift to a unique one
+    :type upgrade_star_count: :obj:`int
+
     :param total_count: Optional. The total number of the gifts of this type that can be sent; for limited gifts only
     :type total_count: :obj:`int`
 
@@ -34,6 +37,7 @@ def __init__(
         id: "str" = None,
         sticker: "tgram.types.Sticker" = None,
         star_count: "int" = None,
+        upgrade_star_count: "int" = None,
         total_count: "int" = None,
         remaining_count: "int" = None,
         me: "tgram.TgBot" = None,
@@ -43,6 +47,7 @@ def __init__(
         self.id = id
         self.sticker = sticker
         self.star_count = star_count
+        self.upgrade_star_count = upgrade_star_count
         self.total_count = total_count
         self.remaining_count = remaining_count
 
@@ -55,6 +60,7 @@ def _parse(
                 id=d.get("id"),
                 sticker=tgram.types.Sticker._parse(me, d.get("sticker")),
                 star_count=d.get("star_count"),
+                upgrade_star_count=d.get("upgrade_star_count"),
                 total_count=d.get("total_count"),
                 remaining_count=d.get("remaining_count"),
             )

tgram/types/_inline_query_result_article.py

@@ -29,9 +29,6 @@ class InlineQueryResultArticle(Type_):
     :param url: Optional. URL of the result
     :type url: :obj:`str`
 
-    :param hide_url: Optional. Pass True, if you don't want the URL to be shown in the message
-    :type hide_url: :obj:`bool`
-
     :param description: Optional. Short description of the result
     :type description: :obj:`str`
 
@@ -54,7 +51,6 @@ def __init__(
         input_message_content: "tgram.types.InputMessageContent" = None,
         reply_markup: "tgram.types.InlineKeyboardMarkup" = None,
         url: "str" = None,
-        hide_url: "bool" = None,
         description: "str" = None,
         thumbnail_url: "str" = None,
         thumbnail_width: "int" = None,
@@ -69,7 +65,6 @@ def __init__(
         self.input_message_content = input_message_content
         self.reply_markup = reply_markup
         self.url = url
-        self.hide_url = hide_url
         self.description = description
         self.thumbnail_url = thumbnail_url
         self.thumbnail_width = thumbnail_width
@@ -91,7 +86,6 @@ def _parse(
                     me=me, d=d.get("reply_markup")
                 ),
                 url=d.get("url"),
-                hide_url=d.get("hide_url"),
                 description=d.get("description"),
                 thumbnail_url=d.get("thumbnail_url"),
                 thumbnail_width=d.get("thumbnail_width"),