Update API Scheme to Layer 205 (#187)

Co-authored-by: KurimuzonAkuma <[email protected]>

Author: SpEcHiDe

compiler/api/source/main_api.tl

@@ -229,6 +229,9 @@ def get_title_list(s: str) -> list:
             translate_message_text
             delete_chat_history
             send_screenshot_notification
+            send_checklist
+            edit_message_checklist
+            mark_checklist_tasks_as_done
         """,
         chats="""
         Chats
@@ -494,6 +497,7 @@ def get_title_list(s: str) -> list:
             VideoChatEnded
             VideoChatParticipantsInvited
             PaidMessagePriceChanged
+            DirectMessagePriceChanged
             PaidMessagesRefunded
             Dialog
             EmojiStatus
@@ -535,6 +539,12 @@ def get_title_list(s: str) -> list:
             InputPollOption
             Poll
             PollAnswer
+            ChecklistTask
+            Checklist
+            InputChecklistTask
+            InputChecklist
+            ChecklistTasksDone
+            ChecklistTasksAdded
             Location
             Venue
             Gift

compiler/docs/compiler.py

@@ -58,6 +58,7 @@ BOT_WEBVIEW_DISABLED	A webview cannot be opened in the specified conditions: emi
 BROADCAST_ID_INVALID	Broadcast ID invalid.
 BROADCAST_PUBLIC_VOTERS_FORBIDDEN	You can't forward polls with public voters.
 BROADCAST_REQUIRED	This method can only be called on a channel, please use stats.getMegagroupStats for supergroups.
+BUSINESS_BOT_MISSING	The business bot is missing.
 BUSINESS_CONNECTION_INVALID	The business connection is invalid.
 BUSINESS_CONNECTION_NOT_ALLOWED	This business connection is not allowed.
 BUSINESS_PEER_INVALID	Messages can't be set to the specified peer through the current [business connection](https://core.telegram.org/api/business#connected-bots).
@@ -89,6 +90,7 @@ CHANNEL_BANNED	The channel is banned
 CHANNEL_FORUM_MISSING	This supergroup is not a forum.
 CHANNEL_ID_INVALID	The specified supergroup ID is invalid.
 CHANNEL_INVALID	The provided channel is invalid.
+CHANNEL_MONOFORUM_UNSUPPORTED	The provided channel is not supported.
 CHANNEL_PARICIPANT_MISSING	The current user is not in the channel.
 CHANNEL_PRIVATE	You haven't joined this channel/supergroup.
 CHANNEL_TOO_BIG	This channel has too many participants (>1000) to be deleted.
@@ -210,6 +212,7 @@ FORUM_ENABLED	You can't execute the specified action because the group is a [for
 FRESH_CHANGE_ADMINS_FORBIDDEN	You were just elected admin, you can't add or modify other admins yet.
 FROM_MESSAGE_BOT_DISABLED	Bots can't use fromMessage min constructors.
 FROM_PEER_INVALID	The specified from_id is invalid.
+FROZEN_PARTICIPANT_MISSING	The account is frozen and cannot access the chat participant.
 GAME_BOT_INVALID	Bots can't send another bot's game.
 GENERAL_MODIFY_ICON_FORBIDDEN	You can't modify the icon of the 'General' topic.
 GEO_POINT_INVALID	Invalid geoposition provided.
@@ -302,6 +305,7 @@ MESSAGE_TOO_LONG	The provided message is too long.
 MESSAGE_TOO_OLD	The message is too old, the requested information is not available.
 METHOD_INVALID	The specified method is invalid.
 MIN_DATE_INVALID	The specified minimum date is invalid.
+MONOFORUM_FILTER_INVALID	The specified filter is invalid.
 MSG_ID_INVALID	Invalid message ID provided.
 MSG_TOO_OLD	[`chat_read_mark_expire_period` seconds](https://core.telegram.org/api/config#chat-read-mark-expire-period) have passed since the message was sent, read receipts were deleted.
 MSG_WAIT_FAILED	A waiting call returned an error.
@@ -374,6 +378,7 @@ POLL_OPTION_INVALID	Invalid poll option provided.
 POLL_QUESTION_INVALID	One of the poll questions is not acceptable.
 POLL_UNSUPPORTED	This layer does not support polls in the invoked method
 POLL_VOTE_REQUIRED	Cast a vote in the poll before calling this method
+PRECHECKOUT_FAILED	precheckout failed
 PREMIUM_ACCOUNT_REQUIRED	A premium account is required to execute this action.
 PRICING_CHAT_INVALID	The pricing for the [subscription](https://core.telegram.org/api/subscriptions) is invalid, the maximum price is specified in the [`stars_subscription_amount_max` config key](https://core.telegram.org/api/config#stars-subscription-amount-max).
 PRIVACY_KEY_INVALID	The privacy key is invalid.
@@ -407,6 +412,7 @@ REPLY_MARKUP_TOO_LONG	The specified reply_markup is too long.
 REPLY_MESSAGES_TOO_MUCH	Each shortcut can contain a maximum of [appConfig.`quick_reply_messages_limit`](https://core.telegram.org/api/config#quick-reply-messages-limit) messages, the limit was reached.
 REPLY_MESSAGE_ID_INVALID	The specified reply-to message ID is invalid.
 REPLY_TO_INVALID	The specified `reply_to` field is invalid.
+REPLY_TO_MONOFORUM_PEER_INVALID	The specified `reply_to` field is invalid.
 REPLY_TO_USER_INVALID	The replied-to user is invalid.
 REQUEST_TOKEN_INVALID	The master DC did not accept the `request_token` from the CDN DC. Continue downloading the file from the master DC using upload.getFile.
 RESET_REQUEST_MISSING	No password reset is in progress.
@@ -448,8 +454,13 @@ SMS_CODE_CREATE_FAILED	An error occurred while creating the SMS code.
 SRP_A_INVALID	The specified inputCheckPasswordSRP.A value is invalid.
 SRP_ID_INVALID	Invalid SRP ID provided.
 SRP_PASSWORD_CHANGED	Password has changed.
+STARGIFT_CONVERT_TOO_OLD	This gift can no longer be converted into stars.
 STARGIFT_INVALID	The passed [inputInvoiceStarGift](https://core.telegram.org/constructor/inputInvoiceStarGift) is invalid.
+STARGIFT_MESSAGE_INVALID	The provided message for this gift is invalid.
 STARGIFT_NOT_FOUND	The specified star gift was not found.
+STARGIFT_NOT_OWNER	You cannot control this gift because it does not belong to you.
+STARGIFT_RESELL_NOT_ALLOWED	You cannot buy this gift. Someone else may have already bought it.
+STARGIFT_RESELL_TOO_EARLY_X	A wait of {value} seconds is required to resell this gift.
 STARGIFT_SLUG_INVALID	The provided star gift slug is invalid.
 STARGIFT_USAGE_LIMITED	The gift is sold out.
 STARREF_AWAITING_END	The previous referral program was terminated less than 24 hours ago: further changes can be made after the date specified in userFull.starref_program.end_date.
@@ -458,6 +469,7 @@ STARREF_MONTHS_TOO_LOW	The ``duration_months`` parameter must be between 0 and 3
 STARREF_PERMILLE_INVALID	The specified commission_permille is invalid: the minimum and maximum values for this parameter are contained in the [starref_min_commission_permille](https://core.telegram.org/api/config#starref-min-commission-permille) and [starref_max_commission_permille](https://core.telegram.org/api/config#starref-max-commission-permille) client configuration parameters.
 STARREF_PERMILLE_TOO_LOW	The specified commission_permille is too low: the minimum and maximum values for this parameter are contained in the [starref_min_commission_permille](https://core.telegram.org/api/config#starref-min-commission-permille) and [starref_max_commission_permille](https://core.telegram.org/api/config#starref-max-commission-permille) client configuration parameters.
 STARS_AMOUNT_INVALID	The specified ``paid_stars`` amount is invalid.
+STARS_FORM_AMOUNT_MISMATCH	stars form amount mismatch
 STARS_INVOICE_INVALID	The specified Telegram Star invoice is invalid.
 STARS_PAYMENT_REQUIRED	To import this chat invite link, you must first [pay for the associated Telegram Star subscription](https://core.telegram.org/api/subscriptions#channel-subscriptions).
 START_PARAM_EMPTY	The start parameter is empty.
@@ -532,6 +544,8 @@ TTL_MEDIA_INVALID	Invalid media Time To Live was provided.
 TTL_PERIOD_INVALID	The specified TTL period is invalid.
 TYPES_EMPTY	No top peer type was provided.
 TYPE_CONSTRUCTOR_INVALID	The type constructor is invalid
+UNKNOWN_ERROR	Unknown error.
+UNSUPPORTED	This method is not supported.
 UNTIL_DATE_INVALID	Invalid until date provided.
 URL_INVALID	Invalid URL provided.
 USAGE_LIMIT_INVALID	The specified usage limit is invalid.

compiler/errors/source/400_BAD_REQUEST.tsv

@@ -1,4 +1,5 @@
 id	message
+ACCESS_DENIED	You cannot perform this request.
 ALLOW_PAYMENT_REQUIRED_X	The user has enabled paid messages with {value} stars.
 ANONYMOUS_REACTIONS_DISABLED	Sorry, anonymous administrators cannot leave reactions or participate in polls.
 BOT_ACCESS_FORBIDDEN	You cannot access this bot.

compiler/errors/source/403_FORBIDDEN.tsv

@@ -4,6 +4,7 @@ ADDRESS_INVALID	The specified geopoint address is invalid.
 FLOOD_PREMIUM_WAIT_X	Please wait {value} seconds before repeating the action, or purchase a [Telegram Premium subscription](https://core.telegram.org/api/premium) to remove this rate limit.
 FLOOD_TEST_PHONE_WAIT_X	A wait of {value} seconds is required in the test servers
 FLOOD_WAIT_X	Please wait {value} seconds before repeating the action.
+FROZEN_METHOD_INVALID	The method cannot be used by frozen account. You can appeal via @SpamBot if you believe this was a mistake.
 PREMIUM_SUB_ACTIVE_UNTIL_X	You already have a premium subscription active until unixtime {value} .
 SLOWMODE_WAIT_X	Slowmode is enabled in this chat: wait {value} seconds before sending another message to this chat.
 STORY_SEND_FLOOD_X	A wait of {value} seconds is required to continue posting stories

compiler/errors/source/420_FLOOD.tsv

@@ -9,6 +9,7 @@ CHAT_ID_GENERATE_FAILED	Failure while generating the chat ID.
 CHAT_INVALID	Invalid chat.
 CHAT_OCCUPY_LOC_FAILED	An internal error occurred while creating the chat
 CHAT_OCCUPY_USERNAME_FAILED	Failure to occupy chat username due to Telegram having internal problems. Please try again later
+CHP_BAD_EVENT	Telegram is having internal problems. Please try again later.
 CHP_CALL_FAIL	Telegram is having internal problems. Please try again later
 ENCRYPTION_OCCUPY_ADMIN_FAILED	Failed occupying memory for admin info due to Telegram having internal problems. Please try again later
 ENCRYPTION_OCCUPY_FAILED	Internal server error while accepting secret chat

compiler/errors/source/500_INTERNAL_SERVER_ERROR.tsv

@@ -32,10 +32,23 @@ Changes in this Fork
 =====================
 
 +------------------------+
-| Scheme layer used: 203 |
-+------------------------+
-
-- View `new and changed <https://telegramplayground.github.io/TG-APIs/TL/diff/tdlib.html?from=202&to=203>`__ `raw API methods <https://telegramplayground.github.io/TG-APIs/TL/diff/tdesktop.html?from=202&to=203>`__.
+| Scheme layer used: 205 |
++------------------------+
+
+- Added the :obj:`~pyrogram.types.ChecklistTask` representing a task in a checklist.
+- Added the :obj:`~pyrogram.types.Checklist` representing a checklist.
+- Added the :obj:`~pyrogram.types.InputChecklistTask` representing a task to add to a checklist.
+- Added the :obj:`~pyrogram.types.InputChecklist` representing a checklist to create.
+- Added the field ``checklist`` to the :obj:`~pyrogram.types.Message` and :obj:`~pyrogram.types.ExternalReplyInfo`, describing a checklist in a message.
+- Added the :obj:`~pyrogram.types.ChecklistTasksDone` and the field ``checklist_tasks_done`` to the :obj:`~pyrogram.types.Message`, describing a service message about status changes for tasks in a checklist (i.e., marked as done/not done).
+- Added the :obj:`~pyrogram.types.ChecklistTasksAdded` and the field ``checklist_tasks_added`` to the :obj:`~pyrogram.types.Message`, describing a service message about the addition of new tasks to a checklist.
+- Added the :meth:`~pyrogram.Client.send_checklist`, allowing bots to send a checklist on behalf of a business account.
+- Added the :meth:`~pyrogram.Client.edit_message_checklist`, allowing bots to edit a checklist on behalf of a business account.
+- Added the :obj:`~pyrogram.types.DirectMessagePriceChanged` and the field ``direct_message_price_changed`` to the :obj:`~pyrogram.types.Message`, describing a service message about a price change for direct messages sent to the channel chat.
+- `Fix conditions for recover_gaps <https://github.com/KurimuzonAkuma/pyrogram/commit/b59ae77>`__.
+- Added ``reply_parameters`` in :meth:`~pyrogram.Client.forward_messages`.
+- Increased the maximum number of options in a poll to 12.
+- View `new and changed <https://telegramplayground.github.io/TG-APIs/TL/diff/tdlib.html?from=202&to=205>`__ `raw API methods <https://telegramplayground.github.io/TG-APIs/TL/diff/tdesktop.html?from=202&to=205>`__.
 
 +------------------------+
 | Scheme layer used: 202 |

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

@@ -32,7 +32,7 @@
 from io import StringIO, BytesIO
 from mimetypes import MimeTypes
 from pathlib import Path
-from typing import Union, Optional, Callable, AsyncGenerator
+from typing import AsyncGenerator, Callable, Optional, Tuple, Union
 
 import pyrogram
 from pyrogram import __version__, __license__
@@ -53,7 +53,7 @@
 from pyrogram.session import Auth, Session
 from pyrogram.storage import Storage, FileStorage, MemoryStorage
 from pyrogram.types import User, TermsOfService
-from pyrogram.utils import ainput
+from pyrogram.utils import MIN_MONOFORUM_CHANNEL_ID, ainput
 from .connection import Connection
 from .connection.transport import TCP, TCPAbridged, TCPFull
 from .dispatcher import Dispatcher
@@ -711,18 +711,24 @@ async def handle_updates(self, updates):
         elif isinstance(updates, raw.types.UpdatesTooLong):
             log.info(updates)
 
-    async def recover_gaps(self) -> tuple[int, int]:
+    async def recover_gaps(self) -> Tuple[int, int]:
+        if self.skip_updates:
+            log.info("Recover gaps disabled in client params. Skipping recovery")
+            return (0, 0)
+
         states = await self.storage.update_state()
 
+        if not states:
+            log.info("No states found, skipping recovery")
+            return (0, 0)
+
         message_updates_counter = 0
         other_updates_counter = 0
 
-        if not states:
-            log.info("No states found, skipping recovery.")
-            return (message_updates_counter, other_updates_counter)
+        log.info("Started gaps recovering...")
 
-        for state in states:
-            id, local_pts, _, local_date, _ = state
+        for local_state in states:
+            id, local_pts, local_qts, local_date, local_seq = local_state
 
             prev_pts = 0
 
@@ -735,7 +741,7 @@ async def recover_gaps(self) -> tuple[int, int]:
                             pts=local_pts,
                             limit=10000,
                             force=False
-                        ) if id < 0 else
+                        ) if id < 0 or id > MIN_MONOFORUM_CHANNEL_ID else
                         raw.functions.updates.GetDifference(
                             pts=local_pts,
                             date=local_date,
@@ -746,29 +752,65 @@ async def recover_gaps(self) -> tuple[int, int]:
                     break
 
                 if isinstance(diff, raw.types.updates.DifferenceEmpty):
+                    await self.storage.update_state(
+                        (
+                            id,
+                            local_pts,
+                            None,
+                            diff.date,
+                            diff.seq
+                        )
+                    )
                     break
                 elif isinstance(diff, raw.types.updates.DifferenceTooLong):
-                    break
+                    await self.storage.update_state(
+                        (
+                            id,
+                            diff.pts,
+                            None,
+                            local_date,
+                            local_seq
+                        )
+                    )
+                    continue
                 elif isinstance(diff, raw.types.updates.Difference):
                     local_pts = diff.state.pts
+                    local_date = diff.state.date
+                    local_seq = diff.state.seq
                 elif isinstance(diff, raw.types.updates.DifferenceSlice):
                     local_pts = diff.intermediate_state.pts
                     local_date = diff.intermediate_state.date
+                    local_seq = diff.intermediate_state.seq
 
                     if prev_pts == local_pts:
                         break
 
                     prev_pts = local_pts
                 elif isinstance(diff, raw.types.updates.ChannelDifferenceEmpty):
+                    await self.storage.update_state(
+                        (
+                            id,
+                            diff.pts,
+                            None,
+                            local_date,
+                            local_seq
+                        )
+                    )
                     break
                 elif isinstance(diff, raw.types.updates.ChannelDifferenceTooLong):
-                    break
+                    await self.storage.update_state(
+                        (
+                            id,
+                            diff.dialog.pts,
+                            None,
+                            local_date,
+                            local_seq
+                        )
+                    )
+                    continue
                 elif isinstance(diff, raw.types.updates.ChannelDifference):
                     local_pts = diff.pts
 
-                if not diff:
-                    break
-
                 users = {i.id: i for i in diff.users}
                 chats = {i.id: i for i in diff.chats}
 
@@ -795,9 +837,17 @@ async def recover_gaps(self) -> tuple[int, int]:
                 if isinstance(diff, (raw.types.updates.Difference, raw.types.updates.ChannelDifference)):
                     break
 
-            await self.storage.update_state(id)
+            await self.storage.update_state(
+                (
+                    id,
+                    local_pts,
+                    None,
+                    local_date,
+                    local_seq
+                )
+            )
 
-        log.info("Recovered %s messages and %s updates.", message_updates_counter, other_updates_counter)
+        log.info("Recovered %s messages and %s updates", message_updates_counter, other_updates_counter)
         return (message_updates_counter, other_updates_counter)
 
     async def load_session(self):

pyrogram/client.py

@@ -83,3 +83,9 @@ class MessageMediaType(AutoName):
 
     PAID_MEDIA = auto()
     "Paid Media"
+
+    CHECKLIST = auto()
+    "Checklist"
+
+    UNKNOWN = auto()
+    "This message media is unsupported by the current version of Pyrogram"

pyrogram/enums/message_media_type.py

@@ -150,5 +150,14 @@ class MessageServiceType(AutoName):
     PAID_MESSAGES_REFUNDED = auto()
     "Refunded paid messages"
 
+    DIRECT_MESSAGE_PRICE_CHANGED = auto()
+    "Direct message price"
+
+    CHECKLIST_TASKS_DONE = auto()
+    "Checklist tasks done"
+
+    CHECKLIST_TASKS_ADDED = auto()
+    "Checklist tasks added"
+
     UNKNOWN = auto()
     "This service message is unsupported by the current version of Pyrogram"