Update names similar to Bot API 8.3 names

Author: SpEcHiDe

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

@@ -36,7 +36,7 @@ Changes in this Fork
 - Added ``message.content`` property.
 - Added the parameter ``pinned`` and made the parameter ``chat_id`` optional in :meth:`~pyrogram.Client.get_messages`. **NOTE**: Please be aware about using the correct :doc:`Message Identifiers <../../topics/message-identifiers>`, when using this method.
 - Added the ``cover`` and ``start_timestamp`` parameters in :meth:`~pyrogram.Client.send_video` and :obj:`~pyrogram.types.InputPaidMediaVideo`.
-- Added the ``new_video_start_timestamp`` and renamed the ``send_copy`` and ``remove_caption`` parameters in :meth:`~pyrogram.Client.forward_messages` and :meth:`~pyrogram.types.Message.forward`.
+- Added the ``video_start_timestamp`` and renamed the ``send_copy`` and ``remove_caption`` parameters in :meth:`~pyrogram.Client.forward_messages` and :meth:`~pyrogram.types.Message.forward`.
 - Added the ``gift_count`` to the :obj:`~pyrogram.types.Chat`.
 - Added the :meth:`~pyrogram.Client.get_similar_bots`.
 - Changed types in :obj:`~pyrogram.types.UpgradedGift`, :obj:`~pyrogram.types.UserGift`.

pyrogram/methods/business/get_available_gifts.py

@@ -31,7 +31,7 @@ async def get_available_gifts(
         .. include:: /_includes/usable-by/users-bots.rst
 
         Returns:
-            List of :obj:`~pyrogram.types.Gift` | :obj:`~pyrogram.types.UpgradedGift`: On success, a list of star gifts is returned.
+            List of :obj:`~pyrogram.types.Gift` | :obj:`~pyrogram.types.UpgradedGift`: On success, a list of star gifts that can be sent by the Client to users and channel chats is returned.
 
         Example:
             .. code-block:: python

pyrogram/methods/business/send_gift.py

@@ -26,21 +26,32 @@
 class SendGift:
     async def send_gift(
         self: "pyrogram.Client",
-        user_id: Union[int, str],
-        gift_id: int,
+        *,
+        user_id: Union[int, str] = None,
+        chat_id: Union[int, str] = None,
+        gift_id: int = None,
         pay_for_upgrade: Optional[bool] = None,
         text: Optional[str] = None,
-        parse_mode: Optional["enums.ParseMode"] = None,
-        entities: Optional[list["types.MessageEntity"]] = None,
+        text_parse_mode: Optional["enums.ParseMode"] = None,
+        text_entities: Optional[list["types.MessageEntity"]] = None,
         is_private: Optional[bool] = None,
     ) -> bool:
-        """Sends a gift to another user.
+        """Sends a gift to the given user or channel chat. The gift can't be converted to Telegram Stars by the receiver.
 
         .. include:: /_includes/usable-by/users-bots.rst
 
+        You must use exactly one of ``user_id`` OR ``chat_id``.
+
         Parameters:
             user_id (``int`` | ``str``):
-                Unique identifier (int) or username (str) of the user that will receive the gift.
+                Required if ``chat_id`` is not specified.
+                Unique identifier (int) or username (str) of the target user that will receive the gift.
+                For your personal cloud (Saved Messages) you can simply use "me" or "self".
+                For a contact that exists in your Telegram address book you can use his phone number (str).
+
+            chat_id (``int`` | ``str``):
+                Required if ``user_id`` is not specified.
+                Unique identifier (int) or username (str) for the chat or username of the channel that will receive the gift.
                 For your personal cloud (Saved Messages) you can simply use "me" or "self".
                 For a contact that exists in your Telegram address book you can use his phone number (str).
 
@@ -53,12 +64,12 @@ async def send_gift(
             text (``str``, *optional*):
                 Text that will be shown along with the gift. 0-``gift_text_length_max`` characters.
 
-            parse_mode (:obj:`~pyrogram.enums.ParseMode`, *optional*):
+            text_parse_mode (:obj:`~pyrogram.enums.ParseMode`, *optional*):
                 By default, texts are parsed using both Markdown and HTML styles.
                 You can combine both syntaxes together.
 
-            entities (List of :obj:`~pyrogram.types.MessageEntity`, *optional*):
-                List of special entities that appear in message text, which can be specified instead of *parse_mode*.
+            text_entities (List of :obj:`~pyrogram.types.MessageEntity`, *optional*):
+                List of special entities that appear in message text, which can be specified instead of *text_parse_mode*.
                 Only Bold, Italic, Underline, Strikethrough, Spoiler, and CustomEmoji entities are allowed.
 
             is_private (``bool``, *optional*):
@@ -77,12 +88,15 @@ async def send_gift(
                 app.send_gift(user_id=user_id, gift_id=123)
 
         """
-        peer = await self.resolve_peer(user_id)
-
-        if not isinstance(peer, (raw.types.InputPeerUser, raw.types.InputPeerSelf)):
-            raise ValueError("user_id must belong to a user.")
-
-        text, entities = (await utils.parse_text_entities(self, text, parse_mode, entities)).values()
+        peer = None
+        if user_id:
+            peer = await self.resolve_peer(user_id)
+        elif chat_id:
+            peer = await self.resolve_peer(chat_id)
+        # TODO
+        if not peer:
+            raise ValueError("You must use exactly one of user_id OR chat_id")
+        text, entities = (await utils.parse_text_entities(self, text, text_parse_mode, text_entities)).values()
 
         invoice = raw.types.InputInvoiceStarGift(
             user_id=peer,

pyrogram/methods/messages/forward_messages.py

@@ -36,7 +36,7 @@ async def forward_messages(
         allow_paid_broadcast: bool = None,
         send_copy: bool = None,
         remove_caption: bool = None,
-        new_video_start_timestamp: int = None,
+        video_start_timestamp: int = None,
         send_as: Union[int, str] = None,
         schedule_date: datetime = None
     ) -> Union["types.Message", list["types.Message"]]:
@@ -77,8 +77,8 @@ async def forward_messages(
             remove_caption (``bool``, *optional*):
                 Pass True to remove media captions of message copies.
 
-            new_video_start_timestamp (``int``, *optional*):
-                The new video start timestamp. Pass time to replace video start timestamp in the forwarded message.
+            video_start_timestamp (``int``, *optional*):
+                New start timestamp for the forwarded video in the message.
 
             send_as (``int`` | ``str``):
                 Unique identifier (int) or username (str) of the chat or channel to send the message as.
@@ -114,7 +114,7 @@ async def forward_messages(
                 id=message_ids,
                 silent=disable_notification or None,
                 # TODO
-                video_timestamp=new_video_start_timestamp,
+                video_timestamp=video_start_timestamp,
                 drop_author=send_copy,
                 drop_media_captions=remove_caption,
                 noforwards=protect_content,

pyrogram/methods/messages/send_video.py

@@ -45,6 +45,8 @@ async def send_video(
         width: int = 0,
         height: int = 0,
         thumb: Union[str, "io.BytesIO"] = None,
+        cover: Optional[Union[str, "io.BytesIO"]] = None,
+        start_timestamp: int = None,
         has_spoiler: bool = None,
         supports_streaming: bool = True,
         disable_notification: bool = None,
@@ -65,8 +67,6 @@ async def send_video(
         view_once: bool = None,
         file_name: str = None,
         mime_type: str = None,
-        cover: Optional[Union[str, "io.BytesIO"]] = None,
-        start_timestamp: int = None,
         schedule_date: datetime = None,
         reply_to_message_id: int = None,
         progress: Callable = None,
@@ -121,6 +121,12 @@ async def send_video(
                 A thumbnail's width and height should not exceed 320 pixels.
                 Thumbnails can't be reused and can be only uploaded as a new file.
 
+            cover (``str`` | :obj:`io.BytesIO`, *optional*):
+                Cover for the video in the message. Pass None to skip cover uploading.
+            
+            start_timestamp (``int``, *optional*):
+                Timestamp from which the video playing must start, in seconds.
+
             has_spoiler (``bool``, *optional*):
                 Pass True if the video needs to be covered with a spoiler animation.
 
@@ -175,12 +181,6 @@ async def send_video(
             mime_type (``str``, *optional*):
                 no docs!
 
-            cover (``str`` | :obj:`io.BytesIO`, *optional*):
-                Cover of the video; pass None to skip cover uploading.
-            
-            start_timestamp (``int``, *optional*):
-                Timestamp from which the video playing must start, in seconds.
-
             schedule_date (:py:obj:`~datetime.datetime`, *optional*):
                 Date when the message will be automatically sent.
 
@@ -248,6 +248,47 @@ async def progress(current, total):
         file = None
         ttl_seconds = 0x7FFFFFFF if view_once else ttl_seconds
 
+        coverfile = None
+        if cover:
+            is_bytes_io = isinstance(cover, io.BytesIO)
+            is_uploaded_file = is_bytes_io or os.path.isfile(cover)
+            is_external_url = not is_uploaded_file and re.match("^https?://", cover)
+
+            if is_bytes_io and not hasattr(cover, "name"):
+                cover.name = "cover.jpg"
+            if is_uploaded_file:
+                coverfile = await self.invoke(
+                    raw.functions.messages.UploadMedia(
+                        business_connection_id=business_connection_id,
+                        peer=await self.resolve_peer(chat_id),
+                        media=raw.types.InputMediaUploadedPhoto(
+                            file=await self.save_file(cover)
+                        )
+                    )
+                )
+                coverfile = raw.types.InputPhoto(
+                    id=coverfile.photo.id,
+                    access_hash=coverfile.photo.access_hash,
+                    file_reference=coverfile.photo.file_reference
+                )
+            elif is_external_url:
+                coverfile = await self.invoke(
+                    raw.functions.messages.UploadMedia(
+                        business_connection_id=business_connection_id,
+                        peer=await self.resolve_peer(chat_id),
+                        media=raw.types.InputMediaPhotoExternal(
+                            url=cover
+                        )
+                    )
+                )
+                coverfile = raw.types.InputPhoto(
+                    id=coverfile.photo.id,
+                    access_hash=coverfile.photo.access_hash,
+                    file_reference=coverfile.photo.file_reference
+                )
+            else:
+                coverfile = (utils.get_input_media_from_file_id(cover, FileType.PHOTO)).id
+
         try:
             if isinstance(video, str):
                 if os.path.isfile(video):
@@ -269,15 +310,15 @@ async def progress(current, total):
                             ),
                             raw.types.DocumentAttributeFilename(file_name=file_name or os.path.basename(video))
                         ],
-                        video_cover=await self.save_file(cover) if cover else None,
+                        video_cover=coverfile,
                         video_timestamp=start_timestamp
                     )
                 elif re.match("^https?://", video):
                     media = raw.types.InputMediaDocumentExternal(
                         url=video,
                         ttl_seconds=ttl_seconds,
                         spoiler=has_spoiler,
-                        video_cover=await self.save_file(cover) if cover else None,
+                        video_cover=coverfile,
                         video_timestamp=start_timestamp
                     )
                 else:
@@ -287,6 +328,9 @@ async def progress(current, total):
                         ttl_seconds=ttl_seconds,
                         has_spoiler=has_spoiler
                     )
+                    media.video_cover = coverfile
+                    media.video_timestamp = start_timestamp
+                    
             else:
                 file = await self.save_file(video, progress=progress, progress_args=progress_args)
                 thumb = await self.save_file(thumb)
@@ -305,7 +349,7 @@ async def progress(current, total):
                         ),
                         raw.types.DocumentAttributeFilename(file_name=file_name or video.name)
                     ],
-                    video_cover=await self.save_file(cover) if cover else None,
+                    video_cover=coverfile,
                     video_timestamp=start_timestamp
                 )
 

pyrogram/methods/messages/set_reaction.py

@@ -36,7 +36,7 @@ async def set_reaction(
         add_to_recent: bool = True
     ) -> "types.MessageReactions":
         """Use this method to change the chosen reactions on a message.
-        Bots can't react to service messages.
+        Service messages of some types can't be reacted to. Use :obj:`~pyrogram.types.Message._raw.reactions_are_possible` to check if it is possible to react to the message.
         Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel.
         Bots can't use paid reactions.
 

pyrogram/types/input_media/input_media_video.py

@@ -78,6 +78,13 @@ class InputMediaVideo(InputMedia):
         disable_content_type_detection (``bool``, *optional*):
             Pass True, if the uploaded video is a video message with no sound.
             Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always True, if the document is sent as part of an album.
+        
+        cover (``str`` | :obj:`io.BytesIO`, *optional*):
+            Cover for the video in the message. pass None to skip cover uploading.
+        
+        start_timestamp (``int``, *optional*):
+            Timestamp from which the video playing must start, in seconds.
+
     """
 
     def __init__(
@@ -95,6 +102,8 @@ def __init__(
         supports_streaming: bool = True,
         has_spoiler: bool = None,
         disable_content_type_detection: bool = None,
+        cover: Optional[Union[str, "io.BytesIO"]] = None,
+        start_timestamp: int = None
     ):
         super().__init__(media, caption, parse_mode, caption_entities)
 
@@ -107,3 +116,5 @@ def __init__(
         self.supports_streaming = supports_streaming
         self.has_spoiler = has_spoiler
         self.disable_content_type_detection = disable_content_type_detection
+        self.cover = cover
+        self.start_timestamp = start_timestamp

pyrogram/types/input_paid_media/input_paid_media_video.py

@@ -55,7 +55,7 @@ class InputPaidMediaVideo(InputPaidMedia):
             Pass True, if the uploaded video is suitable for streaming.
 
         cover (``str`` | :obj:`io.BytesIO`, *optional*):
-            Cover of the video; pass None to skip cover uploading.
+            Cover for the video in the message. pass None to skip cover uploading.
         
         start_timestamp (``int``, *optional*):
             Timestamp from which the video playing must start, in seconds.

pyrogram/types/messages_and_media/message.py

@@ -3551,6 +3551,8 @@ async def reply_video(
         width: int = 0,
         height: int = 0,
         thumb: Union[str, "io.BytesIO"] = None,
+        cover: Optional[Union[str, "io.BytesIO"]] = None,
+        start_timestamp: int = None,
         has_spoiler: bool = None,
         supports_streaming: bool = True,
         disable_notification: bool = None,
@@ -3630,6 +3632,12 @@ async def reply_video(
                 A thumbnail's width and height should not exceed 320 pixels.
                 Thumbnails can't be reused and can be only uploaded as a new file.
 
+            cover (``str`` | :obj:`io.BytesIO`, *optional*):
+                Cover for the video in the message. Pass None to skip cover uploading.
+            
+            start_timestamp (``int``, *optional*):
+                Timestamp from which the video playing must start, in seconds.
+
             has_spoiler (``bool``, *optional*):
                 Pass True if the video needs to be covered with a spoiler animation.
 
@@ -3730,6 +3738,8 @@ async def reply_video(
             width=width,
             height=height,
             thumb=thumb,
+            cover=cover,
+            start_timestamp=start_timestamp,
             has_spoiler=has_spoiler,
             supports_streaming=supports_streaming,
             disable_notification=disable_notification,
@@ -4582,7 +4592,7 @@ async def forward(
         allow_paid_broadcast: bool = None,
         send_copy: bool = None,
         remove_caption: bool = None,
-        new_video_start_timestamp: int = None,
+        video_start_timestamp: int = None,
         send_as: Union[int, str] = None,
         schedule_date: datetime = None
     ) -> Union["types.Message", list["types.Message"]]:
@@ -4628,8 +4638,8 @@ async def forward(
             remove_caption (``bool``, *optional*):
                 Pass True to remove media captions of message copies.
 
-            new_video_start_timestamp (``int``, *optional*):
-                The new video start timestamp. Pass time to replace video start timestamp in the forwarded message.
+            video_start_timestamp (``int``, *optional*):
+                New start timestamp for the copied video in the message.
 
             send_as (``int`` | ``str``):
                 Unique identifier (int) or username (str) of the chat or channel to send the message as.
@@ -4657,7 +4667,7 @@ async def forward(
             allow_paid_broadcast=allow_paid_broadcast,
             send_copy=send_copy,
             remove_caption=remove_caption,
-            new_video_start_timestamp=new_video_start_timestamp,
+            video_start_timestamp=video_start_timestamp,
             send_as=send_as,
             schedule_date=schedule_date
         )