pyTelegramBotAPI 4.25.0__py3-none-any.whl → 4.26.0__py3-none-any.whl

{pytelegrambotapi-4.25.0.dist-info → pytelegrambotapi-4.26.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: pyTelegramBotAPI
-Version: 4.25.0
+Version: 4.26.0
 Summary: Python Telegram bot api.
 Project-URL: Homepage, https://github.com/eternnoir/pyTelegramBotAPI
 Project-URL: Documentation, https://pytba.readthedocs.org
@@ -8,6 +8,7 @@ Project-URL: Repository, https://github.com/eternnoir/pyTelegramBotAPI
 Project-URL: Issues, https://github.com/eternnoir/pyTelegramBotAPI/issues
 Author-email: eternnoir <eternnoir@gmail.com>
 License: GPL2
+License-File: LICENSE
 Keywords: api,bot,telegram,tools
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
@@ -52,7 +53,7 @@ Description-Content-Type: text/markdown
 <p align="center">A simple, but extensible Python implementation for the <a href="https://core.telegram.org/bots/api">Telegram Bot API</a>.</p>
 <p align="center">Both synchronous and asynchronous.</p>
 
-## <p align="center">Supported Bot API version: <a href="https://core.telegram.org/bots/api#november-17-2024"><img src="https://img.shields.io/badge/Bot%20API-8.1-blue?logo=telegram" alt="Supported Bot API version"></a>
+## <p align="center">Supported Bot API version: <a href="https://core.telegram.org/bots/api#january-1-2025"><img src="https://img.shields.io/badge/Bot%20API-8.2-blue?logo=telegram" alt="Supported Bot API version"></a>
 
 <h2><a href='https://pytba.readthedocs.io/en/latest/index.html'>Official documentation</a></h2>
 <h2><a href='https://pytba.readthedocs.io/ru/latest/index.html'>Official ru documentation</a></h2>

{pytelegrambotapi-4.25.0.dist-info → pytelegrambotapi-4.26.0.dist-info}/RECORD

@@ -1,17 +1,17 @@
-telebot/__init__.py,sha256=a57ZJyp8GP-r-MiC5ecygZphIbWgNS8pMCOLd5TuSSM,432408
-telebot/apihelper.py,sha256=alfT2M1viZVOmDFMHb_Mdh5JeP4EE2mzZOnlvhGpBoM,100182
-telebot/async_telebot.py,sha256=qSENsVubvmCIXBn8-YARFLeha8IlDaNhgSDF9fVybc8,405457
+telebot/__init__.py,sha256=ZQtRT7eeEcZ8PH640XvIlzqHnB3TBk5k7KjZF2U-xzs,435648
+telebot/apihelper.py,sha256=N89dapRPfv3TfA7_YqZZpolJ5C_bTLrZRUW6klzd6J0,101613
+telebot/async_telebot.py,sha256=IC197RbcdRLLSsgtVhkKNCEkwBZ8Yp3vBhFWc7BurCg,408733
 telebot/asyncio_filters.py,sha256=w63xFjFnXtr4oo3Kqx1Fs485vQxNCgXZs1ukdkNcnEA,12854
 telebot/asyncio_handler_backends.py,sha256=BWS7zr93FJNZJmPHBoXo4i_PIHGlmrEoWy1miXax9aI,2785
-telebot/asyncio_helper.py,sha256=SzBRMAhMr0A6gL3qnyoNJUNvOkXn28sVrytjhuRWZqM,101072
+telebot/asyncio_helper.py,sha256=HCfTkX0_o4US2Mp5xCrbb6BPEZX5cgKXxCp--1ZxYFo,102561
 telebot/callback_data.py,sha256=k4Rz3lAONG5J2M9TESKMIjqXoBNJMfEy9nnrmJAyi3Q,5358
 telebot/custom_filters.py,sha256=ncF8_zwlSqkuATI46Xc6HQ5Y1ZoQ1fO6AlcRbs7bO3U,12975
 telebot/formatting.py,sha256=UFZTRSX-DMcALmaQ7xztHObop8DWeCtHdKsOoGLgDY0,15172
 telebot/handler_backends.py,sha256=lyKu0PaH2c4y5FfyQS3M9tOyBJ8ATjxHZkATzu01XpE,7969
 telebot/service_utils.py,sha256=xLmlZLTVs34UOdQtMvwduor8hnLxQCx8iJ92wDGl2Mw,2053
-telebot/types.py,sha256=lA3JYmLYBHcjzustmFaflPSwKXj5BOLzcWdSCSt2Mbo,474882
+telebot/types.py,sha256=3iDuL1CBMfH7FUITdxOAa04AQwswEBKXgswUMwwacaE,475305
 telebot/util.py,sha256=ylRtI4DI4I1BJAF2Ack7WyGbTN1cRkubUCbhLNiiPj4,21385
-telebot/version.py,sha256=CFmNAe1WwcbIebAfVhERMAnvhFbYytIkUtMZMvGQQ7c,99
+telebot/version.py,sha256=PVbmIN1Rpi1DPItgqp-6XAZxaknSOoqK63cBImPFerg,99
 telebot/asyncio_storage/__init__.py,sha256=fraOWJby1ddJmPAXf1oXWmZJXRodSpING17MF875NPI,433
 telebot/asyncio_storage/base_storage.py,sha256=I-NII9ZMCxCHStPc-73qSyQhjBtkhNzb2IcZPhjR1Eg,3243
 telebot/asyncio_storage/memory_storage.py,sha256=h8yc2xpfLmbcBjPmKkqNhZtUtpNQ7EuKIfMGue61e7w,5849
@@ -35,7 +35,7 @@ telebot/storage/base_storage.py,sha256=WzGgSflKzcn2ENsgz1Q-D_v-ZKCtnMOURGOHIwNJ0
 telebot/storage/memory_storage.py,sha256=-r1vuIt1YHq9btkr6E7BCu4Do-wUDlNcttG22SSgEYo,5799
 telebot/storage/pickle_storage.py,sha256=wjFuRxSBeCMB3h-fUqLgqe2XcZoc6-ixkN5qsm3th9I,7136
 telebot/storage/redis_storage.py,sha256=DReU2lc8cI0f3XMIT1N9-suGZ6jE8H9I_mapK3A-lyE,9450
-pytelegrambotapi-4.25.0.dist-info/METADATA,sha256=5ihfiBhE_mcs7oLTcB7-rddg33a6qyurCqj642X3Ugo,48123
-pytelegrambotapi-4.25.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-pytelegrambotapi-4.25.0.dist-info/licenses/LICENSE,sha256=qz_jTTxi4zSAFaTdASiwml2iAk0UZ6R4MRADNzwYo_A,18387
-pytelegrambotapi-4.25.0.dist-info/RECORD,,
+pytelegrambotapi-4.26.0.dist-info/METADATA,sha256=74lUQzeDkW4EQE2QFlnleOTIR5y7tMFaVfZJttC6K1U,48143
+pytelegrambotapi-4.26.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pytelegrambotapi-4.26.0.dist-info/licenses/LICENSE,sha256=qz_jTTxi4zSAFaTdASiwml2iAk0UZ6R4MRADNzwYo_A,18387
+pytelegrambotapi-4.26.0.dist-info/RECORD,,

{pytelegrambotapi-4.25.0.dist-info → pytelegrambotapi-4.26.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.26.3
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any

telebot/__init__.py

@@ -5474,7 +5474,7 @@ class TeleBot:
             (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)
         :type prices: :obj:`list` of :obj:`types.LabeledPrice`
 
-        :subscription_period: 	The number of seconds the subscription will be active for before the next payment.
+        :param subscription_period: The number of seconds the subscription will be active for before the next payment.
             The currency must be set to “XTR” (Telegram Stars) if the parameter is used. Currently, it must always
             be 2592000 (30 days) if specified.
         :type subscription_period: :obj:`int`
@@ -6250,7 +6250,8 @@ class TeleBot:
         """
         return apihelper.delete_sticker_set(self.token, name)
 
-    def send_gift(self, user_id: int, gift_id: str, text: Optional[str]=None, text_parse_mode: Optional[str]=None, text_entities: Optional[List[types.MessageEntity]]=None) -> bool:
+    def send_gift(self, user_id: int, gift_id: str, text: Optional[str]=None, text_parse_mode: Optional[str]=None, 
+                  text_entities: Optional[List[types.MessageEntity]]=None, pay_for_upgrade: Optional[bool]=None) -> bool:
         """
         Sends a gift to the given user. The gift can't be converted to Telegram Stars by the user. Returns True on success.
 
@@ -6262,6 +6263,9 @@ class TeleBot:
         :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`
 
@@ -6274,7 +6278,71 @@ class TeleBot:
         :return: Returns True on success.
         :rtype: :obj:`bool`
         """
-        return apihelper.send_gift(self.token, user_id, gift_id, text=text, text_parse_mode=text_parse_mode, text_entities=text_entities)
+        return apihelper.send_gift(self.token, user_id, gift_id, text=text, text_parse_mode=text_parse_mode, text_entities=text_entities,
+                                      pay_for_upgrade=pay_for_upgrade)
+    
+    def verify_user(self, user_id: int, custom_description: Optional[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: Custom 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: Returns True on success.
+        :rtype: :obj:`bool`
+        """
+        return apihelper.verify_user(self.token, user_id, custom_description=custom_description)
+
+    def verify_chat(self, chat_id: Union[int, str], custom_description: Optional[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` | :obj:`str`
+
+        :param custom_description: Custom 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: Returns True on success.
+        :rtype: :obj:`bool`
+        """
+        return apihelper.verify_chat(self.token, chat_id, custom_description=custom_description)
+
+    def remove_user_verification(self, 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: Returns True on success.
+        :rtype: :obj:`bool`
+        """
+
+        return apihelper.remove_user_verification(self.token, user_id)
+
+    def remove_chat_verification(self, chat_id: Union[int, str]) -> 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` | :obj:`str`
+
+        :return: Returns True on success.
+        :rtype: :obj:`bool`
+        """
+        return apihelper.remove_chat_verification(self.token, chat_id)
     
     def get_available_gifts(self) -> types.Gifts:
         """

telebot/apihelper.py

@@ -1929,7 +1929,7 @@ def get_available_gifts(token):
     return _make_request(token, method_url)
 
 
-def send_gift(token, user_id, gift_id, text=None, text_parse_mode=None, text_entities=None):
+def send_gift(token, user_id, gift_id, text=None, text_parse_mode=None, text_entities=None, pay_for_upgrade=None):
     method_url = 'sendGift'
     payload = {'user_id': user_id, 'gift_id': gift_id}
     if text:
@@ -1938,6 +1938,36 @@ def send_gift(token, user_id, gift_id, text=None, text_parse_mode=None, text_ent
         payload['text_parse_mode'] = text_parse_mode
     if text_entities:
         payload['text_entities'] = json.dumps(types.MessageEntity.to_list_of_dicts(text_entities))
+    if pay_for_upgrade is not None:
+        payload['pay_for_upgrade'] = pay_for_upgrade
+    return _make_request(token, method_url, params=payload, method='post')
+
+    
+def verify_user(token, user_id, custom_description=None):
+    method_url = 'verifyUser'
+    payload = {'user_id': user_id}
+    if custom_description:
+        payload['custom_description'] = custom_description
+    return _make_request(token, method_url, params=payload, method='post')
+
+
+def verify_chat(token, chat_id, custom_description=None):
+    method_url = 'verifyChat'
+    payload = {'chat_id': chat_id}
+    if custom_description:
+        payload['custom_description'] = custom_description
+    return _make_request(token, method_url, params=payload, method='post')
+
+
+def remove_user_verification(token, user_id):
+    method_url = 'removeUserVerification'
+    payload = {'user_id': user_id}
+    return _make_request(token, method_url, params=payload, method='post')
+
+
+def remove_chat_verification(token, chat_id):
+    method_url = 'removeChatVerification'
+    payload = {'chat_id': chat_id}
     return _make_request(token, method_url, params=payload, method='post')
 
 def set_sticker_emoji_list(token, sticker, emoji_list):
@@ -2271,6 +2301,12 @@ def convert_input_media_array(array):
             if media_dict['media'].startswith('attach://'):
                 key = media_dict['media'].replace('attach://', '')
                 files[key] = input_media.media
+            if 'thumbnail' in media_dict:
+                thumbnail = media_dict['thumbnail']
+                if isinstance(thumbnail, types.InputFile):
+                    thumbnail_key = 'thumbnail_' + key  
+                    files[thumbnail_key] = thumbnail    
+                    media_dict['thumbnail'] = 'attach://' + thumbnail_key   
             media.append(media_dict)
     return json.dumps(media), files
 

telebot/async_telebot.py

@@ -6922,7 +6922,7 @@ class AsyncTeleBot:
             (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)
         :type prices: :obj:`list` of :obj:`types.LabeledPrice`
 
-        :subscription_period: 	The number of seconds the subscription will be active for before the next payment.
+        :param subscription_period: The number of seconds the subscription will be active for before the next payment.
             The currency must be set to “XTR” (Telegram Stars) if the parameter is used. Currently, it must always
             be 2592000 (30 days) if specified.
         :type subscription_period: :obj:`int`
@@ -7707,7 +7707,8 @@ class AsyncTeleBot:
 
         return await asyncio_helper.delete_sticker_set(self.token, name)
 
-    async def send_gift(self, user_id: int, gift_id: str, text: Optional[str]=None, text_parse_mode: Optional[str]=None, text_entities: Optional[List[types.MessageEntity]]=None) -> bool:
+    async def send_gift(self, user_id: int, gift_id: str, text: Optional[str]=None, text_parse_mode: Optional[str]=None,
+                        text_entities: Optional[List[types.MessageEntity]]=None, pay_for_upgrade: Optional[bool]=None) -> bool:
         """
         Sends a gift to the given user. The gift can't be converted to Telegram Stars by the user. Returns True on success.
 
@@ -7719,6 +7720,9 @@ class AsyncTeleBot:
         :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`
 
@@ -7731,7 +7735,71 @@ class AsyncTeleBot:
         :return: Returns True on success.
         :rtype: :obj:`bool`
         """
-        return await asyncio_helper.send_gift(self.token, user_id, gift_id, text, text_parse_mode, text_entities)
+        return await asyncio_helper.send_gift(self.token, user_id, gift_id, text, text_parse_mode, text_entities, pay_for_upgrade=pay_for_upgrade)
+    
+    async def verify_user(self, user_id: int, custom_description: Optional[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: Custom 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: Returns True on success.
+        :rtype: :obj:`bool`
+        """
+        return await asyncio_helper.verify_user(self.token, user_id, custom_description=custom_description)
+
+    async def verify_chat(self, chat_id: Union[int, str], custom_description: Optional[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` | :obj:`str`
+
+        :param custom_description: Custom 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: Returns True on success.
+        :rtype: :obj:`bool`
+        """
+
+        return await asyncio_helper.verify_chat(self.token, chat_id, custom_description=custom_description)
+
+    async def remove_user_verification(self, 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: Returns True on success.
+        :rtype: :obj:`bool`
+
+        """
+        return await asyncio_helper.remove_user_verification(self.token, user_id)
+
+    async def remove_chat_verification(self, chat_id: Union[int, str]) -> 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` | :obj:`str`
+
+        :return: Returns True on success.
+        :rtype: :obj:`bool`
+        """
+        return await asyncio_helper.remove_chat_verification(self.token, chat_id)
     
     async def get_available_gifts(self) -> types.Gifts:
         """

telebot/asyncio_helper.py

@@ -1916,7 +1916,7 @@ async def delete_sticker_set(token, name):
     payload = {'name': name}
     return await _process_request(token, method_url, params=payload, method='post')
 
-async def send_gift(token, user_id, gift_id, text=None, text_parse_mode=None, text_entities=None):
+async def send_gift(token, user_id, gift_id, text=None, text_parse_mode=None, text_entities=None, pay_for_upgrade=None):
     method_url = 'sendGift'
     payload = {'user_id': user_id, 'gift_id': gift_id}
     if text:
@@ -1925,6 +1925,32 @@ async def send_gift(token, user_id, gift_id, text=None, text_parse_mode=None, te
         payload['text_parse_mode'] = text_parse_mode
     if text_entities:
         payload['text_entities'] = json.dumps(types.MessageEntity.to_list_of_dicts(text_entities))
+    if pay_for_upgrade is not None:
+        payload['pay_for_upgrade'] = pay_for_upgrade
+    return await _process_request(token, method_url, params=payload, method='post')
+    
+async def verify_user(token, user_id, custom_description=None):
+    method_url = 'verifyUser'
+    payload = {'user_id': user_id}
+    if custom_description:
+        payload['custom_description'] = custom_description
+    return await _process_request(token, method_url, params=payload, method='post')
+
+async def verify_chat(token, chat_id, custom_description=None):
+    method_url = 'verifyChat'
+    payload = {'chat_id': chat_id}
+    if custom_description:
+        payload['custom_description'] = custom_description
+    return await _process_request(token, method_url, params=payload, method='post')
+
+async def remove_user_verification(token, user_id):
+    method_url = 'removeUserVerification'
+    payload = {'user_id': user_id}
+    return await _process_request(token, method_url, params=payload, method='post')
+
+async def remove_chat_verification(token, chat_id):
+    method_url = 'removeChatVerification'
+    payload = {'chat_id': chat_id}
     return await _process_request(token, method_url, params=payload, method='post')
 
 async def get_available_gifts(token):
@@ -2243,6 +2269,12 @@ async def convert_input_media_array(array):
             if media_dict['media'].startswith('attach://'):
                 key = media_dict['media'].replace('attach://', '')
                 files[key] = input_media.media
+            if 'thumbnail' in media_dict:
+                thumbnail = media_dict['thumbnail']
+                if isinstance(thumbnail, types.InputFile):
+                    thumbnail_key = 'thumbnail_' + key  
+                    files[thumbnail_key] = thumbnail    
+                    media_dict['thumbnail'] = 'attach://' + thumbnail_key     
             media.append(media_dict)
     return json.dumps(media), files
 

telebot/types.py

@@ -4449,6 +4449,10 @@ class InlineQueryResultArticle(InlineQueryResultBase):
         self.thumbnail_width: Optional[int] = thumbnail_width
         self.thumbnail_height: Optional[int] = thumbnail_height
 
+        if hide_url:
+            log_deprecation_warning('The parameter "hide_url" is deprecated. Pass an empty string as url instead.')
+            self.url = ''
+
 
     @property
     def thumb_url(self) -> str:
@@ -11059,6 +11063,9 @@ class Gift(JsonDeserializable):
     :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`
 
@@ -11069,12 +11076,13 @@ class Gift(JsonDeserializable):
     :rtype: :class:`Gift`
     """
 
-    def __init__(self, id, sticker, star_count, total_count=None, remaining_count=None, **kwargs):
+    def __init__(self, id, sticker, star_count, total_count=None, remaining_count=None, upgrade_star_count=None, **kwargs):
         self.id: str = id
         self.sticker: Sticker = sticker
         self.star_count: int = star_count
         self.total_count: Optional[int] = total_count
         self.remaining_count: Optional[int] = remaining_count
+        self.upgrade_star_count: Optional[int] = upgrade_star_count
 
     @classmethod
     def de_json(cls, json_string):

telebot/version.py

@@ -1,3 +1,3 @@
 # Versions should comply with PEP440.
 # This line is parsed in setup.py:
-__version__ = '4.25.0'
+__version__ = '4.26.0'