Update API Scheme to Layer 200

* document about breaking change
* Update API Scheme to Layer 200, from TDLib (tdlib/td@f5462e3)
* Fix field documentation (tdlib/td@e4608b7)
* Add the paid_message_star_count to Chat and User
* bug fixes
* Add paid_message_star_count to Message
* Add is_pinned to UserGift

Author: SpEcHiDe

compiler/api/source/main_api.tl

@@ -23,11 +23,20 @@ Breaking Changes in this Fork
 - In :meth:`~pyrogram.Client.download_media`, if the message is a :obj:`~pyrogram.types.PaidMediaInfo` with more than one ``paid_media`` **and** ``idx`` was not specified, then a list of paths or binary file-like objects is returned.
 - PR `#115 <https://github.com/TelegramPlayGround/pyrogram/pull/115>`_ This `change <https://github.com/pyrogram/pyrogram/pull/966#issuecomment-1108858881>`_ breaks some usages with offset-naive and offset-aware datetimes.
 - PR from upstream: `#1411 <https://github.com/pyrogram/pyrogram/pull/1411>`_ without attribution.
+- If you relied on internal types like ``import pyrogram.file_id`` OR ``import pyrogram.utils``, Then read this full document to know where `else <https://t.me/PyrogramChat/42497>`_ your code will break.
 
 
 Changes in this Fork
 =====================
 
++------------------------+
+| Scheme layer used: 200 |
++------------------------+
+
+- Added the field ``paid_message_star_count`` to the classes :obj:`~pyrogram.types.Chat`, :obj:`~pyrogram.types.Message` and :obj:`~pyrogram.types.User`.
+- Added the parameter ``paid_message_star_count`` to the methods :meth:`~pyrogram.Client.copy_media_group`, :meth:`~pyrogram.Client.send_game`, :meth:`~pyrogram.Client.send_invoice`, :meth:`~pyrogram.Client.forward_messages`, :meth:`~pyrogram.Client.send_animation`, :meth:`~pyrogram.Client.send_audio`, :meth:`~pyrogram.Client.send_cached_media`, :meth:`~pyrogram.Client.send_contact`, :meth:`~pyrogram.Client.send_dice`, :meth:`~pyrogram.Client.send_document`, :meth:`~pyrogram.Client.send_location`, :meth:`~pyrogram.Client.send_media_group`, :meth:`~pyrogram.Client.send_message`, :meth:`~pyrogram.Client.send_paid_media`, :meth:`~pyrogram.Client.send_photo`, :meth:`~pyrogram.Client.send_poll`, :meth:`~pyrogram.Client.send_sticker`, :meth:`~pyrogram.Client.send_venue`, :meth:`~pyrogram.Client.send_video_note`, :meth:`~pyrogram.Client.send_video`, :meth:`~pyrogram.Client.send_voice` and the bound methods :meth:`~pyrogram.types.Message.forward` and :meth:`~pyrogram.types.Message.copy`.
+- View `new and changed <https://telegramplayground.github.io/TG-APIs/TL/diff/tdlib.html?from=199&to=200>`__ `raw API methods <https://telegramplayground.github.io/TG-APIs/TL/diff/tdesktop.html?from=199&to=200>`__.
+
 +------------------------+
 | Scheme layer used: 199 |
 +------------------------+

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

@@ -33,6 +33,7 @@ async def send_game(
         disable_notification: bool = None,
         protect_content: bool = None,
         allow_paid_broadcast: bool = None,
+        paid_message_star_count: int = None,
         message_thread_id: int = None,
         business_connection_id: str = None,
         send_as: Union[int, str] = None,
@@ -68,6 +69,9 @@ async def send_game(
 
             allow_paid_broadcast (``bool``, *optional*):
                 Pass True to allow the message to ignore regular broadcast limits for a small fee; for bots only
+            
+            paid_message_star_count (``int``, *optional*):
+                The number of Telegram Stars the user agreed to pay to send the messages.
 
             message_thread_id (``int``, *optional*):
                 If the message is in a thread, ID of the original message.
@@ -134,6 +138,7 @@ async def send_game(
             send_as=await self.resolve_peer(send_as) if send_as else None,
             noforwards=protect_content,
             allow_paid_floodskip=allow_paid_broadcast,
+            allow_paid_stars=paid_message_star_count,
             effect=message_effect_id,
             reply_markup=await reply_markup.write(self) if reply_markup else None
         )

pyrogram/methods/bots/send_game.py

@@ -35,6 +35,7 @@ async def send_inline_bot_result(
         disable_notification: bool = None,
         reply_parameters: "types.ReplyParameters" = None,
         send_as: Union[int, str] = None,
+        paid_message_star_count: int = None,
         message_thread_id: int = None,
         schedule_date: datetime = None,
         reply_to_message_id: int = None
@@ -70,6 +71,9 @@ async def send_inline_bot_result(
                 This setting applies to the current message and will remain effective for future messages unless explicitly changed.
                 To set this behavior permanently for all messages, use :meth:`~pyrogram.Client.set_send_as_chat`.
 
+            paid_message_star_count (``int``, *optional*):
+                The number of Telegram Stars the user agreed to pay to send the messages.
+
             message_thread_id (``int``, *optional*):
                 If the message is in a thread, ID of the original message.
 
@@ -116,6 +120,7 @@ async def send_inline_bot_result(
                 send_as=await self.resolve_peer(send_as) if send_as else None,
                 silent=disable_notification or None,
                 reply_to=reply_to,
+                allow_paid_stars=paid_message_star_count,
                 schedule_date=utils.datetime_to_timestamp(schedule_date),
             )
         )

pyrogram/methods/bots/send_inline_bot_result.py

@@ -54,6 +54,7 @@ async def send_invoice(
         disable_notification: bool = None,
         protect_content: bool = None,
         allow_paid_broadcast: bool = None,
+        paid_message_star_count: int = None,
         message_effect_id: int = None,
         reply_parameters: "types.ReplyParameters" = None,
         send_as: Union[int, str] = None,
@@ -151,6 +152,9 @@ async def send_invoice(
             allow_paid_broadcast (``bool``, *optional*):
                 Pass True to allow the message to ignore regular broadcast limits for a small fee; for bots only
 
+            paid_message_star_count (``int``, *optional*):
+                The number of Telegram Stars the user agreed to pay to send the messages.
+
             message_effect_id (``int`` ``64-bit``, *optional*):
                 Unique identifier of the message effect to be added to the message; for private chats only.
 
@@ -229,6 +233,7 @@ async def send_invoice(
             send_as=await self.resolve_peer(send_as) if send_as else None,
             noforwards=protect_content,
             allow_paid_floodskip=allow_paid_broadcast,
+            allow_paid_stars=paid_message_star_count,
             reply_markup=await reply_markup.write(self) if reply_markup else None,
             effect=message_effect_id,
             **await utils.parse_text_entities(self, caption, parse_mode, caption_entities)

pyrogram/methods/business/send_invoice.py

@@ -40,6 +40,7 @@ async def copy_media_group(
         schedule_date: datetime = None,
         protect_content: bool = None,
         allow_paid_broadcast: bool = None,
+        paid_message_star_count: int = None,
         message_effect_id: int = None,
         reply_to_message_id: int = None
     ) -> list["types.Message"]:
@@ -96,6 +97,9 @@ async def copy_media_group(
             allow_paid_broadcast (``bool``, *optional*):
                 Pass True to allow the message to ignore regular broadcast limits for a small fee; for bots only
 
+            paid_message_star_count (``int``, *optional*):
+                The number of Telegram Stars the user agreed to pay to send the messages.
+
             message_effect_id (``int`` ``64-bit``, *optional*):
                 Unique identifier of the message effect to be added to the message; for private chats only.
 
@@ -181,6 +185,7 @@ async def copy_media_group(
                 schedule_date=utils.datetime_to_timestamp(schedule_date),
                 noforwards=protect_content,
                 allow_paid_floodskip=allow_paid_broadcast,
+                allow_paid_stars=paid_message_star_count,
                 effect=message_effect_id,
                 invert_media=any(show_caption_above_media)
             ),

pyrogram/methods/messages/copy_media_group.py

@@ -33,6 +33,7 @@ async def forward_messages(
         disable_notification: bool = None,
         protect_content: bool = None,
         allow_paid_broadcast: bool = None,
+        paid_message_star_count: int = None,
         send_copy: bool = None,
         remove_caption: bool = None,
         video_start_timestamp: int = None,
@@ -70,6 +71,9 @@ async def forward_messages(
             allow_paid_broadcast (``bool``, *optional*):
                 Pass True to allow the message to ignore regular broadcast limits for a fee; for bots only
 
+            paid_message_star_count (``int``, *optional*):
+                The number of Telegram Stars the user agreed to pay to send the messages.
+
             send_copy (``bool``, *optional*):
                 Pass True to copy content of the messages without reference to the original sender.
 
@@ -118,6 +122,7 @@ async def forward_messages(
                 drop_media_captions=remove_caption,
                 noforwards=protect_content,
                 allow_paid_floodskip=allow_paid_broadcast,
+                allow_paid_stars=paid_message_star_count,
                 random_id=[self.rnd_id() for _ in message_ids],
                 send_as=await self.resolve_peer(send_as) if send_as else None,
                 schedule_date=utils.datetime_to_timestamp(schedule_date),

pyrogram/methods/messages/forward_messages.py

@@ -57,6 +57,7 @@ async def send_animation(
         schedule_date: datetime = None,
         protect_content: bool = None,
         allow_paid_broadcast: bool = None,
+        paid_message_star_count: int = None,
         ttl_seconds: int = None,
         reply_markup: Union[
             "types.InlineKeyboardMarkup",
@@ -156,6 +157,9 @@ async def send_animation(
             allow_paid_broadcast (``bool``, *optional*):
                 Pass True to allow the message to ignore regular broadcast limits for a small fee; for bots only
 
+            paid_message_star_count (``int``, *optional*):
+                The number of Telegram Stars the user agreed to pay to send the messages.
+
             ttl_seconds (``int``, *optional*):
                 The message will be self-destructed in the specified time after its content was opened.
                 The message's self-destruct time, in seconds; must be between 0 and 60 in private chats.
@@ -299,6 +303,7 @@ async def progress(current, total):
                 schedule_date=utils.datetime_to_timestamp(schedule_date),
                 noforwards=protect_content,
                 allow_paid_floodskip=allow_paid_broadcast,
+                allow_paid_stars=paid_message_star_count,
                 reply_markup=await reply_markup.write(self) if reply_markup else None,
                 effect=message_effect_id,
                 invert_media=show_caption_above_media,

pyrogram/methods/messages/send_animation.py

@@ -54,6 +54,7 @@ async def send_audio(
         schedule_date: datetime = None,
         protect_content: bool = None,
         allow_paid_broadcast: bool = None,
+        paid_message_star_count: int = None,
         reply_markup: Union[
             "types.InlineKeyboardMarkup",
             "types.ReplyKeyboardMarkup",
@@ -144,6 +145,9 @@ async def send_audio(
             allow_paid_broadcast (``bool``, *optional*):
                 Pass True to allow the message to ignore regular broadcast limits for a small fee; for bots only
 
+            paid_message_star_count (``int``, *optional*):
+                The number of Telegram Stars the user agreed to pay to send the messages.
+
             reply_markup (:obj:`~pyrogram.types.InlineKeyboardMarkup` | :obj:`~pyrogram.types.ReplyKeyboardMarkup` | :obj:`~pyrogram.types.ReplyKeyboardRemove` | :obj:`~pyrogram.types.ForceReply`, *optional*):
                 Additional interface options. An object for an inline keyboard, custom reply keyboard,
                 instructions to remove reply keyboard or to force a reply from the user.
@@ -268,6 +272,7 @@ async def progress(current, total):
                 schedule_date=utils.datetime_to_timestamp(schedule_date),
                 noforwards=protect_content,
                 allow_paid_floodskip=allow_paid_broadcast,
+                allow_paid_stars=paid_message_star_count,
                 reply_markup=await reply_markup.write(self) if reply_markup else None,
                 effect=message_effect_id,
                 **await utils.parse_text_entities(self, caption, parse_mode, caption_entities)

pyrogram/methods/messages/send_audio.py

@@ -44,6 +44,7 @@ async def send_cached_media(
         schedule_date: datetime = None,
         protect_content: bool = None,
         allow_paid_broadcast: bool = None,
+        paid_message_star_count: int = None,
         has_spoiler: bool = None,
         reply_markup: Union[
             "types.InlineKeyboardMarkup",
@@ -116,6 +117,9 @@ async def send_cached_media(
             allow_paid_broadcast (``bool``, *optional*):
                 Pass True to allow the message to ignore regular broadcast limits for a small fee; for bots only
 
+            paid_message_star_count (``int``, *optional*):
+                The number of Telegram Stars the user agreed to pay to send the messages.
+
             has_spoiler (``bool``, *optional*):
                 True, if the message media is covered by a spoiler animation.
 
@@ -160,6 +164,7 @@ async def send_cached_media(
             schedule_date=utils.datetime_to_timestamp(schedule_date),
             noforwards=protect_content,
             allow_paid_floodskip=allow_paid_broadcast,
+            allow_paid_stars=paid_message_star_count,
             reply_markup=await reply_markup.write(self) if reply_markup else None,
             effect=message_effect_id,
             invert_media=show_caption_above_media,