diff --git a/aiogram/client/bot.py b/aiogram/client/bot.py index ce1be304..a22213f6 100644 --- a/aiogram/client/bot.py +++ b/aiogram/client/bot.py @@ -141,7 +141,10 @@ T = TypeVar("T") class Bot(ContextInstanceMixin["Bot"]): def __init__( - self, token: str, session: Optional[BaseSession] = None, parse_mode: Optional[str] = None, + self, + token: str, + session: Optional[BaseSession] = None, + parse_mode: Optional[str] = None, ) -> None: """ Bot class @@ -327,38 +330,27 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> List[Update]: """ - Use this method to receive incoming updates using long polling (wiki). An Array of Update - objects is returned. - Notes - 1. This method will not work if an outgoing webhook is set up. - 2. In order to avoid getting duplicate updates, recalculate offset after each server - response. + Use this method to receive incoming updates using long polling (`wiki `_). An Array of `Update `_ objects is returned. + **Notes** + + **1.** This method will not work if an outgoing webhook is set up. + + **2.** In order to avoid getting duplicate updates, recalculate *offset* after each server response. Source: https://core.telegram.org/bots/api#getupdates - :param offset: Identifier of the first update to be returned. Must be greater by one than - the highest among the identifiers of previously received updates. By - default, updates starting with the earliest unconfirmed update are - returned. An update is considered confirmed as soon as getUpdates is called - with an offset higher than its update_id. The negative offset can be - specified to retrieve updates starting from -offset update from the end of - the updates queue. All previous updates will forgotten. - :param limit: Limits the number of updates to be retrieved. Values between 1-100 are - accepted. Defaults to 100. - :param timeout: Timeout in seconds for long polling. Defaults to 0, i.e. usual short - polling. Should be positive, short polling should be used for testing - purposes only. - :param allowed_updates: A JSON-serialized list of the update types you want your bot to - receive. For example, specify ['message', 'edited_channel_post', - 'callback_query'] to only receive updates of these types. See - Update for a complete list of available update types. Specify an - empty list to receive all updates regardless of type (default). If - not specified, the previous setting will be used. + :param offset: Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as `getUpdates `_ is called with an *offset* higher than its *update_id*. The negative offset can be specified to retrieve updates starting from *-offset* update from the end of the updates queue. All previous updates will forgotten. + :param limit: Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100. + :param timeout: Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only. + :param allowed_updates: A JSON-serialized list of the update types you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See `Update `_ for a complete list of available update types. Specify an empty list to receive all updates regardless of type (default). If not specified, the previous setting will be used. :param request_timeout: Request timeout :return: An Array of Update objects is returned. """ call = GetUpdates( - offset=offset, limit=limit, timeout=timeout, allowed_updates=allowed_updates, + offset=offset, + limit=limit, + timeout=timeout, + allowed_updates=allowed_updates, ) return await self(call, request_timeout=request_timeout) @@ -373,41 +365,25 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> bool: """ - Use this method to specify a url and receive incoming updates via an outgoing webhook. - Whenever there is an update for the bot, we will send an HTTPS POST request to the - specified url, containing a JSON-serialized Update. In case of an unsuccessful request, we - will give up after a reasonable amount of attempts. Returns True on success. - If you'd like to make sure that the Webhook request comes from Telegram, we recommend - using a secret path in the URL, e.g. https://www.example.com/. Since nobody else - knows your bot's token, you can be pretty sure it's us. - Notes - 1. You will not be able to receive updates using getUpdates for as long as an outgoing - webhook is set up. - 2. To use a self-signed certificate, you need to upload your public key certificate using - certificate parameter. Please upload as InputFile, sending a String will not work. - 3. Ports currently supported for Webhooks: 443, 80, 88, 8443. - NEW! If you're having any trouble setting up webhooks, please check out this amazing guide - to Webhooks. + Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified url, containing a JSON-serialized `Update `_. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns *True* on success. + If you'd like to make sure that the Webhook request comes from Telegram, we recommend using a secret path in the URL, e.g. :code:`https://www.example.com/`. Since nobody else knows your bot's token, you can be pretty sure it's us. + **Notes** + + **1.** You will not be able to receive updates using `getUpdates `_ for as long as an outgoing webhook is set up. + + **2.** To use a self-signed certificate, you need to upload your `public key certificate `_ using *certificate* parameter. Please upload as InputFile, sending a String will not work. + + **3.** Ports currently supported *for Webhooks*: **443, 80, 88, 8443**. + **NEW!** If you're having any trouble setting up webhooks, please check out this `amazing guide to Webhooks `_. Source: https://core.telegram.org/bots/api#setwebhook - :param url: HTTPS url to send updates to. Use an empty string to remove webhook - integration - :param certificate: Upload your public key certificate so that the root certificate in use - can be checked. See our self-signed guide for details. - :param ip_address: The fixed IP address which will be used to send webhook requests - instead of the IP address resolved through DNS - :param max_connections: Maximum allowed number of simultaneous HTTPS connections to the - webhook for update delivery, 1-100. Defaults to 40. Use lower - values to limit the load on your bot's server, and higher values - to increase your bot's throughput. - :param allowed_updates: A JSON-serialized list of the update types you want your bot to - receive. For example, specify ['message', 'edited_channel_post', - 'callback_query'] to only receive updates of these types. See - Update for a complete list of available update types. Specify an - empty list to receive all updates regardless of type (default). If - not specified, the previous setting will be used. - :param drop_pending_updates: Pass True to drop all pending updates + :param url: HTTPS url to send updates to. Use an empty string to remove webhook integration + :param certificate: Upload your public key certificate so that the root certificate in use can be checked. See our `self-signed guide `_ for details. + :param ip_address: The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS + :param max_connections: Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to *40*. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput. + :param allowed_updates: A JSON-serialized list of the update types you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See `Update `_ for a complete list of available update types. Specify an empty list to receive all updates regardless of type (default). If not specified, the previous setting will be used. + :param drop_pending_updates: Pass *True* to drop all pending updates :param request_timeout: Request timeout :return: Returns True on success. """ @@ -422,26 +398,30 @@ class Bot(ContextInstanceMixin["Bot"]): return await self(call, request_timeout=request_timeout) async def delete_webhook( - self, drop_pending_updates: Optional[bool] = None, request_timeout: Optional[int] = None, + self, + drop_pending_updates: Optional[bool] = None, + request_timeout: Optional[int] = None, ) -> bool: """ - Use this method to remove webhook integration if you decide to switch back to getUpdates. - Returns True on success. + Use this method to remove webhook integration if you decide to switch back to `getUpdates `_. Returns *True* on success. Source: https://core.telegram.org/bots/api#deletewebhook - :param drop_pending_updates: Pass True to drop all pending updates + :param drop_pending_updates: Pass *True* to drop all pending updates :param request_timeout: Request timeout :return: Returns True on success. """ - call = DeleteWebhook(drop_pending_updates=drop_pending_updates,) + call = DeleteWebhook( + drop_pending_updates=drop_pending_updates, + ) return await self(call, request_timeout=request_timeout) - async def get_webhook_info(self, request_timeout: Optional[int] = None,) -> WebhookInfo: + async def get_webhook_info( + self, + request_timeout: Optional[int] = None, + ) -> WebhookInfo: """ - Use this method to get current webhook status. Requires no parameters. On success, returns - a WebhookInfo object. If the bot is using getUpdates, will return an object with the url - field empty. + Use this method to get current webhook status. Requires no parameters. On success, returns a `WebhookInfo `_ object. If the bot is using `getUpdates `_, will return an object with the *url* field empty. Source: https://core.telegram.org/bots/api#getwebhookinfo @@ -457,10 +437,12 @@ class Bot(ContextInstanceMixin["Bot"]): # Source: https://core.telegram.org/bots/api#available-methods # ============================================================================================= - async def get_me(self, request_timeout: Optional[int] = None,) -> User: + async def get_me( + self, + request_timeout: Optional[int] = None, + ) -> User: """ - A simple method for testing your bot's auth token. Requires no parameters. Returns basic - information about the bot in form of a User object. + A simple method for testing your bot's auth token. Requires no parameters. Returns basic information about the bot in form of a `User `_ object. Source: https://core.telegram.org/bots/api#getme @@ -470,13 +452,12 @@ class Bot(ContextInstanceMixin["Bot"]): call = GetMe() return await self(call, request_timeout=request_timeout) - async def log_out(self, request_timeout: Optional[int] = None,) -> bool: + async def log_out( + self, + request_timeout: Optional[int] = None, + ) -> bool: """ - Use this method to log out from the cloud Bot API server before launching the bot locally. - You must log out the bot before running it locally, otherwise there is no guarantee that - the bot will receive updates. After a successful call, you can immediately log in on a - local server, but will not be able to log in back to the cloud Bot API server for 10 - minutes. Returns True on success. Requires no parameters. + Use this method to log out from the cloud Bot API server before launching the bot locally. You **must** log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns *True* on success. Requires no parameters. Source: https://core.telegram.org/bots/api#logout @@ -486,12 +467,12 @@ class Bot(ContextInstanceMixin["Bot"]): call = LogOut() return await self(call, request_timeout=request_timeout) - async def close(self, request_timeout: Optional[int] = None,) -> bool: + async def close( + self, + request_timeout: Optional[int] = None, + ) -> bool: """ - Use this method to close the bot instance before moving it from one local server to - another. You need to delete the webhook before calling this method to ensure that the bot - isn't launched again after server restart. The method will return error 429 in the first - 10 minutes after the bot is launched. Returns True on success. Requires no parameters. + Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns *True* on success. Requires no parameters. Source: https://core.telegram.org/bots/api#close @@ -518,26 +499,19 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> Message: """ - Use this method to send text messages. On success, the sent Message is returned. + Use this method to send text messages. On success, the sent `Message `_ is returned. Source: https://core.telegram.org/bots/api#sendmessage - :param chat_id: Unique identifier for the target chat or username of the target channel - (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) :param text: Text of the message to be sent, 1-4096 characters after entities parsing - :param parse_mode: Mode for parsing entities in the message text. See formatting options - for more details. - :param entities: List of special entities that appear in message text, which can be - specified instead of parse_mode + :param parse_mode: Mode for parsing entities in the message text. See `formatting options `_ for more details. + :param entities: List of special entities that appear in message text, which can be specified instead of *parse_mode* :param disable_web_page_preview: Disables link previews for links in this message - :param disable_notification: Sends the message silently. Users will receive a notification - with no sound. + :param disable_notification: Sends the message `silently `_. Users will receive a notification with no sound. :param reply_to_message_id: If the message is a reply, ID of the original message - :param allow_sending_without_reply: Pass True, if the message should be sent even if the - specified replied-to message is not found - :param reply_markup: Additional interface options. A JSON-serialized object for an inline - keyboard, custom reply keyboard, instructions to remove reply - keyboard or to force a reply from the user. + :param allow_sending_without_reply: Pass *True*, if the message should be sent even if the specified replied-to message is not found + :param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove reply keyboard or to force a reply from the user. :param request_timeout: Request timeout :return: On success, the sent Message is returned. """ @@ -563,17 +537,14 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> Message: """ - Use this method to forward messages of any kind. On success, the sent Message is returned. + Use this method to forward messages of any kind. On success, the sent `Message `_ is returned. Source: https://core.telegram.org/bots/api#forwardmessage - :param chat_id: Unique identifier for the target chat or username of the target channel - (in the format @channelusername) - :param from_chat_id: Unique identifier for the chat where the original message was sent - (or channel username in the format @channelusername) - :param message_id: Message identifier in the chat specified in from_chat_id - :param disable_notification: Sends the message silently. Users will receive a notification - with no sound. + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) + :param from_chat_id: Unique identifier for the chat where the original message was sent (or channel username in the format :code:`@channelusername`) + :param message_id: Message identifier in the chat specified in *from_chat_id* + :param disable_notification: Sends the message `silently `_. Users will receive a notification with no sound. :param request_timeout: Request timeout :return: On success, the sent Message is returned. """ @@ -602,31 +573,20 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> MessageId: """ - Use this method to copy messages of any kind. The method is analogous to the method - forwardMessages, but the copied message doesn't have a link to the original message. - Returns the MessageId of the sent message on success. + Use this method to copy messages of any kind. The method is analogous to the method `forwardMessages `_, but the copied message doesn't have a link to the original message. Returns the `MessageId `_ of the sent message on success. Source: https://core.telegram.org/bots/api#copymessage - :param chat_id: Unique identifier for the target chat or username of the target channel - (in the format @channelusername) - :param from_chat_id: Unique identifier for the chat where the original message was sent - (or channel username in the format @channelusername) - :param message_id: Message identifier in the chat specified in from_chat_id - :param caption: New caption for media, 0-1024 characters after entities parsing. If not - specified, the original caption is kept - :param parse_mode: Mode for parsing entities in the new caption. See formatting options - for more details. - :param caption_entities: List of special entities that appear in the new caption, which - can be specified instead of parse_mode - :param disable_notification: Sends the message silently. Users will receive a notification - with no sound. + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) + :param from_chat_id: Unique identifier for the chat where the original message was sent (or channel username in the format :code:`@channelusername`) + :param message_id: Message identifier in the chat specified in *from_chat_id* + :param caption: New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept + :param parse_mode: Mode for parsing entities in the new caption. See `formatting options `_ for more details. + :param caption_entities: List of special entities that appear in the new caption, which can be specified instead of *parse_mode* + :param disable_notification: Sends the message `silently `_. Users will receive a notification with no sound. :param reply_to_message_id: If the message is a reply, ID of the original message - :param allow_sending_without_reply: Pass True, if the message should be sent even if the - specified replied-to message is not found - :param reply_markup: Additional interface options. A JSON-serialized object for an inline - keyboard, custom reply keyboard, instructions to remove reply - keyboard or to force a reply from the user. + :param allow_sending_without_reply: Pass *True*, if the message should be sent even if the specified replied-to message is not found + :param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove reply keyboard or to force a reply from the user. :param request_timeout: Request timeout :return: Returns the MessageId of the sent message on success. """ @@ -660,30 +620,19 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> Message: """ - Use this method to send photos. On success, the sent Message is returned. + Use this method to send photos. On success, the sent `Message `_ is returned. Source: https://core.telegram.org/bots/api#sendphoto - :param chat_id: Unique identifier for the target chat or username of the target channel - (in the format @channelusername) - :param photo: Photo to send. Pass a file_id as String to send a photo that exists on the - Telegram servers (recommended), pass an HTTP URL as a String for Telegram to - get a photo from the Internet, or upload a new photo using - multipart/form-data. - :param caption: Photo caption (may also be used when resending photos by file_id), 0-1024 - characters after entities parsing - :param parse_mode: Mode for parsing entities in the photo caption. See formatting options - for more details. - :param caption_entities: List of special entities that appear in the caption, which can be - specified instead of parse_mode - :param disable_notification: Sends the message silently. Users will receive a notification - with no sound. + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) + :param photo: Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. `More info on Sending Files » `_ + :param caption: Photo caption (may also be used when resending photos by *file_id*), 0-1024 characters after entities parsing + :param parse_mode: Mode for parsing entities in the photo caption. See `formatting options `_ for more details. + :param caption_entities: List of special entities that appear in the caption, which can be specified instead of *parse_mode* + :param disable_notification: Sends the message `silently `_. Users will receive a notification with no sound. :param reply_to_message_id: If the message is a reply, ID of the original message - :param allow_sending_without_reply: Pass True, if the message should be sent even if the - specified replied-to message is not found - :param reply_markup: Additional interface options. A JSON-serialized object for an inline - keyboard, custom reply keyboard, instructions to remove reply - keyboard or to force a reply from the user. + :param allow_sending_without_reply: Pass *True*, if the message should be sent even if the specified replied-to message is not found + :param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove reply keyboard or to force a reply from the user. :param request_timeout: Request timeout :return: On success, the sent Message is returned. """ @@ -720,43 +669,24 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> Message: """ - Use this method to send audio files, if you want Telegram clients to display them in the - music player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message - is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be - changed in the future. - For sending voice messages, use the sendVoice method instead. + Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent `Message `_ is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future. + For sending voice messages, use the `sendVoice `_ method instead. Source: https://core.telegram.org/bots/api#sendaudio - :param chat_id: Unique identifier for the target chat or username of the target channel - (in the format @channelusername) - :param audio: Audio file to send. Pass a file_id as String to send an audio file that - exists on the Telegram servers (recommended), pass an HTTP URL as a String - for Telegram to get an audio file from the Internet, or upload a new one - using multipart/form-data. + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) + :param audio: Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. `More info on Sending Files » `_ :param caption: Audio caption, 0-1024 characters after entities parsing - :param parse_mode: Mode for parsing entities in the audio caption. See formatting options - for more details. - :param caption_entities: List of special entities that appear in the caption, which can be - specified instead of parse_mode + :param parse_mode: Mode for parsing entities in the audio caption. See `formatting options `_ for more details. + :param caption_entities: List of special entities that appear in the caption, which can be specified instead of *parse_mode* :param duration: Duration of the audio in seconds :param performer: Performer :param title: Track name - :param thumb: Thumbnail of the file sent; can be ignored if thumbnail generation for the - file is supported server-side. The thumbnail should be in JPEG format and - less than 200 kB in size. A thumbnail's width and height should not exceed - 320. Ignored if the file is not uploaded using multipart/form-data. - Thumbnails can't be reused and can be only uploaded as a new file, so you - can pass 'attach://' if the thumbnail was uploaded using - multipart/form-data under . - :param disable_notification: Sends the message silently. Users will receive a notification - with no sound. + :param thumb: Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://” if the thumbnail was uploaded using multipart/form-data under . `More info on Sending Files » `_ + :param disable_notification: Sends the message `silently `_. Users will receive a notification with no sound. :param reply_to_message_id: If the message is a reply, ID of the original message - :param allow_sending_without_reply: Pass True, if the message should be sent even if the - specified replied-to message is not found - :param reply_markup: Additional interface options. A JSON-serialized object for an inline - keyboard, custom reply keyboard, instructions to remove reply - keyboard or to force a reply from the user. + :param allow_sending_without_reply: Pass *True*, if the message should be sent even if the specified replied-to message is not found + :param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove reply keyboard or to force a reply from the user. :param request_timeout: Request timeout :return: On success, the sent Message is returned. """ @@ -795,42 +725,21 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> Message: """ - Use this method to send general files. On success, the sent Message is returned. Bots can - currently send files of any type of up to 50 MB in size, this limit may be changed in the - future. + Use this method to send general files. On success, the sent `Message `_ is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future. Source: https://core.telegram.org/bots/api#senddocument - :param chat_id: Unique identifier for the target chat or username of the target channel - (in the format @channelusername) - :param document: File to send. Pass a file_id as String to send a file that exists on the - Telegram servers (recommended), pass an HTTP URL as a String for Telegram - to get a file from the Internet, or upload a new one using - multipart/form-data. - :param thumb: Thumbnail of the file sent; can be ignored if thumbnail generation for the - file is supported server-side. The thumbnail should be in JPEG format and - less than 200 kB in size. A thumbnail's width and height should not exceed - 320. Ignored if the file is not uploaded using multipart/form-data. - Thumbnails can't be reused and can be only uploaded as a new file, so you - can pass 'attach://' if the thumbnail was uploaded using - multipart/form-data under . - :param caption: Document caption (may also be used when resending documents by file_id), - 0-1024 characters after entities parsing - :param parse_mode: Mode for parsing entities in the document caption. See formatting - options for more details. - :param caption_entities: List of special entities that appear in the caption, which can be - specified instead of parse_mode - :param disable_content_type_detection: Disables automatic server-side content type - detection for files uploaded using - multipart/form-data - :param disable_notification: Sends the message silently. Users will receive a notification - with no sound. + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) + :param document: File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. `More info on Sending Files » `_ + :param thumb: Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://” if the thumbnail was uploaded using multipart/form-data under . `More info on Sending Files » `_ + :param caption: Document caption (may also be used when resending documents by *file_id*), 0-1024 characters after entities parsing + :param parse_mode: Mode for parsing entities in the document caption. See `formatting options `_ for more details. + :param caption_entities: List of special entities that appear in the caption, which can be specified instead of *parse_mode* + :param disable_content_type_detection: Disables automatic server-side content type detection for files uploaded using multipart/form-data + :param disable_notification: Sends the message `silently `_. Users will receive a notification with no sound. :param reply_to_message_id: If the message is a reply, ID of the original message - :param allow_sending_without_reply: Pass True, if the message should be sent even if the - specified replied-to message is not found - :param reply_markup: Additional interface options. A JSON-serialized object for an inline - keyboard, custom reply keyboard, instructions to remove reply - keyboard or to force a reply from the user. + :param allow_sending_without_reply: Pass *True*, if the message should be sent even if the specified replied-to message is not found + :param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove reply keyboard or to force a reply from the user. :param request_timeout: Request timeout :return: On success, the sent Message is returned. """ @@ -870,43 +779,24 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> Message: """ - Use this method to send video files, Telegram clients support mp4 videos (other formats - may be sent as Document). On success, the sent Message is returned. Bots can currently - send video files of up to 50 MB in size, this limit may be changed in the future. + Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as `Document `_). On success, the sent `Message `_ is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future. Source: https://core.telegram.org/bots/api#sendvideo - :param chat_id: Unique identifier for the target chat or username of the target channel - (in the format @channelusername) - :param video: Video to send. Pass a file_id as String to send a video that exists on the - Telegram servers (recommended), pass an HTTP URL as a String for Telegram to - get a video from the Internet, or upload a new video using - multipart/form-data. + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) + :param video: Video to send. Pass a file_id as String to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data. `More info on Sending Files » `_ :param duration: Duration of sent video in seconds :param width: Video width :param height: Video height - :param thumb: Thumbnail of the file sent; can be ignored if thumbnail generation for the - file is supported server-side. The thumbnail should be in JPEG format and - less than 200 kB in size. A thumbnail's width and height should not exceed - 320. Ignored if the file is not uploaded using multipart/form-data. - Thumbnails can't be reused and can be only uploaded as a new file, so you - can pass 'attach://' if the thumbnail was uploaded using - multipart/form-data under . - :param caption: Video caption (may also be used when resending videos by file_id), 0-1024 - characters after entities parsing - :param parse_mode: Mode for parsing entities in the video caption. See formatting options - for more details. - :param caption_entities: List of special entities that appear in the caption, which can be - specified instead of parse_mode - :param supports_streaming: Pass True, if the uploaded video is suitable for streaming - :param disable_notification: Sends the message silently. Users will receive a notification - with no sound. + :param thumb: Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://” if the thumbnail was uploaded using multipart/form-data under . `More info on Sending Files » `_ + :param caption: Video caption (may also be used when resending videos by *file_id*), 0-1024 characters after entities parsing + :param parse_mode: Mode for parsing entities in the video caption. See `formatting options `_ for more details. + :param caption_entities: List of special entities that appear in the caption, which can be specified instead of *parse_mode* + :param supports_streaming: Pass *True*, if the uploaded video is suitable for streaming + :param disable_notification: Sends the message `silently `_. Users will receive a notification with no sound. :param reply_to_message_id: If the message is a reply, ID of the original message - :param allow_sending_without_reply: Pass True, if the message should be sent even if the - specified replied-to message is not found - :param reply_markup: Additional interface options. A JSON-serialized object for an inline - keyboard, custom reply keyboard, instructions to remove reply - keyboard or to force a reply from the user. + :param allow_sending_without_reply: Pass *True*, if the message should be sent even if the specified replied-to message is not found + :param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove reply keyboard or to force a reply from the user. :param request_timeout: Request timeout :return: On success, the sent Message is returned. """ @@ -948,42 +838,23 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> Message: """ - Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On - success, the sent Message is returned. Bots can currently send animation files of up to 50 - MB in size, this limit may be changed in the future. + Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent `Message `_ is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future. Source: https://core.telegram.org/bots/api#sendanimation - :param chat_id: Unique identifier for the target chat or username of the target channel - (in the format @channelusername) - :param animation: Animation to send. Pass a file_id as String to send an animation that - exists on the Telegram servers (recommended), pass an HTTP URL as a - String for Telegram to get an animation from the Internet, or upload a - new animation using multipart/form-data. + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) + :param animation: Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. `More info on Sending Files » `_ :param duration: Duration of sent animation in seconds :param width: Animation width :param height: Animation height - :param thumb: Thumbnail of the file sent; can be ignored if thumbnail generation for the - file is supported server-side. The thumbnail should be in JPEG format and - less than 200 kB in size. A thumbnail's width and height should not exceed - 320. Ignored if the file is not uploaded using multipart/form-data. - Thumbnails can't be reused and can be only uploaded as a new file, so you - can pass 'attach://' if the thumbnail was uploaded using - multipart/form-data under . - :param caption: Animation caption (may also be used when resending animation by file_id), - 0-1024 characters after entities parsing - :param parse_mode: Mode for parsing entities in the animation caption. See formatting - options for more details. - :param caption_entities: List of special entities that appear in the caption, which can be - specified instead of parse_mode - :param disable_notification: Sends the message silently. Users will receive a notification - with no sound. + :param thumb: Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://” if the thumbnail was uploaded using multipart/form-data under . `More info on Sending Files » `_ + :param caption: Animation caption (may also be used when resending animation by *file_id*), 0-1024 characters after entities parsing + :param parse_mode: Mode for parsing entities in the animation caption. See `formatting options `_ for more details. + :param caption_entities: List of special entities that appear in the caption, which can be specified instead of *parse_mode* + :param disable_notification: Sends the message `silently `_. Users will receive a notification with no sound. :param reply_to_message_id: If the message is a reply, ID of the original message - :param allow_sending_without_reply: Pass True, if the message should be sent even if the - specified replied-to message is not found - :param reply_markup: Additional interface options. A JSON-serialized object for an inline - keyboard, custom reply keyboard, instructions to remove reply - keyboard or to force a reply from the user. + :param allow_sending_without_reply: Pass *True*, if the message should be sent even if the specified replied-to message is not found + :param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove reply keyboard or to force a reply from the user. :param request_timeout: Request timeout :return: On success, the sent Message is returned. """ @@ -1021,34 +892,20 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> Message: """ - Use this method to send audio files, if you want Telegram clients to display the file as a - playable voice message. For this to work, your audio must be in an .OGG file encoded with - OPUS (other formats may be sent as Audio or Document). On success, the sent Message is - returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be - changed in the future. + Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as `Audio `_ or `Document `_). On success, the sent `Message `_ is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future. Source: https://core.telegram.org/bots/api#sendvoice - :param chat_id: Unique identifier for the target chat or username of the target channel - (in the format @channelusername) - :param voice: Audio file to send. Pass a file_id as String to send a file that exists on - the Telegram servers (recommended), pass an HTTP URL as a String for - Telegram to get a file from the Internet, or upload a new one using - multipart/form-data. + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) + :param voice: Audio file to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. `More info on Sending Files » `_ :param caption: Voice message caption, 0-1024 characters after entities parsing - :param parse_mode: Mode for parsing entities in the voice message caption. See formatting - options for more details. - :param caption_entities: List of special entities that appear in the caption, which can be - specified instead of parse_mode + :param parse_mode: Mode for parsing entities in the voice message caption. See `formatting options `_ for more details. + :param caption_entities: List of special entities that appear in the caption, which can be specified instead of *parse_mode* :param duration: Duration of the voice message in seconds - :param disable_notification: Sends the message silently. Users will receive a notification - with no sound. + :param disable_notification: Sends the message `silently `_. Users will receive a notification with no sound. :param reply_to_message_id: If the message is a reply, ID of the original message - :param allow_sending_without_reply: Pass True, if the message should be sent even if the - specified replied-to message is not found - :param reply_markup: Additional interface options. A JSON-serialized object for an inline - keyboard, custom reply keyboard, instructions to remove reply - keyboard or to force a reply from the user. + :param allow_sending_without_reply: Pass *True*, if the message should be sent even if the specified replied-to message is not found + :param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove reply keyboard or to force a reply from the user. :param request_timeout: Request timeout :return: On success, the sent Message is returned. """ @@ -1082,34 +939,19 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> Message: """ - As of v.4.0, Telegram clients support rounded square mp4 videos of up to 1 minute long. - Use this method to send video messages. On success, the sent Message is returned. + As of `v.4.0 `_, Telegram clients support rounded square mp4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent `Message `_ is returned. Source: https://core.telegram.org/bots/api#sendvideonote - :param chat_id: Unique identifier for the target chat or username of the target channel - (in the format @channelusername) - :param video_note: Video note to send. Pass a file_id as String to send a video note that - exists on the Telegram servers (recommended) or upload a new video - using multipart/form-data.. Sending video notes by a URL is currently - unsupported + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) + :param video_note: Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. `More info on Sending Files » `_. Sending video notes by a URL is currently unsupported :param duration: Duration of sent video in seconds :param length: Video width and height, i.e. diameter of the video message - :param thumb: Thumbnail of the file sent; can be ignored if thumbnail generation for the - file is supported server-side. The thumbnail should be in JPEG format and - less than 200 kB in size. A thumbnail's width and height should not exceed - 320. Ignored if the file is not uploaded using multipart/form-data. - Thumbnails can't be reused and can be only uploaded as a new file, so you - can pass 'attach://' if the thumbnail was uploaded using - multipart/form-data under . - :param disable_notification: Sends the message silently. Users will receive a notification - with no sound. + :param thumb: Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://” if the thumbnail was uploaded using multipart/form-data under . `More info on Sending Files » `_ + :param disable_notification: Sends the message `silently `_. Users will receive a notification with no sound. :param reply_to_message_id: If the message is a reply, ID of the original message - :param allow_sending_without_reply: Pass True, if the message should be sent even if the - specified replied-to message is not found - :param reply_markup: Additional interface options. A JSON-serialized object for an inline - keyboard, custom reply keyboard, instructions to remove reply - keyboard or to force a reply from the user. + :param allow_sending_without_reply: Pass *True*, if the message should be sent even if the specified replied-to message is not found + :param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove reply keyboard or to force a reply from the user. :param request_timeout: Request timeout :return: On success, the sent Message is returned. """ @@ -1136,21 +978,15 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> List[Message]: """ - Use this method to send a group of photos, videos, documents or audios as an album. - Documents and audio files can be only grouped in an album with messages of the same type. - On success, an array of Messages that were sent is returned. + Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of `Messages `_ that were sent is returned. Source: https://core.telegram.org/bots/api#sendmediagroup - :param chat_id: Unique identifier for the target chat or username of the target channel - (in the format @channelusername) - :param media: A JSON-serialized array describing messages to be sent, must include 2-10 - items - :param disable_notification: Sends messages silently. Users will receive a notification - with no sound. + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) + :param media: A JSON-serialized array describing messages to be sent, must include 2-10 items + :param disable_notification: Sends messages `silently `_. Users will receive a notification with no sound. :param reply_to_message_id: If the messages are a reply, ID of the original message - :param allow_sending_without_reply: Pass True, if the message should be sent even if the - specified replied-to message is not found + :param allow_sending_without_reply: Pass *True*, if the message should be sent even if the specified replied-to message is not found :param request_timeout: Request timeout :return: On success, an array of Messages that were sent is returned. """ @@ -1181,31 +1017,21 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> Message: """ - Use this method to send point on the map. On success, the sent Message is returned. + Use this method to send point on the map. On success, the sent `Message `_ is returned. Source: https://core.telegram.org/bots/api#sendlocation - :param chat_id: Unique identifier for the target chat or username of the target channel - (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) :param latitude: Latitude of the location :param longitude: Longitude of the location - :param horizontal_accuracy: The radius of uncertainty for the location, measured in - meters; 0-1500 - :param live_period: Period in seconds for which the location will be updated (see Live - Locations, should be between 60 and 86400. - :param heading: For live locations, a direction in which the user is moving, in degrees. - Must be between 1 and 360 if specified. - :param proximity_alert_radius: For live locations, a maximum distance for proximity alerts - about approaching another chat member, in meters. Must be - between 1 and 100000 if specified. - :param disable_notification: Sends the message silently. Users will receive a notification - with no sound. + :param horizontal_accuracy: The radius of uncertainty for the location, measured in meters; 0-1500 + :param live_period: Period in seconds for which the location will be updated (see `Live Locations `_, should be between 60 and 86400. + :param heading: For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified. + :param proximity_alert_radius: For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. + :param disable_notification: Sends the message `silently `_. Users will receive a notification with no sound. :param reply_to_message_id: If the message is a reply, ID of the original message - :param allow_sending_without_reply: Pass True, if the message should be sent even if the - specified replied-to message is not found - :param reply_markup: Additional interface options. A JSON-serialized object for an inline - keyboard, custom reply keyboard, instructions to remove reply - keyboard or to force a reply from the user. + :param allow_sending_without_reply: Pass *True*, if the message should be sent even if the specified replied-to message is not found + :param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove reply keyboard or to force a reply from the user. :param request_timeout: Request timeout :return: On success, the sent Message is returned. """ @@ -1238,30 +1064,19 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> Union[Message, bool]: """ - Use this method to edit live location messages. A location can be edited until its - live_period expires or editing is explicitly disabled by a call to - stopMessageLiveLocation. On success, if the edited message is not an inline message, the - edited Message is returned, otherwise True is returned. + Use this method to edit live location messages. A location can be edited until its *live_period* expires or editing is explicitly disabled by a call to `stopMessageLiveLocation `_. On success, if the edited message is not an inline message, the edited `Message `_ is returned, otherwise *True* is returned. Source: https://core.telegram.org/bots/api#editmessagelivelocation :param latitude: Latitude of new location :param longitude: Longitude of new location - :param chat_id: Required if inline_message_id is not specified. Unique identifier for the - target chat or username of the target channel (in the format - @channelusername) - :param message_id: Required if inline_message_id is not specified. Identifier of the - message to edit - :param inline_message_id: Required if chat_id and message_id are not specified. Identifier - of the inline message - :param horizontal_accuracy: The radius of uncertainty for the location, measured in - meters; 0-1500 - :param heading: Direction in which the user is moving, in degrees. Must be between 1 and - 360 if specified. - :param proximity_alert_radius: Maximum distance for proximity alerts about approaching - another chat member, in meters. Must be between 1 and - 100000 if specified. - :param reply_markup: A JSON-serialized object for a new inline keyboard. + :param chat_id: Required if *inline_message_id* is not specified. Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) + :param message_id: Required if *inline_message_id* is not specified. Identifier of the message to edit + :param inline_message_id: Required if *chat_id* and *message_id* are not specified. Identifier of the inline message + :param horizontal_accuracy: The radius of uncertainty for the location, measured in meters; 0-1500 + :param heading: Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified. + :param proximity_alert_radius: Maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. + :param reply_markup: A JSON-serialized object for a new `inline keyboard `_. :param request_timeout: Request timeout :return: On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. @@ -1288,20 +1103,14 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> Union[Message, bool]: """ - Use this method to stop updating a live location message before live_period expires. On - success, if the message was sent by the bot, the sent Message is returned, otherwise True - is returned. + Use this method to stop updating a live location message before *live_period* expires. On success, if the message was sent by the bot, the sent `Message `_ is returned, otherwise *True* is returned. Source: https://core.telegram.org/bots/api#stopmessagelivelocation - :param chat_id: Required if inline_message_id is not specified. Unique identifier for the - target chat or username of the target channel (in the format - @channelusername) - :param message_id: Required if inline_message_id is not specified. Identifier of the - message with live location to stop - :param inline_message_id: Required if chat_id and message_id are not specified. Identifier - of the inline message - :param reply_markup: A JSON-serialized object for a new inline keyboard. + :param chat_id: Required if *inline_message_id* is not specified. Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) + :param message_id: Required if *inline_message_id* is not specified. Identifier of the message with live location to stop + :param inline_message_id: Required if *chat_id* and *message_id* are not specified. Identifier of the inline message + :param reply_markup: A JSON-serialized object for a new `inline keyboard `_. :param request_timeout: Request timeout :return: On success, if the message was sent by the bot, the sent Message is returned, otherwise True is returned. @@ -1334,31 +1143,23 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> Message: """ - Use this method to send information about a venue. On success, the sent Message is - returned. + Use this method to send information about a venue. On success, the sent `Message `_ is returned. Source: https://core.telegram.org/bots/api#sendvenue - :param chat_id: Unique identifier for the target chat or username of the target channel - (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) :param latitude: Latitude of the venue :param longitude: Longitude of the venue :param title: Name of the venue :param address: Address of the venue :param foursquare_id: Foursquare identifier of the venue - :param foursquare_type: Foursquare type of the venue, if known. (For example, - 'arts_entertainment/default', 'arts_entertainment/aquarium' or - 'food/icecream'.) + :param foursquare_type: Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.) :param google_place_id: Google Places identifier of the venue - :param google_place_type: Google Places type of the venue. (See supported types.) - :param disable_notification: Sends the message silently. Users will receive a notification - with no sound. + :param google_place_type: Google Places type of the venue. (See `supported types `_.) + :param disable_notification: Sends the message `silently `_. Users will receive a notification with no sound. :param reply_to_message_id: If the message is a reply, ID of the original message - :param allow_sending_without_reply: Pass True, if the message should be sent even if the - specified replied-to message is not found - :param reply_markup: Additional interface options. A JSON-serialized object for an inline - keyboard, custom reply keyboard, instructions to remove reply - keyboard or to force a reply from the user. + :param allow_sending_without_reply: Pass *True*, if the message should be sent even if the specified replied-to message is not found + :param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove reply keyboard or to force a reply from the user. :param request_timeout: Request timeout :return: On success, the sent Message is returned. """ @@ -1395,24 +1196,19 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> Message: """ - Use this method to send phone contacts. On success, the sent Message is returned. + Use this method to send phone contacts. On success, the sent `Message `_ is returned. Source: https://core.telegram.org/bots/api#sendcontact - :param chat_id: Unique identifier for the target chat or username of the target channel - (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) :param phone_number: Contact's phone number :param first_name: Contact's first name :param last_name: Contact's last name - :param vcard: Additional data about the contact in the form of a vCard, 0-2048 bytes - :param disable_notification: Sends the message silently. Users will receive a notification - with no sound. + :param vcard: Additional data about the contact in the form of a `vCard `_, 0-2048 bytes + :param disable_notification: Sends the message `silently `_. Users will receive a notification with no sound. :param reply_to_message_id: If the message is a reply, ID of the original message - :param allow_sending_without_reply: Pass True, if the message should be sent even if the - specified replied-to message is not found - :param reply_markup: Additional interface options. A JSON-serialized object for an inline - keyboard, custom reply keyboard, instructions to remove keyboard or - to force a reply from the user. + :param allow_sending_without_reply: Pass *True*, if the message should be sent even if the specified replied-to message is not found + :param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove keyboard or to force a reply from the user. :param request_timeout: Request timeout :return: On success, the sent Message is returned. """ @@ -1453,43 +1249,27 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> Message: """ - Use this method to send a native poll. On success, the sent Message is returned. + Use this method to send a native poll. On success, the sent `Message `_ is returned. Source: https://core.telegram.org/bots/api#sendpoll - :param chat_id: Unique identifier for the target chat or username of the target channel - (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) :param question: Poll question, 1-300 characters - :param options: A JSON-serialized list of answer options, 2-10 strings 1-100 characters - each - :param is_anonymous: True, if the poll needs to be anonymous, defaults to True - :param type: Poll type, 'quiz' or 'regular', defaults to 'regular' - :param allows_multiple_answers: True, if the poll allows multiple answers, ignored for - polls in quiz mode, defaults to False - :param correct_option_id: 0-based identifier of the correct answer option, required for - polls in quiz mode - :param explanation: Text that is shown when a user chooses an incorrect answer or taps on - the lamp icon in a quiz-style poll, 0-200 characters with at most 2 - line feeds after entities parsing - :param explanation_parse_mode: Mode for parsing entities in the explanation. See - formatting options for more details. - :param explanation_entities: List of special entities that appear in the poll explanation, - which can be specified instead of parse_mode - :param open_period: Amount of time in seconds the poll will be active after creation, - 5-600. Can't be used together with close_date. - :param close_date: Point in time (Unix timestamp) when the poll will be automatically - closed. Must be at least 5 and no more than 600 seconds in the future. - Can't be used together with open_period. - :param is_closed: Pass True, if the poll needs to be immediately closed. This can be - useful for poll preview. - :param disable_notification: Sends the message silently. Users will receive a notification - with no sound. + :param options: A JSON-serialized list of answer options, 2-10 strings 1-100 characters each + :param is_anonymous: True, if the poll needs to be anonymous, defaults to *True* + :param type: Poll type, “quiz” or “regular”, defaults to “regular” + :param allows_multiple_answers: True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to *False* + :param correct_option_id: 0-based identifier of the correct answer option, required for polls in quiz mode + :param explanation: Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after entities parsing + :param explanation_parse_mode: Mode for parsing entities in the explanation. See `formatting options `_ for more details. + :param explanation_entities: List of special entities that appear in the poll explanation, which can be specified instead of *parse_mode* + :param open_period: Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with *close_date*. + :param close_date: Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can't be used together with *open_period*. + :param is_closed: Pass *True*, if the poll needs to be immediately closed. This can be useful for poll preview. + :param disable_notification: Sends the message `silently `_. Users will receive a notification with no sound. :param reply_to_message_id: If the message is a reply, ID of the original message - :param allow_sending_without_reply: Pass True, if the message should be sent even if the - specified replied-to message is not found - :param reply_markup: Additional interface options. A JSON-serialized object for an inline - keyboard, custom reply keyboard, instructions to remove reply - keyboard or to force a reply from the user. + :param allow_sending_without_reply: Pass *True*, if the message should be sent even if the specified replied-to message is not found + :param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove reply keyboard or to force a reply from the user. :param request_timeout: Request timeout :return: On success, the sent Message is returned. """ @@ -1527,24 +1307,16 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> Message: """ - Use this method to send an animated emoji that will display a random value. On success, - the sent Message is returned. + Use this method to send an animated emoji that will display a random value. On success, the sent `Message `_ is returned. Source: https://core.telegram.org/bots/api#senddice - :param chat_id: Unique identifier for the target chat or username of the target channel - (in the format @channelusername) - :param emoji: Emoji on which the dice throw animation is based. Currently, must be one of - '', '', '', '', or ''. Dice can have values 1-6 for '' and '', values 1-5 - for '' and '', and values 1-64 for ''. Defaults to '' - :param disable_notification: Sends the message silently. Users will receive a notification - with no sound. + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) + :param emoji: Emoji on which the dice throw animation is based. Currently, must be one of “”, “”, “”, “”, or “”. Dice can have values 1-6 for “” and “”, values 1-5 for “” and “”, and values 1-64 for “”. Defaults to “” + :param disable_notification: Sends the message `silently `_. Users will receive a notification with no sound. :param reply_to_message_id: If the message is a reply, ID of the original message - :param allow_sending_without_reply: Pass True, if the message should be sent even if the - specified replied-to message is not found - :param reply_markup: Additional interface options. A JSON-serialized object for an inline - keyboard, custom reply keyboard, instructions to remove reply - keyboard or to force a reply from the user. + :param allow_sending_without_reply: Pass *True*, if the message should be sent even if the specified replied-to message is not found + :param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove reply keyboard or to force a reply from the user. :param request_timeout: Request timeout :return: On success, the sent Message is returned. """ @@ -1559,32 +1331,28 @@ class Bot(ContextInstanceMixin["Bot"]): return await self(call, request_timeout=request_timeout) async def send_chat_action( - self, chat_id: Union[int, str], action: str, request_timeout: Optional[int] = None, + self, + chat_id: Union[int, str], + action: str, + request_timeout: Optional[int] = None, ) -> bool: """ - Use this method when you need to tell the user that something is happening on the bot's - side. The status is set for 5 seconds or less (when a message arrives from your bot, - Telegram clients clear its typing status). Returns True on success. - Example: The ImageBot needs some time to process a request and upload the image. Instead - of sending a text message along the lines of 'Retrieving image, please wait…', the bot may - use sendChatAction with action = upload_photo. The user will see a 'sending photo' status - for the bot. - We only recommend using this method when a response from the bot will take a noticeable - amount of time to arrive. + Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns *True* on success. + Example: The `ImageBot `_ needs some time to process a request and upload the image. Instead of sending a text message along the lines of “Retrieving image, please wait…”, the bot may use `sendChatAction `_ with *action* = *upload_photo*. The user will see a “sending photo” status for the bot. + + We only recommend using this method when a response from the bot will take a **noticeable** amount of time to arrive. Source: https://core.telegram.org/bots/api#sendchataction - :param chat_id: Unique identifier for the target chat or username of the target channel - (in the format @channelusername) - :param action: Type of action to broadcast. Choose one, depending on what the user is - about to receive: typing for text messages, upload_photo for photos, - record_video or upload_video for videos, record_audio or upload_audio for - audio files, upload_document for general files, find_location for location - data, record_video_note or upload_video_note for video notes. + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) + :param action: Type of action to broadcast. Choose one, depending on what the user is about to receive: *typing* for `text messages `_, *upload_photo* for `photos `_, *record_video* or *upload_video* for `videos `_, *record_voice* or *upload_voice* for `voice notes `_, *upload_document* for `general files `_, *find_location* for `location data `_, *record_video_note* or *upload_video_note* for `video notes `_. :param request_timeout: Request timeout :return: Returns True on success. """ - call = SendChatAction(chat_id=chat_id, action=action,) + call = SendChatAction( + chat_id=chat_id, + action=action, + ) return await self(call, request_timeout=request_timeout) async def get_user_profile_photos( @@ -1595,32 +1363,31 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> UserProfilePhotos: """ - Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos - object. + Use this method to get a list of profile pictures for a user. Returns a `UserProfilePhotos `_ object. Source: https://core.telegram.org/bots/api#getuserprofilephotos :param user_id: Unique identifier of the target user - :param offset: Sequential number of the first photo to be returned. By default, all photos - are returned. - :param limit: Limits the number of photos to be retrieved. Values between 1-100 are - accepted. Defaults to 100. + :param offset: Sequential number of the first photo to be returned. By default, all photos are returned. + :param limit: Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100. :param request_timeout: Request timeout :return: Returns a UserProfilePhotos object. """ - call = GetUserProfilePhotos(user_id=user_id, offset=offset, limit=limit,) + call = GetUserProfilePhotos( + user_id=user_id, + offset=offset, + limit=limit, + ) return await self(call, request_timeout=request_timeout) - async def get_file(self, file_id: str, request_timeout: Optional[int] = None,) -> File: + async def get_file( + self, + file_id: str, + request_timeout: Optional[int] = None, + ) -> File: """ - Use this method to get basic info about a file and prepare it for downloading. For the - moment, bots can download files of up to 20MB in size. On success, a File object is - returned. The file can then be downloaded via the link - https://api.telegram.org/file/bot/, where is taken from the - response. It is guaranteed that the link will be valid for at least 1 hour. When the link - expires, a new one can be requested by calling getFile again. - Note: This function may not preserve the original file name and MIME type. You should save - the file's MIME type and name (if available) when the File object is received. + Use this method to get basic info about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a `File `_ object is returned. The file can then be downloaded via the link :code:`https://api.telegram.org/file/bot/`, where :code:`` is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling `getFile `_ again. + **Note:** This function may not preserve the original file name and MIME type. You should save the file's MIME type and name (if available) when the File object is received. Source: https://core.telegram.org/bots/api#getfile @@ -1628,7 +1395,9 @@ class Bot(ContextInstanceMixin["Bot"]): :param request_timeout: Request timeout :return: On success, a File object is returned. """ - call = GetFile(file_id=file_id,) + call = GetFile( + file_id=file_id, + ) return await self(call, request_timeout=request_timeout) async def kick_chat_member( @@ -1639,24 +1408,22 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> bool: """ - Use this method to kick a user from a group, a supergroup or a channel. In the case of - supergroups and channels, the user will not be able to return to the group on their own - using invite links, etc., unless unbanned first. The bot must be an administrator in the - chat for this to work and must have the appropriate admin rights. Returns True on success. + Use this method to kick a user from a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless `unbanned `_ first. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns *True* on success. Source: https://core.telegram.org/bots/api#kickchatmember - :param chat_id: Unique identifier for the target group or username of the target - supergroup or channel (in the format @channelusername) + :param chat_id: Unique identifier for the target group or username of the target supergroup or channel (in the format :code:`@channelusername`) :param user_id: Unique identifier of the target user - :param until_date: Date when the user will be unbanned, unix time. If user is banned for - more than 366 days or less than 30 seconds from the current time they - are considered to be banned forever + :param until_date: Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only. :param request_timeout: Request timeout :return: In the case of supergroups and channels, the user will not be able to return to - the group on their own using invite links, etc. Returns True on success. + the chat on their own using invite links, etc. Returns True on success. """ - call = KickChatMember(chat_id=chat_id, user_id=user_id, until_date=until_date,) + call = KickChatMember( + chat_id=chat_id, + user_id=user_id, + until_date=until_date, + ) return await self(call, request_timeout=request_timeout) async def unban_chat_member( @@ -1667,24 +1434,22 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> bool: """ - Use this method to unban a previously kicked user in a supergroup or channel. The user - will not return to the group or channel automatically, but will be able to join via link, - etc. The bot must be an administrator for this to work. By default, this method guarantees - that after the call the user is not a member of the chat, but will be able to join it. So - if the user is a member of the chat they will also be removed from the chat. If you don't - want this, use the parameter only_if_banned. Returns True on success. + Use this method to unban a previously kicked user in a supergroup or channel. The user will **not** return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be **removed** from the chat. If you don't want this, use the parameter *only_if_banned*. Returns *True* on success. Source: https://core.telegram.org/bots/api#unbanchatmember - :param chat_id: Unique identifier for the target group or username of the target - supergroup or channel (in the format @username) + :param chat_id: Unique identifier for the target group or username of the target supergroup or channel (in the format :code:`@username`) :param user_id: Unique identifier of the target user :param only_if_banned: Do nothing if the user is not banned :param request_timeout: Request timeout :return: The user will not return to the group or channel automatically, but will be able to join via link, etc. Returns True on success. """ - call = UnbanChatMember(chat_id=chat_id, user_id=user_id, only_if_banned=only_if_banned,) + call = UnbanChatMember( + chat_id=chat_id, + user_id=user_id, + only_if_banned=only_if_banned, + ) return await self(call, request_timeout=request_timeout) async def restrict_chat_member( @@ -1696,24 +1461,22 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> bool: """ - Use this method to restrict a user in a supergroup. The bot must be an administrator in - the supergroup for this to work and must have the appropriate admin rights. Pass True for - all permissions to lift restrictions from a user. Returns True on success. + Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate admin rights. Pass *True* for all permissions to lift restrictions from a user. Returns *True* on success. Source: https://core.telegram.org/bots/api#restrictchatmember - :param chat_id: Unique identifier for the target chat or username of the target supergroup - (in the format @supergroupusername) + :param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`) :param user_id: Unique identifier of the target user :param permissions: A JSON-serialized object for new user permissions - :param until_date: Date when restrictions will be lifted for the user, unix time. If user - is restricted for more than 366 days or less than 30 seconds from the - current time, they are considered to be restricted forever + :param until_date: Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever :param request_timeout: Request timeout :return: Returns True on success. """ call = RestrictChatMember( - chat_id=chat_id, user_id=user_id, permissions=permissions, until_date=until_date, + chat_id=chat_id, + user_id=user_id, + permissions=permissions, + until_date=until_date, ) return await self(call, request_timeout=request_timeout) @@ -1733,33 +1496,21 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> bool: """ - Use this method to promote or demote a user in a supergroup or a channel. The bot must be - an administrator in the chat for this to work and must have the appropriate admin rights. - Pass False for all boolean parameters to demote a user. Returns True on success. + Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Pass *False* for all boolean parameters to demote a user. Returns *True* on success. Source: https://core.telegram.org/bots/api#promotechatmember - :param chat_id: Unique identifier for the target chat or username of the target channel - (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) :param user_id: Unique identifier of the target user - :param is_anonymous: Pass True, if the administrator's presence in the chat is hidden - :param can_change_info: Pass True, if the administrator can change chat title, photo and - other settings - :param can_post_messages: Pass True, if the administrator can create channel posts, - channels only - :param can_edit_messages: Pass True, if the administrator can edit messages of other users - and can pin messages, channels only - :param can_delete_messages: Pass True, if the administrator can delete messages of other - users + :param is_anonymous: Pass *True*, if the administrator's presence in the chat is hidden + :param can_change_info: Pass True, if the administrator can change chat title, photo and other settings + :param can_post_messages: Pass True, if the administrator can create channel posts, channels only + :param can_edit_messages: Pass True, if the administrator can edit messages of other users and can pin messages, channels only + :param can_delete_messages: Pass True, if the administrator can delete messages of other users :param can_invite_users: Pass True, if the administrator can invite new users to the chat - :param can_restrict_members: Pass True, if the administrator can restrict, ban or unban - chat members - :param can_pin_messages: Pass True, if the administrator can pin messages, supergroups - only - :param can_promote_members: Pass True, if the administrator can add new administrators - with a subset of their own privileges or demote administrators - that he has promoted, directly or indirectly (promoted by - administrators that were appointed by him) + :param can_restrict_members: Pass True, if the administrator can restrict, ban or unban chat members + :param can_pin_messages: Pass True, if the administrator can pin messages, supergroups only + :param can_promote_members: Pass True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by him) :param request_timeout: Request timeout :return: Returns True on success. """ @@ -1786,21 +1537,20 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> bool: """ - Use this method to set a custom title for an administrator in a supergroup promoted by the - bot. Returns True on success. + Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns *True* on success. Source: https://core.telegram.org/bots/api#setchatadministratorcustomtitle - :param chat_id: Unique identifier for the target chat or username of the target supergroup - (in the format @supergroupusername) + :param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`) :param user_id: Unique identifier of the target user - :param custom_title: New custom title for the administrator; 0-16 characters, emoji are - not allowed + :param custom_title: New custom title for the administrator; 0-16 characters, emoji are not allowed :param request_timeout: Request timeout :return: Returns True on success. """ call = SetChatAdministratorCustomTitle( - chat_id=chat_id, user_id=user_id, custom_title=custom_title, + chat_id=chat_id, + user_id=user_id, + custom_title=custom_title, ) return await self(call, request_timeout=request_timeout) @@ -1811,98 +1561,102 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> bool: """ - Use this method to set default chat permissions for all members. The bot must be an - administrator in the group or a supergroup for this to work and must have the - can_restrict_members admin rights. Returns True on success. + Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the *can_restrict_members* admin rights. Returns *True* on success. Source: https://core.telegram.org/bots/api#setchatpermissions - :param chat_id: Unique identifier for the target chat or username of the target supergroup - (in the format @supergroupusername) + :param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`) :param permissions: New default chat permissions :param request_timeout: Request timeout :return: Returns True on success. """ - call = SetChatPermissions(chat_id=chat_id, permissions=permissions,) + call = SetChatPermissions( + chat_id=chat_id, + permissions=permissions, + ) return await self(call, request_timeout=request_timeout) async def export_chat_invite_link( - self, chat_id: Union[int, str], request_timeout: Optional[int] = None, + self, + chat_id: Union[int, str], + request_timeout: Optional[int] = None, ) -> str: """ - Use this method to generate a new invite link for a chat; any previously generated link is - revoked. The bot must be an administrator in the chat for this to work and must have the - appropriate admin rights. Returns the new invite link as String on success. - Note: Each administrator in a chat generates their own invite links. Bots can't use invite - links generated by other administrators. If you want your bot to work with invite links, - it will need to generate its own link using exportChatInviteLink — after this the link - will become available to the bot via the getChat method. If your bot needs to generate a - new invite link replacing its previous one, use exportChatInviteLink again. + Use this method to generate a new invite link for a chat; any previously generated link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the new invite link as *String* on success. + Note: Each administrator in a chat generates their own invite links. Bots can't use invite links generated by other administrators. If you want your bot to work with invite links, it will need to generate its own link using `exportChatInviteLink `_ — after this the link will become available to the bot via the `getChat `_ method. If your bot needs to generate a new invite link replacing its previous one, use `exportChatInviteLink `_ again. Source: https://core.telegram.org/bots/api#exportchatinvitelink - :param chat_id: Unique identifier for the target chat or username of the target channel - (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) :param request_timeout: Request timeout :return: Returns the new invite link as String on success. """ - call = ExportChatInviteLink(chat_id=chat_id,) + call = ExportChatInviteLink( + chat_id=chat_id, + ) return await self(call, request_timeout=request_timeout) async def set_chat_photo( - self, chat_id: Union[int, str], photo: InputFile, request_timeout: Optional[int] = None, + self, + chat_id: Union[int, str], + photo: InputFile, + request_timeout: Optional[int] = None, ) -> bool: """ - Use this method to set a new profile photo for the chat. Photos can't be changed for - private chats. The bot must be an administrator in the chat for this to work and must have - the appropriate admin rights. Returns True on success. + Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns *True* on success. Source: https://core.telegram.org/bots/api#setchatphoto - :param chat_id: Unique identifier for the target chat or username of the target channel - (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) :param photo: New chat photo, uploaded using multipart/form-data :param request_timeout: Request timeout :return: Returns True on success. """ - call = SetChatPhoto(chat_id=chat_id, photo=photo,) + call = SetChatPhoto( + chat_id=chat_id, + photo=photo, + ) return await self(call, request_timeout=request_timeout) async def delete_chat_photo( - self, chat_id: Union[int, str], request_timeout: Optional[int] = None, + self, + chat_id: Union[int, str], + request_timeout: Optional[int] = None, ) -> bool: """ - Use this method to delete a chat photo. Photos can't be changed for private chats. The bot - must be an administrator in the chat for this to work and must have the appropriate admin - rights. Returns True on success. + Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns *True* on success. Source: https://core.telegram.org/bots/api#deletechatphoto - :param chat_id: Unique identifier for the target chat or username of the target channel - (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) :param request_timeout: Request timeout :return: Returns True on success. """ - call = DeleteChatPhoto(chat_id=chat_id,) + call = DeleteChatPhoto( + chat_id=chat_id, + ) return await self(call, request_timeout=request_timeout) async def set_chat_title( - self, chat_id: Union[int, str], title: str, request_timeout: Optional[int] = None, + self, + chat_id: Union[int, str], + title: str, + request_timeout: Optional[int] = None, ) -> bool: """ - Use this method to change the title of a chat. Titles can't be changed for private chats. - The bot must be an administrator in the chat for this to work and must have the - appropriate admin rights. Returns True on success. + Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns *True* on success. Source: https://core.telegram.org/bots/api#setchattitle - :param chat_id: Unique identifier for the target chat or username of the target channel - (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) :param title: New chat title, 1-255 characters :param request_timeout: Request timeout :return: Returns True on success. """ - call = SetChatTitle(chat_id=chat_id, title=title,) + call = SetChatTitle( + chat_id=chat_id, + title=title, + ) return await self(call, request_timeout=request_timeout) async def set_chat_description( @@ -1912,19 +1666,19 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> bool: """ - Use this method to change the description of a group, a supergroup or a channel. The bot - must be an administrator in the chat for this to work and must have the appropriate admin - rights. Returns True on success. + Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns *True* on success. Source: https://core.telegram.org/bots/api#setchatdescription - :param chat_id: Unique identifier for the target chat or username of the target channel - (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) :param description: New chat description, 0-255 characters :param request_timeout: Request timeout :return: Returns True on success. """ - call = SetChatDescription(chat_id=chat_id, description=description,) + call = SetChatDescription( + chat_id=chat_id, + description=description, + ) return await self(call, request_timeout=request_timeout) async def pin_chat_message( @@ -1935,24 +1689,20 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> bool: """ - Use this method to add a message to the list of pinned messages in a chat. If the chat is - not a private chat, the bot must be an administrator in the chat for this to work and must - have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right - in a channel. Returns True on success. + Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns *True* on success. Source: https://core.telegram.org/bots/api#pinchatmessage - :param chat_id: Unique identifier for the target chat or username of the target channel - (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) :param message_id: Identifier of a message to pin - :param disable_notification: Pass True, if it is not necessary to send a notification to - all chat members about the new pinned message. Notifications - are always disabled in channels and private chats. + :param disable_notification: Pass *True*, if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats. :param request_timeout: Request timeout :return: Returns True on success. """ call = PinChatMessage( - chat_id=chat_id, message_id=message_id, disable_notification=disable_notification, + chat_id=chat_id, + message_id=message_id, + disable_notification=disable_notification, ) return await self(call, request_timeout=request_timeout) @@ -1963,131 +1713,139 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> bool: """ - Use this method to remove a message from the list of pinned messages in a chat. If the - chat is not a private chat, the bot must be an administrator in the chat for this to work - and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' - admin right in a channel. Returns True on success. + Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns *True* on success. Source: https://core.telegram.org/bots/api#unpinchatmessage - :param chat_id: Unique identifier for the target chat or username of the target channel - (in the format @channelusername) - :param message_id: Identifier of a message to unpin. If not specified, the most recent - pinned message (by sending date) will be unpinned. + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) + :param message_id: Identifier of a message to unpin. If not specified, the most recent pinned message (by sending date) will be unpinned. :param request_timeout: Request timeout :return: Returns True on success. """ - call = UnpinChatMessage(chat_id=chat_id, message_id=message_id,) + call = UnpinChatMessage( + chat_id=chat_id, + message_id=message_id, + ) return await self(call, request_timeout=request_timeout) async def unpin_all_chat_messages( - self, chat_id: Union[int, str], request_timeout: Optional[int] = None, + self, + chat_id: Union[int, str], + request_timeout: Optional[int] = None, ) -> bool: """ - Use this method to clear the list of pinned messages in a chat. If the chat is not a - private chat, the bot must be an administrator in the chat for this to work and must have - the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a - channel. Returns True on success. + Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns *True* on success. Source: https://core.telegram.org/bots/api#unpinallchatmessages - :param chat_id: Unique identifier for the target chat or username of the target channel - (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) :param request_timeout: Request timeout :return: Returns True on success. """ - call = UnpinAllChatMessages(chat_id=chat_id,) + call = UnpinAllChatMessages( + chat_id=chat_id, + ) return await self(call, request_timeout=request_timeout) async def leave_chat( - self, chat_id: Union[int, str], request_timeout: Optional[int] = None, + self, + chat_id: Union[int, str], + request_timeout: Optional[int] = None, ) -> bool: """ - Use this method for your bot to leave a group, supergroup or channel. Returns True on - success. + Use this method for your bot to leave a group, supergroup or channel. Returns *True* on success. Source: https://core.telegram.org/bots/api#leavechat - :param chat_id: Unique identifier for the target chat or username of the target supergroup - or channel (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target supergroup or channel (in the format :code:`@channelusername`) :param request_timeout: Request timeout :return: Returns True on success. """ - call = LeaveChat(chat_id=chat_id,) + call = LeaveChat( + chat_id=chat_id, + ) return await self(call, request_timeout=request_timeout) async def get_chat( - self, chat_id: Union[int, str], request_timeout: Optional[int] = None, + self, + chat_id: Union[int, str], + request_timeout: Optional[int] = None, ) -> Chat: """ - Use this method to get up to date information about the chat (current name of the user for - one-on-one conversations, current username of a user, group or channel, etc.). Returns a - Chat object on success. + Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). Returns a `Chat `_ object on success. Source: https://core.telegram.org/bots/api#getchat - :param chat_id: Unique identifier for the target chat or username of the target supergroup - or channel (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target supergroup or channel (in the format :code:`@channelusername`) :param request_timeout: Request timeout :return: Returns a Chat object on success. """ - call = GetChat(chat_id=chat_id,) + call = GetChat( + chat_id=chat_id, + ) return await self(call, request_timeout=request_timeout) async def get_chat_administrators( - self, chat_id: Union[int, str], request_timeout: Optional[int] = None, + self, + chat_id: Union[int, str], + request_timeout: Optional[int] = None, ) -> List[ChatMember]: """ - Use this method to get a list of administrators in a chat. On success, returns an Array of - ChatMember objects that contains information about all chat administrators except other - bots. If the chat is a group or a supergroup and no administrators were appointed, only - the creator will be returned. + Use this method to get a list of administrators in a chat. On success, returns an Array of `ChatMember `_ objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned. Source: https://core.telegram.org/bots/api#getchatadministrators - :param chat_id: Unique identifier for the target chat or username of the target supergroup - or channel (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target supergroup or channel (in the format :code:`@channelusername`) :param request_timeout: Request timeout :return: On success, returns an Array of ChatMember objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned. """ - call = GetChatAdministrators(chat_id=chat_id,) + call = GetChatAdministrators( + chat_id=chat_id, + ) return await self(call, request_timeout=request_timeout) async def get_chat_members_count( - self, chat_id: Union[int, str], request_timeout: Optional[int] = None, + self, + chat_id: Union[int, str], + request_timeout: Optional[int] = None, ) -> int: """ - Use this method to get the number of members in a chat. Returns Int on success. + Use this method to get the number of members in a chat. Returns *Int* on success. Source: https://core.telegram.org/bots/api#getchatmemberscount - :param chat_id: Unique identifier for the target chat or username of the target supergroup - or channel (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target supergroup or channel (in the format :code:`@channelusername`) :param request_timeout: Request timeout :return: Returns Int on success. """ - call = GetChatMembersCount(chat_id=chat_id,) + call = GetChatMembersCount( + chat_id=chat_id, + ) return await self(call, request_timeout=request_timeout) async def get_chat_member( - self, chat_id: Union[int, str], user_id: int, request_timeout: Optional[int] = None, + self, + chat_id: Union[int, str], + user_id: int, + request_timeout: Optional[int] = None, ) -> ChatMember: """ - Use this method to get information about a member of a chat. Returns a ChatMember object - on success. + Use this method to get information about a member of a chat. Returns a `ChatMember `_ object on success. Source: https://core.telegram.org/bots/api#getchatmember - :param chat_id: Unique identifier for the target chat or username of the target supergroup - or channel (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target supergroup or channel (in the format :code:`@channelusername`) :param user_id: Unique identifier of the target user :param request_timeout: Request timeout :return: Returns a ChatMember object on success. """ - call = GetChatMember(chat_id=chat_id, user_id=user_id,) + call = GetChatMember( + chat_id=chat_id, + user_id=user_id, + ) return await self(call, request_timeout=request_timeout) async def set_chat_sticker_set( @@ -2097,41 +1855,40 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> bool: """ - Use this method to set a new group sticker set for a supergroup. The bot must be an - administrator in the chat for this to work and must have the appropriate admin rights. Use - the field can_set_sticker_set optionally returned in getChat requests to check if the bot - can use this method. Returns True on success. + Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field *can_set_sticker_set* optionally returned in `getChat `_ requests to check if the bot can use this method. Returns *True* on success. Source: https://core.telegram.org/bots/api#setchatstickerset - :param chat_id: Unique identifier for the target chat or username of the target supergroup - (in the format @supergroupusername) + :param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`) :param sticker_set_name: Name of the sticker set to be set as the group sticker set :param request_timeout: Request timeout :return: Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success. """ - call = SetChatStickerSet(chat_id=chat_id, sticker_set_name=sticker_set_name,) + call = SetChatStickerSet( + chat_id=chat_id, + sticker_set_name=sticker_set_name, + ) return await self(call, request_timeout=request_timeout) async def delete_chat_sticker_set( - self, chat_id: Union[int, str], request_timeout: Optional[int] = None, + self, + chat_id: Union[int, str], + request_timeout: Optional[int] = None, ) -> bool: """ - Use this method to delete a group sticker set from a supergroup. The bot must be an - administrator in the chat for this to work and must have the appropriate admin rights. Use - the field can_set_sticker_set optionally returned in getChat requests to check if the bot - can use this method. Returns True on success. + Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field *can_set_sticker_set* optionally returned in `getChat `_ requests to check if the bot can use this method. Returns *True* on success. Source: https://core.telegram.org/bots/api#deletechatstickerset - :param chat_id: Unique identifier for the target chat or username of the target supergroup - (in the format @supergroupusername) + :param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`) :param request_timeout: Request timeout :return: Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success. """ - call = DeleteChatStickerSet(chat_id=chat_id,) + call = DeleteChatStickerSet( + chat_id=chat_id, + ) return await self(call, request_timeout=request_timeout) async def answer_callback_query( @@ -2144,27 +1901,16 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> bool: """ - Use this method to send answers to callback queries sent from inline keyboards. The answer - will be displayed to the user as a notification at the top of the chat screen or as an - alert. On success, True is returned. - Alternatively, the user can be redirected to the specified Game URL. For this option to - work, you must first create a game for your bot via @Botfather and accept the terms. - Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a - parameter. + Use this method to send answers to callback queries sent from `inline keyboards `_. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, *True* is returned. + Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via `@Botfather `_ and accept the terms. Otherwise, you may use links like :code:`t.me/your_bot?start=XXXX` that open your bot with a parameter. Source: https://core.telegram.org/bots/api#answercallbackquery :param callback_query_id: Unique identifier for the query to be answered - :param text: Text of the notification. If not specified, nothing will be shown to the - user, 0-200 characters - :param show_alert: If true, an alert will be shown by the client instead of a notification - at the top of the chat screen. Defaults to false. - :param url: URL that will be opened by the user's client. If you have created a Game and - accepted the conditions via @Botfather, specify the URL that opens your game — - note that this will only work if the query comes from a callback_game button. - :param cache_time: The maximum amount of time in seconds that the result of the callback - query may be cached client-side. Telegram apps will support caching - starting in version 3.14. Defaults to 0. + :param text: Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters + :param show_alert: If *true*, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to *false*. + :param url: URL that will be opened by the user's client. If you have created a `Game `_ and accepted the conditions via `@Botfather `_, specify the URL that opens your game — note that this will only work if the query comes from a `https://core.telegram.org/bots/api#inlinekeyboardbutton `_*callback_game* button. + :param cache_time: The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0. :param request_timeout: Request timeout :return: On success, True is returned. """ @@ -2178,25 +1924,30 @@ class Bot(ContextInstanceMixin["Bot"]): return await self(call, request_timeout=request_timeout) async def set_my_commands( - self, commands: List[BotCommand], request_timeout: Optional[int] = None, + self, + commands: List[BotCommand], + request_timeout: Optional[int] = None, ) -> bool: """ - Use this method to change the list of the bot's commands. Returns True on success. + Use this method to change the list of the bot's commands. Returns *True* on success. Source: https://core.telegram.org/bots/api#setmycommands - :param commands: A JSON-serialized list of bot commands to be set as the list of the bot's - commands. At most 100 commands can be specified. + :param commands: A JSON-serialized list of bot commands to be set as the list of the bot's commands. At most 100 commands can be specified. :param request_timeout: Request timeout :return: Returns True on success. """ - call = SetMyCommands(commands=commands,) + call = SetMyCommands( + commands=commands, + ) return await self(call, request_timeout=request_timeout) - async def get_my_commands(self, request_timeout: Optional[int] = None,) -> List[BotCommand]: + async def get_my_commands( + self, + request_timeout: Optional[int] = None, + ) -> List[BotCommand]: """ - Use this method to get the current list of the bot's commands. Requires no parameters. - Returns Array of BotCommand on success. + Use this method to get the current list of the bot's commands. Requires no parameters. Returns Array of `BotCommand `_ on success. Source: https://core.telegram.org/bots/api#getmycommands @@ -2224,25 +1975,18 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> Union[Message, bool]: """ - Use this method to edit text and game messages. On success, if the edited message is not - an inline message, the edited Message is returned, otherwise True is returned. + Use this method to edit text and `game `_ messages. On success, if the edited message is not an inline message, the edited `Message `_ is returned, otherwise *True* is returned. Source: https://core.telegram.org/bots/api#editmessagetext :param text: New text of the message, 1-4096 characters after entities parsing - :param chat_id: Required if inline_message_id is not specified. Unique identifier for the - target chat or username of the target channel (in the format - @channelusername) - :param message_id: Required if inline_message_id is not specified. Identifier of the - message to edit - :param inline_message_id: Required if chat_id and message_id are not specified. Identifier - of the inline message - :param parse_mode: Mode for parsing entities in the message text. See formatting options - for more details. - :param entities: List of special entities that appear in message text, which can be - specified instead of parse_mode + :param chat_id: Required if *inline_message_id* is not specified. Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) + :param message_id: Required if *inline_message_id* is not specified. Identifier of the message to edit + :param inline_message_id: Required if *chat_id* and *message_id* are not specified. Identifier of the inline message + :param parse_mode: Mode for parsing entities in the message text. See `formatting options `_ for more details. + :param entities: List of special entities that appear in message text, which can be specified instead of *parse_mode* :param disable_web_page_preview: Disables link previews for links in this message - :param reply_markup: A JSON-serialized object for an inline keyboard. + :param reply_markup: A JSON-serialized object for an `inline keyboard `_. :param request_timeout: Request timeout :return: On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. @@ -2271,24 +2015,17 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> Union[Message, bool]: """ - Use this method to edit captions of messages. On success, if the edited message is not an - inline message, the edited Message is returned, otherwise True is returned. + Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited `Message `_ is returned, otherwise *True* is returned. Source: https://core.telegram.org/bots/api#editmessagecaption - :param chat_id: Required if inline_message_id is not specified. Unique identifier for the - target chat or username of the target channel (in the format - @channelusername) - :param message_id: Required if inline_message_id is not specified. Identifier of the - message to edit - :param inline_message_id: Required if chat_id and message_id are not specified. Identifier - of the inline message + :param chat_id: Required if *inline_message_id* is not specified. Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) + :param message_id: Required if *inline_message_id* is not specified. Identifier of the message to edit + :param inline_message_id: Required if *chat_id* and *message_id* are not specified. Identifier of the inline message :param caption: New caption of the message, 0-1024 characters after entities parsing - :param parse_mode: Mode for parsing entities in the message caption. See formatting - options for more details. - :param caption_entities: List of special entities that appear in the caption, which can be - specified instead of parse_mode - :param reply_markup: A JSON-serialized object for an inline keyboard. + :param parse_mode: Mode for parsing entities in the message caption. See `formatting options `_ for more details. + :param caption_entities: List of special entities that appear in the caption, which can be specified instead of *parse_mode* + :param reply_markup: A JSON-serialized object for an `inline keyboard `_. :param request_timeout: Request timeout :return: On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. @@ -2314,24 +2051,15 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> Union[Message, bool]: """ - Use this method to edit animation, audio, document, photo, or video messages. If a message - is part of a message album, then it can be edited only to an audio for audio albums, only - to a document for document albums and to a photo or a video otherwise. When an inline - message is edited, a new file can't be uploaded. Use a previously uploaded file via its - file_id or specify a URL. On success, if the edited message was sent by the bot, the - edited Message is returned, otherwise True is returned. + Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded. Use a previously uploaded file via its file_id or specify a URL. On success, if the edited message was sent by the bot, the edited `Message `_ is returned, otherwise *True* is returned. Source: https://core.telegram.org/bots/api#editmessagemedia :param media: A JSON-serialized object for a new media content of the message - :param chat_id: Required if inline_message_id is not specified. Unique identifier for the - target chat or username of the target channel (in the format - @channelusername) - :param message_id: Required if inline_message_id is not specified. Identifier of the - message to edit - :param inline_message_id: Required if chat_id and message_id are not specified. Identifier - of the inline message - :param reply_markup: A JSON-serialized object for a new inline keyboard. + :param chat_id: Required if *inline_message_id* is not specified. Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) + :param message_id: Required if *inline_message_id* is not specified. Identifier of the message to edit + :param inline_message_id: Required if *chat_id* and *message_id* are not specified. Identifier of the inline message + :param reply_markup: A JSON-serialized object for a new `inline keyboard `_. :param request_timeout: Request timeout :return: On success, if the edited message was sent by the bot, the edited Message is returned, otherwise True is returned. @@ -2354,20 +2082,14 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> Union[Message, bool]: """ - Use this method to edit only the reply markup of messages. On success, if the edited - message is not an inline message, the edited Message is returned, otherwise True is - returned. + Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited `Message `_ is returned, otherwise *True* is returned. Source: https://core.telegram.org/bots/api#editmessagereplymarkup - :param chat_id: Required if inline_message_id is not specified. Unique identifier for the - target chat or username of the target channel (in the format - @channelusername) - :param message_id: Required if inline_message_id is not specified. Identifier of the - message to edit - :param inline_message_id: Required if chat_id and message_id are not specified. Identifier - of the inline message - :param reply_markup: A JSON-serialized object for an inline keyboard. + :param chat_id: Required if *inline_message_id* is not specified. Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) + :param message_id: Required if *inline_message_id* is not specified. Identifier of the message to edit + :param inline_message_id: Required if *chat_id* and *message_id* are not specified. Identifier of the inline message + :param reply_markup: A JSON-serialized object for an `inline keyboard `_. :param request_timeout: Request timeout :return: On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. @@ -2388,47 +2110,59 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> Poll: """ - Use this method to stop a poll which was sent by the bot. On success, the stopped Poll - with the final results is returned. + Use this method to stop a poll which was sent by the bot. On success, the stopped `Poll `_ with the final results is returned. Source: https://core.telegram.org/bots/api#stoppoll - :param chat_id: Unique identifier for the target chat or username of the target channel - (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) :param message_id: Identifier of the original message with the poll - :param reply_markup: A JSON-serialized object for a new message inline keyboard. + :param reply_markup: A JSON-serialized object for a new message `inline keyboard `_. :param request_timeout: Request timeout :return: On success, the stopped Poll with the final results is returned. """ - call = StopPoll(chat_id=chat_id, message_id=message_id, reply_markup=reply_markup,) + call = StopPoll( + chat_id=chat_id, + message_id=message_id, + reply_markup=reply_markup, + ) return await self(call, request_timeout=request_timeout) async def delete_message( - self, chat_id: Union[int, str], message_id: int, request_timeout: Optional[int] = None, + self, + chat_id: Union[int, str], + message_id: int, + request_timeout: Optional[int] = None, ) -> bool: """ - Use this method to delete a message, including service messages, with the following - limitations: + Use this method to delete a message, including service messages, with the following limitations: + - A message can only be deleted if it was sent less than 48 hours ago. - - A dice message in a private chat can only be deleted if it was sent more than 24 hours - ago. + + - A dice message in a private chat can only be deleted if it was sent more than 24 hours ago. + - Bots can delete outgoing messages in private chats, groups, and supergroups. + - Bots can delete incoming messages in private chats. - - Bots granted can_post_messages permissions can delete outgoing messages in channels. + + - Bots granted *can_post_messages* permissions can delete outgoing messages in channels. + - If the bot is an administrator of a group, it can delete any message there. - - If the bot has can_delete_messages permission in a supergroup or a channel, it can - delete any message there. - Returns True on success. + + - If the bot has *can_delete_messages* permission in a supergroup or a channel, it can delete any message there. + + Returns *True* on success. Source: https://core.telegram.org/bots/api#deletemessage - :param chat_id: Unique identifier for the target chat or username of the target channel - (in the format @channelusername) + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) :param message_id: Identifier of the message to delete :param request_timeout: Request timeout :return: Returns True on success. """ - call = DeleteMessage(chat_id=chat_id, message_id=message_id,) + call = DeleteMessage( + chat_id=chat_id, + message_id=message_id, + ) return await self(call, request_timeout=request_timeout) # ============================================================================================= @@ -2449,25 +2183,16 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> Message: """ - Use this method to send static .WEBP or animated .TGS stickers. On success, the sent - Message is returned. + Use this method to send static .WEBP or `animated `_ .TGS stickers. On success, the sent `Message `_ is returned. Source: https://core.telegram.org/bots/api#sendsticker - :param chat_id: Unique identifier for the target chat or username of the target channel - (in the format @channelusername) - :param sticker: Sticker to send. Pass a file_id as String to send a file that exists on - the Telegram servers (recommended), pass an HTTP URL as a String for - Telegram to get a .WEBP file from the Internet, or upload a new one using - multipart/form-data. - :param disable_notification: Sends the message silently. Users will receive a notification - with no sound. + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`) + :param sticker: Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP file from the Internet, or upload a new one using multipart/form-data. `More info on Sending Files » `_ + :param disable_notification: Sends the message `silently `_. Users will receive a notification with no sound. :param reply_to_message_id: If the message is a reply, ID of the original message - :param allow_sending_without_reply: Pass True, if the message should be sent even if the - specified replied-to message is not found - :param reply_markup: Additional interface options. A JSON-serialized object for an inline - keyboard, custom reply keyboard, instructions to remove reply - keyboard or to force a reply from the user. + :param allow_sending_without_reply: Pass *True*, if the message should be sent even if the specified replied-to message is not found + :param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove reply keyboard or to force a reply from the user. :param request_timeout: Request timeout :return: On success, the sent Message is returned. """ @@ -2482,10 +2207,12 @@ class Bot(ContextInstanceMixin["Bot"]): return await self(call, request_timeout=request_timeout) async def get_sticker_set( - self, name: str, request_timeout: Optional[int] = None, + self, + name: str, + request_timeout: Optional[int] = None, ) -> StickerSet: """ - Use this method to get a sticker set. On success, a StickerSet object is returned. + Use this method to get a sticker set. On success, a `StickerSet `_ object is returned. Source: https://core.telegram.org/bots/api#getstickerset @@ -2493,27 +2220,31 @@ class Bot(ContextInstanceMixin["Bot"]): :param request_timeout: Request timeout :return: On success, a StickerSet object is returned. """ - call = GetStickerSet(name=name,) + call = GetStickerSet( + name=name, + ) return await self(call, request_timeout=request_timeout) async def upload_sticker_file( - self, user_id: int, png_sticker: InputFile, request_timeout: Optional[int] = None, + self, + user_id: int, + png_sticker: InputFile, + request_timeout: Optional[int] = None, ) -> File: """ - Use this method to upload a .PNG file with a sticker for later use in createNewStickerSet - and addStickerToSet methods (can be used multiple times). Returns the uploaded File on - success. + Use this method to upload a .PNG file with a sticker for later use in *createNewStickerSet* and *addStickerToSet* methods (can be used multiple times). Returns the uploaded `File `_ on success. Source: https://core.telegram.org/bots/api#uploadstickerfile :param user_id: User identifier of sticker file owner - :param png_sticker: PNG image with the sticker, must be up to 512 kilobytes in size, - dimensions must not exceed 512px, and either width or height must be - exactly 512px. + :param png_sticker: **PNG** image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. `More info on Sending Files » `_ :param request_timeout: Request timeout :return: Returns the uploaded File on success. """ - call = UploadStickerFile(user_id=user_id, png_sticker=png_sticker,) + call = UploadStickerFile( + user_id=user_id, + png_sticker=png_sticker, + ) return await self(call, request_timeout=request_timeout) async def create_new_sticker_set( @@ -2529,31 +2260,18 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> bool: """ - Use this method to create a new sticker set owned by a user. The bot will be able to edit - the sticker set thus created. You must use exactly one of the fields png_sticker or - tgs_sticker. Returns True on success. + Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. You **must** use exactly one of the fields *png_sticker* or *tgs_sticker*. Returns *True* on success. Source: https://core.telegram.org/bots/api#createnewstickerset :param user_id: User identifier of created sticker set owner - :param name: Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., - animals). Can contain only english letters, digits and underscores. Must - begin with a letter, can't contain consecutive underscores and must end in - '_by_'. is case insensitive. 1-64 characters. + :param name: Short name of sticker set, to be used in :code:`t.me/addstickers/` URLs (e.g., *animals*). Can contain only english letters, digits and underscores. Must begin with a letter, can't contain consecutive underscores and must end in *“_by_”*. ** is case insensitive. 1-64 characters. :param title: Sticker set title, 1-64 characters :param emojis: One or more emoji corresponding to the sticker - :param png_sticker: PNG image with the sticker, must be up to 512 kilobytes in size, - dimensions must not exceed 512px, and either width or height must be - exactly 512px. Pass a file_id as a String to send a file that already - exists on the Telegram servers, pass an HTTP URL as a String for - Telegram to get a file from the Internet, or upload a new one using - multipart/form-data. - :param tgs_sticker: TGS animation with the sticker, uploaded using multipart/form-data. - See https://core.telegram.org/animated_stickers#technical-requirements - for technical requirements - :param contains_masks: Pass True, if a set of mask stickers should be created - :param mask_position: A JSON-serialized object for position where the mask should be - placed on faces + :param png_sticker: **PNG** image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. Pass a *file_id* as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. `More info on Sending Files » `_ + :param tgs_sticker: **TGS** animation with the sticker, uploaded using multipart/form-data. See `https://core.telegram.org/animated_stickers#technical-requirements `_`https://core.telegram.org/animated_stickers#technical-requirements `_ for technical requirements + :param contains_masks: Pass *True*, if a set of mask stickers should be created + :param mask_position: A JSON-serialized object for position where the mask should be placed on faces :param request_timeout: Request timeout :return: Returns True on success. """ @@ -2580,27 +2298,16 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> bool: """ - Use this method to add a new sticker to a set created by the bot. You must use exactly one - of the fields png_sticker or tgs_sticker. Animated stickers can be added to animated - sticker sets and only to them. Animated sticker sets can have up to 50 stickers. Static - sticker sets can have up to 120 stickers. Returns True on success. + Use this method to add a new sticker to a set created by the bot. You **must** use exactly one of the fields *png_sticker* or *tgs_sticker*. Animated stickers can be added to animated sticker sets and only to them. Animated sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns *True* on success. Source: https://core.telegram.org/bots/api#addstickertoset :param user_id: User identifier of sticker set owner :param name: Sticker set name :param emojis: One or more emoji corresponding to the sticker - :param png_sticker: PNG image with the sticker, must be up to 512 kilobytes in size, - dimensions must not exceed 512px, and either width or height must be - exactly 512px. Pass a file_id as a String to send a file that already - exists on the Telegram servers, pass an HTTP URL as a String for - Telegram to get a file from the Internet, or upload a new one using - multipart/form-data. - :param tgs_sticker: TGS animation with the sticker, uploaded using multipart/form-data. - See https://core.telegram.org/animated_stickers#technical-requirements - for technical requirements - :param mask_position: A JSON-serialized object for position where the mask should be - placed on faces + :param png_sticker: **PNG** image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. Pass a *file_id* as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. `More info on Sending Files » `_ + :param tgs_sticker: **TGS** animation with the sticker, uploaded using multipart/form-data. See `https://core.telegram.org/animated_stickers#technical-requirements `_`https://core.telegram.org/animated_stickers#technical-requirements `_ for technical requirements + :param mask_position: A JSON-serialized object for position where the mask should be placed on faces :param request_timeout: Request timeout :return: Returns True on success. """ @@ -2615,11 +2322,13 @@ class Bot(ContextInstanceMixin["Bot"]): return await self(call, request_timeout=request_timeout) async def set_sticker_position_in_set( - self, sticker: str, position: int, request_timeout: Optional[int] = None, + self, + sticker: str, + position: int, + request_timeout: Optional[int] = None, ) -> bool: """ - Use this method to move a sticker in a set created by the bot to a specific position. - Returns True on success. + Use this method to move a sticker in a set created by the bot to a specific position. Returns *True* on success. Source: https://core.telegram.org/bots/api#setstickerpositioninset @@ -2628,15 +2337,19 @@ class Bot(ContextInstanceMixin["Bot"]): :param request_timeout: Request timeout :return: Returns True on success. """ - call = SetStickerPositionInSet(sticker=sticker, position=position,) + call = SetStickerPositionInSet( + sticker=sticker, + position=position, + ) return await self(call, request_timeout=request_timeout) async def delete_sticker_from_set( - self, sticker: str, request_timeout: Optional[int] = None, + self, + sticker: str, + request_timeout: Optional[int] = None, ) -> bool: """ - Use this method to delete a sticker from a set created by the bot. Returns True on - success. + Use this method to delete a sticker from a set created by the bot. Returns *True* on success. Source: https://core.telegram.org/bots/api#deletestickerfromset @@ -2644,7 +2357,9 @@ class Bot(ContextInstanceMixin["Bot"]): :param request_timeout: Request timeout :return: Returns True on success. """ - call = DeleteStickerFromSet(sticker=sticker,) + call = DeleteStickerFromSet( + sticker=sticker, + ) return await self(call, request_timeout=request_timeout) async def set_sticker_set_thumb( @@ -2655,26 +2370,21 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> bool: """ - Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for - animated sticker sets only. Returns True on success. + Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Returns *True* on success. Source: https://core.telegram.org/bots/api#setstickersetthumb :param name: Sticker set name :param user_id: User identifier of the sticker set owner - :param thumb: A PNG image with the thumbnail, must be up to 128 kilobytes in size and have - width and height exactly 100px, or a TGS animation with the thumbnail up to - 32 kilobytes in size; see - https://core.telegram.org/animated_stickers#technical-requirements for - animated sticker technical requirements. Pass a file_id as a String to send - a file that already exists on the Telegram servers, pass an HTTP URL as a - String for Telegram to get a file from the Internet, or upload a new one - using multipart/form-data.. Animated sticker set thumbnail can't be uploaded - via HTTP URL. + :param thumb: A **PNG** image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a **TGS** animation with the thumbnail up to 32 kilobytes in size; see `https://core.telegram.org/animated_stickers#technical-requirements `_`https://core.telegram.org/animated_stickers#technical-requirements `_ for animated sticker technical requirements. Pass a *file_id* as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. `More info on Sending Files » `_. Animated sticker set thumbnail can't be uploaded via HTTP URL. :param request_timeout: Request timeout :return: Returns True on success. """ - call = SetStickerSetThumb(name=name, user_id=user_id, thumb=thumb,) + call = SetStickerSetThumb( + name=name, + user_id=user_id, + thumb=thumb, + ) return await self(call, request_timeout=request_timeout) # ============================================================================================= @@ -2694,28 +2404,19 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> bool: """ - Use this method to send answers to an inline query. On success, True is returned. - No more than 50 results per query are allowed. + Use this method to send answers to an inline query. On success, *True* is returned. + + No more than **50** results per query are allowed. Source: https://core.telegram.org/bots/api#answerinlinequery :param inline_query_id: Unique identifier for the answered query :param results: A JSON-serialized array of results for the inline query - :param cache_time: The maximum amount of time in seconds that the result of the inline - query may be cached on the server. Defaults to 300. - :param is_personal: Pass True, if results may be cached on the server side only for the - user that sent the query. By default, results may be returned to any - user who sends the same query - :param next_offset: Pass the offset that a client should send in the next query with the - same text to receive more results. Pass an empty string if there are - no more results or if you don't support pagination. Offset length - can't exceed 64 bytes. - :param switch_pm_text: If passed, clients will display a button with specified text that - switches the user to a private chat with the bot and sends the bot - a start message with the parameter switch_pm_parameter - :param switch_pm_parameter: Deep-linking parameter for the /start message sent to the bot - when user presses the switch button. 1-64 characters, only - A-Z, a-z, 0-9, _ and - are allowed. + :param cache_time: The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300. + :param is_personal: Pass *True*, if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query + :param next_offset: Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don't support pagination. Offset length can't exceed 64 bytes. + :param switch_pm_text: If passed, clients will display a button with specified text that switches the user to a private chat with the bot and sends the bot a start message with the parameter *switch_pm_parameter* + :param switch_pm_parameter: `Deep-linking `_ parameter for the /start message sent to the bot when user presses the switch button. 1-64 characters, only :code:`A-Z`, :code:`a-z`, :code:`0-9`, :code:`_` and :code:`-` are allowed. :param request_timeout: Request timeout :return: On success, True is returned. """ @@ -2764,50 +2465,34 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> Message: """ - Use this method to send invoices. On success, the sent Message is returned. + Use this method to send invoices. On success, the sent `Message `_ is returned. Source: https://core.telegram.org/bots/api#sendinvoice :param chat_id: Unique identifier for the target private chat :param title: Product name, 1-32 characters :param description: Product description, 1-255 characters - :param payload: Bot-defined invoice payload, 1-128 bytes. This will not be displayed to - the user, use for your internal processes. - :param provider_token: Payments provider token, obtained via Botfather - :param start_parameter: Unique deep-linking parameter that can be used to generate this - invoice when used as a start parameter - :param currency: Three-letter ISO 4217 currency code, see more on currencies - :param prices: Price breakdown, a JSON-serialized list of components (e.g. product price, - tax, discount, delivery cost, delivery tax, bonus, etc.) - :param provider_data: A JSON-serialized data about the invoice, which will be shared with - the payment provider. A detailed description of required fields - should be provided by the payment provider. - :param photo_url: URL of the product photo for the invoice. Can be a photo of the goods or - a marketing image for a service. People like it better when they see - what they are paying for. + :param payload: Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. + :param provider_token: Payments provider token, obtained via `Botfather `_ + :param start_parameter: Unique deep-linking parameter that can be used to generate this invoice when used as a start parameter + :param currency: Three-letter ISO 4217 currency code, see `more on currencies `_ + :param prices: Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.) + :param provider_data: A JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider. + :param photo_url: URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for. :param photo_size: Photo size :param photo_width: Photo width :param photo_height: Photo height - :param need_name: Pass True, if you require the user's full name to complete the order - :param need_phone_number: Pass True, if you require the user's phone number to complete - the order - :param need_email: Pass True, if you require the user's email address to complete the - order - :param need_shipping_address: Pass True, if you require the user's shipping address to - complete the order - :param send_phone_number_to_provider: Pass True, if user's phone number should be sent to - provider - :param send_email_to_provider: Pass True, if user's email address should be sent to - provider - :param is_flexible: Pass True, if the final price depends on the shipping method - :param disable_notification: Sends the message silently. Users will receive a notification - with no sound. + :param need_name: Pass *True*, if you require the user's full name to complete the order + :param need_phone_number: Pass *True*, if you require the user's phone number to complete the order + :param need_email: Pass *True*, if you require the user's email address to complete the order + :param need_shipping_address: Pass *True*, if you require the user's shipping address to complete the order + :param send_phone_number_to_provider: Pass *True*, if user's phone number should be sent to provider + :param send_email_to_provider: Pass *True*, if user's email address should be sent to provider + :param is_flexible: Pass *True*, if the final price depends on the shipping method + :param disable_notification: Sends the message `silently `_. Users will receive a notification with no sound. :param reply_to_message_id: If the message is a reply, ID of the original message - :param allow_sending_without_reply: Pass True, if the message should be sent even if the - specified replied-to message is not found - :param reply_markup: A JSON-serialized object for an inline keyboard. If empty, one 'Pay - total price' button will be shown. If not empty, the first button - must be a Pay button. + :param allow_sending_without_reply: Pass *True*, if the message should be sent even if the specified replied-to message is not found + :param reply_markup: A JSON-serialized object for an `inline keyboard `_. If empty, one 'Pay :code:`total price`' button will be shown. If not empty, the first button must be a Pay button. :param request_timeout: Request timeout :return: On success, the sent Message is returned. """ @@ -2848,22 +2533,14 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> bool: """ - If you sent an invoice requesting a shipping address and the parameter is_flexible was - specified, the Bot API will send an Update with a shipping_query field to the bot. Use - this method to reply to shipping queries. On success, True is returned. + If you sent an invoice requesting a shipping address and the parameter *is_flexible* was specified, the Bot API will send an `Update `_ with a *shipping_query* field to the bot. Use this method to reply to shipping queries. On success, True is returned. Source: https://core.telegram.org/bots/api#answershippingquery :param shipping_query_id: Unique identifier for the query to be answered - :param ok: Specify True if delivery to the specified address is possible and False if - there are any problems (for example, if delivery to the specified address is - not possible) - :param shipping_options: Required if ok is True. A JSON-serialized array of available - shipping options. - :param error_message: Required if ok is False. Error message in human readable form that - explains why it is impossible to complete the order (e.g. "Sorry, - delivery to your desired address is unavailable'). Telegram will - display this message to the user. + :param ok: Specify True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible) + :param shipping_options: Required if *ok* is True. A JSON-serialized array of available shipping options. + :param error_message: Required if *ok* is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. "Sorry, delivery to your desired address is unavailable'). Telegram will display this message to the user. :param request_timeout: Request timeout :return: On success, True is returned. """ @@ -2883,27 +2560,20 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> bool: """ - Once the user has confirmed their payment and shipping details, the Bot API sends the - final confirmation in the form of an Update with the field pre_checkout_query. Use this - method to respond to such pre-checkout queries. On success, True is returned. Note: The - Bot API must receive an answer within 10 seconds after the pre-checkout query was sent. + Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an `Update `_ with the field *pre_checkout_query*. Use this method to respond to such pre-checkout queries. On success, True is returned. **Note:** The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent. Source: https://core.telegram.org/bots/api#answerprecheckoutquery :param pre_checkout_query_id: Unique identifier for the query to be answered - :param ok: Specify True if everything is alright (goods are available, etc.) and the bot - is ready to proceed with the order. Use False if there are any problems. - :param error_message: Required if ok is False. Error message in human readable form that - explains the reason for failure to proceed with the checkout (e.g. - "Sorry, somebody just bought the last of our amazing black T-shirts - while you were busy filling out your payment details. Please choose - a different color or garment!"). Telegram will display this message - to the user. + :param ok: Specify *True* if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use *False* if there are any problems. + :param error_message: Required if *ok* is *False*. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!"). Telegram will display this message to the user. :param request_timeout: Request timeout :return: On success, True is returned. """ call = AnswerPreCheckoutQuery( - pre_checkout_query_id=pre_checkout_query_id, ok=ok, error_message=error_message, + pre_checkout_query_id=pre_checkout_query_id, + ok=ok, + error_message=error_message, ) return await self(call, request_timeout=request_timeout) @@ -2919,14 +2589,8 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> bool: """ - Informs a user that some of the Telegram Passport elements they provided contains errors. - The user will not be able to re-submit their Passport to you until the errors are fixed - (the contents of the field for which you returned the error must change). Returns True on - success. - Use this if the data submitted by the user doesn't satisfy the standards your service - requires for any reason. For example, if a birthday date seems invalid, a submitted - document is blurry, a scan shows evidence of tampering, etc. Supply some details in the - error message to make sure the user knows how to correct the issues. + Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns *True* on success. + Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues. Source: https://core.telegram.org/bots/api#setpassportdataerrors @@ -2937,7 +2601,10 @@ class Bot(ContextInstanceMixin["Bot"]): fixed (the contents of the field for which you returned the error must change). Returns True on success. """ - call = SetPassportDataErrors(user_id=user_id, errors=errors,) + call = SetPassportDataErrors( + user_id=user_id, + errors=errors, + ) return await self(call, request_timeout=request_timeout) # ============================================================================================= @@ -2956,21 +2623,16 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> Message: """ - Use this method to send a game. On success, the sent Message is returned. + Use this method to send a game. On success, the sent `Message `_ is returned. Source: https://core.telegram.org/bots/api#sendgame :param chat_id: Unique identifier for the target chat - :param game_short_name: Short name of the game, serves as the unique identifier for the - game. Set up your games via Botfather. - :param disable_notification: Sends the message silently. Users will receive a notification - with no sound. + :param game_short_name: Short name of the game, serves as the unique identifier for the game. Set up your games via `Botfather `_. + :param disable_notification: Sends the message `silently `_. Users will receive a notification with no sound. :param reply_to_message_id: If the message is a reply, ID of the original message - :param allow_sending_without_reply: Pass True, if the message should be sent even if the - specified replied-to message is not found - :param reply_markup: A JSON-serialized object for an inline keyboard. If empty, one 'Play - game_title' button will be shown. If not empty, the first button must - launch the game. + :param allow_sending_without_reply: Pass *True*, if the message should be sent even if the specified replied-to message is not found + :param reply_markup: A JSON-serialized object for an `inline keyboard `_. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game. :param request_timeout: Request timeout :return: On success, the sent Message is returned. """ @@ -2996,25 +2658,17 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> Union[Message, bool]: """ - Use this method to set the score of the specified user in a game. On success, if the - message was sent by the bot, returns the edited Message, otherwise returns True. Returns - an error, if the new score is not greater than the user's current score in the chat and - force is False. + Use this method to set the score of the specified user in a game. On success, if the message was sent by the bot, returns the edited `Message `_, otherwise returns *True*. Returns an error, if the new score is not greater than the user's current score in the chat and *force* is *False*. Source: https://core.telegram.org/bots/api#setgamescore :param user_id: User identifier :param score: New score, must be non-negative - :param force: Pass True, if the high score is allowed to decrease. This can be useful when - fixing mistakes or banning cheaters - :param disable_edit_message: Pass True, if the game message should not be automatically - edited to include the current scoreboard - :param chat_id: Required if inline_message_id is not specified. Unique identifier for the - target chat - :param message_id: Required if inline_message_id is not specified. Identifier of the sent - message - :param inline_message_id: Required if chat_id and message_id are not specified. Identifier - of the inline message + :param force: Pass True, if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters + :param disable_edit_message: Pass True, if the game message should not be automatically edited to include the current scoreboard + :param chat_id: Required if *inline_message_id* is not specified. Unique identifier for the target chat + :param message_id: Required if *inline_message_id* is not specified. Identifier of the sent message + :param inline_message_id: Required if *chat_id* and *message_id* are not specified. Identifier of the inline message :param request_timeout: Request timeout :return: On success, if the message was sent by the bot, returns the edited Message, otherwise returns True. Returns an error, if the new score is not greater than @@ -3040,22 +2694,15 @@ class Bot(ContextInstanceMixin["Bot"]): request_timeout: Optional[int] = None, ) -> List[GameHighScore]: """ - Use this method to get data for high score tables. Will return the score of the specified - user and several of their neighbors in a game. On success, returns an Array of - GameHighScore objects. - This method will currently return scores for the target user, plus two of their closest - neighbors on each side. Will also return the top three users if the user and his neighbors - are not among them. Please note that this behavior is subject to change. + Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. On success, returns an *Array* of `GameHighScore `_ objects. + This method will currently return scores for the target user, plus two of their closest neighbors on each side. Will also return the top three users if the user and his neighbors are not among them. Please note that this behavior is subject to change. Source: https://core.telegram.org/bots/api#getgamehighscores :param user_id: Target user id - :param chat_id: Required if inline_message_id is not specified. Unique identifier for the - target chat - :param message_id: Required if inline_message_id is not specified. Identifier of the sent - message - :param inline_message_id: Required if chat_id and message_id are not specified. Identifier - of the inline message + :param chat_id: Required if *inline_message_id* is not specified. Unique identifier for the target chat + :param message_id: Required if *inline_message_id* is not specified. Identifier of the sent message + :param inline_message_id: Required if *chat_id* and *message_id* are not specified. Identifier of the inline message :param request_timeout: Request timeout :return: Will return the score of the specified user and several of their neighbors in a game. On success, returns an Array of GameHighScore objects. This method will diff --git a/aiogram/methods/add_sticker_to_set.py b/aiogram/methods/add_sticker_to_set.py index 735371e4..b31f2cb2 100644 --- a/aiogram/methods/add_sticker_to_set.py +++ b/aiogram/methods/add_sticker_to_set.py @@ -11,10 +11,7 @@ if TYPE_CHECKING: # pragma: no cover class AddStickerToSet(TelegramMethod[bool]): """ - Use this method to add a new sticker to a set created by the bot. You must use exactly one of - the fields png_sticker or tgs_sticker. Animated stickers can be added to animated sticker sets - and only to them. Animated sticker sets can have up to 50 stickers. Static sticker sets can - have up to 120 stickers. Returns True on success. + Use this method to add a new sticker to a set created by the bot. You **must** use exactly one of the fields *png_sticker* or *tgs_sticker*. Animated stickers can be added to animated sticker sets and only to them. Animated sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns *True* on success. Source: https://core.telegram.org/bots/api#addstickertoset """ @@ -28,14 +25,9 @@ class AddStickerToSet(TelegramMethod[bool]): emojis: str """One or more emoji corresponding to the sticker""" png_sticker: Optional[Union[InputFile, str]] = None - """PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed - 512px, and either width or height must be exactly 512px. Pass a file_id as a String to send - a file that already exists on the Telegram servers, pass an HTTP URL as a String for - Telegram to get a file from the Internet, or upload a new one using multipart/form-data.""" + """**PNG** image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. Pass a *file_id* as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. `More info on Sending Files » `_""" tgs_sticker: Optional[InputFile] = None - """TGS animation with the sticker, uploaded using multipart/form-data. See - https://core.telegram.org/animated_stickers#technical-requirements for technical - requirements""" + """**TGS** animation with the sticker, uploaded using multipart/form-data. See `https://core.telegram.org/animated_stickers#technical-requirements `_`https://core.telegram.org/animated_stickers#technical-requirements `_ for technical requirements""" mask_position: Optional[MaskPosition] = None """A JSON-serialized object for position where the mask should be placed on faces""" diff --git a/aiogram/methods/answer_callback_query.py b/aiogram/methods/answer_callback_query.py index 1f407c70..f3ac688b 100644 --- a/aiogram/methods/answer_callback_query.py +++ b/aiogram/methods/answer_callback_query.py @@ -10,12 +10,8 @@ if TYPE_CHECKING: # pragma: no cover class AnswerCallbackQuery(TelegramMethod[bool]): """ - Use this method to send answers to callback queries sent from inline keyboards. The answer - will be displayed to the user as a notification at the top of the chat screen or as an alert. - On success, True is returned. - Alternatively, the user can be redirected to the specified Game URL. For this option to work, - you must first create a game for your bot via @Botfather and accept the terms. Otherwise, you - may use links like t.me/your_bot?start=XXXX that open your bot with a parameter. + Use this method to send answers to callback queries sent from `inline keyboards `_. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, *True* is returned. + Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via `@Botfather `_ and accept the terms. Otherwise, you may use links like :code:`t.me/your_bot?start=XXXX` that open your bot with a parameter. Source: https://core.telegram.org/bots/api#answercallbackquery """ @@ -25,18 +21,13 @@ class AnswerCallbackQuery(TelegramMethod[bool]): callback_query_id: str """Unique identifier for the query to be answered""" text: Optional[str] = None - """Text of the notification. If not specified, nothing will be shown to the user, 0-200 - characters""" + """Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters""" show_alert: Optional[bool] = None - """If true, an alert will be shown by the client instead of a notification at the top of the - chat screen. Defaults to false.""" + """If *true*, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to *false*.""" url: Optional[str] = None - """URL that will be opened by the user's client. If you have created a Game and accepted the - conditions via @Botfather, specify the URL that opens your game — note that this will only - work if the query comes from a callback_game button.""" + """URL that will be opened by the user's client. If you have created a `Game `_ and accepted the conditions via `@Botfather `_, specify the URL that opens your game — note that this will only work if the query comes from a `https://core.telegram.org/bots/api#inlinekeyboardbutton `_*callback_game* button.""" cache_time: Optional[int] = None - """The maximum amount of time in seconds that the result of the callback query may be cached - client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0.""" + """The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/answer_inline_query.py b/aiogram/methods/answer_inline_query.py index c5c2709d..2d7e085d 100644 --- a/aiogram/methods/answer_inline_query.py +++ b/aiogram/methods/answer_inline_query.py @@ -11,8 +11,9 @@ if TYPE_CHECKING: # pragma: no cover class AnswerInlineQuery(TelegramMethod[bool]): """ - Use this method to send answers to an inline query. On success, True is returned. - No more than 50 results per query are allowed. + Use this method to send answers to an inline query. On success, *True* is returned. + + No more than **50** results per query are allowed. Source: https://core.telegram.org/bots/api#answerinlinequery """ @@ -24,22 +25,15 @@ class AnswerInlineQuery(TelegramMethod[bool]): results: List[InlineQueryResult] """A JSON-serialized array of results for the inline query""" cache_time: Optional[int] = None - """The maximum amount of time in seconds that the result of the inline query may be cached on - the server. Defaults to 300.""" + """The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300.""" is_personal: Optional[bool] = None - """Pass True, if results may be cached on the server side only for the user that sent the - query. By default, results may be returned to any user who sends the same query""" + """Pass *True*, if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query""" next_offset: Optional[str] = None - """Pass the offset that a client should send in the next query with the same text to receive - more results. Pass an empty string if there are no more results or if you don't support - pagination. Offset length can't exceed 64 bytes.""" + """Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don't support pagination. Offset length can't exceed 64 bytes.""" switch_pm_text: Optional[str] = None - """If passed, clients will display a button with specified text that switches the user to a - private chat with the bot and sends the bot a start message with the parameter - switch_pm_parameter""" + """If passed, clients will display a button with specified text that switches the user to a private chat with the bot and sends the bot a start message with the parameter *switch_pm_parameter*""" switch_pm_parameter: Optional[str] = None - """Deep-linking parameter for the /start message sent to the bot when user presses the switch - button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed.""" + """`Deep-linking `_ parameter for the /start message sent to the bot when user presses the switch button. 1-64 characters, only :code:`A-Z`, :code:`a-z`, :code:`0-9`, :code:`_` and :code:`-` are allowed.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/answer_pre_checkout_query.py b/aiogram/methods/answer_pre_checkout_query.py index 8ffae74e..9438ca47 100644 --- a/aiogram/methods/answer_pre_checkout_query.py +++ b/aiogram/methods/answer_pre_checkout_query.py @@ -10,10 +10,7 @@ if TYPE_CHECKING: # pragma: no cover class AnswerPreCheckoutQuery(TelegramMethod[bool]): """ - Once the user has confirmed their payment and shipping details, the Bot API sends the final - confirmation in the form of an Update with the field pre_checkout_query. Use this method to - respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must - receive an answer within 10 seconds after the pre-checkout query was sent. + Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an `Update `_ with the field *pre_checkout_query*. Use this method to respond to such pre-checkout queries. On success, True is returned. **Note:** The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent. Source: https://core.telegram.org/bots/api#answerprecheckoutquery """ @@ -23,13 +20,9 @@ class AnswerPreCheckoutQuery(TelegramMethod[bool]): pre_checkout_query_id: str """Unique identifier for the query to be answered""" ok: bool - """Specify True if everything is alright (goods are available, etc.) and the bot is ready to - proceed with the order. Use False if there are any problems.""" + """Specify *True* if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use *False* if there are any problems.""" error_message: Optional[str] = None - """Required if ok is False. Error message in human readable form that explains the reason for - failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our - amazing black T-shirts while you were busy filling out your payment details. Please choose - a different color or garment!"). Telegram will display this message to the user.""" + """Required if *ok* is *False*. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!"). Telegram will display this message to the user.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/answer_shipping_query.py b/aiogram/methods/answer_shipping_query.py index da79adb5..da3978c5 100644 --- a/aiogram/methods/answer_shipping_query.py +++ b/aiogram/methods/answer_shipping_query.py @@ -11,9 +11,7 @@ if TYPE_CHECKING: # pragma: no cover class AnswerShippingQuery(TelegramMethod[bool]): """ - If you sent an invoice requesting a shipping address and the parameter is_flexible was - specified, the Bot API will send an Update with a shipping_query field to the bot. Use this - method to reply to shipping queries. On success, True is returned. + If you sent an invoice requesting a shipping address and the parameter *is_flexible* was specified, the Bot API will send an `Update `_ with a *shipping_query* field to the bot. Use this method to reply to shipping queries. On success, True is returned. Source: https://core.telegram.org/bots/api#answershippingquery """ @@ -23,14 +21,11 @@ class AnswerShippingQuery(TelegramMethod[bool]): shipping_query_id: str """Unique identifier for the query to be answered""" ok: bool - """Specify True if delivery to the specified address is possible and False if there are any - problems (for example, if delivery to the specified address is not possible)""" + """Specify True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible)""" shipping_options: Optional[List[ShippingOption]] = None - """Required if ok is True. A JSON-serialized array of available shipping options.""" + """Required if *ok* is True. A JSON-serialized array of available shipping options.""" error_message: Optional[str] = None - """Required if ok is False. Error message in human readable form that explains why it is - impossible to complete the order (e.g. "Sorry, delivery to your desired address is - unavailable'). Telegram will display this message to the user.""" + """Required if *ok* is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. "Sorry, delivery to your desired address is unavailable'). Telegram will display this message to the user.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/close.py b/aiogram/methods/close.py index 04999a22..16f4dea7 100644 --- a/aiogram/methods/close.py +++ b/aiogram/methods/close.py @@ -10,10 +10,7 @@ if TYPE_CHECKING: # pragma: no cover class Close(TelegramMethod[bool]): """ - Use this method to close the bot instance before moving it from one local server to another. - You need to delete the webhook before calling this method to ensure that the bot isn't - launched again after server restart. The method will return error 429 in the first 10 minutes - after the bot is launched. Returns True on success. Requires no parameters. + Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns *True* on success. Requires no parameters. Source: https://core.telegram.org/bots/api#close """ diff --git a/aiogram/methods/copy_message.py b/aiogram/methods/copy_message.py index 0f3e0e91..4b000fd6 100644 --- a/aiogram/methods/copy_message.py +++ b/aiogram/methods/copy_message.py @@ -19,9 +19,7 @@ if TYPE_CHECKING: # pragma: no cover class CopyMessage(TelegramMethod[MessageId]): """ - Use this method to copy messages of any kind. The method is analogous to the method - forwardMessages, but the copied message doesn't have a link to the original message. Returns - the MessageId of the sent message on success. + Use this method to copy messages of any kind. The method is analogous to the method `forwardMessages `_, but the copied message doesn't have a link to the original message. Returns the `MessageId `_ of the sent message on success. Source: https://core.telegram.org/bots/api#copymessage """ @@ -29,33 +27,27 @@ class CopyMessage(TelegramMethod[MessageId]): __returning__ = MessageId chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target channel (in the format - @channelusername)""" + """Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" from_chat_id: Union[int, str] - """Unique identifier for the chat where the original message was sent (or channel username in - the format @channelusername)""" + """Unique identifier for the chat where the original message was sent (or channel username in the format :code:`@channelusername`)""" message_id: int - """Message identifier in the chat specified in from_chat_id""" + """Message identifier in the chat specified in *from_chat_id*""" caption: Optional[str] = None - """New caption for media, 0-1024 characters after entities parsing. If not specified, the - original caption is kept""" + """New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept""" parse_mode: Optional[str] = UNSET - """Mode for parsing entities in the new caption. See formatting options for more details.""" + """Mode for parsing entities in the new caption. See `formatting options `_ for more details.""" caption_entities: Optional[List[MessageEntity]] = None - """List of special entities that appear in the new caption, which can be specified instead of - parse_mode""" + """List of special entities that appear in the new caption, which can be specified instead of *parse_mode*""" disable_notification: Optional[bool] = None - """Sends the message silently. Users will receive a notification with no sound.""" + """Sends the message `silently `_. Users will receive a notification with no sound.""" reply_to_message_id: Optional[int] = None """If the message is a reply, ID of the original message""" allow_sending_without_reply: Optional[bool] = None - """Pass True, if the message should be sent even if the specified replied-to message is not - found""" + """Pass *True*, if the message should be sent even if the specified replied-to message is not found""" reply_markup: Optional[ Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply] ] = None - """Additional interface options. A JSON-serialized object for an inline keyboard, custom reply - keyboard, instructions to remove reply keyboard or to force a reply from the user.""" + """Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove reply keyboard or to force a reply from the user.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/create_new_sticker_set.py b/aiogram/methods/create_new_sticker_set.py index e6a222ae..f9cdfe5c 100644 --- a/aiogram/methods/create_new_sticker_set.py +++ b/aiogram/methods/create_new_sticker_set.py @@ -11,9 +11,7 @@ if TYPE_CHECKING: # pragma: no cover class CreateNewStickerSet(TelegramMethod[bool]): """ - Use this method to create a new sticker set owned by a user. The bot will be able to edit the - sticker set thus created. You must use exactly one of the fields png_sticker or tgs_sticker. - Returns True on success. + Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. You **must** use exactly one of the fields *png_sticker* or *tgs_sticker*. Returns *True* on success. Source: https://core.telegram.org/bots/api#createnewstickerset """ @@ -23,25 +21,17 @@ class CreateNewStickerSet(TelegramMethod[bool]): user_id: int """User identifier of created sticker set owner""" name: str - """Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can - contain only english letters, digits and underscores. Must begin with a letter, can't - contain consecutive underscores and must end in '_by_'. is - case insensitive. 1-64 characters.""" + """Short name of sticker set, to be used in :code:`t.me/addstickers/` URLs (e.g., *animals*). Can contain only english letters, digits and underscores. Must begin with a letter, can't contain consecutive underscores and must end in *“_by_”*. ** is case insensitive. 1-64 characters.""" title: str """Sticker set title, 1-64 characters""" emojis: str """One or more emoji corresponding to the sticker""" png_sticker: Optional[Union[InputFile, str]] = None - """PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed - 512px, and either width or height must be exactly 512px. Pass a file_id as a String to send - a file that already exists on the Telegram servers, pass an HTTP URL as a String for - Telegram to get a file from the Internet, or upload a new one using multipart/form-data.""" + """**PNG** image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. Pass a *file_id* as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. `More info on Sending Files » `_""" tgs_sticker: Optional[InputFile] = None - """TGS animation with the sticker, uploaded using multipart/form-data. See - https://core.telegram.org/animated_stickers#technical-requirements for technical - requirements""" + """**TGS** animation with the sticker, uploaded using multipart/form-data. See `https://core.telegram.org/animated_stickers#technical-requirements `_`https://core.telegram.org/animated_stickers#technical-requirements `_ for technical requirements""" contains_masks: Optional[bool] = None - """Pass True, if a set of mask stickers should be created""" + """Pass *True*, if a set of mask stickers should be created""" mask_position: Optional[MaskPosition] = None """A JSON-serialized object for position where the mask should be placed on faces""" diff --git a/aiogram/methods/delete_chat_photo.py b/aiogram/methods/delete_chat_photo.py index 8be35986..55e3f447 100644 --- a/aiogram/methods/delete_chat_photo.py +++ b/aiogram/methods/delete_chat_photo.py @@ -10,9 +10,7 @@ if TYPE_CHECKING: # pragma: no cover class DeleteChatPhoto(TelegramMethod[bool]): """ - Use this method to delete a chat photo. Photos can't be changed for private chats. The bot - must be an administrator in the chat for this to work and must have the appropriate admin - rights. Returns True on success. + Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns *True* on success. Source: https://core.telegram.org/bots/api#deletechatphoto """ @@ -20,8 +18,7 @@ class DeleteChatPhoto(TelegramMethod[bool]): __returning__ = bool chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target channel (in the format - @channelusername)""" + """Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/delete_chat_sticker_set.py b/aiogram/methods/delete_chat_sticker_set.py index 14801ec4..ce92e799 100644 --- a/aiogram/methods/delete_chat_sticker_set.py +++ b/aiogram/methods/delete_chat_sticker_set.py @@ -10,10 +10,7 @@ if TYPE_CHECKING: # pragma: no cover class DeleteChatStickerSet(TelegramMethod[bool]): """ - Use this method to delete a group sticker set from a supergroup. The bot must be an - administrator in the chat for this to work and must have the appropriate admin rights. Use the - field can_set_sticker_set optionally returned in getChat requests to check if the bot can use - this method. Returns True on success. + Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field *can_set_sticker_set* optionally returned in `getChat `_ requests to check if the bot can use this method. Returns *True* on success. Source: https://core.telegram.org/bots/api#deletechatstickerset """ @@ -21,8 +18,7 @@ class DeleteChatStickerSet(TelegramMethod[bool]): __returning__ = bool chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target supergroup (in the format - @supergroupusername)""" + """Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/delete_message.py b/aiogram/methods/delete_message.py index da0edce1..cd6984d6 100644 --- a/aiogram/methods/delete_message.py +++ b/aiogram/methods/delete_message.py @@ -10,17 +10,23 @@ if TYPE_CHECKING: # pragma: no cover class DeleteMessage(TelegramMethod[bool]): """ - Use this method to delete a message, including service messages, with the following - limitations: + Use this method to delete a message, including service messages, with the following limitations: + - A message can only be deleted if it was sent less than 48 hours ago. + - A dice message in a private chat can only be deleted if it was sent more than 24 hours ago. + - Bots can delete outgoing messages in private chats, groups, and supergroups. + - Bots can delete incoming messages in private chats. - - Bots granted can_post_messages permissions can delete outgoing messages in channels. + + - Bots granted *can_post_messages* permissions can delete outgoing messages in channels. + - If the bot is an administrator of a group, it can delete any message there. - - If the bot has can_delete_messages permission in a supergroup or a channel, it can delete - any message there. - Returns True on success. + + - If the bot has *can_delete_messages* permission in a supergroup or a channel, it can delete any message there. + + Returns *True* on success. Source: https://core.telegram.org/bots/api#deletemessage """ @@ -28,8 +34,7 @@ class DeleteMessage(TelegramMethod[bool]): __returning__ = bool chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target channel (in the format - @channelusername)""" + """Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" message_id: int """Identifier of the message to delete""" diff --git a/aiogram/methods/delete_sticker_from_set.py b/aiogram/methods/delete_sticker_from_set.py index 30ac3d4b..0c04254f 100644 --- a/aiogram/methods/delete_sticker_from_set.py +++ b/aiogram/methods/delete_sticker_from_set.py @@ -10,7 +10,7 @@ if TYPE_CHECKING: # pragma: no cover class DeleteStickerFromSet(TelegramMethod[bool]): """ - Use this method to delete a sticker from a set created by the bot. Returns True on success. + Use this method to delete a sticker from a set created by the bot. Returns *True* on success. Source: https://core.telegram.org/bots/api#deletestickerfromset """ diff --git a/aiogram/methods/delete_webhook.py b/aiogram/methods/delete_webhook.py index 71b3f167..fe80b5f0 100644 --- a/aiogram/methods/delete_webhook.py +++ b/aiogram/methods/delete_webhook.py @@ -10,8 +10,7 @@ if TYPE_CHECKING: # pragma: no cover class DeleteWebhook(TelegramMethod[bool]): """ - Use this method to remove webhook integration if you decide to switch back to getUpdates. - Returns True on success. + Use this method to remove webhook integration if you decide to switch back to `getUpdates `_. Returns *True* on success. Source: https://core.telegram.org/bots/api#deletewebhook """ @@ -19,7 +18,7 @@ class DeleteWebhook(TelegramMethod[bool]): __returning__ = bool drop_pending_updates: Optional[bool] = None - """Pass True to drop all pending updates""" + """Pass *True* to drop all pending updates""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/edit_message_caption.py b/aiogram/methods/edit_message_caption.py index be8efc0f..47f1f756 100644 --- a/aiogram/methods/edit_message_caption.py +++ b/aiogram/methods/edit_message_caption.py @@ -11,8 +11,7 @@ if TYPE_CHECKING: # pragma: no cover class EditMessageCaption(TelegramMethod[Union[Message, bool]]): """ - Use this method to edit captions of messages. On success, if the edited message is not an - inline message, the edited Message is returned, otherwise True is returned. + Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited `Message `_ is returned, otherwise *True* is returned. Source: https://core.telegram.org/bots/api#editmessagecaption """ @@ -20,21 +19,19 @@ class EditMessageCaption(TelegramMethod[Union[Message, bool]]): __returning__ = Union[Message, bool] chat_id: Optional[Union[int, str]] = None - """Required if inline_message_id is not specified. Unique identifier for the target chat or - username of the target channel (in the format @channelusername)""" + """Required if *inline_message_id* is not specified. Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" message_id: Optional[int] = None - """Required if inline_message_id is not specified. Identifier of the message to edit""" + """Required if *inline_message_id* is not specified. Identifier of the message to edit""" inline_message_id: Optional[str] = None - """Required if chat_id and message_id are not specified. Identifier of the inline message""" + """Required if *chat_id* and *message_id* are not specified. Identifier of the inline message""" caption: Optional[str] = None """New caption of the message, 0-1024 characters after entities parsing""" parse_mode: Optional[str] = UNSET - """Mode for parsing entities in the message caption. See formatting options for more details.""" + """Mode for parsing entities in the message caption. See `formatting options `_ for more details.""" caption_entities: Optional[List[MessageEntity]] = None - """List of special entities that appear in the caption, which can be specified instead of - parse_mode""" + """List of special entities that appear in the caption, which can be specified instead of *parse_mode*""" reply_markup: Optional[InlineKeyboardMarkup] = None - """A JSON-serialized object for an inline keyboard.""" + """A JSON-serialized object for an `inline keyboard `_.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/edit_message_live_location.py b/aiogram/methods/edit_message_live_location.py index c5366d98..f3e48e77 100644 --- a/aiogram/methods/edit_message_live_location.py +++ b/aiogram/methods/edit_message_live_location.py @@ -11,10 +11,7 @@ if TYPE_CHECKING: # pragma: no cover class EditMessageLiveLocation(TelegramMethod[Union[Message, bool]]): """ - Use this method to edit live location messages. A location can be edited until its live_period - expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if - the edited message is not an inline message, the edited Message is returned, otherwise True is - returned. + Use this method to edit live location messages. A location can be edited until its *live_period* expires or editing is explicitly disabled by a call to `stopMessageLiveLocation `_. On success, if the edited message is not an inline message, the edited `Message `_ is returned, otherwise *True* is returned. Source: https://core.telegram.org/bots/api#editmessagelivelocation """ @@ -26,21 +23,19 @@ class EditMessageLiveLocation(TelegramMethod[Union[Message, bool]]): longitude: float """Longitude of new location""" chat_id: Optional[Union[int, str]] = None - """Required if inline_message_id is not specified. Unique identifier for the target chat or - username of the target channel (in the format @channelusername)""" + """Required if *inline_message_id* is not specified. Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" message_id: Optional[int] = None - """Required if inline_message_id is not specified. Identifier of the message to edit""" + """Required if *inline_message_id* is not specified. Identifier of the message to edit""" inline_message_id: Optional[str] = None - """Required if chat_id and message_id are not specified. Identifier of the inline message""" + """Required if *chat_id* and *message_id* are not specified. Identifier of the inline message""" horizontal_accuracy: Optional[float] = None """The radius of uncertainty for the location, measured in meters; 0-1500""" heading: Optional[int] = None """Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.""" proximity_alert_radius: Optional[int] = None - """Maximum distance for proximity alerts about approaching another chat member, in meters. - Must be between 1 and 100000 if specified.""" + """Maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.""" reply_markup: Optional[InlineKeyboardMarkup] = None - """A JSON-serialized object for a new inline keyboard.""" + """A JSON-serialized object for a new `inline keyboard `_.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/edit_message_media.py b/aiogram/methods/edit_message_media.py index f03272f3..c7b30376 100644 --- a/aiogram/methods/edit_message_media.py +++ b/aiogram/methods/edit_message_media.py @@ -11,12 +11,7 @@ if TYPE_CHECKING: # pragma: no cover class EditMessageMedia(TelegramMethod[Union[Message, bool]]): """ - Use this method to edit animation, audio, document, photo, or video messages. If a message is - part of a message album, then it can be edited only to an audio for audio albums, only to a - document for document albums and to a photo or a video otherwise. When an inline message is - edited, a new file can't be uploaded. Use a previously uploaded file via its file_id or - specify a URL. On success, if the edited message was sent by the bot, the edited Message is - returned, otherwise True is returned. + Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded. Use a previously uploaded file via its file_id or specify a URL. On success, if the edited message was sent by the bot, the edited `Message `_ is returned, otherwise *True* is returned. Source: https://core.telegram.org/bots/api#editmessagemedia """ @@ -26,14 +21,13 @@ class EditMessageMedia(TelegramMethod[Union[Message, bool]]): media: InputMedia """A JSON-serialized object for a new media content of the message""" chat_id: Optional[Union[int, str]] = None - """Required if inline_message_id is not specified. Unique identifier for the target chat or - username of the target channel (in the format @channelusername)""" + """Required if *inline_message_id* is not specified. Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" message_id: Optional[int] = None - """Required if inline_message_id is not specified. Identifier of the message to edit""" + """Required if *inline_message_id* is not specified. Identifier of the message to edit""" inline_message_id: Optional[str] = None - """Required if chat_id and message_id are not specified. Identifier of the inline message""" + """Required if *chat_id* and *message_id* are not specified. Identifier of the inline message""" reply_markup: Optional[InlineKeyboardMarkup] = None - """A JSON-serialized object for a new inline keyboard.""" + """A JSON-serialized object for a new `inline keyboard `_.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/edit_message_reply_markup.py b/aiogram/methods/edit_message_reply_markup.py index 5887dbed..ea0c2596 100644 --- a/aiogram/methods/edit_message_reply_markup.py +++ b/aiogram/methods/edit_message_reply_markup.py @@ -11,8 +11,7 @@ if TYPE_CHECKING: # pragma: no cover class EditMessageReplyMarkup(TelegramMethod[Union[Message, bool]]): """ - Use this method to edit only the reply markup of messages. On success, if the edited message - is not an inline message, the edited Message is returned, otherwise True is returned. + Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited `Message `_ is returned, otherwise *True* is returned. Source: https://core.telegram.org/bots/api#editmessagereplymarkup """ @@ -20,14 +19,13 @@ class EditMessageReplyMarkup(TelegramMethod[Union[Message, bool]]): __returning__ = Union[Message, bool] chat_id: Optional[Union[int, str]] = None - """Required if inline_message_id is not specified. Unique identifier for the target chat or - username of the target channel (in the format @channelusername)""" + """Required if *inline_message_id* is not specified. Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" message_id: Optional[int] = None - """Required if inline_message_id is not specified. Identifier of the message to edit""" + """Required if *inline_message_id* is not specified. Identifier of the message to edit""" inline_message_id: Optional[str] = None - """Required if chat_id and message_id are not specified. Identifier of the inline message""" + """Required if *chat_id* and *message_id* are not specified. Identifier of the inline message""" reply_markup: Optional[InlineKeyboardMarkup] = None - """A JSON-serialized object for an inline keyboard.""" + """A JSON-serialized object for an `inline keyboard `_.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/edit_message_text.py b/aiogram/methods/edit_message_text.py index a8f661d0..3e3b58e8 100644 --- a/aiogram/methods/edit_message_text.py +++ b/aiogram/methods/edit_message_text.py @@ -11,8 +11,7 @@ if TYPE_CHECKING: # pragma: no cover class EditMessageText(TelegramMethod[Union[Message, bool]]): """ - Use this method to edit text and game messages. On success, if the edited message is not an - inline message, the edited Message is returned, otherwise True is returned. + Use this method to edit text and `game `_ messages. On success, if the edited message is not an inline message, the edited `Message `_ is returned, otherwise *True* is returned. Source: https://core.telegram.org/bots/api#editmessagetext """ @@ -22,21 +21,19 @@ class EditMessageText(TelegramMethod[Union[Message, bool]]): text: str """New text of the message, 1-4096 characters after entities parsing""" chat_id: Optional[Union[int, str]] = None - """Required if inline_message_id is not specified. Unique identifier for the target chat or - username of the target channel (in the format @channelusername)""" + """Required if *inline_message_id* is not specified. Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" message_id: Optional[int] = None - """Required if inline_message_id is not specified. Identifier of the message to edit""" + """Required if *inline_message_id* is not specified. Identifier of the message to edit""" inline_message_id: Optional[str] = None - """Required if chat_id and message_id are not specified. Identifier of the inline message""" + """Required if *chat_id* and *message_id* are not specified. Identifier of the inline message""" parse_mode: Optional[str] = UNSET - """Mode for parsing entities in the message text. See formatting options for more details.""" + """Mode for parsing entities in the message text. See `formatting options `_ for more details.""" entities: Optional[List[MessageEntity]] = None - """List of special entities that appear in message text, which can be specified instead of - parse_mode""" + """List of special entities that appear in message text, which can be specified instead of *parse_mode*""" disable_web_page_preview: Optional[bool] = None """Disables link previews for links in this message""" reply_markup: Optional[InlineKeyboardMarkup] = None - """A JSON-serialized object for an inline keyboard.""" + """A JSON-serialized object for an `inline keyboard `_.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/export_chat_invite_link.py b/aiogram/methods/export_chat_invite_link.py index b77b01a5..c057f8c1 100644 --- a/aiogram/methods/export_chat_invite_link.py +++ b/aiogram/methods/export_chat_invite_link.py @@ -10,14 +10,8 @@ if TYPE_CHECKING: # pragma: no cover class ExportChatInviteLink(TelegramMethod[str]): """ - Use this method to generate a new invite link for a chat; any previously generated link is - revoked. The bot must be an administrator in the chat for this to work and must have the - appropriate admin rights. Returns the new invite link as String on success. - Note: Each administrator in a chat generates their own invite links. Bots can't use invite - links generated by other administrators. If you want your bot to work with invite links, it - will need to generate its own link using exportChatInviteLink — after this the link will - become available to the bot via the getChat method. If your bot needs to generate a new invite - link replacing its previous one, use exportChatInviteLink again. + Use this method to generate a new invite link for a chat; any previously generated link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the new invite link as *String* on success. + Note: Each administrator in a chat generates their own invite links. Bots can't use invite links generated by other administrators. If you want your bot to work with invite links, it will need to generate its own link using `exportChatInviteLink `_ — after this the link will become available to the bot via the `getChat `_ method. If your bot needs to generate a new invite link replacing its previous one, use `exportChatInviteLink `_ again. Source: https://core.telegram.org/bots/api#exportchatinvitelink """ @@ -25,8 +19,7 @@ class ExportChatInviteLink(TelegramMethod[str]): __returning__ = str chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target channel (in the format - @channelusername)""" + """Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/forward_message.py b/aiogram/methods/forward_message.py index 06f19956..8b781da5 100644 --- a/aiogram/methods/forward_message.py +++ b/aiogram/methods/forward_message.py @@ -11,7 +11,7 @@ if TYPE_CHECKING: # pragma: no cover class ForwardMessage(TelegramMethod[Message]): """ - Use this method to forward messages of any kind. On success, the sent Message is returned. + Use this method to forward messages of any kind. On success, the sent `Message `_ is returned. Source: https://core.telegram.org/bots/api#forwardmessage """ @@ -19,15 +19,13 @@ class ForwardMessage(TelegramMethod[Message]): __returning__ = Message chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target channel (in the format - @channelusername)""" + """Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" from_chat_id: Union[int, str] - """Unique identifier for the chat where the original message was sent (or channel username in - the format @channelusername)""" + """Unique identifier for the chat where the original message was sent (or channel username in the format :code:`@channelusername`)""" message_id: int - """Message identifier in the chat specified in from_chat_id""" + """Message identifier in the chat specified in *from_chat_id*""" disable_notification: Optional[bool] = None - """Sends the message silently. Users will receive a notification with no sound.""" + """Sends the message `silently `_. Users will receive a notification with no sound.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/get_chat.py b/aiogram/methods/get_chat.py index 6131c00d..2f69108b 100644 --- a/aiogram/methods/get_chat.py +++ b/aiogram/methods/get_chat.py @@ -11,9 +11,7 @@ if TYPE_CHECKING: # pragma: no cover class GetChat(TelegramMethod[Chat]): """ - Use this method to get up to date information about the chat (current name of the user for - one-on-one conversations, current username of a user, group or channel, etc.). Returns a Chat - object on success. + Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). Returns a `Chat `_ object on success. Source: https://core.telegram.org/bots/api#getchat """ @@ -21,8 +19,7 @@ class GetChat(TelegramMethod[Chat]): __returning__ = Chat chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target supergroup or channel (in - the format @channelusername)""" + """Unique identifier for the target chat or username of the target supergroup or channel (in the format :code:`@channelusername`)""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/get_chat_administrators.py b/aiogram/methods/get_chat_administrators.py index 584d6f9a..9fb17ad5 100644 --- a/aiogram/methods/get_chat_administrators.py +++ b/aiogram/methods/get_chat_administrators.py @@ -11,10 +11,7 @@ if TYPE_CHECKING: # pragma: no cover class GetChatAdministrators(TelegramMethod[List[ChatMember]]): """ - Use this method to get a list of administrators in a chat. On success, returns an Array of - ChatMember objects that contains information about all chat administrators except other bots. - If the chat is a group or a supergroup and no administrators were appointed, only the creator - will be returned. + Use this method to get a list of administrators in a chat. On success, returns an Array of `ChatMember `_ objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned. Source: https://core.telegram.org/bots/api#getchatadministrators """ @@ -22,8 +19,7 @@ class GetChatAdministrators(TelegramMethod[List[ChatMember]]): __returning__ = List[ChatMember] chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target supergroup or channel (in - the format @channelusername)""" + """Unique identifier for the target chat or username of the target supergroup or channel (in the format :code:`@channelusername`)""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/get_chat_member.py b/aiogram/methods/get_chat_member.py index 903fd803..de193808 100644 --- a/aiogram/methods/get_chat_member.py +++ b/aiogram/methods/get_chat_member.py @@ -11,8 +11,7 @@ if TYPE_CHECKING: # pragma: no cover class GetChatMember(TelegramMethod[ChatMember]): """ - Use this method to get information about a member of a chat. Returns a ChatMember object on - success. + Use this method to get information about a member of a chat. Returns a `ChatMember `_ object on success. Source: https://core.telegram.org/bots/api#getchatmember """ @@ -20,8 +19,7 @@ class GetChatMember(TelegramMethod[ChatMember]): __returning__ = ChatMember chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target supergroup or channel (in - the format @channelusername)""" + """Unique identifier for the target chat or username of the target supergroup or channel (in the format :code:`@channelusername`)""" user_id: int """Unique identifier of the target user""" diff --git a/aiogram/methods/get_chat_members_count.py b/aiogram/methods/get_chat_members_count.py index 9b830af0..2ec638f4 100644 --- a/aiogram/methods/get_chat_members_count.py +++ b/aiogram/methods/get_chat_members_count.py @@ -10,7 +10,7 @@ if TYPE_CHECKING: # pragma: no cover class GetChatMembersCount(TelegramMethod[int]): """ - Use this method to get the number of members in a chat. Returns Int on success. + Use this method to get the number of members in a chat. Returns *Int* on success. Source: https://core.telegram.org/bots/api#getchatmemberscount """ @@ -18,8 +18,7 @@ class GetChatMembersCount(TelegramMethod[int]): __returning__ = int chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target supergroup or channel (in - the format @channelusername)""" + """Unique identifier for the target chat or username of the target supergroup or channel (in the format :code:`@channelusername`)""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/get_file.py b/aiogram/methods/get_file.py index 9fce6eb0..e77e299d 100644 --- a/aiogram/methods/get_file.py +++ b/aiogram/methods/get_file.py @@ -11,13 +11,8 @@ if TYPE_CHECKING: # pragma: no cover class GetFile(TelegramMethod[File]): """ - Use this method to get basic info about a file and prepare it for downloading. For the moment, - bots can download files of up to 20MB in size. On success, a File object is returned. The file - can then be downloaded via the link https://api.telegram.org/file/bot/, - where is taken from the response. It is guaranteed that the link will be valid for - at least 1 hour. When the link expires, a new one can be requested by calling getFile again. - Note: This function may not preserve the original file name and MIME type. You should save the - file's MIME type and name (if available) when the File object is received. + Use this method to get basic info about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a `File `_ object is returned. The file can then be downloaded via the link :code:`https://api.telegram.org/file/bot/`, where :code:`` is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling `getFile `_ again. + **Note:** This function may not preserve the original file name and MIME type. You should save the file's MIME type and name (if available) when the File object is received. Source: https://core.telegram.org/bots/api#getfile """ diff --git a/aiogram/methods/get_game_high_scores.py b/aiogram/methods/get_game_high_scores.py index c2dd0671..9ba04f99 100644 --- a/aiogram/methods/get_game_high_scores.py +++ b/aiogram/methods/get_game_high_scores.py @@ -11,12 +11,8 @@ if TYPE_CHECKING: # pragma: no cover class GetGameHighScores(TelegramMethod[List[GameHighScore]]): """ - Use this method to get data for high score tables. Will return the score of the specified user - and several of their neighbors in a game. On success, returns an Array of GameHighScore - objects. - This method will currently return scores for the target user, plus two of their closest - neighbors on each side. Will also return the top three users if the user and his neighbors are - not among them. Please note that this behavior is subject to change. + Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. On success, returns an *Array* of `GameHighScore `_ objects. + This method will currently return scores for the target user, plus two of their closest neighbors on each side. Will also return the top three users if the user and his neighbors are not among them. Please note that this behavior is subject to change. Source: https://core.telegram.org/bots/api#getgamehighscores """ @@ -26,11 +22,11 @@ class GetGameHighScores(TelegramMethod[List[GameHighScore]]): user_id: int """Target user id""" chat_id: Optional[int] = None - """Required if inline_message_id is not specified. Unique identifier for the target chat""" + """Required if *inline_message_id* is not specified. Unique identifier for the target chat""" message_id: Optional[int] = None - """Required if inline_message_id is not specified. Identifier of the sent message""" + """Required if *inline_message_id* is not specified. Identifier of the sent message""" inline_message_id: Optional[str] = None - """Required if chat_id and message_id are not specified. Identifier of the inline message""" + """Required if *chat_id* and *message_id* are not specified. Identifier of the inline message""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/get_me.py b/aiogram/methods/get_me.py index c9171d47..29f3323b 100644 --- a/aiogram/methods/get_me.py +++ b/aiogram/methods/get_me.py @@ -11,8 +11,7 @@ if TYPE_CHECKING: # pragma: no cover class GetMe(TelegramMethod[User]): """ - A simple method for testing your bot's auth token. Requires no parameters. Returns basic - information about the bot in form of a User object. + A simple method for testing your bot's auth token. Requires no parameters. Returns basic information about the bot in form of a `User `_ object. Source: https://core.telegram.org/bots/api#getme """ diff --git a/aiogram/methods/get_my_commands.py b/aiogram/methods/get_my_commands.py index c748cb92..6e10811f 100644 --- a/aiogram/methods/get_my_commands.py +++ b/aiogram/methods/get_my_commands.py @@ -11,8 +11,7 @@ if TYPE_CHECKING: # pragma: no cover class GetMyCommands(TelegramMethod[List[BotCommand]]): """ - Use this method to get the current list of the bot's commands. Requires no parameters. Returns - Array of BotCommand on success. + Use this method to get the current list of the bot's commands. Requires no parameters. Returns Array of `BotCommand `_ on success. Source: https://core.telegram.org/bots/api#getmycommands """ diff --git a/aiogram/methods/get_sticker_set.py b/aiogram/methods/get_sticker_set.py index 56e54577..dbf678a8 100644 --- a/aiogram/methods/get_sticker_set.py +++ b/aiogram/methods/get_sticker_set.py @@ -11,7 +11,7 @@ if TYPE_CHECKING: # pragma: no cover class GetStickerSet(TelegramMethod[StickerSet]): """ - Use this method to get a sticker set. On success, a StickerSet object is returned. + Use this method to get a sticker set. On success, a `StickerSet `_ object is returned. Source: https://core.telegram.org/bots/api#getstickerset """ diff --git a/aiogram/methods/get_updates.py b/aiogram/methods/get_updates.py index ffb74c92..0d4c5354 100644 --- a/aiogram/methods/get_updates.py +++ b/aiogram/methods/get_updates.py @@ -11,11 +11,12 @@ if TYPE_CHECKING: # pragma: no cover class GetUpdates(TelegramMethod[List[Update]]): """ - Use this method to receive incoming updates using long polling (wiki). An Array of Update - objects is returned. - Notes - 1. This method will not work if an outgoing webhook is set up. - 2. In order to avoid getting duplicate updates, recalculate offset after each server response. + Use this method to receive incoming updates using long polling (`wiki `_). An Array of `Update `_ objects is returned. + **Notes** + + **1.** This method will not work if an outgoing webhook is set up. + + **2.** In order to avoid getting duplicate updates, recalculate *offset* after each server response. Source: https://core.telegram.org/bots/api#getupdates """ @@ -23,24 +24,13 @@ class GetUpdates(TelegramMethod[List[Update]]): __returning__ = List[Update] offset: Optional[int] = None - """Identifier of the first update to be returned. Must be greater by one than the highest - among the identifiers of previously received updates. By default, updates starting with the - earliest unconfirmed update are returned. An update is considered confirmed as soon as - getUpdates is called with an offset higher than its update_id. The negative offset can be - specified to retrieve updates starting from -offset update from the end of the updates - queue. All previous updates will forgotten.""" + """Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as `getUpdates `_ is called with an *offset* higher than its *update_id*. The negative offset can be specified to retrieve updates starting from *-offset* update from the end of the updates queue. All previous updates will forgotten.""" limit: Optional[int] = None - """Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults - to 100.""" + """Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100.""" timeout: Optional[int] = None - """Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be - positive, short polling should be used for testing purposes only.""" + """Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only.""" allowed_updates: Optional[List[str]] = None - """A JSON-serialized list of the update types you want your bot to receive. For example, - specify ['message', 'edited_channel_post', 'callback_query'] to only receive updates of - these types. See Update for a complete list of available update types. Specify an empty - list to receive all updates regardless of type (default). If not specified, the previous - setting will be used.""" + """A JSON-serialized list of the update types you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See `Update `_ for a complete list of available update types. Specify an empty list to receive all updates regardless of type (default). If not specified, the previous setting will be used.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/get_user_profile_photos.py b/aiogram/methods/get_user_profile_photos.py index bce33116..210b198c 100644 --- a/aiogram/methods/get_user_profile_photos.py +++ b/aiogram/methods/get_user_profile_photos.py @@ -11,8 +11,7 @@ if TYPE_CHECKING: # pragma: no cover class GetUserProfilePhotos(TelegramMethod[UserProfilePhotos]): """ - Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos - object. + Use this method to get a list of profile pictures for a user. Returns a `UserProfilePhotos `_ object. Source: https://core.telegram.org/bots/api#getuserprofilephotos """ @@ -24,8 +23,7 @@ class GetUserProfilePhotos(TelegramMethod[UserProfilePhotos]): offset: Optional[int] = None """Sequential number of the first photo to be returned. By default, all photos are returned.""" limit: Optional[int] = None - """Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to - 100.""" + """Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/get_webhook_info.py b/aiogram/methods/get_webhook_info.py index 218569bb..a34bc342 100644 --- a/aiogram/methods/get_webhook_info.py +++ b/aiogram/methods/get_webhook_info.py @@ -11,9 +11,7 @@ if TYPE_CHECKING: # pragma: no cover class GetWebhookInfo(TelegramMethod[WebhookInfo]): """ - Use this method to get current webhook status. Requires no parameters. On success, returns a - WebhookInfo object. If the bot is using getUpdates, will return an object with the url field - empty. + Use this method to get current webhook status. Requires no parameters. On success, returns a `WebhookInfo `_ object. If the bot is using `getUpdates `_, will return an object with the *url* field empty. Source: https://core.telegram.org/bots/api#getwebhookinfo """ diff --git a/aiogram/methods/kick_chat_member.py b/aiogram/methods/kick_chat_member.py index 45880c4c..4197d5ea 100644 --- a/aiogram/methods/kick_chat_member.py +++ b/aiogram/methods/kick_chat_member.py @@ -11,10 +11,7 @@ if TYPE_CHECKING: # pragma: no cover class KickChatMember(TelegramMethod[bool]): """ - Use this method to kick a user from a group, a supergroup or a channel. In the case of - supergroups and channels, the user will not be able to return to the group on their own using - invite links, etc., unless unbanned first. The bot must be an administrator in the chat for - this to work and must have the appropriate admin rights. Returns True on success. + Use this method to kick a user from a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless `unbanned `_ first. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns *True* on success. Source: https://core.telegram.org/bots/api#kickchatmember """ @@ -22,13 +19,11 @@ class KickChatMember(TelegramMethod[bool]): __returning__ = bool chat_id: Union[int, str] - """Unique identifier for the target group or username of the target supergroup or channel (in - the format @channelusername)""" + """Unique identifier for the target group or username of the target supergroup or channel (in the format :code:`@channelusername`)""" user_id: int """Unique identifier of the target user""" until_date: Optional[Union[datetime.datetime, datetime.timedelta, int]] = None - """Date when the user will be unbanned, unix time. If user is banned for more than 366 days or - less than 30 seconds from the current time they are considered to be banned forever""" + """Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/leave_chat.py b/aiogram/methods/leave_chat.py index 7af04143..7108fa30 100644 --- a/aiogram/methods/leave_chat.py +++ b/aiogram/methods/leave_chat.py @@ -10,7 +10,7 @@ if TYPE_CHECKING: # pragma: no cover class LeaveChat(TelegramMethod[bool]): """ - Use this method for your bot to leave a group, supergroup or channel. Returns True on success. + Use this method for your bot to leave a group, supergroup or channel. Returns *True* on success. Source: https://core.telegram.org/bots/api#leavechat """ @@ -18,8 +18,7 @@ class LeaveChat(TelegramMethod[bool]): __returning__ = bool chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target supergroup or channel (in - the format @channelusername)""" + """Unique identifier for the target chat or username of the target supergroup or channel (in the format :code:`@channelusername`)""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/log_out.py b/aiogram/methods/log_out.py index bba9f7ea..70ed9027 100644 --- a/aiogram/methods/log_out.py +++ b/aiogram/methods/log_out.py @@ -10,11 +10,7 @@ if TYPE_CHECKING: # pragma: no cover class LogOut(TelegramMethod[bool]): """ - Use this method to log out from the cloud Bot API server before launching the bot locally. You - must log out the bot before running it locally, otherwise there is no guarantee that the bot - will receive updates. After a successful call, you can immediately log in on a local server, - but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True - on success. Requires no parameters. + Use this method to log out from the cloud Bot API server before launching the bot locally. You **must** log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns *True* on success. Requires no parameters. Source: https://core.telegram.org/bots/api#logout """ diff --git a/aiogram/methods/pin_chat_message.py b/aiogram/methods/pin_chat_message.py index e372178a..2c6a8950 100644 --- a/aiogram/methods/pin_chat_message.py +++ b/aiogram/methods/pin_chat_message.py @@ -10,10 +10,7 @@ if TYPE_CHECKING: # pragma: no cover class PinChatMessage(TelegramMethod[bool]): """ - Use this method to add a message to the list of pinned messages in a chat. If the chat is not - a private chat, the bot must be an administrator in the chat for this to work and must have - the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a - channel. Returns True on success. + Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns *True* on success. Source: https://core.telegram.org/bots/api#pinchatmessage """ @@ -21,13 +18,11 @@ class PinChatMessage(TelegramMethod[bool]): __returning__ = bool chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target channel (in the format - @channelusername)""" + """Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" message_id: int """Identifier of a message to pin""" disable_notification: Optional[bool] = None - """Pass True, if it is not necessary to send a notification to all chat members about the new - pinned message. Notifications are always disabled in channels and private chats.""" + """Pass *True*, if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/promote_chat_member.py b/aiogram/methods/promote_chat_member.py index 23572897..2b714579 100644 --- a/aiogram/methods/promote_chat_member.py +++ b/aiogram/methods/promote_chat_member.py @@ -10,9 +10,7 @@ if TYPE_CHECKING: # pragma: no cover class PromoteChatMember(TelegramMethod[bool]): """ - Use this method to promote or demote a user in a supergroup or a channel. The bot must be an - administrator in the chat for this to work and must have the appropriate admin rights. Pass - False for all boolean parameters to demote a user. Returns True on success. + Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Pass *False* for all boolean parameters to demote a user. Returns *True* on success. Source: https://core.telegram.org/bots/api#promotechatmember """ @@ -20,19 +18,17 @@ class PromoteChatMember(TelegramMethod[bool]): __returning__ = bool chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target channel (in the format - @channelusername)""" + """Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" user_id: int """Unique identifier of the target user""" is_anonymous: Optional[bool] = None - """Pass True, if the administrator's presence in the chat is hidden""" + """Pass *True*, if the administrator's presence in the chat is hidden""" can_change_info: Optional[bool] = None """Pass True, if the administrator can change chat title, photo and other settings""" can_post_messages: Optional[bool] = None """Pass True, if the administrator can create channel posts, channels only""" can_edit_messages: Optional[bool] = None - """Pass True, if the administrator can edit messages of other users and can pin messages, - channels only""" + """Pass True, if the administrator can edit messages of other users and can pin messages, channels only""" can_delete_messages: Optional[bool] = None """Pass True, if the administrator can delete messages of other users""" can_invite_users: Optional[bool] = None @@ -42,9 +38,7 @@ class PromoteChatMember(TelegramMethod[bool]): can_pin_messages: Optional[bool] = None """Pass True, if the administrator can pin messages, supergroups only""" can_promote_members: Optional[bool] = None - """Pass True, if the administrator can add new administrators with a subset of their own - privileges or demote administrators that he has promoted, directly or indirectly (promoted - by administrators that were appointed by him)""" + """Pass True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by him)""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/restrict_chat_member.py b/aiogram/methods/restrict_chat_member.py index 8bad26c7..42984596 100644 --- a/aiogram/methods/restrict_chat_member.py +++ b/aiogram/methods/restrict_chat_member.py @@ -12,9 +12,7 @@ if TYPE_CHECKING: # pragma: no cover class RestrictChatMember(TelegramMethod[bool]): """ - Use this method to restrict a user in a supergroup. The bot must be an administrator in the - supergroup for this to work and must have the appropriate admin rights. Pass True for all - permissions to lift restrictions from a user. Returns True on success. + Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate admin rights. Pass *True* for all permissions to lift restrictions from a user. Returns *True* on success. Source: https://core.telegram.org/bots/api#restrictchatmember """ @@ -22,16 +20,13 @@ class RestrictChatMember(TelegramMethod[bool]): __returning__ = bool chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target supergroup (in the format - @supergroupusername)""" + """Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)""" user_id: int """Unique identifier of the target user""" permissions: ChatPermissions """A JSON-serialized object for new user permissions""" until_date: Optional[Union[datetime.datetime, datetime.timedelta, int]] = None - """Date when restrictions will be lifted for the user, unix time. If user is restricted for - more than 366 days or less than 30 seconds from the current time, they are considered to be - restricted forever""" + """Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/send_animation.py b/aiogram/methods/send_animation.py index 28630812..9191e5ff 100644 --- a/aiogram/methods/send_animation.py +++ b/aiogram/methods/send_animation.py @@ -20,9 +20,7 @@ if TYPE_CHECKING: # pragma: no cover class SendAnimation(TelegramMethod[Message]): """ - Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On - success, the sent Message is returned. Bots can currently send animation files of up to 50 MB - in size, this limit may be changed in the future. + Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent `Message `_ is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future. Source: https://core.telegram.org/bots/api#sendanimation """ @@ -30,12 +28,9 @@ class SendAnimation(TelegramMethod[Message]): __returning__ = Message chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target channel (in the format - @channelusername)""" + """Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" animation: Union[InputFile, str] - """Animation to send. Pass a file_id as String to send an animation that exists on the - Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an - animation from the Internet, or upload a new animation using multipart/form-data.""" + """Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. `More info on Sending Files » `_""" duration: Optional[int] = None """Duration of sent animation in seconds""" width: Optional[int] = None @@ -43,33 +38,23 @@ class SendAnimation(TelegramMethod[Message]): height: Optional[int] = None """Animation height""" thumb: Optional[Union[InputFile, str]] = None - """Thumbnail of the file sent; can be ignored if thumbnail generation for the file is - supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. - A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded - using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new - file, so you can pass 'attach://' if the thumbnail was uploaded using - multipart/form-data under .""" + """Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://” if the thumbnail was uploaded using multipart/form-data under . `More info on Sending Files » `_""" caption: Optional[str] = None - """Animation caption (may also be used when resending animation by file_id), 0-1024 characters - after entities parsing""" + """Animation caption (may also be used when resending animation by *file_id*), 0-1024 characters after entities parsing""" parse_mode: Optional[str] = UNSET - """Mode for parsing entities in the animation caption. See formatting options for more - details.""" + """Mode for parsing entities in the animation caption. See `formatting options `_ for more details.""" caption_entities: Optional[List[MessageEntity]] = None - """List of special entities that appear in the caption, which can be specified instead of - parse_mode""" + """List of special entities that appear in the caption, which can be specified instead of *parse_mode*""" disable_notification: Optional[bool] = None - """Sends the message silently. Users will receive a notification with no sound.""" + """Sends the message `silently `_. Users will receive a notification with no sound.""" reply_to_message_id: Optional[int] = None """If the message is a reply, ID of the original message""" allow_sending_without_reply: Optional[bool] = None - """Pass True, if the message should be sent even if the specified replied-to message is not - found""" + """Pass *True*, if the message should be sent even if the specified replied-to message is not found""" reply_markup: Optional[ Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply] ] = None - """Additional interface options. A JSON-serialized object for an inline keyboard, custom reply - keyboard, instructions to remove reply keyboard or to force a reply from the user.""" + """Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove reply keyboard or to force a reply from the user.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict(exclude={"animation", "thumb"}) diff --git a/aiogram/methods/send_audio.py b/aiogram/methods/send_audio.py index b09e7d92..72d4558c 100644 --- a/aiogram/methods/send_audio.py +++ b/aiogram/methods/send_audio.py @@ -20,11 +20,8 @@ if TYPE_CHECKING: # pragma: no cover class SendAudio(TelegramMethod[Message]): """ - Use this method to send audio files, if you want Telegram clients to display them in the music - player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message is - returned. Bots can currently send audio files of up to 50 MB in size, this limit may be - changed in the future. - For sending voice messages, use the sendVoice method instead. + Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent `Message `_ is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future. + For sending voice messages, use the `sendVoice `_ method instead. Source: https://core.telegram.org/bots/api#sendaudio """ @@ -32,19 +29,15 @@ class SendAudio(TelegramMethod[Message]): __returning__ = Message chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target channel (in the format - @channelusername)""" + """Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" audio: Union[InputFile, str] - """Audio file to send. Pass a file_id as String to send an audio file that exists on the - Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio - file from the Internet, or upload a new one using multipart/form-data.""" + """Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. `More info on Sending Files » `_""" caption: Optional[str] = None """Audio caption, 0-1024 characters after entities parsing""" parse_mode: Optional[str] = UNSET - """Mode for parsing entities in the audio caption. See formatting options for more details.""" + """Mode for parsing entities in the audio caption. See `formatting options `_ for more details.""" caption_entities: Optional[List[MessageEntity]] = None - """List of special entities that appear in the caption, which can be specified instead of - parse_mode""" + """List of special entities that appear in the caption, which can be specified instead of *parse_mode*""" duration: Optional[int] = None """Duration of the audio in seconds""" performer: Optional[str] = None @@ -52,24 +45,17 @@ class SendAudio(TelegramMethod[Message]): title: Optional[str] = None """Track name""" thumb: Optional[Union[InputFile, str]] = None - """Thumbnail of the file sent; can be ignored if thumbnail generation for the file is - supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. - A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded - using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new - file, so you can pass 'attach://' if the thumbnail was uploaded using - multipart/form-data under .""" + """Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://” if the thumbnail was uploaded using multipart/form-data under . `More info on Sending Files » `_""" disable_notification: Optional[bool] = None - """Sends the message silently. Users will receive a notification with no sound.""" + """Sends the message `silently `_. Users will receive a notification with no sound.""" reply_to_message_id: Optional[int] = None """If the message is a reply, ID of the original message""" allow_sending_without_reply: Optional[bool] = None - """Pass True, if the message should be sent even if the specified replied-to message is not - found""" + """Pass *True*, if the message should be sent even if the specified replied-to message is not found""" reply_markup: Optional[ Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply] ] = None - """Additional interface options. A JSON-serialized object for an inline keyboard, custom reply - keyboard, instructions to remove reply keyboard or to force a reply from the user.""" + """Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove reply keyboard or to force a reply from the user.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict(exclude={"audio", "thumb"}) diff --git a/aiogram/methods/send_chat_action.py b/aiogram/methods/send_chat_action.py index bff4283c..f54d0a1c 100644 --- a/aiogram/methods/send_chat_action.py +++ b/aiogram/methods/send_chat_action.py @@ -10,15 +10,10 @@ if TYPE_CHECKING: # pragma: no cover class SendChatAction(TelegramMethod[bool]): """ - Use this method when you need to tell the user that something is happening on the bot's side. - The status is set for 5 seconds or less (when a message arrives from your bot, Telegram - clients clear its typing status). Returns True on success. - Example: The ImageBot needs some time to process a request and upload the image. Instead of - sending a text message along the lines of 'Retrieving image, please wait…', the bot may use - sendChatAction with action = upload_photo. The user will see a 'sending photo' status for the - bot. - We only recommend using this method when a response from the bot will take a noticeable amount - of time to arrive. + Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns *True* on success. + Example: The `ImageBot `_ needs some time to process a request and upload the image. Instead of sending a text message along the lines of “Retrieving image, please wait…”, the bot may use `sendChatAction `_ with *action* = *upload_photo*. The user will see a “sending photo” status for the bot. + + We only recommend using this method when a response from the bot will take a **noticeable** amount of time to arrive. Source: https://core.telegram.org/bots/api#sendchataction """ @@ -26,13 +21,9 @@ class SendChatAction(TelegramMethod[bool]): __returning__ = bool chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target channel (in the format - @channelusername)""" + """Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" action: str - """Type of action to broadcast. Choose one, depending on what the user is about to receive: - typing for text messages, upload_photo for photos, record_video or upload_video for videos, - record_audio or upload_audio for audio files, upload_document for general files, - find_location for location data, record_video_note or upload_video_note for video notes.""" + """Type of action to broadcast. Choose one, depending on what the user is about to receive: *typing* for `text messages `_, *upload_photo* for `photos `_, *record_video* or *upload_video* for `videos `_, *record_voice* or *upload_voice* for `voice notes `_, *upload_document* for `general files `_, *find_location* for `location data `_, *record_video_note* or *upload_video_note* for `video notes `_.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/send_contact.py b/aiogram/methods/send_contact.py index b92a4d05..4c9ea1da 100644 --- a/aiogram/methods/send_contact.py +++ b/aiogram/methods/send_contact.py @@ -17,7 +17,7 @@ if TYPE_CHECKING: # pragma: no cover class SendContact(TelegramMethod[Message]): """ - Use this method to send phone contacts. On success, the sent Message is returned. + Use this method to send phone contacts. On success, the sent `Message `_ is returned. Source: https://core.telegram.org/bots/api#sendcontact """ @@ -25,8 +25,7 @@ class SendContact(TelegramMethod[Message]): __returning__ = Message chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target channel (in the format - @channelusername)""" + """Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" phone_number: str """Contact's phone number""" first_name: str @@ -34,19 +33,17 @@ class SendContact(TelegramMethod[Message]): last_name: Optional[str] = None """Contact's last name""" vcard: Optional[str] = None - """Additional data about the contact in the form of a vCard, 0-2048 bytes""" + """Additional data about the contact in the form of a `vCard `_, 0-2048 bytes""" disable_notification: Optional[bool] = None - """Sends the message silently. Users will receive a notification with no sound.""" + """Sends the message `silently `_. Users will receive a notification with no sound.""" reply_to_message_id: Optional[int] = None """If the message is a reply, ID of the original message""" allow_sending_without_reply: Optional[bool] = None - """Pass True, if the message should be sent even if the specified replied-to message is not - found""" + """Pass *True*, if the message should be sent even if the specified replied-to message is not found""" reply_markup: Optional[ Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply] ] = None - """Additional interface options. A JSON-serialized object for an inline keyboard, custom reply - keyboard, instructions to remove keyboard or to force a reply from the user.""" + """Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove keyboard or to force a reply from the user.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/send_dice.py b/aiogram/methods/send_dice.py index b648c134..06d1f33b 100644 --- a/aiogram/methods/send_dice.py +++ b/aiogram/methods/send_dice.py @@ -17,8 +17,7 @@ if TYPE_CHECKING: # pragma: no cover class SendDice(TelegramMethod[Message]): """ - Use this method to send an animated emoji that will display a random value. On success, the - sent Message is returned. + Use this method to send an animated emoji that will display a random value. On success, the sent `Message `_ is returned. Source: https://core.telegram.org/bots/api#senddice """ @@ -26,24 +25,19 @@ class SendDice(TelegramMethod[Message]): __returning__ = Message chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target channel (in the format - @channelusername)""" + """Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" emoji: Optional[str] = None - """Emoji on which the dice throw animation is based. Currently, must be one of '', '', '', '', - or ''. Dice can have values 1-6 for '' and '', values 1-5 for '' and '', and values 1-64 - for ''. Defaults to ''""" + """Emoji on which the dice throw animation is based. Currently, must be one of “”, “”, “”, “”, or “”. Dice can have values 1-6 for “” and “”, values 1-5 for “” and “”, and values 1-64 for “”. Defaults to “”""" disable_notification: Optional[bool] = None - """Sends the message silently. Users will receive a notification with no sound.""" + """Sends the message `silently `_. Users will receive a notification with no sound.""" reply_to_message_id: Optional[int] = None """If the message is a reply, ID of the original message""" allow_sending_without_reply: Optional[bool] = None - """Pass True, if the message should be sent even if the specified replied-to message is not - found""" + """Pass *True*, if the message should be sent even if the specified replied-to message is not found""" reply_markup: Optional[ Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply] ] = None - """Additional interface options. A JSON-serialized object for an inline keyboard, custom reply - keyboard, instructions to remove reply keyboard or to force a reply from the user.""" + """Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove reply keyboard or to force a reply from the user.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/send_document.py b/aiogram/methods/send_document.py index 2fc7dab7..a8d2c46c 100644 --- a/aiogram/methods/send_document.py +++ b/aiogram/methods/send_document.py @@ -20,9 +20,7 @@ if TYPE_CHECKING: # pragma: no cover class SendDocument(TelegramMethod[Message]): """ - Use this method to send general files. On success, the sent Message is returned. Bots can - currently send files of any type of up to 50 MB in size, this limit may be changed in the - future. + Use this method to send general files. On success, the sent `Message `_ is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future. Source: https://core.telegram.org/bots/api#senddocument """ @@ -30,42 +28,29 @@ class SendDocument(TelegramMethod[Message]): __returning__ = Message chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target channel (in the format - @channelusername)""" + """Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" document: Union[InputFile, str] - """File to send. Pass a file_id as String to send a file that exists on the Telegram servers - (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, - or upload a new one using multipart/form-data.""" + """File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. `More info on Sending Files » `_""" thumb: Optional[Union[InputFile, str]] = None - """Thumbnail of the file sent; can be ignored if thumbnail generation for the file is - supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. - A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded - using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new - file, so you can pass 'attach://' if the thumbnail was uploaded using - multipart/form-data under .""" + """Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://” if the thumbnail was uploaded using multipart/form-data under . `More info on Sending Files » `_""" caption: Optional[str] = None - """Document caption (may also be used when resending documents by file_id), 0-1024 characters - after entities parsing""" + """Document caption (may also be used when resending documents by *file_id*), 0-1024 characters after entities parsing""" parse_mode: Optional[str] = UNSET - """Mode for parsing entities in the document caption. See formatting options for more details.""" + """Mode for parsing entities in the document caption. See `formatting options `_ for more details.""" caption_entities: Optional[List[MessageEntity]] = None - """List of special entities that appear in the caption, which can be specified instead of - parse_mode""" + """List of special entities that appear in the caption, which can be specified instead of *parse_mode*""" disable_content_type_detection: Optional[bool] = None - """Disables automatic server-side content type detection for files uploaded using - multipart/form-data""" + """Disables automatic server-side content type detection for files uploaded using multipart/form-data""" disable_notification: Optional[bool] = None - """Sends the message silently. Users will receive a notification with no sound.""" + """Sends the message `silently `_. Users will receive a notification with no sound.""" reply_to_message_id: Optional[int] = None """If the message is a reply, ID of the original message""" allow_sending_without_reply: Optional[bool] = None - """Pass True, if the message should be sent even if the specified replied-to message is not - found""" + """Pass *True*, if the message should be sent even if the specified replied-to message is not found""" reply_markup: Optional[ Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply] ] = None - """Additional interface options. A JSON-serialized object for an inline keyboard, custom reply - keyboard, instructions to remove reply keyboard or to force a reply from the user.""" + """Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove reply keyboard or to force a reply from the user.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict(exclude={"document", "thumb"}) diff --git a/aiogram/methods/send_game.py b/aiogram/methods/send_game.py index 1f6fd05f..517fd700 100644 --- a/aiogram/methods/send_game.py +++ b/aiogram/methods/send_game.py @@ -11,7 +11,7 @@ if TYPE_CHECKING: # pragma: no cover class SendGame(TelegramMethod[Message]): """ - Use this method to send a game. On success, the sent Message is returned. + Use this method to send a game. On success, the sent `Message `_ is returned. Source: https://core.telegram.org/bots/api#sendgame """ @@ -21,18 +21,15 @@ class SendGame(TelegramMethod[Message]): chat_id: int """Unique identifier for the target chat""" game_short_name: str - """Short name of the game, serves as the unique identifier for the game. Set up your games via - Botfather.""" + """Short name of the game, serves as the unique identifier for the game. Set up your games via `Botfather `_.""" disable_notification: Optional[bool] = None - """Sends the message silently. Users will receive a notification with no sound.""" + """Sends the message `silently `_. Users will receive a notification with no sound.""" reply_to_message_id: Optional[int] = None """If the message is a reply, ID of the original message""" allow_sending_without_reply: Optional[bool] = None - """Pass True, if the message should be sent even if the specified replied-to message is not - found""" + """Pass *True*, if the message should be sent even if the specified replied-to message is not found""" reply_markup: Optional[InlineKeyboardMarkup] = None - """A JSON-serialized object for an inline keyboard. If empty, one 'Play game_title' button - will be shown. If not empty, the first button must launch the game.""" + """A JSON-serialized object for an `inline keyboard `_. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/send_invoice.py b/aiogram/methods/send_invoice.py index 6277fc82..56e8fdbb 100644 --- a/aiogram/methods/send_invoice.py +++ b/aiogram/methods/send_invoice.py @@ -11,7 +11,7 @@ if TYPE_CHECKING: # pragma: no cover class SendInvoice(TelegramMethod[Message]): """ - Use this method to send invoices. On success, the sent Message is returned. + Use this method to send invoices. On success, the sent `Message `_ is returned. Source: https://core.telegram.org/bots/api#sendinvoice """ @@ -25,24 +25,19 @@ class SendInvoice(TelegramMethod[Message]): description: str """Product description, 1-255 characters""" payload: str - """Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for - your internal processes.""" + """Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.""" provider_token: str - """Payments provider token, obtained via Botfather""" + """Payments provider token, obtained via `Botfather `_""" start_parameter: str - """Unique deep-linking parameter that can be used to generate this invoice when used as a - start parameter""" + """Unique deep-linking parameter that can be used to generate this invoice when used as a start parameter""" currency: str - """Three-letter ISO 4217 currency code, see more on currencies""" + """Three-letter ISO 4217 currency code, see `more on currencies `_""" prices: List[LabeledPrice] - """Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, - delivery cost, delivery tax, bonus, etc.)""" + """Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)""" provider_data: Optional[str] = None - """A JSON-serialized data about the invoice, which will be shared with the payment provider. A - detailed description of required fields should be provided by the payment provider.""" + """A JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.""" photo_url: Optional[str] = None - """URL of the product photo for the invoice. Can be a photo of the goods or a marketing image - for a service. People like it better when they see what they are paying for.""" + """URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for.""" photo_size: Optional[int] = None """Photo size""" photo_width: Optional[int] = None @@ -50,29 +45,27 @@ class SendInvoice(TelegramMethod[Message]): photo_height: Optional[int] = None """Photo height""" need_name: Optional[bool] = None - """Pass True, if you require the user's full name to complete the order""" + """Pass *True*, if you require the user's full name to complete the order""" need_phone_number: Optional[bool] = None - """Pass True, if you require the user's phone number to complete the order""" + """Pass *True*, if you require the user's phone number to complete the order""" need_email: Optional[bool] = None - """Pass True, if you require the user's email address to complete the order""" + """Pass *True*, if you require the user's email address to complete the order""" need_shipping_address: Optional[bool] = None - """Pass True, if you require the user's shipping address to complete the order""" + """Pass *True*, if you require the user's shipping address to complete the order""" send_phone_number_to_provider: Optional[bool] = None - """Pass True, if user's phone number should be sent to provider""" + """Pass *True*, if user's phone number should be sent to provider""" send_email_to_provider: Optional[bool] = None - """Pass True, if user's email address should be sent to provider""" + """Pass *True*, if user's email address should be sent to provider""" is_flexible: Optional[bool] = None - """Pass True, if the final price depends on the shipping method""" + """Pass *True*, if the final price depends on the shipping method""" disable_notification: Optional[bool] = None - """Sends the message silently. Users will receive a notification with no sound.""" + """Sends the message `silently `_. Users will receive a notification with no sound.""" reply_to_message_id: Optional[int] = None """If the message is a reply, ID of the original message""" allow_sending_without_reply: Optional[bool] = None - """Pass True, if the message should be sent even if the specified replied-to message is not - found""" + """Pass *True*, if the message should be sent even if the specified replied-to message is not found""" reply_markup: Optional[InlineKeyboardMarkup] = None - """A JSON-serialized object for an inline keyboard. If empty, one 'Pay total price' button - will be shown. If not empty, the first button must be a Pay button.""" + """A JSON-serialized object for an `inline keyboard `_. If empty, one 'Pay :code:`total price`' button will be shown. If not empty, the first button must be a Pay button.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/send_location.py b/aiogram/methods/send_location.py index d1225c69..70d04242 100644 --- a/aiogram/methods/send_location.py +++ b/aiogram/methods/send_location.py @@ -17,7 +17,7 @@ if TYPE_CHECKING: # pragma: no cover class SendLocation(TelegramMethod[Message]): """ - Use this method to send point on the map. On success, the sent Message is returned. + Use this method to send point on the map. On success, the sent `Message `_ is returned. Source: https://core.telegram.org/bots/api#sendlocation """ @@ -25,8 +25,7 @@ class SendLocation(TelegramMethod[Message]): __returning__ = Message chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target channel (in the format - @channelusername)""" + """Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" latitude: float """Latitude of the location""" longitude: float @@ -34,26 +33,21 @@ class SendLocation(TelegramMethod[Message]): horizontal_accuracy: Optional[float] = None """The radius of uncertainty for the location, measured in meters; 0-1500""" live_period: Optional[int] = None - """Period in seconds for which the location will be updated (see Live Locations, should be - between 60 and 86400.""" + """Period in seconds for which the location will be updated (see `Live Locations `_, should be between 60 and 86400.""" heading: Optional[int] = None - """For live locations, a direction in which the user is moving, in degrees. Must be between 1 - and 360 if specified.""" + """For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.""" proximity_alert_radius: Optional[int] = None - """For live locations, a maximum distance for proximity alerts about approaching another chat - member, in meters. Must be between 1 and 100000 if specified.""" + """For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.""" disable_notification: Optional[bool] = None - """Sends the message silently. Users will receive a notification with no sound.""" + """Sends the message `silently `_. Users will receive a notification with no sound.""" reply_to_message_id: Optional[int] = None """If the message is a reply, ID of the original message""" allow_sending_without_reply: Optional[bool] = None - """Pass True, if the message should be sent even if the specified replied-to message is not - found""" + """Pass *True*, if the message should be sent even if the specified replied-to message is not found""" reply_markup: Optional[ Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply] ] = None - """Additional interface options. A JSON-serialized object for an inline keyboard, custom reply - keyboard, instructions to remove reply keyboard or to force a reply from the user.""" + """Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove reply keyboard or to force a reply from the user.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/send_media_group.py b/aiogram/methods/send_media_group.py index a67a30fa..483e14e3 100644 --- a/aiogram/methods/send_media_group.py +++ b/aiogram/methods/send_media_group.py @@ -18,9 +18,7 @@ if TYPE_CHECKING: # pragma: no cover class SendMediaGroup(TelegramMethod[List[Message]]): """ - Use this method to send a group of photos, videos, documents or audios as an album. Documents - and audio files can be only grouped in an album with messages of the same type. On success, an - array of Messages that were sent is returned. + Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of `Messages `_ that were sent is returned. Source: https://core.telegram.org/bots/api#sendmediagroup """ @@ -28,17 +26,15 @@ class SendMediaGroup(TelegramMethod[List[Message]]): __returning__ = List[Message] chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target channel (in the format - @channelusername)""" + """Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" media: List[Union[InputMediaAudio, InputMediaDocument, InputMediaPhoto, InputMediaVideo]] """A JSON-serialized array describing messages to be sent, must include 2-10 items""" disable_notification: Optional[bool] = None - """Sends messages silently. Users will receive a notification with no sound.""" + """Sends messages `silently `_. Users will receive a notification with no sound.""" reply_to_message_id: Optional[int] = None """If the messages are a reply, ID of the original message""" allow_sending_without_reply: Optional[bool] = None - """Pass True, if the message should be sent even if the specified replied-to message is not - found""" + """Pass *True*, if the message should be sent even if the specified replied-to message is not found""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/send_message.py b/aiogram/methods/send_message.py index 1e1720c3..93c98b53 100644 --- a/aiogram/methods/send_message.py +++ b/aiogram/methods/send_message.py @@ -19,7 +19,7 @@ if TYPE_CHECKING: # pragma: no cover class SendMessage(TelegramMethod[Message]): """ - Use this method to send text messages. On success, the sent Message is returned. + Use this method to send text messages. On success, the sent `Message `_ is returned. Source: https://core.telegram.org/bots/api#sendmessage """ @@ -27,29 +27,25 @@ class SendMessage(TelegramMethod[Message]): __returning__ = Message chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target channel (in the format - @channelusername)""" + """Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" text: str """Text of the message to be sent, 1-4096 characters after entities parsing""" parse_mode: Optional[str] = UNSET - """Mode for parsing entities in the message text. See formatting options for more details.""" + """Mode for parsing entities in the message text. See `formatting options `_ for more details.""" entities: Optional[List[MessageEntity]] = None - """List of special entities that appear in message text, which can be specified instead of - parse_mode""" + """List of special entities that appear in message text, which can be specified instead of *parse_mode*""" disable_web_page_preview: Optional[bool] = None """Disables link previews for links in this message""" disable_notification: Optional[bool] = None - """Sends the message silently. Users will receive a notification with no sound.""" + """Sends the message `silently `_. Users will receive a notification with no sound.""" reply_to_message_id: Optional[int] = None """If the message is a reply, ID of the original message""" allow_sending_without_reply: Optional[bool] = None - """Pass True, if the message should be sent even if the specified replied-to message is not - found""" + """Pass *True*, if the message should be sent even if the specified replied-to message is not found""" reply_markup: Optional[ Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply] ] = None - """Additional interface options. A JSON-serialized object for an inline keyboard, custom reply - keyboard, instructions to remove reply keyboard or to force a reply from the user.""" + """Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove reply keyboard or to force a reply from the user.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/send_photo.py b/aiogram/methods/send_photo.py index a3b0377f..53a22249 100644 --- a/aiogram/methods/send_photo.py +++ b/aiogram/methods/send_photo.py @@ -20,7 +20,7 @@ if TYPE_CHECKING: # pragma: no cover class SendPhoto(TelegramMethod[Message]): """ - Use this method to send photos. On success, the sent Message is returned. + Use this method to send photos. On success, the sent `Message `_ is returned. Source: https://core.telegram.org/bots/api#sendphoto """ @@ -28,32 +28,25 @@ class SendPhoto(TelegramMethod[Message]): __returning__ = Message chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target channel (in the format - @channelusername)""" + """Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" photo: Union[InputFile, str] - """Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers - (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, - or upload a new photo using multipart/form-data.""" + """Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. `More info on Sending Files » `_""" caption: Optional[str] = None - """Photo caption (may also be used when resending photos by file_id), 0-1024 characters after - entities parsing""" + """Photo caption (may also be used when resending photos by *file_id*), 0-1024 characters after entities parsing""" parse_mode: Optional[str] = UNSET - """Mode for parsing entities in the photo caption. See formatting options for more details.""" + """Mode for parsing entities in the photo caption. See `formatting options `_ for more details.""" caption_entities: Optional[List[MessageEntity]] = None - """List of special entities that appear in the caption, which can be specified instead of - parse_mode""" + """List of special entities that appear in the caption, which can be specified instead of *parse_mode*""" disable_notification: Optional[bool] = None - """Sends the message silently. Users will receive a notification with no sound.""" + """Sends the message `silently `_. Users will receive a notification with no sound.""" reply_to_message_id: Optional[int] = None """If the message is a reply, ID of the original message""" allow_sending_without_reply: Optional[bool] = None - """Pass True, if the message should be sent even if the specified replied-to message is not - found""" + """Pass *True*, if the message should be sent even if the specified replied-to message is not found""" reply_markup: Optional[ Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply] ] = None - """Additional interface options. A JSON-serialized object for an inline keyboard, custom reply - keyboard, instructions to remove reply keyboard or to force a reply from the user.""" + """Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove reply keyboard or to force a reply from the user.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict(exclude={"photo"}) diff --git a/aiogram/methods/send_poll.py b/aiogram/methods/send_poll.py index 49bfe76e..9f553dbe 100644 --- a/aiogram/methods/send_poll.py +++ b/aiogram/methods/send_poll.py @@ -20,7 +20,7 @@ if TYPE_CHECKING: # pragma: no cover class SendPoll(TelegramMethod[Message]): """ - Use this method to send a native poll. On success, the sent Message is returned. + Use this method to send a native poll. On success, the sent `Message `_ is returned. Source: https://core.telegram.org/bots/api#sendpoll """ @@ -28,49 +28,41 @@ class SendPoll(TelegramMethod[Message]): __returning__ = Message chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target channel (in the format - @channelusername)""" + """Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" question: str """Poll question, 1-300 characters""" options: List[str] """A JSON-serialized list of answer options, 2-10 strings 1-100 characters each""" is_anonymous: Optional[bool] = None - """True, if the poll needs to be anonymous, defaults to True""" + """True, if the poll needs to be anonymous, defaults to *True*""" type: Optional[str] = None - """Poll type, 'quiz' or 'regular', defaults to 'regular'""" + """Poll type, “quiz” or “regular”, defaults to “regular”""" allows_multiple_answers: Optional[bool] = None - """True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to - False""" + """True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to *False*""" correct_option_id: Optional[int] = None """0-based identifier of the correct answer option, required for polls in quiz mode""" explanation: Optional[str] = None - """Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a - quiz-style poll, 0-200 characters with at most 2 line feeds after entities parsing""" + """Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after entities parsing""" explanation_parse_mode: Optional[str] = UNSET - """Mode for parsing entities in the explanation. See formatting options for more details.""" + """Mode for parsing entities in the explanation. See `formatting options `_ for more details.""" explanation_entities: Optional[List[MessageEntity]] = None - """List of special entities that appear in the poll explanation, which can be specified - instead of parse_mode""" + """List of special entities that appear in the poll explanation, which can be specified instead of *parse_mode*""" open_period: Optional[int] = None - """Amount of time in seconds the poll will be active after creation, 5-600. Can't be used - together with close_date.""" + """Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with *close_date*.""" close_date: Optional[Union[datetime.datetime, datetime.timedelta, int]] = None - """Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least - 5 and no more than 600 seconds in the future. Can't be used together with open_period.""" + """Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can't be used together with *open_period*.""" is_closed: Optional[bool] = None - """Pass True, if the poll needs to be immediately closed. This can be useful for poll preview.""" + """Pass *True*, if the poll needs to be immediately closed. This can be useful for poll preview.""" disable_notification: Optional[bool] = None - """Sends the message silently. Users will receive a notification with no sound.""" + """Sends the message `silently `_. Users will receive a notification with no sound.""" reply_to_message_id: Optional[int] = None """If the message is a reply, ID of the original message""" allow_sending_without_reply: Optional[bool] = None - """Pass True, if the message should be sent even if the specified replied-to message is not - found""" + """Pass *True*, if the message should be sent even if the specified replied-to message is not found""" reply_markup: Optional[ Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply] ] = None - """Additional interface options. A JSON-serialized object for an inline keyboard, custom reply - keyboard, instructions to remove reply keyboard or to force a reply from the user.""" + """Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove reply keyboard or to force a reply from the user.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/send_sticker.py b/aiogram/methods/send_sticker.py index 2d6c982a..3b860457 100644 --- a/aiogram/methods/send_sticker.py +++ b/aiogram/methods/send_sticker.py @@ -18,8 +18,7 @@ if TYPE_CHECKING: # pragma: no cover class SendSticker(TelegramMethod[Message]): """ - Use this method to send static .WEBP or animated .TGS stickers. On success, the sent Message - is returned. + Use this method to send static .WEBP or `animated `_ .TGS stickers. On success, the sent `Message `_ is returned. Source: https://core.telegram.org/bots/api#sendsticker """ @@ -27,24 +26,19 @@ class SendSticker(TelegramMethod[Message]): __returning__ = Message chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target channel (in the format - @channelusername)""" + """Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" sticker: Union[InputFile, str] - """Sticker to send. Pass a file_id as String to send a file that exists on the Telegram - servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP file from - the Internet, or upload a new one using multipart/form-data.""" + """Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP file from the Internet, or upload a new one using multipart/form-data. `More info on Sending Files » `_""" disable_notification: Optional[bool] = None - """Sends the message silently. Users will receive a notification with no sound.""" + """Sends the message `silently `_. Users will receive a notification with no sound.""" reply_to_message_id: Optional[int] = None """If the message is a reply, ID of the original message""" allow_sending_without_reply: Optional[bool] = None - """Pass True, if the message should be sent even if the specified replied-to message is not - found""" + """Pass *True*, if the message should be sent even if the specified replied-to message is not found""" reply_markup: Optional[ Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply] ] = None - """Additional interface options. A JSON-serialized object for an inline keyboard, custom reply - keyboard, instructions to remove reply keyboard or to force a reply from the user.""" + """Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove reply keyboard or to force a reply from the user.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict(exclude={"sticker"}) diff --git a/aiogram/methods/send_venue.py b/aiogram/methods/send_venue.py index ef902217..538defc1 100644 --- a/aiogram/methods/send_venue.py +++ b/aiogram/methods/send_venue.py @@ -17,7 +17,7 @@ if TYPE_CHECKING: # pragma: no cover class SendVenue(TelegramMethod[Message]): """ - Use this method to send information about a venue. On success, the sent Message is returned. + Use this method to send information about a venue. On success, the sent `Message `_ is returned. Source: https://core.telegram.org/bots/api#sendvenue """ @@ -25,8 +25,7 @@ class SendVenue(TelegramMethod[Message]): __returning__ = Message chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target channel (in the format - @channelusername)""" + """Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" latitude: float """Latitude of the venue""" longitude: float @@ -38,24 +37,21 @@ class SendVenue(TelegramMethod[Message]): foursquare_id: Optional[str] = None """Foursquare identifier of the venue""" foursquare_type: Optional[str] = None - """Foursquare type of the venue, if known. (For example, 'arts_entertainment/default', - 'arts_entertainment/aquarium' or 'food/icecream'.)""" + """Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)""" google_place_id: Optional[str] = None """Google Places identifier of the venue""" google_place_type: Optional[str] = None - """Google Places type of the venue. (See supported types.)""" + """Google Places type of the venue. (See `supported types `_.)""" disable_notification: Optional[bool] = None - """Sends the message silently. Users will receive a notification with no sound.""" + """Sends the message `silently `_. Users will receive a notification with no sound.""" reply_to_message_id: Optional[int] = None """If the message is a reply, ID of the original message""" allow_sending_without_reply: Optional[bool] = None - """Pass True, if the message should be sent even if the specified replied-to message is not - found""" + """Pass *True*, if the message should be sent even if the specified replied-to message is not found""" reply_markup: Optional[ Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply] ] = None - """Additional interface options. A JSON-serialized object for an inline keyboard, custom reply - keyboard, instructions to remove reply keyboard or to force a reply from the user.""" + """Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove reply keyboard or to force a reply from the user.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/send_video.py b/aiogram/methods/send_video.py index bee4bc94..cd853764 100644 --- a/aiogram/methods/send_video.py +++ b/aiogram/methods/send_video.py @@ -20,9 +20,7 @@ if TYPE_CHECKING: # pragma: no cover class SendVideo(TelegramMethod[Message]): """ - Use this method to send video files, Telegram clients support mp4 videos (other formats may be - sent as Document). On success, the sent Message is returned. Bots can currently send video - files of up to 50 MB in size, this limit may be changed in the future. + Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as `Document `_). On success, the sent `Message `_ is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future. Source: https://core.telegram.org/bots/api#sendvideo """ @@ -30,12 +28,9 @@ class SendVideo(TelegramMethod[Message]): __returning__ = Message chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target channel (in the format - @channelusername)""" + """Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" video: Union[InputFile, str] - """Video to send. Pass a file_id as String to send a video that exists on the Telegram servers - (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, - or upload a new video using multipart/form-data.""" + """Video to send. Pass a file_id as String to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data. `More info on Sending Files » `_""" duration: Optional[int] = None """Duration of sent video in seconds""" width: Optional[int] = None @@ -43,34 +38,25 @@ class SendVideo(TelegramMethod[Message]): height: Optional[int] = None """Video height""" thumb: Optional[Union[InputFile, str]] = None - """Thumbnail of the file sent; can be ignored if thumbnail generation for the file is - supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. - A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded - using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new - file, so you can pass 'attach://' if the thumbnail was uploaded using - multipart/form-data under .""" + """Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://” if the thumbnail was uploaded using multipart/form-data under . `More info on Sending Files » `_""" caption: Optional[str] = None - """Video caption (may also be used when resending videos by file_id), 0-1024 characters after - entities parsing""" + """Video caption (may also be used when resending videos by *file_id*), 0-1024 characters after entities parsing""" parse_mode: Optional[str] = UNSET - """Mode for parsing entities in the video caption. See formatting options for more details.""" + """Mode for parsing entities in the video caption. See `formatting options `_ for more details.""" caption_entities: Optional[List[MessageEntity]] = None - """List of special entities that appear in the caption, which can be specified instead of - parse_mode""" + """List of special entities that appear in the caption, which can be specified instead of *parse_mode*""" supports_streaming: Optional[bool] = None - """Pass True, if the uploaded video is suitable for streaming""" + """Pass *True*, if the uploaded video is suitable for streaming""" disable_notification: Optional[bool] = None - """Sends the message silently. Users will receive a notification with no sound.""" + """Sends the message `silently `_. Users will receive a notification with no sound.""" reply_to_message_id: Optional[int] = None """If the message is a reply, ID of the original message""" allow_sending_without_reply: Optional[bool] = None - """Pass True, if the message should be sent even if the specified replied-to message is not - found""" + """Pass *True*, if the message should be sent even if the specified replied-to message is not found""" reply_markup: Optional[ Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply] ] = None - """Additional interface options. A JSON-serialized object for an inline keyboard, custom reply - keyboard, instructions to remove reply keyboard or to force a reply from the user.""" + """Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove reply keyboard or to force a reply from the user.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict(exclude={"video", "thumb"}) diff --git a/aiogram/methods/send_video_note.py b/aiogram/methods/send_video_note.py index 6d7eb177..8f1549c0 100644 --- a/aiogram/methods/send_video_note.py +++ b/aiogram/methods/send_video_note.py @@ -18,8 +18,7 @@ if TYPE_CHECKING: # pragma: no cover class SendVideoNote(TelegramMethod[Message]): """ - As of v.4.0, Telegram clients support rounded square mp4 videos of up to 1 minute long. Use - this method to send video messages. On success, the sent Message is returned. + As of `v.4.0 `_, Telegram clients support rounded square mp4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent `Message `_ is returned. Source: https://core.telegram.org/bots/api#sendvideonote """ @@ -27,35 +26,25 @@ class SendVideoNote(TelegramMethod[Message]): __returning__ = Message chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target channel (in the format - @channelusername)""" + """Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" video_note: Union[InputFile, str] - """Video note to send. Pass a file_id as String to send a video note that exists on the - Telegram servers (recommended) or upload a new video using multipart/form-data.. Sending - video notes by a URL is currently unsupported""" + """Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. `More info on Sending Files » `_. Sending video notes by a URL is currently unsupported""" duration: Optional[int] = None """Duration of sent video in seconds""" length: Optional[int] = None """Video width and height, i.e. diameter of the video message""" thumb: Optional[Union[InputFile, str]] = None - """Thumbnail of the file sent; can be ignored if thumbnail generation for the file is - supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. - A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded - using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new - file, so you can pass 'attach://' if the thumbnail was uploaded using - multipart/form-data under .""" + """Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://” if the thumbnail was uploaded using multipart/form-data under . `More info on Sending Files » `_""" disable_notification: Optional[bool] = None - """Sends the message silently. Users will receive a notification with no sound.""" + """Sends the message `silently `_. Users will receive a notification with no sound.""" reply_to_message_id: Optional[int] = None """If the message is a reply, ID of the original message""" allow_sending_without_reply: Optional[bool] = None - """Pass True, if the message should be sent even if the specified replied-to message is not - found""" + """Pass *True*, if the message should be sent even if the specified replied-to message is not found""" reply_markup: Optional[ Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply] ] = None - """Additional interface options. A JSON-serialized object for an inline keyboard, custom reply - keyboard, instructions to remove reply keyboard or to force a reply from the user.""" + """Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove reply keyboard or to force a reply from the user.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict(exclude={"video_note", "thumb"}) diff --git a/aiogram/methods/send_voice.py b/aiogram/methods/send_voice.py index f146e7e2..700f6c59 100644 --- a/aiogram/methods/send_voice.py +++ b/aiogram/methods/send_voice.py @@ -20,11 +20,7 @@ if TYPE_CHECKING: # pragma: no cover class SendVoice(TelegramMethod[Message]): """ - Use this method to send audio files, if you want Telegram clients to display the file as a - playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS - (other formats may be sent as Audio or Document). On success, the sent Message is returned. - Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in - the future. + Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as `Audio `_ or `Document `_). On success, the sent `Message `_ is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future. Source: https://core.telegram.org/bots/api#sendvoice """ @@ -32,34 +28,27 @@ class SendVoice(TelegramMethod[Message]): __returning__ = Message chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target channel (in the format - @channelusername)""" + """Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" voice: Union[InputFile, str] - """Audio file to send. Pass a file_id as String to send a file that exists on the Telegram - servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the - Internet, or upload a new one using multipart/form-data.""" + """Audio file to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. `More info on Sending Files » `_""" caption: Optional[str] = None """Voice message caption, 0-1024 characters after entities parsing""" parse_mode: Optional[str] = UNSET - """Mode for parsing entities in the voice message caption. See formatting options for more - details.""" + """Mode for parsing entities in the voice message caption. See `formatting options `_ for more details.""" caption_entities: Optional[List[MessageEntity]] = None - """List of special entities that appear in the caption, which can be specified instead of - parse_mode""" + """List of special entities that appear in the caption, which can be specified instead of *parse_mode*""" duration: Optional[int] = None """Duration of the voice message in seconds""" disable_notification: Optional[bool] = None - """Sends the message silently. Users will receive a notification with no sound.""" + """Sends the message `silently `_. Users will receive a notification with no sound.""" reply_to_message_id: Optional[int] = None """If the message is a reply, ID of the original message""" allow_sending_without_reply: Optional[bool] = None - """Pass True, if the message should be sent even if the specified replied-to message is not - found""" + """Pass *True*, if the message should be sent even if the specified replied-to message is not found""" reply_markup: Optional[ Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply] ] = None - """Additional interface options. A JSON-serialized object for an inline keyboard, custom reply - keyboard, instructions to remove reply keyboard or to force a reply from the user.""" + """Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove reply keyboard or to force a reply from the user.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict(exclude={"voice"}) diff --git a/aiogram/methods/set_chat_administrator_custom_title.py b/aiogram/methods/set_chat_administrator_custom_title.py index e4929c51..01392c43 100644 --- a/aiogram/methods/set_chat_administrator_custom_title.py +++ b/aiogram/methods/set_chat_administrator_custom_title.py @@ -10,8 +10,7 @@ if TYPE_CHECKING: # pragma: no cover class SetChatAdministratorCustomTitle(TelegramMethod[bool]): """ - Use this method to set a custom title for an administrator in a supergroup promoted by the - bot. Returns True on success. + Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns *True* on success. Source: https://core.telegram.org/bots/api#setchatadministratorcustomtitle """ @@ -19,8 +18,7 @@ class SetChatAdministratorCustomTitle(TelegramMethod[bool]): __returning__ = bool chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target supergroup (in the format - @supergroupusername)""" + """Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)""" user_id: int """Unique identifier of the target user""" custom_title: str diff --git a/aiogram/methods/set_chat_description.py b/aiogram/methods/set_chat_description.py index 2a7ac937..02705a7c 100644 --- a/aiogram/methods/set_chat_description.py +++ b/aiogram/methods/set_chat_description.py @@ -10,9 +10,7 @@ if TYPE_CHECKING: # pragma: no cover class SetChatDescription(TelegramMethod[bool]): """ - Use this method to change the description of a group, a supergroup or a channel. The bot must - be an administrator in the chat for this to work and must have the appropriate admin rights. - Returns True on success. + Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns *True* on success. Source: https://core.telegram.org/bots/api#setchatdescription """ @@ -20,8 +18,7 @@ class SetChatDescription(TelegramMethod[bool]): __returning__ = bool chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target channel (in the format - @channelusername)""" + """Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" description: Optional[str] = None """New chat description, 0-255 characters""" diff --git a/aiogram/methods/set_chat_permissions.py b/aiogram/methods/set_chat_permissions.py index f4739c5c..00e1eaf3 100644 --- a/aiogram/methods/set_chat_permissions.py +++ b/aiogram/methods/set_chat_permissions.py @@ -11,9 +11,7 @@ if TYPE_CHECKING: # pragma: no cover class SetChatPermissions(TelegramMethod[bool]): """ - Use this method to set default chat permissions for all members. The bot must be an - administrator in the group or a supergroup for this to work and must have the - can_restrict_members admin rights. Returns True on success. + Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the *can_restrict_members* admin rights. Returns *True* on success. Source: https://core.telegram.org/bots/api#setchatpermissions """ @@ -21,8 +19,7 @@ class SetChatPermissions(TelegramMethod[bool]): __returning__ = bool chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target supergroup (in the format - @supergroupusername)""" + """Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)""" permissions: ChatPermissions """New default chat permissions""" diff --git a/aiogram/methods/set_chat_photo.py b/aiogram/methods/set_chat_photo.py index 94e8cf55..b4b65288 100644 --- a/aiogram/methods/set_chat_photo.py +++ b/aiogram/methods/set_chat_photo.py @@ -11,9 +11,7 @@ if TYPE_CHECKING: # pragma: no cover class SetChatPhoto(TelegramMethod[bool]): """ - Use this method to set a new profile photo for the chat. Photos can't be changed for private - chats. The bot must be an administrator in the chat for this to work and must have the - appropriate admin rights. Returns True on success. + Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns *True* on success. Source: https://core.telegram.org/bots/api#setchatphoto """ @@ -21,8 +19,7 @@ class SetChatPhoto(TelegramMethod[bool]): __returning__ = bool chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target channel (in the format - @channelusername)""" + """Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" photo: InputFile """New chat photo, uploaded using multipart/form-data""" diff --git a/aiogram/methods/set_chat_sticker_set.py b/aiogram/methods/set_chat_sticker_set.py index 7f37c7ff..65984af6 100644 --- a/aiogram/methods/set_chat_sticker_set.py +++ b/aiogram/methods/set_chat_sticker_set.py @@ -10,10 +10,7 @@ if TYPE_CHECKING: # pragma: no cover class SetChatStickerSet(TelegramMethod[bool]): """ - Use this method to set a new group sticker set for a supergroup. The bot must be an - administrator in the chat for this to work and must have the appropriate admin rights. Use the - field can_set_sticker_set optionally returned in getChat requests to check if the bot can use - this method. Returns True on success. + Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field *can_set_sticker_set* optionally returned in `getChat `_ requests to check if the bot can use this method. Returns *True* on success. Source: https://core.telegram.org/bots/api#setchatstickerset """ @@ -21,8 +18,7 @@ class SetChatStickerSet(TelegramMethod[bool]): __returning__ = bool chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target supergroup (in the format - @supergroupusername)""" + """Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)""" sticker_set_name: str """Name of the sticker set to be set as the group sticker set""" diff --git a/aiogram/methods/set_chat_title.py b/aiogram/methods/set_chat_title.py index 4b3bd8b4..a949df75 100644 --- a/aiogram/methods/set_chat_title.py +++ b/aiogram/methods/set_chat_title.py @@ -10,9 +10,7 @@ if TYPE_CHECKING: # pragma: no cover class SetChatTitle(TelegramMethod[bool]): """ - Use this method to change the title of a chat. Titles can't be changed for private chats. The - bot must be an administrator in the chat for this to work and must have the appropriate admin - rights. Returns True on success. + Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns *True* on success. Source: https://core.telegram.org/bots/api#setchattitle """ @@ -20,8 +18,7 @@ class SetChatTitle(TelegramMethod[bool]): __returning__ = bool chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target channel (in the format - @channelusername)""" + """Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" title: str """New chat title, 1-255 characters""" diff --git a/aiogram/methods/set_game_score.py b/aiogram/methods/set_game_score.py index 41d3f054..cb579825 100644 --- a/aiogram/methods/set_game_score.py +++ b/aiogram/methods/set_game_score.py @@ -11,9 +11,7 @@ if TYPE_CHECKING: # pragma: no cover class SetGameScore(TelegramMethod[Union[Message, bool]]): """ - Use this method to set the score of the specified user in a game. On success, if the message - was sent by the bot, returns the edited Message, otherwise returns True. Returns an error, if - the new score is not greater than the user's current score in the chat and force is False. + Use this method to set the score of the specified user in a game. On success, if the message was sent by the bot, returns the edited `Message `_, otherwise returns *True*. Returns an error, if the new score is not greater than the user's current score in the chat and *force* is *False*. Source: https://core.telegram.org/bots/api#setgamescore """ @@ -25,17 +23,15 @@ class SetGameScore(TelegramMethod[Union[Message, bool]]): score: int """New score, must be non-negative""" force: Optional[bool] = None - """Pass True, if the high score is allowed to decrease. This can be useful when fixing - mistakes or banning cheaters""" + """Pass True, if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters""" disable_edit_message: Optional[bool] = None - """Pass True, if the game message should not be automatically edited to include the current - scoreboard""" + """Pass True, if the game message should not be automatically edited to include the current scoreboard""" chat_id: Optional[int] = None - """Required if inline_message_id is not specified. Unique identifier for the target chat""" + """Required if *inline_message_id* is not specified. Unique identifier for the target chat""" message_id: Optional[int] = None - """Required if inline_message_id is not specified. Identifier of the sent message""" + """Required if *inline_message_id* is not specified. Identifier of the sent message""" inline_message_id: Optional[str] = None - """Required if chat_id and message_id are not specified. Identifier of the inline message""" + """Required if *chat_id* and *message_id* are not specified. Identifier of the inline message""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/set_my_commands.py b/aiogram/methods/set_my_commands.py index f7fd7b9a..8d1458f4 100644 --- a/aiogram/methods/set_my_commands.py +++ b/aiogram/methods/set_my_commands.py @@ -11,7 +11,7 @@ if TYPE_CHECKING: # pragma: no cover class SetMyCommands(TelegramMethod[bool]): """ - Use this method to change the list of the bot's commands. Returns True on success. + Use this method to change the list of the bot's commands. Returns *True* on success. Source: https://core.telegram.org/bots/api#setmycommands """ @@ -19,8 +19,7 @@ class SetMyCommands(TelegramMethod[bool]): __returning__ = bool commands: List[BotCommand] - """A JSON-serialized list of bot commands to be set as the list of the bot's commands. At most - 100 commands can be specified.""" + """A JSON-serialized list of bot commands to be set as the list of the bot's commands. At most 100 commands can be specified.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/set_passport_data_errors.py b/aiogram/methods/set_passport_data_errors.py index 280187a9..85dfcff5 100644 --- a/aiogram/methods/set_passport_data_errors.py +++ b/aiogram/methods/set_passport_data_errors.py @@ -11,13 +11,8 @@ if TYPE_CHECKING: # pragma: no cover class SetPassportDataErrors(TelegramMethod[bool]): """ - Informs a user that some of the Telegram Passport elements they provided contains errors. The - user will not be able to re-submit their Passport to you until the errors are fixed (the - contents of the field for which you returned the error must change). Returns True on success. - Use this if the data submitted by the user doesn't satisfy the standards your service requires - for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, - a scan shows evidence of tampering, etc. Supply some details in the error message to make sure - the user knows how to correct the issues. + Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns *True* on success. + Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues. Source: https://core.telegram.org/bots/api#setpassportdataerrors """ diff --git a/aiogram/methods/set_sticker_position_in_set.py b/aiogram/methods/set_sticker_position_in_set.py index 54c27bfd..1b3cc37f 100644 --- a/aiogram/methods/set_sticker_position_in_set.py +++ b/aiogram/methods/set_sticker_position_in_set.py @@ -10,8 +10,7 @@ if TYPE_CHECKING: # pragma: no cover class SetStickerPositionInSet(TelegramMethod[bool]): """ - Use this method to move a sticker in a set created by the bot to a specific position. Returns - True on success. + Use this method to move a sticker in a set created by the bot to a specific position. Returns *True* on success. Source: https://core.telegram.org/bots/api#setstickerpositioninset """ diff --git a/aiogram/methods/set_sticker_set_thumb.py b/aiogram/methods/set_sticker_set_thumb.py index 67d3e50e..57f88557 100644 --- a/aiogram/methods/set_sticker_set_thumb.py +++ b/aiogram/methods/set_sticker_set_thumb.py @@ -11,8 +11,7 @@ if TYPE_CHECKING: # pragma: no cover class SetStickerSetThumb(TelegramMethod[bool]): """ - Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for - animated sticker sets only. Returns True on success. + Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Returns *True* on success. Source: https://core.telegram.org/bots/api#setstickersetthumb """ @@ -24,13 +23,7 @@ class SetStickerSetThumb(TelegramMethod[bool]): user_id: int """User identifier of the sticker set owner""" thumb: Optional[Union[InputFile, str]] = None - """A PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and - height exactly 100px, or a TGS animation with the thumbnail up to 32 kilobytes in size; see - https://core.telegram.org/animated_stickers#technical-requirements for animated sticker - technical requirements. Pass a file_id as a String to send a file that already exists on - the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the - Internet, or upload a new one using multipart/form-data.. Animated sticker set thumbnail - can't be uploaded via HTTP URL.""" + """A **PNG** image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a **TGS** animation with the thumbnail up to 32 kilobytes in size; see `https://core.telegram.org/animated_stickers#technical-requirements `_`https://core.telegram.org/animated_stickers#technical-requirements `_ for animated sticker technical requirements. Pass a *file_id* as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. `More info on Sending Files » `_. Animated sticker set thumbnail can't be uploaded via HTTP URL.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict(exclude={"thumb"}) diff --git a/aiogram/methods/set_webhook.py b/aiogram/methods/set_webhook.py index e3d3a240..a0584603 100644 --- a/aiogram/methods/set_webhook.py +++ b/aiogram/methods/set_webhook.py @@ -11,21 +11,16 @@ if TYPE_CHECKING: # pragma: no cover class SetWebhook(TelegramMethod[bool]): """ - Use this method to specify a url and receive incoming updates via an outgoing webhook. - Whenever there is an update for the bot, we will send an HTTPS POST request to the specified - url, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up - after a reasonable amount of attempts. Returns True on success. - If you'd like to make sure that the Webhook request comes from Telegram, we recommend using a - secret path in the URL, e.g. https://www.example.com/. Since nobody else knows your - bot's token, you can be pretty sure it's us. - Notes - 1. You will not be able to receive updates using getUpdates for as long as an outgoing webhook - is set up. - 2. To use a self-signed certificate, you need to upload your public key certificate using - certificate parameter. Please upload as InputFile, sending a String will not work. - 3. Ports currently supported for Webhooks: 443, 80, 88, 8443. - NEW! If you're having any trouble setting up webhooks, please check out this amazing guide to - Webhooks. + Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified url, containing a JSON-serialized `Update `_. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns *True* on success. + If you'd like to make sure that the Webhook request comes from Telegram, we recommend using a secret path in the URL, e.g. :code:`https://www.example.com/`. Since nobody else knows your bot's token, you can be pretty sure it's us. + **Notes** + + **1.** You will not be able to receive updates using `getUpdates `_ for as long as an outgoing webhook is set up. + + **2.** To use a self-signed certificate, you need to upload your `public key certificate `_ using *certificate* parameter. Please upload as InputFile, sending a String will not work. + + **3.** Ports currently supported *for Webhooks*: **443, 80, 88, 8443**. + **NEW!** If you're having any trouble setting up webhooks, please check out this `amazing guide to Webhooks `_. Source: https://core.telegram.org/bots/api#setwebhook """ @@ -35,23 +30,15 @@ class SetWebhook(TelegramMethod[bool]): url: str """HTTPS url to send updates to. Use an empty string to remove webhook integration""" certificate: Optional[InputFile] = None - """Upload your public key certificate so that the root certificate in use can be checked. See - our self-signed guide for details.""" + """Upload your public key certificate so that the root certificate in use can be checked. See our `self-signed guide `_ for details.""" ip_address: Optional[str] = None - """The fixed IP address which will be used to send webhook requests instead of the IP address - resolved through DNS""" + """The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS""" max_connections: Optional[int] = None - """Maximum allowed number of simultaneous HTTPS connections to the webhook for update - delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, - and higher values to increase your bot's throughput.""" + """Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to *40*. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput.""" allowed_updates: Optional[List[str]] = None - """A JSON-serialized list of the update types you want your bot to receive. For example, - specify ['message', 'edited_channel_post', 'callback_query'] to only receive updates of - these types. See Update for a complete list of available update types. Specify an empty - list to receive all updates regardless of type (default). If not specified, the previous - setting will be used.""" + """A JSON-serialized list of the update types you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See `Update `_ for a complete list of available update types. Specify an empty list to receive all updates regardless of type (default). If not specified, the previous setting will be used.""" drop_pending_updates: Optional[bool] = None - """Pass True to drop all pending updates""" + """Pass *True* to drop all pending updates""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict(exclude={"certificate"}) diff --git a/aiogram/methods/stop_message_live_location.py b/aiogram/methods/stop_message_live_location.py index a7677163..183a3195 100644 --- a/aiogram/methods/stop_message_live_location.py +++ b/aiogram/methods/stop_message_live_location.py @@ -11,9 +11,7 @@ if TYPE_CHECKING: # pragma: no cover class StopMessageLiveLocation(TelegramMethod[Union[Message, bool]]): """ - Use this method to stop updating a live location message before live_period expires. On - success, if the message was sent by the bot, the sent Message is returned, otherwise True is - returned. + Use this method to stop updating a live location message before *live_period* expires. On success, if the message was sent by the bot, the sent `Message `_ is returned, otherwise *True* is returned. Source: https://core.telegram.org/bots/api#stopmessagelivelocation """ @@ -21,15 +19,13 @@ class StopMessageLiveLocation(TelegramMethod[Union[Message, bool]]): __returning__ = Union[Message, bool] chat_id: Optional[Union[int, str]] = None - """Required if inline_message_id is not specified. Unique identifier for the target chat or - username of the target channel (in the format @channelusername)""" + """Required if *inline_message_id* is not specified. Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" message_id: Optional[int] = None - """Required if inline_message_id is not specified. Identifier of the message with live - location to stop""" + """Required if *inline_message_id* is not specified. Identifier of the message with live location to stop""" inline_message_id: Optional[str] = None - """Required if chat_id and message_id are not specified. Identifier of the inline message""" + """Required if *chat_id* and *message_id* are not specified. Identifier of the inline message""" reply_markup: Optional[InlineKeyboardMarkup] = None - """A JSON-serialized object for a new inline keyboard.""" + """A JSON-serialized object for a new `inline keyboard `_.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/stop_poll.py b/aiogram/methods/stop_poll.py index 81e8ef26..b39cf848 100644 --- a/aiogram/methods/stop_poll.py +++ b/aiogram/methods/stop_poll.py @@ -11,8 +11,7 @@ if TYPE_CHECKING: # pragma: no cover class StopPoll(TelegramMethod[Poll]): """ - Use this method to stop a poll which was sent by the bot. On success, the stopped Poll with - the final results is returned. + Use this method to stop a poll which was sent by the bot. On success, the stopped `Poll `_ with the final results is returned. Source: https://core.telegram.org/bots/api#stoppoll """ @@ -20,12 +19,11 @@ class StopPoll(TelegramMethod[Poll]): __returning__ = Poll chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target channel (in the format - @channelusername)""" + """Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" message_id: int """Identifier of the original message with the poll""" reply_markup: Optional[InlineKeyboardMarkup] = None - """A JSON-serialized object for a new message inline keyboard.""" + """A JSON-serialized object for a new message `inline keyboard `_.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/unban_chat_member.py b/aiogram/methods/unban_chat_member.py index f50e430c..4c37c5eb 100644 --- a/aiogram/methods/unban_chat_member.py +++ b/aiogram/methods/unban_chat_member.py @@ -10,12 +10,7 @@ if TYPE_CHECKING: # pragma: no cover class UnbanChatMember(TelegramMethod[bool]): """ - Use this method to unban a previously kicked user in a supergroup or channel. The user will - not return to the group or channel automatically, but will be able to join via link, etc. The - bot must be an administrator for this to work. By default, this method guarantees that after - the call the user is not a member of the chat, but will be able to join it. So if the user is - a member of the chat they will also be removed from the chat. If you don't want this, use the - parameter only_if_banned. Returns True on success. + Use this method to unban a previously kicked user in a supergroup or channel. The user will **not** return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be **removed** from the chat. If you don't want this, use the parameter *only_if_banned*. Returns *True* on success. Source: https://core.telegram.org/bots/api#unbanchatmember """ @@ -23,8 +18,7 @@ class UnbanChatMember(TelegramMethod[bool]): __returning__ = bool chat_id: Union[int, str] - """Unique identifier for the target group or username of the target supergroup or channel (in - the format @username)""" + """Unique identifier for the target group or username of the target supergroup or channel (in the format :code:`@username`)""" user_id: int """Unique identifier of the target user""" only_if_banned: Optional[bool] = None diff --git a/aiogram/methods/unpin_all_chat_messages.py b/aiogram/methods/unpin_all_chat_messages.py index c26d6874..a0020047 100644 --- a/aiogram/methods/unpin_all_chat_messages.py +++ b/aiogram/methods/unpin_all_chat_messages.py @@ -10,10 +10,7 @@ if TYPE_CHECKING: # pragma: no cover class UnpinAllChatMessages(TelegramMethod[bool]): """ - Use this method to clear the list of pinned messages in a chat. If the chat is not a private - chat, the bot must be an administrator in the chat for this to work and must have the - 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a - channel. Returns True on success. + Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns *True* on success. Source: https://core.telegram.org/bots/api#unpinallchatmessages """ @@ -21,8 +18,7 @@ class UnpinAllChatMessages(TelegramMethod[bool]): __returning__ = bool chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target channel (in the format - @channelusername)""" + """Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/unpin_chat_message.py b/aiogram/methods/unpin_chat_message.py index 86eaf325..a2c02ff8 100644 --- a/aiogram/methods/unpin_chat_message.py +++ b/aiogram/methods/unpin_chat_message.py @@ -10,10 +10,7 @@ if TYPE_CHECKING: # pragma: no cover class UnpinChatMessage(TelegramMethod[bool]): """ - Use this method to remove a message from the list of pinned messages in a chat. If the chat is - not a private chat, the bot must be an administrator in the chat for this to work and must - have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in - a channel. Returns True on success. + Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns *True* on success. Source: https://core.telegram.org/bots/api#unpinchatmessage """ @@ -21,11 +18,9 @@ class UnpinChatMessage(TelegramMethod[bool]): __returning__ = bool chat_id: Union[int, str] - """Unique identifier for the target chat or username of the target channel (in the format - @channelusername)""" + """Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)""" message_id: Optional[int] = None - """Identifier of a message to unpin. If not specified, the most recent pinned message (by - sending date) will be unpinned.""" + """Identifier of a message to unpin. If not specified, the most recent pinned message (by sending date) will be unpinned.""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict() diff --git a/aiogram/methods/upload_sticker_file.py b/aiogram/methods/upload_sticker_file.py index a5f553e3..80a4c237 100644 --- a/aiogram/methods/upload_sticker_file.py +++ b/aiogram/methods/upload_sticker_file.py @@ -11,8 +11,7 @@ if TYPE_CHECKING: # pragma: no cover class UploadStickerFile(TelegramMethod[File]): """ - Use this method to upload a .PNG file with a sticker for later use in createNewStickerSet and - addStickerToSet methods (can be used multiple times). Returns the uploaded File on success. + Use this method to upload a .PNG file with a sticker for later use in *createNewStickerSet* and *addStickerToSet* methods (can be used multiple times). Returns the uploaded `File `_ on success. Source: https://core.telegram.org/bots/api#uploadstickerfile """ @@ -22,8 +21,7 @@ class UploadStickerFile(TelegramMethod[File]): user_id: int """User identifier of sticker file owner""" png_sticker: InputFile - """PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed - 512px, and either width or height must be exactly 512px.""" + """**PNG** image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. `More info on Sending Files » `_""" def build_request(self, bot: Bot) -> Request: data: Dict[str, Any] = self.dict(exclude={"png_sticker"})