`\n",
+ "name": "sticker"
+ },
+ {
+ "type": "String",
+ "required": true,
+ "description": "Format of the sticker, must be one of 'static', 'animated', 'video'",
+ "html_description": "| Format of the sticker, must be one of “static”, “animated”, “video” | ",
+ "rst_description": "Format of the sticker, must be one of 'static', 'animated', 'video'\n",
+ "name": "sticker_format"
}
],
"category": "methods"
diff --git a/.butcher/schema/schema.json b/.butcher/schema/schema.json
index 5a184105..02015146 100644
--- a/.butcher/schema/schema.json
+++ b/.butcher/schema/schema.json
@@ -1,7 +1,7 @@
{
"api": {
- "version": "6.3",
- "release_date": "2022-11-05"
+ "version": "6.6",
+ "release_date": "2023-03-09"
},
"items": [
{
@@ -635,6 +635,22 @@
"name": "message_auto_delete_time",
"required": false
},
+ {
+ "type": "True",
+ "description": "True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators. Returned only in getChat.",
+ "html_description": "Optional. True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators. Returned only in getChat. | ",
+ "rst_description": "*Optional*. :code:`True`, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
+ "name": "has_aggressive_anti_spam_enabled",
+ "required": false
+ },
+ {
+ "type": "True",
+ "description": "True, if non-administrators can only get the list of bots and administrators in the chat. Returned only in getChat.",
+ "html_description": "Optional. True, if non-administrators can only get the list of bots and administrators in the chat. Returned only in getChat. | ",
+ "rst_description": "*Optional*. :code:`True`, if non-administrators can only get the list of bots and administrators in the chat. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
+ "name": "has_hidden_members",
+ "required": false
+ },
{
"type": "True",
"description": "True, if messages from the chat can't be forwarded to other chats. Returned only in getChat.",
@@ -941,6 +957,14 @@
"name": "caption_entities",
"required": false
},
+ {
+ "type": "True",
+ "description": "True, if the message media is covered by a spoiler animation",
+ "html_description": "Optional. True, if the message media is covered by a spoiler animation | ",
+ "rst_description": "*Optional*. :code:`True`, if the message media is covered by a spoiler animation\n",
+ "name": "has_media_spoiler",
+ "required": false
+ },
{
"type": "Contact",
"description": "Message is a shared contact, information about the contact",
@@ -1101,6 +1125,22 @@
"name": "successful_payment",
"required": false
},
+ {
+ "type": "UserShared",
+ "description": "Service message: a user was shared with the bot",
+ "html_description": "Optional. Service message: a user was shared with the bot | ",
+ "rst_description": "*Optional*. Service message: a user was shared with the bot\n",
+ "name": "user_shared",
+ "required": false
+ },
+ {
+ "type": "ChatShared",
+ "description": "Service message: a chat was shared with the bot",
+ "html_description": "Optional. Service message: a chat was shared with the bot | ",
+ "rst_description": "*Optional*. Service message: a chat was shared with the bot\n",
+ "name": "chat_shared",
+ "required": false
+ },
{
"type": "String",
"description": "The domain name of the website on which the user has logged in.",
@@ -1109,6 +1149,14 @@
"name": "connected_website",
"required": false
},
+ {
+ "type": "WriteAccessAllowed",
+ "description": "Service message: the user allowed the bot added to the attachment menu to write messages",
+ "html_description": "Optional. Service message: the user allowed the bot added to the attachment menu to write messages | ",
+ "rst_description": "*Optional*. Service message: the user allowed the bot added to the attachment menu to write messages\n",
+ "name": "write_access_allowed",
+ "required": false
+ },
{
"type": "PassportData",
"description": "Telegram Passport data",
@@ -1133,6 +1181,14 @@
"name": "forum_topic_created",
"required": false
},
+ {
+ "type": "ForumTopicEdited",
+ "description": "Service message: forum topic edited",
+ "html_description": "Optional. Service message: forum topic edited | ",
+ "rst_description": "*Optional*. Service message: forum topic edited\n",
+ "name": "forum_topic_edited",
+ "required": false
+ },
{
"type": "ForumTopicClosed",
"description": "Service message: forum topic closed",
@@ -1149,6 +1205,22 @@
"name": "forum_topic_reopened",
"required": false
},
+ {
+ "type": "GeneralForumTopicHidden",
+ "description": "Service message: the 'General' forum topic hidden",
+ "html_description": "Optional. Service message: the 'General' forum topic hidden | ",
+ "rst_description": "*Optional*. Service message: the 'General' forum topic hidden\n",
+ "name": "general_forum_topic_hidden",
+ "required": false
+ },
+ {
+ "type": "GeneralForumTopicUnhidden",
+ "description": "Service message: the 'General' forum topic unhidden",
+ "html_description": "Optional. Service message: the 'General' forum topic unhidden | ",
+ "rst_description": "*Optional*. Service message: the 'General' forum topic unhidden\n",
+ "name": "general_forum_topic_unhidden",
+ "required": false
+ },
{
"type": "VideoChatScheduled",
"description": "Service message: video chat scheduled",
@@ -1386,7 +1458,7 @@
"description": "Animation thumbnail as defined by sender",
"html_description": "Optional. Animation thumbnail as defined by sender | ",
"rst_description": "*Optional*. Animation thumbnail as defined by sender\n",
- "name": "thumb",
+ "name": "thumbnail",
"required": false
},
{
@@ -1492,7 +1564,7 @@
"description": "Thumbnail of the album cover to which the music file belongs",
"html_description": "Optional. Thumbnail of the album cover to which the music file belongs | ",
"rst_description": "*Optional*. Thumbnail of the album cover to which the music file belongs\n",
- "name": "thumb",
+ "name": "thumbnail",
"required": false
}
],
@@ -1526,7 +1598,7 @@
"description": "Document thumbnail as defined by sender",
"html_description": "Optional. Document thumbnail as defined by sender | ",
"rst_description": "*Optional*. Document thumbnail as defined by sender\n",
- "name": "thumb",
+ "name": "thumbnail",
"required": false
},
{
@@ -1608,7 +1680,7 @@
"description": "Video thumbnail",
"html_description": "Optional. Video thumbnail | ",
"rst_description": "*Optional*. Video thumbnail\n",
- "name": "thumb",
+ "name": "thumbnail",
"required": false
},
{
@@ -1682,7 +1754,7 @@
"description": "Video thumbnail",
"html_description": "Optional. Video thumbnail | ",
"rst_description": "*Optional*. Video thumbnail\n",
- "name": "thumb",
+ "name": "thumbnail",
"required": false
},
{
@@ -2241,6 +2313,32 @@
"annotations": [],
"category": "types"
},
+ {
+ "anchor": "forumtopicedited",
+ "name": "ForumTopicEdited",
+ "description": "This object represents a service message about an edited forum topic.",
+ "html_description": "This object represents a service message about an edited forum topic.
",
+ "rst_description": "This object represents a service message about an edited forum topic.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "New name of the topic, if it was edited",
+ "html_description": "Optional. New name of the topic, if it was edited | ",
+ "rst_description": "*Optional*. New name of the topic, if it was edited\n",
+ "name": "name",
+ "required": false
+ },
+ {
+ "type": "String",
+ "description": "New identifier of the custom emoji shown as the topic icon, if it was edited; an empty string if the icon was removed",
+ "html_description": "Optional. New identifier of the custom emoji shown as the topic icon, if it was edited; an empty string if the icon was removed | ",
+ "rst_description": "*Optional*. New identifier of the custom emoji shown as the topic icon, if it was edited; an empty string if the icon was removed\n",
+ "name": "icon_custom_emoji_id",
+ "required": false
+ }
+ ],
+ "category": "types"
+ },
{
"anchor": "forumtopicreopened",
"name": "ForumTopicReopened",
@@ -2250,6 +2348,85 @@
"annotations": [],
"category": "types"
},
+ {
+ "anchor": "generalforumtopichidden",
+ "name": "GeneralForumTopicHidden",
+ "description": "This object represents a service message about General forum topic hidden in the chat. Currently holds no information.",
+ "html_description": "This object represents a service message about General forum topic hidden in the chat. Currently holds no information.
",
+ "rst_description": "This object represents a service message about General forum topic hidden in the chat. Currently holds no information.",
+ "annotations": [],
+ "category": "types"
+ },
+ {
+ "anchor": "generalforumtopicunhidden",
+ "name": "GeneralForumTopicUnhidden",
+ "description": "This object represents a service message about General forum topic unhidden in the chat. Currently holds no information.",
+ "html_description": "This object represents a service message about General forum topic unhidden in the chat. Currently holds no information.
",
+ "rst_description": "This object represents a service message about General forum topic unhidden in the chat. Currently holds no information.",
+ "annotations": [],
+ "category": "types"
+ },
+ {
+ "anchor": "usershared",
+ "name": "UserShared",
+ "description": "This object contains information about the user whose identifier was shared with the bot using a KeyboardButtonRequestUser button.",
+ "html_description": "This object contains information about the user whose identifier was shared with the bot using a KeyboardButtonRequestUser button.
",
+ "rst_description": "This object contains information about the user whose identifier was shared with the bot using a :class:`aiogram.types.keyboard_button_request_user.KeyboardButtonRequestUser` button.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "description": "Identifier of the request",
+ "html_description": "Identifier of the request | ",
+ "rst_description": "Identifier of the request\n",
+ "name": "request_id",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "Identifier of the shared user. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot may not have access to the user and could be unable to use this identifier, unless the user is already known to the bot by some other means.",
+ "html_description": "Identifier of the shared user. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot may not have access to the user and could be unable to use this identifier, unless the user is already known to the bot by some other means. | ",
+ "rst_description": "Identifier of the shared user. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot may not have access to the user and could be unable to use this identifier, unless the user is already known to the bot by some other means.\n",
+ "name": "user_id",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "chatshared",
+ "name": "ChatShared",
+ "description": "This object contains information about the chat whose identifier was shared with the bot using a KeyboardButtonRequestChat button.",
+ "html_description": "This object contains information about the chat whose identifier was shared with the bot using a KeyboardButtonRequestChat button.
",
+ "rst_description": "This object contains information about the chat whose identifier was shared with the bot using a :class:`aiogram.types.keyboard_button_request_chat.KeyboardButtonRequestChat` button.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "description": "Identifier of the request",
+ "html_description": "Identifier of the request | ",
+ "rst_description": "Identifier of the request\n",
+ "name": "request_id",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "Identifier of the shared chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot may not have access to the chat and could be unable to use this identifier, unless the chat is already known to the bot by some other means.",
+ "html_description": "Identifier of the shared chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot may not have access to the chat and could be unable to use this identifier, unless the chat is already known to the bot by some other means. | ",
+ "rst_description": "Identifier of the shared chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot may not have access to the chat and could be unable to use this identifier, unless the chat is already known to the bot by some other means.\n",
+ "name": "chat_id",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "writeaccessallowed",
+ "name": "WriteAccessAllowed",
+ "description": "This object represents a service message about a user allowing a bot added to the attachment menu to write messages. Currently holds no information.",
+ "html_description": "This object represents a service message about a user allowing a bot added to the attachment menu to write messages. Currently holds no information.
",
+ "rst_description": "This object represents a service message about a user allowing a bot added to the attachment menu to write messages. Currently holds no information.",
+ "annotations": [],
+ "category": "types"
+ },
{
"anchor": "videochatscheduled",
"name": "VideoChatScheduled",
@@ -2414,6 +2591,14 @@
"name": "keyboard",
"required": true
},
+ {
+ "type": "Boolean",
+ "description": "Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon.",
+ "html_description": "Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon. | ",
+ "rst_description": "*Optional*. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to *false*, in which case the custom keyboard can be hidden and opened with a keyboard icon.\n",
+ "name": "is_persistent",
+ "required": false
+ },
{
"type": "Boolean",
"description": "Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard.",
@@ -2452,9 +2637,9 @@
{
"anchor": "keyboardbutton",
"name": "KeyboardButton",
- "description": "This object represents one button of the reply keyboard. For simple text buttons String can be used instead of this object to specify text of the button. Optional fields web_app, request_contact, request_location, and request_poll are mutually exclusive.\nNote: request_contact and request_location options will only work in Telegram versions released after 9 April, 2016. Older clients will display unsupported message.\nNote: request_poll option will only work in Telegram versions released after 23 January, 2020. Older clients will display unsupported message.\nNote: web_app option will only work in Telegram versions released after 16 April, 2022. Older clients will display unsupported message.",
- "html_description": "This object represents one button of the reply keyboard. For simple text buttons String can be used instead of this object to specify text of the button. Optional fields web_app, request_contact, request_location, and request_poll are mutually exclusive.
Note: request_contact and request_location options will only work in Telegram versions released after 9 April, 2016. Older clients will display unsupported message.
\nNote: request_poll option will only work in Telegram versions released after 23 January, 2020. Older clients will display unsupported message.
\nNote: web_app option will only work in Telegram versions released after 16 April, 2022. Older clients will display unsupported message.
",
- "rst_description": "This object represents one button of the reply keyboard. For simple text buttons *String* can be used instead of this object to specify text of the button. Optional fields *web_app*, *request_contact*, *request_location*, and *request_poll* are mutually exclusive.\n**Note:** *request_contact* and *request_location* options will only work in Telegram versions released after 9 April, 2016. Older clients will display *unsupported message*.\n\n**Note:** *request_poll* option will only work in Telegram versions released after 23 January, 2020. Older clients will display *unsupported message*.\n\n**Note:** *web_app* option will only work in Telegram versions released after 16 April, 2022. Older clients will display *unsupported message*.",
+ "description": "This object represents one button of the reply keyboard. For simple text buttons, String can be used instead of this object to specify the button text. The optional fields web_app, request_user, request_chat, request_contact, request_location, and request_poll are mutually exclusive.\nNote: request_contact and request_location options will only work in Telegram versions released after 9 April, 2016. Older clients will display unsupported message.\nNote: request_poll option will only work in Telegram versions released after 23 January, 2020. Older clients will display unsupported message.\nNote: web_app option will only work in Telegram versions released after 16 April, 2022. Older clients will display unsupported message.\nNote: request_user and request_chat options will only work in Telegram versions released after 3 February, 2023. Older clients will display unsupported message.",
+ "html_description": "This object represents one button of the reply keyboard. For simple text buttons, String can be used instead of this object to specify the button text. The optional fields web_app, request_user, request_chat, request_contact, request_location, and request_poll are mutually exclusive.
Note: request_contact and request_location options will only work in Telegram versions released after 9 April, 2016. Older clients will display unsupported message.
\nNote: request_poll option will only work in Telegram versions released after 23 January, 2020. Older clients will display unsupported message.
\nNote: web_app option will only work in Telegram versions released after 16 April, 2022. Older clients will display unsupported message.
\nNote: request_user and request_chat options will only work in Telegram versions released after 3 February, 2023. Older clients will display unsupported message.
",
+ "rst_description": "This object represents one button of the reply keyboard. For simple text buttons, *String* can be used instead of this object to specify the button text. The optional fields *web_app*, *request_user*, *request_chat*, *request_contact*, *request_location*, and *request_poll* are mutually exclusive.\n**Note:** *request_contact* and *request_location* options will only work in Telegram versions released after 9 April, 2016. Older clients will display *unsupported message*.\n\n**Note:** *request_poll* option will only work in Telegram versions released after 23 January, 2020. Older clients will display *unsupported message*.\n\n**Note:** *web_app* option will only work in Telegram versions released after 16 April, 2022. Older clients will display *unsupported message*.\n\n**Note:** *request_user* and *request_chat* options will only work in Telegram versions released after 3 February, 2023. Older clients will display *unsupported message*.",
"annotations": [
{
"type": "String",
@@ -2464,6 +2649,22 @@
"name": "text",
"required": true
},
+ {
+ "type": "KeyboardButtonRequestUser",
+ "description": "If specified, pressing the button will open a list of suitable users. Tapping on any user will send their identifier to the bot in a 'user_shared' service message. Available in private chats only.",
+ "html_description": "Optional. If specified, pressing the button will open a list of suitable users. Tapping on any user will send their identifier to the bot in a “user_shared” service message. Available in private chats only. | ",
+ "rst_description": "*Optional.* If specified, pressing the button will open a list of suitable users. Tapping on any user will send their identifier to the bot in a 'user_shared' service message. Available in private chats only.\n",
+ "name": "request_user",
+ "required": false
+ },
+ {
+ "type": "KeyboardButtonRequestChat",
+ "description": "If specified, pressing the button will open a list of suitable chats. Tapping on a chat will send its identifier to the bot in a 'chat_shared' service message. Available in private chats only.",
+ "html_description": "Optional. If specified, pressing the button will open a list of suitable chats. Tapping on a chat will send its identifier to the bot in a “chat_shared” service message. Available in private chats only. | ",
+ "rst_description": "*Optional.* If specified, pressing the button will open a list of suitable chats. Tapping on a chat will send its identifier to the bot in a 'chat_shared' service message. Available in private chats only.\n",
+ "name": "request_chat",
+ "required": false
+ },
{
"type": "Boolean",
"description": "If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only.",
@@ -2499,6 +2700,114 @@
],
"category": "types"
},
+ {
+ "anchor": "keyboardbuttonrequestuser",
+ "name": "KeyboardButtonRequestUser",
+ "description": "This object defines the criteria used to request a suitable user. The identifier of the selected user will be shared with the bot when the corresponding button is pressed.",
+ "html_description": "This object defines the criteria used to request a suitable user. The identifier of the selected user will be shared with the bot when the corresponding button is pressed.
",
+ "rst_description": "This object defines the criteria used to request a suitable user. The identifier of the selected user will be shared with the bot when the corresponding button is pressed.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "description": "Signed 32-bit identifier of the request, which will be received back in the UserShared object. Must be unique within the message",
+ "html_description": "Signed 32-bit identifier of the request, which will be received back in the UserShared object. Must be unique within the message | ",
+ "rst_description": "Signed 32-bit identifier of the request, which will be received back in the :class:`aiogram.types.user_shared.UserShared` object. Must be unique within the message\n",
+ "name": "request_id",
+ "required": true
+ },
+ {
+ "type": "Boolean",
+ "description": "Pass True to request a bot, pass False to request a regular user. If not specified, no additional restrictions are applied.",
+ "html_description": "Optional. Pass True to request a bot, pass False to request a regular user. If not specified, no additional restrictions are applied. | ",
+ "rst_description": "*Optional*. Pass :code:`True` to request a bot, pass :code:`False` to request a regular user. If not specified, no additional restrictions are applied.\n",
+ "name": "user_is_bot",
+ "required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "Pass True to request a premium user, pass False to request a non-premium user. If not specified, no additional restrictions are applied.",
+ "html_description": "Optional. Pass True to request a premium user, pass False to request a non-premium user. If not specified, no additional restrictions are applied. | ",
+ "rst_description": "*Optional*. Pass :code:`True` to request a premium user, pass :code:`False` to request a non-premium user. If not specified, no additional restrictions are applied.\n",
+ "name": "user_is_premium",
+ "required": false
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "keyboardbuttonrequestchat",
+ "name": "KeyboardButtonRequestChat",
+ "description": "This object defines the criteria used to request a suitable chat. The identifier of the selected chat will be shared with the bot when the corresponding button is pressed.",
+ "html_description": "This object defines the criteria used to request a suitable chat. The identifier of the selected chat will be shared with the bot when the corresponding button is pressed.
",
+ "rst_description": "This object defines the criteria used to request a suitable chat. The identifier of the selected chat will be shared with the bot when the corresponding button is pressed.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "description": "Signed 32-bit identifier of the request, which will be received back in the ChatShared object. Must be unique within the message",
+ "html_description": "Signed 32-bit identifier of the request, which will be received back in the ChatShared object. Must be unique within the message | ",
+ "rst_description": "Signed 32-bit identifier of the request, which will be received back in the :class:`aiogram.types.chat_shared.ChatShared` object. Must be unique within the message\n",
+ "name": "request_id",
+ "required": true
+ },
+ {
+ "type": "Boolean",
+ "description": "Pass True to request a channel chat, pass False to request a group or a supergroup chat.",
+ "html_description": "Pass True to request a channel chat, pass False to request a group or a supergroup chat. | ",
+ "rst_description": "Pass :code:`True` to request a channel chat, pass :code:`False` to request a group or a supergroup chat.\n",
+ "name": "chat_is_channel",
+ "required": true
+ },
+ {
+ "type": "Boolean",
+ "description": "Pass True to request a forum supergroup, pass False to request a non-forum chat. If not specified, no additional restrictions are applied.",
+ "html_description": "Optional. Pass True to request a forum supergroup, pass False to request a non-forum chat. If not specified, no additional restrictions are applied. | ",
+ "rst_description": "*Optional*. Pass :code:`True` to request a forum supergroup, pass :code:`False` to request a non-forum chat. If not specified, no additional restrictions are applied.\n",
+ "name": "chat_is_forum",
+ "required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "Pass True to request a supergroup or a channel with a username, pass False to request a chat without a username. If not specified, no additional restrictions are applied.",
+ "html_description": "Optional. Pass True to request a supergroup or a channel with a username, pass False to request a chat without a username. If not specified, no additional restrictions are applied. | ",
+ "rst_description": "*Optional*. Pass :code:`True` to request a supergroup or a channel with a username, pass :code:`False` to request a chat without a username. If not specified, no additional restrictions are applied.\n",
+ "name": "chat_has_username",
+ "required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "Pass True to request a chat owned by the user. Otherwise, no additional restrictions are applied.",
+ "html_description": "Optional. Pass True to request a chat owned by the user. Otherwise, no additional restrictions are applied. | ",
+ "rst_description": "*Optional*. Pass :code:`True` to request a chat owned by the user. Otherwise, no additional restrictions are applied.\n",
+ "name": "chat_is_created",
+ "required": false
+ },
+ {
+ "type": "ChatAdministratorRights",
+ "description": "A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of bot_administrator_rights. If not specified, no additional restrictions are applied.",
+ "html_description": "Optional. A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of bot_administrator_rights. If not specified, no additional restrictions are applied. | ",
+ "rst_description": "*Optional*. A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of *bot_administrator_rights*. If not specified, no additional restrictions are applied.\n",
+ "name": "user_administrator_rights",
+ "required": false
+ },
+ {
+ "type": "ChatAdministratorRights",
+ "description": "A JSON-serialized object listing the required administrator rights of the bot in the chat. The rights must be a subset of user_administrator_rights. If not specified, no additional restrictions are applied.",
+ "html_description": "Optional. A JSON-serialized object listing the required administrator rights of the bot in the chat. The rights must be a subset of user_administrator_rights. If not specified, no additional restrictions are applied. | ",
+ "rst_description": "*Optional*. A JSON-serialized object listing the required administrator rights of the bot in the chat. The rights must be a subset of *user_administrator_rights*. If not specified, no additional restrictions are applied.\n",
+ "name": "bot_administrator_rights",
+ "required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "Pass True to request a chat with the bot as a member. Otherwise, no additional restrictions are applied.",
+ "html_description": "Optional. Pass True to request a chat with the bot as a member. Otherwise, no additional restrictions are applied. | ",
+ "rst_description": "*Optional*. Pass :code:`True` to request a chat with the bot as a member. Otherwise, no additional restrictions are applied.\n",
+ "name": "bot_is_member",
+ "required": false
+ }
+ ],
+ "category": "types"
+ },
{
"anchor": "keyboardbuttonpolltype",
"name": "KeyboardButtonPollType",
@@ -2958,9 +3267,9 @@
},
{
"type": "Boolean",
- "description": "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 the user)",
- "html_description": "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 the user) | ",
- "rst_description": ":code:`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 the user)\n",
+ "description": "True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user)",
+ "html_description": "True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user) | ",
+ "rst_description": ":code:`True`, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user)\n",
"name": "can_promote_members",
"required": true
},
@@ -3139,9 +3448,9 @@
},
{
"type": "Boolean",
- "description": "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 the user)",
- "html_description": "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 the user) | ",
- "rst_description": ":code:`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 the user)\n",
+ "description": "True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user)",
+ "html_description": "True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user) | ",
+ "rst_description": ":code:`True`, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user)\n",
"name": "can_promote_members",
"required": true
},
@@ -3261,6 +3570,86 @@
"name": "is_member",
"required": true
},
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to send text messages, contacts, invoices, locations and venues",
+ "html_description": "True, if the user is allowed to send text messages, contacts, invoices, locations and venues | ",
+ "rst_description": ":code:`True`, if the user is allowed to send text messages, contacts, invoices, locations and venues\n",
+ "name": "can_send_messages",
+ "required": true
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to send audios",
+ "html_description": "True, if the user is allowed to send audios | ",
+ "rst_description": ":code:`True`, if the user is allowed to send audios\n",
+ "name": "can_send_audios",
+ "required": true
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to send documents",
+ "html_description": "True, if the user is allowed to send documents | ",
+ "rst_description": ":code:`True`, if the user is allowed to send documents\n",
+ "name": "can_send_documents",
+ "required": true
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to send photos",
+ "html_description": "True, if the user is allowed to send photos | ",
+ "rst_description": ":code:`True`, if the user is allowed to send photos\n",
+ "name": "can_send_photos",
+ "required": true
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to send videos",
+ "html_description": "True, if the user is allowed to send videos | ",
+ "rst_description": ":code:`True`, if the user is allowed to send videos\n",
+ "name": "can_send_videos",
+ "required": true
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to send video notes",
+ "html_description": "True, if the user is allowed to send video notes | ",
+ "rst_description": ":code:`True`, if the user is allowed to send video notes\n",
+ "name": "can_send_video_notes",
+ "required": true
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to send voice notes",
+ "html_description": "True, if the user is allowed to send voice notes | ",
+ "rst_description": ":code:`True`, if the user is allowed to send voice notes\n",
+ "name": "can_send_voice_notes",
+ "required": true
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to send polls",
+ "html_description": "True, if the user is allowed to send polls | ",
+ "rst_description": ":code:`True`, if the user is allowed to send polls\n",
+ "name": "can_send_polls",
+ "required": true
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to send animations, games, stickers and use inline bots",
+ "html_description": "True, if the user is allowed to send animations, games, stickers and use inline bots | ",
+ "rst_description": ":code:`True`, if the user is allowed to send animations, games, stickers and use inline bots\n",
+ "name": "can_send_other_messages",
+ "required": true
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to add web page previews to their messages",
+ "html_description": "True, if the user is allowed to add web page previews to their messages | ",
+ "rst_description": ":code:`True`, if the user is allowed to add web page previews to their messages\n",
+ "name": "can_add_web_page_previews",
+ "required": true
+ },
{
"type": "Boolean",
"description": "True, if the user is allowed to change the chat title, photo and other settings",
@@ -3293,46 +3682,6 @@
"name": "can_manage_topics",
"required": true
},
- {
- "type": "Boolean",
- "description": "True, if the user is allowed to send text messages, contacts, locations and venues",
- "html_description": "True, if the user is allowed to send text messages, contacts, locations and venues | ",
- "rst_description": ":code:`True`, if the user is allowed to send text messages, contacts, locations and venues\n",
- "name": "can_send_messages",
- "required": true
- },
- {
- "type": "Boolean",
- "description": "True, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes",
- "html_description": "True, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes | ",
- "rst_description": ":code:`True`, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes\n",
- "name": "can_send_media_messages",
- "required": true
- },
- {
- "type": "Boolean",
- "description": "True, if the user is allowed to send polls",
- "html_description": "True, if the user is allowed to send polls | ",
- "rst_description": ":code:`True`, if the user is allowed to send polls\n",
- "name": "can_send_polls",
- "required": true
- },
- {
- "type": "Boolean",
- "description": "True, if the user is allowed to send animations, games, stickers and use inline bots",
- "html_description": "True, if the user is allowed to send animations, games, stickers and use inline bots | ",
- "rst_description": ":code:`True`, if the user is allowed to send animations, games, stickers and use inline bots\n",
- "name": "can_send_other_messages",
- "required": true
- },
- {
- "type": "Boolean",
- "description": "True, if the user is allowed to add web page previews to their messages",
- "html_description": "True, if the user is allowed to add web page previews to their messages | ",
- "rst_description": ":code:`True`, if the user is allowed to add web page previews to their messages\n",
- "name": "can_add_web_page_previews",
- "required": true
- },
{
"type": "Integer",
"description": "Date when restrictions will be lifted for this user; unix time. If 0, then the user is restricted forever",
@@ -3485,6 +3834,14 @@
"name": "from",
"required": true
},
+ {
+ "type": "Integer",
+ "description": "Identifier of a private chat with the user who sent the join request. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot can use this identifier for 24 hours to send messages until the join request is processed, assuming no other administrator contacted the user.",
+ "html_description": "Identifier of a private chat with the user who sent the join request. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot can use this identifier for 24 hours to send messages until the join request is processed, assuming no other administrator contacted the user. | ",
+ "rst_description": "Identifier of a private chat with the user who sent the join request. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot can use this identifier for 24 hours to send messages until the join request is processed, assuming no other administrator contacted the user.\n",
+ "name": "user_chat_id",
+ "required": true
+ },
{
"type": "Integer",
"description": "Date the request was sent in Unix time",
@@ -3521,41 +3878,81 @@
"annotations": [
{
"type": "Boolean",
- "description": "True, if the user is allowed to send text messages, contacts, locations and venues",
- "html_description": "Optional. True, if the user is allowed to send text messages, contacts, locations and venues | ",
- "rst_description": "*Optional*. :code:`True`, if the user is allowed to send text messages, contacts, locations and venues\n",
+ "description": "True, if the user is allowed to send text messages, contacts, invoices, locations and venues",
+ "html_description": "Optional. True, if the user is allowed to send text messages, contacts, invoices, locations and venues | ",
+ "rst_description": "*Optional*. :code:`True`, if the user is allowed to send text messages, contacts, invoices, locations and venues\n",
"name": "can_send_messages",
"required": false
},
{
"type": "Boolean",
- "description": "True, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages",
- "html_description": "Optional. True, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages | ",
- "rst_description": "*Optional*. :code:`True`, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages\n",
- "name": "can_send_media_messages",
+ "description": "True, if the user is allowed to send audios",
+ "html_description": "Optional. True, if the user is allowed to send audios | ",
+ "rst_description": "*Optional*. :code:`True`, if the user is allowed to send audios\n",
+ "name": "can_send_audios",
"required": false
},
{
"type": "Boolean",
- "description": "True, if the user is allowed to send polls, implies can_send_messages",
- "html_description": "Optional. True, if the user is allowed to send polls, implies can_send_messages | ",
- "rst_description": "*Optional*. :code:`True`, if the user is allowed to send polls, implies can_send_messages\n",
+ "description": "True, if the user is allowed to send documents",
+ "html_description": "Optional. True, if the user is allowed to send documents | ",
+ "rst_description": "*Optional*. :code:`True`, if the user is allowed to send documents\n",
+ "name": "can_send_documents",
+ "required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to send photos",
+ "html_description": "Optional. True, if the user is allowed to send photos | ",
+ "rst_description": "*Optional*. :code:`True`, if the user is allowed to send photos\n",
+ "name": "can_send_photos",
+ "required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to send videos",
+ "html_description": "Optional. True, if the user is allowed to send videos | ",
+ "rst_description": "*Optional*. :code:`True`, if the user is allowed to send videos\n",
+ "name": "can_send_videos",
+ "required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to send video notes",
+ "html_description": "Optional. True, if the user is allowed to send video notes | ",
+ "rst_description": "*Optional*. :code:`True`, if the user is allowed to send video notes\n",
+ "name": "can_send_video_notes",
+ "required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to send voice notes",
+ "html_description": "Optional. True, if the user is allowed to send voice notes | ",
+ "rst_description": "*Optional*. :code:`True`, if the user is allowed to send voice notes\n",
+ "name": "can_send_voice_notes",
+ "required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to send polls",
+ "html_description": "Optional. True, if the user is allowed to send polls | ",
+ "rst_description": "*Optional*. :code:`True`, if the user is allowed to send polls\n",
"name": "can_send_polls",
"required": false
},
{
"type": "Boolean",
- "description": "True, if the user is allowed to send animations, games, stickers and use inline bots, implies can_send_media_messages",
- "html_description": "Optional. True, if the user is allowed to send animations, games, stickers and use inline bots, implies can_send_media_messages | ",
- "rst_description": "*Optional*. :code:`True`, if the user is allowed to send animations, games, stickers and use inline bots, implies can_send_media_messages\n",
+ "description": "True, if the user is allowed to send animations, games, stickers and use inline bots",
+ "html_description": "Optional. True, if the user is allowed to send animations, games, stickers and use inline bots | ",
+ "rst_description": "*Optional*. :code:`True`, if the user is allowed to send animations, games, stickers and use inline bots\n",
"name": "can_send_other_messages",
"required": false
},
{
"type": "Boolean",
- "description": "True, if the user is allowed to add web page previews to their messages, implies can_send_media_messages",
- "html_description": "Optional. True, if the user is allowed to add web page previews to their messages, implies can_send_media_messages | ",
- "rst_description": "*Optional*. :code:`True`, if the user is allowed to add web page previews to their messages, implies can_send_media_messages\n",
+ "description": "True, if the user is allowed to add web page previews to their messages",
+ "html_description": "Optional. True, if the user is allowed to add web page previews to their messages | ",
+ "rst_description": "*Optional*. :code:`True`, if the user is allowed to add web page previews to their messages\n",
"name": "can_add_web_page_previews",
"required": false
},
@@ -3855,6 +4252,42 @@
],
"category": "types"
},
+ {
+ "anchor": "botdescription",
+ "name": "BotDescription",
+ "description": "This object represents the bot's description.",
+ "html_description": "This object represents the bot's description.
",
+ "rst_description": "This object represents the bot's description.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "The bot's description",
+ "html_description": "The bot's description | ",
+ "rst_description": "The bot's description\n",
+ "name": "description",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "botshortdescription",
+ "name": "BotShortDescription",
+ "description": "This object represents the bot's short description.",
+ "html_description": "This object represents the bot's short description.
",
+ "rst_description": "This object represents the bot's short description.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "The bot's short description",
+ "html_description": "The bot's short description | ",
+ "rst_description": "The bot's short description\n",
+ "name": "short_description",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
{
"anchor": "menubutton",
"name": "MenuButton",
@@ -4015,6 +4448,14 @@
"rst_description": "*Optional*. List of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"name": "caption_entities",
"required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "Pass True if the photo needs to be covered with a spoiler animation",
+ "html_description": "Optional. Pass True if the photo needs to be covered with a spoiler animation | ",
+ "rst_description": "*Optional*. Pass :code:`True` if the photo needs to be covered with a spoiler animation\n",
+ "name": "has_spoiler",
+ "required": false
}
],
"category": "types"
@@ -4047,7 +4488,7 @@
"description": "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 information on Sending Files",
"html_description": "Optional. 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://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | ",
"rst_description": "*Optional*. 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 . :ref:`More information on Sending Files » `\n",
- "name": "thumb",
+ "name": "thumbnail",
"required": false
},
{
@@ -4105,6 +4546,14 @@
"rst_description": "*Optional*. Pass :code:`True` if the uploaded video is suitable for streaming\n",
"name": "supports_streaming",
"required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "Pass True if the video needs to be covered with a spoiler animation",
+ "html_description": "Optional. Pass True if the video needs to be covered with a spoiler animation | ",
+ "rst_description": "*Optional*. Pass :code:`True` if the video needs to be covered with a spoiler animation\n",
+ "name": "has_spoiler",
+ "required": false
}
],
"category": "types"
@@ -4137,7 +4586,7 @@
"description": "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 information on Sending Files",
"html_description": "Optional. 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://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | ",
"rst_description": "*Optional*. 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 . :ref:`More information on Sending Files » `\n",
- "name": "thumb",
+ "name": "thumbnail",
"required": false
},
{
@@ -4187,6 +4636,14 @@
"rst_description": "*Optional*. Animation duration in seconds\n",
"name": "duration",
"required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "Pass True if the animation needs to be covered with a spoiler animation",
+ "html_description": "Optional. Pass True if the animation needs to be covered with a spoiler animation | ",
+ "rst_description": "*Optional*. Pass :code:`True` if the animation needs to be covered with a spoiler animation\n",
+ "name": "has_spoiler",
+ "required": false
}
],
"category": "types"
@@ -4219,7 +4676,7 @@
"description": "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 information on Sending Files",
"html_description": "Optional. 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://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | ",
"rst_description": "*Optional*. 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 . :ref:`More information on Sending Files » `\n",
- "name": "thumb",
+ "name": "thumbnail",
"required": false
},
{
@@ -4301,7 +4758,7 @@
"description": "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 information on Sending Files",
"html_description": "Optional. 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://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | ",
"rst_description": "*Optional*. 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 . :ref:`More information on Sending Files » `\n",
- "name": "thumb",
+ "name": "thumbnail",
"required": false
},
{
@@ -4699,6 +5156,14 @@
"rst_description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"name": "caption_entities"
},
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True if the photo needs to be covered with a spoiler animation",
+ "html_description": "Pass True if the photo needs to be covered with a spoiler animation | ",
+ "rst_description": "Pass :code:`True` if the photo needs to be covered with a spoiler animation\n",
+ "name": "has_spoiler"
+ },
{
"type": "Boolean",
"required": false,
@@ -4827,7 +5292,7 @@
"description": "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 information on Sending Files",
"html_description": "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://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | ",
"rst_description": "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 . :ref:`More information on Sending Files » `\n",
- "name": "thumb"
+ "name": "thumbnail"
},
{
"type": "Boolean",
@@ -4909,7 +5374,7 @@
"description": "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 information on Sending Files",
"html_description": "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://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | ",
"rst_description": "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 . :ref:`More information on Sending Files » `\n",
- "name": "thumb"
+ "name": "thumbnail"
},
{
"type": "String",
@@ -5047,7 +5512,7 @@
"description": "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 information on Sending Files",
"html_description": "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://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | ",
"rst_description": "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 . :ref:`More information on Sending Files » `\n",
- "name": "thumb"
+ "name": "thumbnail"
},
{
"type": "String",
@@ -5073,6 +5538,14 @@
"rst_description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"name": "caption_entities"
},
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True if the video needs to be covered with a spoiler animation",
+ "html_description": "Pass True if the video needs to be covered with a spoiler animation | ",
+ "rst_description": "Pass :code:`True` if the video needs to be covered with a spoiler animation\n",
+ "name": "has_spoiler"
+ },
{
"type": "Boolean",
"required": false,
@@ -5185,7 +5658,7 @@
"description": "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 information on Sending Files",
"html_description": "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://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | ",
"rst_description": "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 . :ref:`More information on Sending Files » `\n",
- "name": "thumb"
+ "name": "thumbnail"
},
{
"type": "String",
@@ -5211,6 +5684,14 @@
"rst_description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"name": "caption_entities"
},
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True if the animation needs to be covered with a spoiler animation",
+ "html_description": "Pass True if the animation needs to be covered with a spoiler animation | ",
+ "rst_description": "Pass :code:`True` if the animation needs to be covered with a spoiler animation\n",
+ "name": "has_spoiler"
+ },
{
"type": "Boolean",
"required": false,
@@ -5413,7 +5894,7 @@
"description": "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 information on Sending Files",
"html_description": "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://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | ",
"rst_description": "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 . :ref:`More information on Sending Files » `\n",
- "name": "thumb"
+ "name": "thumbnail"
},
{
"type": "Boolean",
@@ -5638,130 +6119,6 @@
],
"category": "methods"
},
- {
- "anchor": "editmessagelivelocation",
- "name": "editMessageLiveLocation",
- "description": "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.",
- "html_description": "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.
",
- "rst_description": "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 :class:`aiogram.methods.stop_message_live_location.StopMessageLiveLocation`. On success, if the edited message is not an inline message, the edited :class:`aiogram.types.message.Message` is returned, otherwise :code:`True` is returned.",
- "annotations": [
- {
- "type": "Integer or String",
- "required": false,
- "description": "Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
- "html_description": "Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ",
- "rst_description": "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`)\n",
- "name": "chat_id"
- },
- {
- "type": "Integer",
- "required": false,
- "description": "Required if inline_message_id is not specified. Identifier of the message to edit",
- "html_description": "Required if inline_message_id is not specified. Identifier of the message to edit | ",
- "rst_description": "Required if *inline_message_id* is not specified. Identifier of the message to edit\n",
- "name": "message_id"
- },
- {
- "type": "String",
- "required": false,
- "description": "Required if chat_id and message_id are not specified. Identifier of the inline message",
- "html_description": "Required if chat_id and message_id are not specified. Identifier of the inline message | ",
- "rst_description": "Required if *chat_id* and *message_id* are not specified. Identifier of the inline message\n",
- "name": "inline_message_id"
- },
- {
- "type": "Float number",
- "required": true,
- "description": "Latitude of new location",
- "html_description": "Latitude of new location | ",
- "rst_description": "Latitude of new location\n",
- "name": "latitude"
- },
- {
- "type": "Float number",
- "required": true,
- "description": "Longitude of new location",
- "html_description": "Longitude of new location | ",
- "rst_description": "Longitude of new location\n",
- "name": "longitude"
- },
- {
- "type": "Float number",
- "required": false,
- "description": "The radius of uncertainty for the location, measured in meters; 0-1500",
- "html_description": "The radius of uncertainty for the location, measured in meters; 0-1500 | ",
- "rst_description": "The radius of uncertainty for the location, measured in meters; 0-1500\n",
- "name": "horizontal_accuracy"
- },
- {
- "type": "Integer",
- "required": false,
- "description": "Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.",
- "html_description": "Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified. | ",
- "rst_description": "Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.\n",
- "name": "heading"
- },
- {
- "type": "Integer",
- "required": false,
- "description": "The maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.",
- "html_description": "The maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. | ",
- "rst_description": "The maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.\n",
- "name": "proximity_alert_radius"
- },
- {
- "type": "InlineKeyboardMarkup",
- "required": false,
- "description": "A JSON-serialized object for a new inline keyboard.",
- "html_description": "A JSON-serialized object for a new inline keyboard. | ",
- "rst_description": "A JSON-serialized object for a new `inline keyboard `_.\n",
- "name": "reply_markup"
- }
- ],
- "category": "methods"
- },
- {
- "anchor": "stopmessagelivelocation",
- "name": "stopMessageLiveLocation",
- "description": "Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.",
- "html_description": "Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.
",
- "rst_description": "Use this method to stop updating a live location message before *live_period* expires. On success, if the message is not an inline message, the edited :class:`aiogram.types.message.Message` is returned, otherwise :code:`True` is returned.",
- "annotations": [
- {
- "type": "Integer or String",
- "required": false,
- "description": "Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
- "html_description": "Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ",
- "rst_description": "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`)\n",
- "name": "chat_id"
- },
- {
- "type": "Integer",
- "required": false,
- "description": "Required if inline_message_id is not specified. Identifier of the message with live location to stop",
- "html_description": "Required if inline_message_id is not specified. Identifier of the message with live location to stop | ",
- "rst_description": "Required if *inline_message_id* is not specified. Identifier of the message with live location to stop\n",
- "name": "message_id"
- },
- {
- "type": "String",
- "required": false,
- "description": "Required if chat_id and message_id are not specified. Identifier of the inline message",
- "html_description": "Required if chat_id and message_id are not specified. Identifier of the inline message | ",
- "rst_description": "Required if *chat_id* and *message_id* are not specified. Identifier of the inline message\n",
- "name": "inline_message_id"
- },
- {
- "type": "InlineKeyboardMarkup",
- "required": false,
- "description": "A JSON-serialized object for a new inline keyboard.",
- "html_description": "A JSON-serialized object for a new inline keyboard. | ",
- "rst_description": "A JSON-serialized object for a new `inline keyboard `_.\n",
- "name": "reply_markup"
- }
- ],
- "category": "methods"
- },
{
"anchor": "sendvenue",
"name": "sendVenue",
@@ -6241,6 +6598,14 @@
"rst_description": "Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n",
"name": "chat_id"
},
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Unique identifier for the target message thread; supergroups only",
+ "html_description": "Unique identifier for the target message thread; supergroups only | ",
+ "rst_description": "Unique identifier for the target message thread; supergroups only\n",
+ "name": "message_thread_id"
+ },
{
"type": "String",
"required": true,
@@ -6411,6 +6776,14 @@
"rst_description": "A JSON-serialized object for new user permissions\n",
"name": "permissions"
},
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission.",
+ "html_description": "Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission. | ",
+ "rst_description": "Pass :code:`True` if chat permissions are set independently. Otherwise, the *can_send_other_messages* and *can_add_web_page_previews* permissions will imply the *can_send_messages*, *can_send_audios*, *can_send_documents*, *can_send_photos*, *can_send_videos*, *can_send_video_notes*, and *can_send_voice_notes* permissions; the *can_send_polls* permission will imply the *can_send_messages* permission.\n",
+ "name": "use_independent_chat_permissions"
+ },
{
"type": "Integer",
"required": false,
@@ -6504,9 +6877,9 @@
{
"type": "Boolean",
"required": false,
- "description": "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)",
- "html_description": "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) | ",
- "rst_description": "Pass :code:`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)\n",
+ "description": "Pass True if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by him)",
+ "html_description": "Pass True if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by him) | ",
+ "rst_description": "Pass :code:`True` if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by him)\n",
"name": "can_promote_members"
},
{
@@ -6652,6 +7025,14 @@
"html_description": "A JSON-serialized object for new default chat permissions | ",
"rst_description": "A JSON-serialized object for new default chat permissions\n",
"name": "permissions"
+ },
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission.",
+ "html_description": "Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission. | ",
+ "rst_description": "Pass :code:`True` if chat permissions are set independently. Otherwise, the *can_send_other_messages* and *can_add_web_page_previews* permissions will imply the *can_send_messages*, *can_send_audios*, *can_send_documents*, *can_send_photos*, *can_send_videos*, *can_send_video_notes*, and *can_send_voice_notes* permissions; the *can_send_polls* permission will imply the *can_send_messages* permission.\n",
+ "name": "use_independent_chat_permissions"
}
],
"category": "methods"
@@ -7109,9 +7490,9 @@
{
"anchor": "getchatmember",
"name": "getChatMember",
- "description": "Use this method to get information about a member of a chat. Returns a ChatMember object on success.",
- "html_description": "Use this method to get information about a member of a chat. Returns a ChatMember object on success.
",
- "rst_description": "Use this method to get information about a member of a chat. Returns a :class:`aiogram.types.chat_member.ChatMember` object on success.",
+ "description": "Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a ChatMember object on success.",
+ "html_description": "Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a ChatMember object on success.
",
+ "rst_description": "Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a :class:`aiogram.types.chat_member.ChatMember` object on success.",
"annotations": [
{
"type": "Integer or String",
@@ -7252,18 +7633,18 @@
},
{
"type": "String",
- "required": true,
- "description": "New topic name, 1-128 characters",
- "html_description": "New topic name, 1-128 characters | ",
- "rst_description": "New topic name, 1-128 characters\n",
+ "required": false,
+ "description": "New topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept",
+ "html_description": "New topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept | ",
+ "rst_description": "New topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept\n",
"name": "name"
},
{
"type": "String",
- "required": true,
- "description": "New unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers.",
- "html_description": "New unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers. | ",
- "rst_description": "New unique identifier of the custom emoji shown as the topic icon. Use :class:`aiogram.methods.get_forum_topic_icon_stickers.GetForumTopicIconStickers` to get all allowed custom emoji identifiers.\n",
+ "required": false,
+ "description": "New unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers. Pass an empty string to remove the icon. If not specified, the current icon will be kept",
+ "html_description": "New unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers. Pass an empty string to remove the icon. If not specified, the current icon will be kept | ",
+ "rst_description": "New unique identifier of the custom emoji shown as the topic icon. Use :class:`aiogram.methods.get_forum_topic_icon_stickers.GetForumTopicIconStickers` to get all allowed custom emoji identifiers. Pass an empty string to remove the icon. If not specified, the current icon will be kept\n",
"name": "icon_custom_emoji_id"
}
],
@@ -7373,6 +7754,104 @@
],
"category": "methods"
},
+ {
+ "anchor": "editgeneralforumtopic",
+ "name": "editGeneralForumTopic",
+ "description": "Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success.",
+ "html_description": "Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success.
",
+ "rst_description": "Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have *can_manage_topics* administrator rights. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "Integer or String",
+ "required": true,
+ "description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
+ "html_description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) | ",
+ "rst_description": "Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
+ "name": "chat_id"
+ },
+ {
+ "type": "String",
+ "required": true,
+ "description": "New topic name, 1-128 characters",
+ "html_description": "New topic name, 1-128 characters | ",
+ "rst_description": "New topic name, 1-128 characters\n",
+ "name": "name"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "closegeneralforumtopic",
+ "name": "closeGeneralForumTopic",
+ "description": "Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.",
+ "html_description": "Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
",
+ "rst_description": "Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "Integer or String",
+ "required": true,
+ "description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
+ "html_description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) | ",
+ "rst_description": "Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
+ "name": "chat_id"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "reopengeneralforumtopic",
+ "name": "reopenGeneralForumTopic",
+ "description": "Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.",
+ "html_description": "Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.
",
+ "rst_description": "Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights. The topic will be automatically unhidden if it was hidden. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "Integer or String",
+ "required": true,
+ "description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
+ "html_description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) | ",
+ "rst_description": "Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
+ "name": "chat_id"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "hidegeneralforumtopic",
+ "name": "hideGeneralForumTopic",
+ "description": "Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.",
+ "html_description": "Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.
",
+ "rst_description": "Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights. The topic will be automatically closed if it was open. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "Integer or String",
+ "required": true,
+ "description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
+ "html_description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) | ",
+ "rst_description": "Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
+ "name": "chat_id"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "unhidegeneralforumtopic",
+ "name": "unhideGeneralForumTopic",
+ "description": "Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.",
+ "html_description": "Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
",
+ "rst_description": "Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "Integer or String",
+ "required": true,
+ "description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
+ "html_description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) | ",
+ "rst_description": "Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
+ "name": "chat_id"
+ }
+ ],
+ "category": "methods"
+ },
{
"anchor": "answercallbackquery",
"name": "answerCallbackQuery",
@@ -7509,6 +7988,94 @@
],
"category": "methods"
},
+ {
+ "anchor": "setmydescription",
+ "name": "setMyDescription",
+ "description": "Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty. Returns True on success.",
+ "html_description": "Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty. Returns True on success.
",
+ "rst_description": "Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "String",
+ "required": false,
+ "description": "New bot description; 0-512 characters. Pass an empty string to remove the dedicated description for the given language.",
+ "html_description": "New bot description; 0-512 characters. Pass an empty string to remove the dedicated description for the given language. | ",
+ "rst_description": "New bot description; 0-512 characters. Pass an empty string to remove the dedicated description for the given language.\n",
+ "name": "description"
+ },
+ {
+ "type": "String",
+ "required": false,
+ "description": "A two-letter ISO 639-1 language code. If empty, the description will be applied to all users for whose language there is no dedicated description.",
+ "html_description": "A two-letter ISO 639-1 language code. If empty, the description will be applied to all users for whose language there is no dedicated description. | ",
+ "rst_description": "A two-letter ISO 639-1 language code. If empty, the description will be applied to all users for whose language there is no dedicated description.\n",
+ "name": "language_code"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "getmydescription",
+ "name": "getMyDescription",
+ "description": "Use this method to get the current bot description for the given user language. Returns BotDescription on success.",
+ "html_description": "Use this method to get the current bot description for the given user language. Returns BotDescription on success.
",
+ "rst_description": "Use this method to get the current bot description for the given user language. Returns :class:`aiogram.types.bot_description.BotDescription` on success.",
+ "annotations": [
+ {
+ "type": "String",
+ "required": false,
+ "description": "A two-letter ISO 639-1 language code or an empty string",
+ "html_description": "A two-letter ISO 639-1 language code or an empty string | ",
+ "rst_description": "A two-letter ISO 639-1 language code or an empty string\n",
+ "name": "language_code"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "setmyshortdescription",
+ "name": "setMyShortDescription",
+ "description": "Use this method to change the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot. Returns True on success.",
+ "html_description": "Use this method to change the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot. Returns True on success.
",
+ "rst_description": "Use this method to change the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "String",
+ "required": false,
+ "description": "New short description for the bot; 0-120 characters. Pass an empty string to remove the dedicated short description for the given language.",
+ "html_description": "New short description for the bot; 0-120 characters. Pass an empty string to remove the dedicated short description for the given language. | ",
+ "rst_description": "New short description for the bot; 0-120 characters. Pass an empty string to remove the dedicated short description for the given language.\n",
+ "name": "short_description"
+ },
+ {
+ "type": "String",
+ "required": false,
+ "description": "A two-letter ISO 639-1 language code. If empty, the short description will be applied to all users for whose language there is no dedicated short description.",
+ "html_description": "A two-letter ISO 639-1 language code. If empty, the short description will be applied to all users for whose language there is no dedicated short description. | ",
+ "rst_description": "A two-letter ISO 639-1 language code. If empty, the short description will be applied to all users for whose language there is no dedicated short description.\n",
+ "name": "language_code"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "getmyshortdescription",
+ "name": "getMyShortDescription",
+ "description": "Use this method to get the current bot short description for the given user language. Returns BotShortDescription on success.",
+ "html_description": "Use this method to get the current bot short description for the given user language. Returns BotShortDescription on success.
",
+ "rst_description": "Use this method to get the current bot short description for the given user language. Returns :class:`aiogram.types.bot_short_description.BotShortDescription` on success.",
+ "annotations": [
+ {
+ "type": "String",
+ "required": false,
+ "description": "A two-letter ISO 639-1 language code or an empty string",
+ "html_description": "A two-letter ISO 639-1 language code or an empty string | ",
+ "rst_description": "A two-letter ISO 639-1 language code or an empty string\n",
+ "name": "language_code"
+ }
+ ],
+ "category": "methods"
+ },
{
"anchor": "setchatmenubutton",
"name": "setChatMenuButton",
@@ -7556,9 +8123,9 @@
{
"anchor": "setmydefaultadministratorrights",
"name": "setMyDefaultAdministratorRights",
- "description": "Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are are free to modify the list before adding the bot. Returns True on success.",
- "html_description": "Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are are free to modify the list before adding the bot. Returns True on success.
",
- "rst_description": "Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are are free to modify the list before adding the bot. Returns :code:`True` on success.",
+ "description": "Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are free to modify the list before adding the bot. Returns True on success.",
+ "html_description": "Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are free to modify the list before adding the bot. Returns True on success.
",
+ "rst_description": "Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are free to modify the list before adding the bot. Returns :code:`True` on success.",
"annotations": [
{
"type": "ChatAdministratorRights",
@@ -7794,6 +8361,130 @@
],
"category": "methods"
},
+ {
+ "anchor": "editmessagelivelocation",
+ "name": "editMessageLiveLocation",
+ "description": "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.",
+ "html_description": "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.
",
+ "rst_description": "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 :class:`aiogram.methods.stop_message_live_location.StopMessageLiveLocation`. On success, if the edited message is not an inline message, the edited :class:`aiogram.types.message.Message` is returned, otherwise :code:`True` is returned.",
+ "annotations": [
+ {
+ "type": "Integer or String",
+ "required": false,
+ "description": "Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
+ "html_description": "Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ",
+ "rst_description": "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`)\n",
+ "name": "chat_id"
+ },
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Required if inline_message_id is not specified. Identifier of the message to edit",
+ "html_description": "Required if inline_message_id is not specified. Identifier of the message to edit | ",
+ "rst_description": "Required if *inline_message_id* is not specified. Identifier of the message to edit\n",
+ "name": "message_id"
+ },
+ {
+ "type": "String",
+ "required": false,
+ "description": "Required if chat_id and message_id are not specified. Identifier of the inline message",
+ "html_description": "Required if chat_id and message_id are not specified. Identifier of the inline message | ",
+ "rst_description": "Required if *chat_id* and *message_id* are not specified. Identifier of the inline message\n",
+ "name": "inline_message_id"
+ },
+ {
+ "type": "Float number",
+ "required": true,
+ "description": "Latitude of new location",
+ "html_description": "Latitude of new location | ",
+ "rst_description": "Latitude of new location\n",
+ "name": "latitude"
+ },
+ {
+ "type": "Float number",
+ "required": true,
+ "description": "Longitude of new location",
+ "html_description": "Longitude of new location | ",
+ "rst_description": "Longitude of new location\n",
+ "name": "longitude"
+ },
+ {
+ "type": "Float number",
+ "required": false,
+ "description": "The radius of uncertainty for the location, measured in meters; 0-1500",
+ "html_description": "The radius of uncertainty for the location, measured in meters; 0-1500 | ",
+ "rst_description": "The radius of uncertainty for the location, measured in meters; 0-1500\n",
+ "name": "horizontal_accuracy"
+ },
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.",
+ "html_description": "Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified. | ",
+ "rst_description": "Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.\n",
+ "name": "heading"
+ },
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "The maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.",
+ "html_description": "The maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. | ",
+ "rst_description": "The maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.\n",
+ "name": "proximity_alert_radius"
+ },
+ {
+ "type": "InlineKeyboardMarkup",
+ "required": false,
+ "description": "A JSON-serialized object for a new inline keyboard.",
+ "html_description": "A JSON-serialized object for a new inline keyboard. | ",
+ "rst_description": "A JSON-serialized object for a new `inline keyboard `_.\n",
+ "name": "reply_markup"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "stopmessagelivelocation",
+ "name": "stopMessageLiveLocation",
+ "description": "Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.",
+ "html_description": "Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.
",
+ "rst_description": "Use this method to stop updating a live location message before *live_period* expires. On success, if the message is not an inline message, the edited :class:`aiogram.types.message.Message` is returned, otherwise :code:`True` is returned.",
+ "annotations": [
+ {
+ "type": "Integer or String",
+ "required": false,
+ "description": "Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
+ "html_description": "Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ",
+ "rst_description": "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`)\n",
+ "name": "chat_id"
+ },
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Required if inline_message_id is not specified. Identifier of the message with live location to stop",
+ "html_description": "Required if inline_message_id is not specified. Identifier of the message with live location to stop | ",
+ "rst_description": "Required if *inline_message_id* is not specified. Identifier of the message with live location to stop\n",
+ "name": "message_id"
+ },
+ {
+ "type": "String",
+ "required": false,
+ "description": "Required if chat_id and message_id are not specified. Identifier of the inline message",
+ "html_description": "Required if chat_id and message_id are not specified. Identifier of the inline message | ",
+ "rst_description": "Required if *chat_id* and *message_id* are not specified. Identifier of the inline message\n",
+ "name": "inline_message_id"
+ },
+ {
+ "type": "InlineKeyboardMarkup",
+ "required": false,
+ "description": "A JSON-serialized object for a new inline keyboard.",
+ "html_description": "A JSON-serialized object for a new inline keyboard. | ",
+ "rst_description": "A JSON-serialized object for a new `inline keyboard `_.\n",
+ "name": "reply_markup"
+ }
+ ],
+ "category": "methods"
+ },
{
"anchor": "editmessagereplymarkup",
"name": "editMessageReplyMarkup",
@@ -7971,7 +8662,7 @@
"description": "Sticker thumbnail in the .WEBP or .JPG format",
"html_description": "Optional. Sticker thumbnail in the .WEBP or .JPG format | ",
"rst_description": "*Optional*. Sticker thumbnail in the .WEBP or .JPG format\n",
- "name": "thumb",
+ "name": "thumbnail",
"required": false
},
{
@@ -8014,6 +8705,14 @@
"name": "custom_emoji_id",
"required": false
},
+ {
+ "type": "True",
+ "description": "True, if the sticker must be repainted to a text color in messages, the color of the Telegram Premium badge in emoji status, white color on chat photos, or another appropriate color in other places",
+ "html_description": "Optional. True, if the sticker must be repainted to a text color in messages, the color of the Telegram Premium badge in emoji status, white color on chat photos, or another appropriate color in other places | ",
+ "rst_description": "*Optional*. :code:`True`, if the sticker must be repainted to a text color in messages, the color of the Telegram Premium badge in emoji status, white color on chat photos, or another appropriate color in other places\n",
+ "name": "needs_repainting",
+ "required": false
+ },
{
"type": "Integer",
"description": "File size in bytes",
@@ -8085,7 +8784,7 @@
"description": "Sticker set thumbnail in the .WEBP, .TGS, or .WEBM format",
"html_description": "Optional. Sticker set thumbnail in the .WEBP, .TGS, or .WEBM format | ",
"rst_description": "*Optional*. Sticker set thumbnail in the .WEBP, .TGS, or .WEBM format\n",
- "name": "thumb",
+ "name": "thumbnail",
"required": false
}
],
@@ -8133,6 +8832,48 @@
],
"category": "types"
},
+ {
+ "anchor": "inputsticker",
+ "name": "InputSticker",
+ "description": "This object describes a sticker to be added to a sticker set.",
+ "html_description": "This object describes a sticker to be added to a sticker set.
",
+ "rst_description": "This object describes a sticker to be added to a sticker set.",
+ "annotations": [
+ {
+ "type": "InputFile or String",
+ "description": "The added sticker. 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 and video stickers can't be uploaded via HTTP URL. More information on Sending Files",
+ "html_description": "The added sticker. 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 and video stickers can't be uploaded via HTTP URL. More information on Sending Files » | ",
+ "rst_description": "The added sticker. 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 and video stickers can't be uploaded via HTTP URL. :ref:`More information on Sending Files » `\n",
+ "name": "sticker",
+ "required": true
+ },
+ {
+ "type": "Array of String",
+ "description": "List of 1-20 emoji associated with the sticker",
+ "html_description": "List of 1-20 emoji associated with the sticker | ",
+ "rst_description": "List of 1-20 emoji associated with the sticker\n",
+ "name": "emoji_list",
+ "required": true
+ },
+ {
+ "type": "MaskPosition",
+ "description": "Position where the mask should be placed on faces. For 'mask' stickers only.",
+ "html_description": "Optional. Position where the mask should be placed on faces. For “mask” stickers only. | ",
+ "rst_description": "*Optional*. Position where the mask should be placed on faces. For 'mask' stickers only.\n",
+ "name": "mask_position",
+ "required": false
+ },
+ {
+ "type": "Array of String",
+ "description": "List of 0-20 search keywords for the sticker with total length of up to 64 characters. For 'regular' and 'custom_emoji' stickers only.",
+ "html_description": "Optional. List of 0-20 search keywords for the sticker with total length of up to 64 characters. For “regular” and “custom_emoji” stickers only. | ",
+ "rst_description": "*Optional*. List of 0-20 search keywords for the sticker with total length of up to 64 characters. For 'regular' and 'custom_emoji' stickers only.\n",
+ "name": "keywords",
+ "required": false
+ }
+ ],
+ "category": "types"
+ },
{
"anchor": "sendsticker",
"name": "sendSticker",
@@ -8159,11 +8900,19 @@
{
"type": "InputFile or String",
"required": true,
- "description": "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 information on Sending Files",
- "html_description": "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 information on Sending Files » | ",
- "rst_description": "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. :ref:`More information on Sending Files » `\n",
+ "description": "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 sticker from the Internet, or upload a new .WEBP or .TGS sticker using multipart/form-data. More information on Sending Files. Video stickers can only be sent by a file_id. Animated stickers can't be sent via an HTTP URL.",
+ "html_description": "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 sticker from the Internet, or upload a new .WEBP or .TGS sticker using multipart/form-data. More information on Sending Files ». Video stickers can only be sent by a file_id. Animated stickers can't be sent via an HTTP URL. | ",
+ "rst_description": "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 sticker from the Internet, or upload a new .WEBP or .TGS sticker using multipart/form-data. :ref:`More information on Sending Files » `. Video stickers can only be sent by a file_id. Animated stickers can't be sent via an HTTP URL.\n",
"name": "sticker"
},
+ {
+ "type": "String",
+ "required": false,
+ "description": "Emoji associated with the sticker; only for just uploaded stickers",
+ "html_description": "Emoji associated with the sticker; only for just uploaded stickers | ",
+ "rst_description": "Emoji associated with the sticker; only for just uploaded stickers\n",
+ "name": "emoji"
+ },
{
"type": "Boolean",
"required": false,
@@ -8246,9 +8995,9 @@
{
"anchor": "uploadstickerfile",
"name": "uploadStickerFile",
- "description": "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.",
- "html_description": "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.
",
- "rst_description": "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 :class:`aiogram.types.file.File` on success.",
+ "description": "Use this method to upload a file with a sticker for later use in the createNewStickerSet and addStickerToSet methods (the file can be used multiple times). Returns the uploaded File on success.",
+ "html_description": "Use this method to upload a file with a sticker for later use in the createNewStickerSet and addStickerToSet methods (the file can be used multiple times). Returns the uploaded File on success.
",
+ "rst_description": "Use this method to upload a file with a sticker for later use in the :class:`aiogram.methods.create_new_sticker_set.CreateNewStickerSet` and :class:`aiogram.methods.add_sticker_to_set.AddStickerToSet` methods (the file can be used multiple times). Returns the uploaded :class:`aiogram.types.file.File` on success.",
"annotations": [
{
"type": "Integer",
@@ -8261,10 +9010,18 @@
{
"type": "InputFile",
"required": true,
- "description": "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 information on Sending Files",
- "html_description": "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 information on Sending Files » | ",
- "rst_description": "**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. :ref:`More information on Sending Files » `\n",
- "name": "png_sticker"
+ "description": "A file with the sticker in .WEBP, .PNG, .TGS, or .WEBM format. See https://core.telegram.org/stickers for technical requirements. More information on Sending Files",
+ "html_description": "A file with the sticker in .WEBP, .PNG, .TGS, or .WEBM format. See https://core.telegram.org/stickers for technical requirements. More information on Sending Files » | ",
+ "rst_description": "A file with the sticker in .WEBP, .PNG, .TGS, or .WEBM format. See `https://core.telegram.org/stickers `_`https://core.telegram.org/stickers `_ for technical requirements. :ref:`More information on Sending Files » `\n",
+ "name": "sticker"
+ },
+ {
+ "type": "String",
+ "required": true,
+ "description": "Format of the sticker, must be one of 'static', 'animated', 'video'",
+ "html_description": "Format of the sticker, must be one of “static”, “animated”, “video” | ",
+ "rst_description": "Format of the sticker, must be one of 'static', 'animated', 'video'\n",
+ "name": "sticker_format"
}
],
"category": "methods"
@@ -8272,9 +9029,9 @@
{
"anchor": "createnewstickerset",
"name": "createNewStickerSet",
- "description": "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, tgs_sticker, or webm_sticker. Returns True on success.",
- "html_description": "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, tgs_sticker, or webm_sticker. Returns True on success.
",
- "rst_description": "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*, *tgs_sticker*, or *webm_sticker*. Returns :code:`True` on success.",
+ "description": "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. Returns True on success.",
+ "html_description": "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. Returns True on success.
",
+ "rst_description": "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. Returns :code:`True` on success.",
"annotations": [
{
"type": "Integer",
@@ -8301,52 +9058,36 @@
"name": "title"
},
{
- "type": "InputFile or String",
- "required": false,
- "description": "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 information on Sending Files",
- "html_description": "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 information on Sending Files » | ",
- "rst_description": "**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. :ref:`More information on Sending Files » `\n",
- "name": "png_sticker"
- },
- {
- "type": "InputFile",
- "required": false,
- "description": "TGS animation with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#animated-sticker-requirements for technical requirements",
- "html_description": "TGS animation with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#animated-sticker-requirements for technical requirements | ",
- "rst_description": "**TGS** animation with the sticker, uploaded using multipart/form-data. See `https://core.telegram.org/stickers#animated-sticker-requirements `_`https://core.telegram.org/stickers#animated-sticker-requirements `_ for technical requirements\n",
- "name": "tgs_sticker"
- },
- {
- "type": "InputFile",
- "required": false,
- "description": "WEBM video with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#video-sticker-requirements for technical requirements",
- "html_description": "WEBM video with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#video-sticker-requirements for technical requirements | ",
- "rst_description": "**WEBM** video with the sticker, uploaded using multipart/form-data. See `https://core.telegram.org/stickers#video-sticker-requirements `_`https://core.telegram.org/stickers#video-sticker-requirements `_ for technical requirements\n",
- "name": "webm_sticker"
- },
- {
- "type": "String",
- "required": false,
- "description": "Type of stickers in the set, pass 'regular' or 'mask'. Custom emoji sticker sets can't be created via the Bot API at the moment. By default, a regular sticker set is created.",
- "html_description": "Type of stickers in the set, pass “regular” or “mask”. Custom emoji sticker sets can't be created via the Bot API at the moment. By default, a regular sticker set is created. | ",
- "rst_description": "Type of stickers in the set, pass 'regular' or 'mask'. Custom emoji sticker sets can't be created via the Bot API at the moment. By default, a regular sticker set is created.\n",
- "name": "sticker_type"
+ "type": "Array of InputSticker",
+ "required": true,
+ "description": "A JSON-serialized list of 1-50 initial stickers to be added to the sticker set",
+ "html_description": "A JSON-serialized list of 1-50 initial stickers to be added to the sticker set | ",
+ "rst_description": "A JSON-serialized list of 1-50 initial stickers to be added to the sticker set\n",
+ "name": "stickers"
},
{
"type": "String",
"required": true,
- "description": "One or more emoji corresponding to the sticker",
- "html_description": "One or more emoji corresponding to the sticker | ",
- "rst_description": "One or more emoji corresponding to the sticker\n",
- "name": "emojis"
+ "description": "Format of stickers in the set, must be one of 'static', 'animated', 'video'",
+ "html_description": "Format of stickers in the set, must be one of “static”, “animated”, “video” | ",
+ "rst_description": "Format of stickers in the set, must be one of 'static', 'animated', 'video'\n",
+ "name": "sticker_format"
},
{
- "type": "MaskPosition",
+ "type": "String",
"required": false,
- "description": "A JSON-serialized object for position where the mask should be placed on faces",
- "html_description": "A JSON-serialized object for position where the mask should be placed on faces | ",
- "rst_description": "A JSON-serialized object for position where the mask should be placed on faces\n",
- "name": "mask_position"
+ "description": "Type of stickers in the set, pass 'regular', 'mask', or 'custom_emoji'. By default, a regular sticker set is created.",
+ "html_description": "Type of stickers in the set, pass “regular”, “mask”, or “custom_emoji”. By default, a regular sticker set is created. | ",
+ "rst_description": "Type of stickers in the set, pass 'regular', 'mask', or 'custom_emoji'. By default, a regular sticker set is created.\n",
+ "name": "sticker_type"
+ },
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True if stickers in the sticker set must be repainted to the color of text when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context; for custom emoji sticker sets only",
+ "html_description": "Pass True if stickers in the sticker set must be repainted to the color of text when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context; for custom emoji sticker sets only | ",
+ "rst_description": "Pass :code:`True` if stickers in the sticker set must be repainted to the color of text when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context; for custom emoji sticker sets only\n",
+ "name": "needs_repainting"
}
],
"category": "methods"
@@ -8354,9 +9095,9 @@
{
"anchor": "addstickertoset",
"name": "addStickerToSet",
- "description": "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, tgs_sticker, or webm_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.",
- "html_description": "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, tgs_sticker, or webm_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.
",
- "rst_description": "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*, *tgs_sticker*, or *webm_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 :code:`True` on success.",
+ "description": "Use this method to add a new sticker to a set created by the bot. The format of the added sticker must match the format of the other stickers in the set. Emoji sticker sets can have up to 200 stickers. Animated and video sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success.",
+ "html_description": "Use this method to add a new sticker to a set created by the bot. The format of the added sticker must match the format of the other stickers in the set. Emoji sticker sets can have up to 200 stickers. Animated and video sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success.
",
+ "rst_description": "Use this method to add a new sticker to a set created by the bot. The format of the added sticker must match the format of the other stickers in the set. Emoji sticker sets can have up to 200 stickers. Animated and video sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns :code:`True` on success.",
"annotations": [
{
"type": "Integer",
@@ -8375,44 +9116,12 @@
"name": "name"
},
{
- "type": "InputFile or String",
- "required": false,
- "description": "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 information on Sending Files",
- "html_description": "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 information on Sending Files » | ",
- "rst_description": "**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. :ref:`More information on Sending Files » `\n",
- "name": "png_sticker"
- },
- {
- "type": "InputFile",
- "required": false,
- "description": "TGS animation with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#animated-sticker-requirements for technical requirements",
- "html_description": "TGS animation with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#animated-sticker-requirements for technical requirements | ",
- "rst_description": "**TGS** animation with the sticker, uploaded using multipart/form-data. See `https://core.telegram.org/stickers#animated-sticker-requirements `_`https://core.telegram.org/stickers#animated-sticker-requirements `_ for technical requirements\n",
- "name": "tgs_sticker"
- },
- {
- "type": "InputFile",
- "required": false,
- "description": "WEBM video with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#video-sticker-requirements for technical requirements",
- "html_description": "WEBM video with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#video-sticker-requirements for technical requirements | ",
- "rst_description": "**WEBM** video with the sticker, uploaded using multipart/form-data. See `https://core.telegram.org/stickers#video-sticker-requirements `_`https://core.telegram.org/stickers#video-sticker-requirements `_ for technical requirements\n",
- "name": "webm_sticker"
- },
- {
- "type": "String",
+ "type": "InputSticker",
"required": true,
- "description": "One or more emoji corresponding to the sticker",
- "html_description": "One or more emoji corresponding to the sticker | ",
- "rst_description": "One or more emoji corresponding to the sticker\n",
- "name": "emojis"
- },
- {
- "type": "MaskPosition",
- "required": false,
- "description": "A JSON-serialized object for position where the mask should be placed on faces",
- "html_description": "A JSON-serialized object for position where the mask should be placed on faces | ",
- "rst_description": "A JSON-serialized object for position where the mask should be placed on faces\n",
- "name": "mask_position"
+ "description": "A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set isn't changed.",
+ "html_description": "A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set isn't changed. | ",
+ "rst_description": "A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set isn't changed.\n",
+ "name": "sticker"
}
],
"category": "methods"
@@ -8462,11 +9171,115 @@
"category": "methods"
},
{
- "anchor": "setstickersetthumb",
- "name": "setStickerSetThumb",
- "description": "Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Video thumbnails can be set only for video sticker sets only. Returns True on success.",
- "html_description": "Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Video thumbnails can be set only for video sticker sets only. Returns True on success.
",
- "rst_description": "Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Video thumbnails can be set only for video sticker sets only. Returns :code:`True` on success.",
+ "anchor": "setstickeremojilist",
+ "name": "setStickerEmojiList",
+ "description": "Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.",
+ "html_description": "Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.
",
+ "rst_description": "Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "String",
+ "required": true,
+ "description": "File identifier of the sticker",
+ "html_description": "File identifier of the sticker | ",
+ "rst_description": "File identifier of the sticker\n",
+ "name": "sticker"
+ },
+ {
+ "type": "Array of String",
+ "required": true,
+ "description": "A JSON-serialized list of 1-20 emoji associated with the sticker",
+ "html_description": "A JSON-serialized list of 1-20 emoji associated with the sticker | ",
+ "rst_description": "A JSON-serialized list of 1-20 emoji associated with the sticker\n",
+ "name": "emoji_list"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "setstickerkeywords",
+ "name": "setStickerKeywords",
+ "description": "Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.",
+ "html_description": "Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.
",
+ "rst_description": "Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "String",
+ "required": true,
+ "description": "File identifier of the sticker",
+ "html_description": "File identifier of the sticker | ",
+ "rst_description": "File identifier of the sticker\n",
+ "name": "sticker"
+ },
+ {
+ "type": "Array of String",
+ "required": false,
+ "description": "A JSON-serialized list of 0-20 search keywords for the sticker with total length of up to 64 characters",
+ "html_description": "A JSON-serialized list of 0-20 search keywords for the sticker with total length of up to 64 characters | ",
+ "rst_description": "A JSON-serialized list of 0-20 search keywords for the sticker with total length of up to 64 characters\n",
+ "name": "keywords"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "setstickermaskposition",
+ "name": "setStickerMaskPosition",
+ "description": "Use this method to change the mask position of a mask sticker. The sticker must belong to a sticker set that was created by the bot. Returns True on success.",
+ "html_description": "Use this method to change the mask position of a mask sticker. The sticker must belong to a sticker set that was created by the bot. Returns True on success.
",
+ "rst_description": "Use this method to change the `mask position `_ of a mask sticker. The sticker must belong to a sticker set that was created by the bot. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "String",
+ "required": true,
+ "description": "File identifier of the sticker",
+ "html_description": "File identifier of the sticker | ",
+ "rst_description": "File identifier of the sticker\n",
+ "name": "sticker"
+ },
+ {
+ "type": "MaskPosition",
+ "required": false,
+ "description": "A JSON-serialized object with the position where the mask should be placed on faces. Omit the parameter to remove the mask position.",
+ "html_description": "A JSON-serialized object with the position where the mask should be placed on faces. Omit the parameter to remove the mask position. | ",
+ "rst_description": "A JSON-serialized object with the position where the mask should be placed on faces. Omit the parameter to remove the mask position.\n",
+ "name": "mask_position"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "setstickersettitle",
+ "name": "setStickerSetTitle",
+ "description": "Use this method to set the title of a created sticker set. Returns True on success.",
+ "html_description": "Use this method to set the title of a created sticker set. Returns True on success.
",
+ "rst_description": "Use this method to set the title of a created sticker set. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "String",
+ "required": true,
+ "description": "Sticker set name",
+ "html_description": "Sticker set name | ",
+ "rst_description": "Sticker set name\n",
+ "name": "name"
+ },
+ {
+ "type": "String",
+ "required": true,
+ "description": "Sticker set title, 1-64 characters",
+ "html_description": "Sticker set title, 1-64 characters | ",
+ "rst_description": "Sticker set title, 1-64 characters\n",
+ "name": "title"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "setstickersetthumbnail",
+ "name": "setStickerSetThumbnail",
+ "description": "Use this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set. Returns True on success.",
+ "html_description": "Use this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set. Returns True on success.
",
+ "rst_description": "Use this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set. Returns :code:`True` on success.",
"annotations": [
{
"type": "String",
@@ -8487,10 +9300,54 @@
{
"type": "InputFile or String",
"required": false,
- "description": "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/stickers#animated-sticker-requirements for animated sticker technical requirements, or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video 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 information on Sending Files. Animated sticker set thumbnails can't be uploaded via HTTP URL.",
- "html_description": "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/stickers#animated-sticker-requirements for animated sticker technical requirements, or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video 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 information on Sending Files ». Animated sticker set thumbnails can't be uploaded via HTTP URL. | ",
- "rst_description": "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/stickers#animated-sticker-requirements `_`https://core.telegram.org/stickers#animated-sticker-requirements `_ for animated sticker technical requirements, or a **WEBM** video with the thumbnail up to 32 kilobytes in size; see `https://core.telegram.org/stickers#video-sticker-requirements `_`https://core.telegram.org/stickers#video-sticker-requirements `_ for video 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. :ref:`More information on Sending Files » `. Animated sticker set thumbnails can't be uploaded via HTTP URL.\n",
- "name": "thumb"
+ "description": "A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see https://core.telegram.org/stickers#animated-sticker-requirements for animated sticker technical requirements), or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video 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 information on Sending Files. Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.",
+ "html_description": "A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see https://core.telegram.org/stickers#animated-sticker-requirements for animated sticker technical requirements), or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video 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 information on Sending Files ». Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail. | ",
+ "rst_description": "A **.WEBP** or **.PNG** image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a **.TGS** animation with a thumbnail up to 32 kilobytes in size (see `https://core.telegram.org/stickers#animated-sticker-requirements `_`https://core.telegram.org/stickers#animated-sticker-requirements `_ for animated sticker technical requirements), or a **WEBM** video with the thumbnail up to 32 kilobytes in size; see `https://core.telegram.org/stickers#video-sticker-requirements `_`https://core.telegram.org/stickers#video-sticker-requirements `_ for video 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. :ref:`More information on Sending Files » `. Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.\n",
+ "name": "thumbnail"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "setcustomemojistickersetthumbnail",
+ "name": "setCustomEmojiStickerSetThumbnail",
+ "description": "Use this method to set the thumbnail of a custom emoji sticker set. Returns True on success.",
+ "html_description": "Use this method to set the thumbnail of a custom emoji sticker set. Returns True on success.
",
+ "rst_description": "Use this method to set the thumbnail of a custom emoji sticker set. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "String",
+ "required": true,
+ "description": "Sticker set name",
+ "html_description": "Sticker set name | ",
+ "rst_description": "Sticker set name\n",
+ "name": "name"
+ },
+ {
+ "type": "String",
+ "required": false,
+ "description": "Custom emoji identifier of a sticker from the sticker set; pass an empty string to drop the thumbnail and use the first sticker as the thumbnail.",
+ "html_description": "Custom emoji identifier of a sticker from the sticker set; pass an empty string to drop the thumbnail and use the first sticker as the thumbnail. | ",
+ "rst_description": "Custom emoji identifier of a sticker from the sticker set; pass an empty string to drop the thumbnail and use the first sticker as the thumbnail.\n",
+ "name": "custom_emoji_id"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "deletestickerset",
+ "name": "deleteStickerSet",
+ "description": "Use this method to delete a sticker set that was created by the bot. Returns True on success.",
+ "html_description": "Use this method to delete a sticker set that was created by the bot. Returns True on success.
",
+ "rst_description": "Use this method to delete a sticker set that was created by the bot. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "String",
+ "required": true,
+ "description": "Sticker set name",
+ "html_description": "Sticker set name | ",
+ "rst_description": "Sticker set name\n",
+ "name": "name"
}
],
"category": "methods"
@@ -8711,7 +9568,7 @@
"description": "Url of the thumbnail for the result",
"html_description": "Optional. Url of the thumbnail for the result | ",
"rst_description": "*Optional*. Url of the thumbnail for the result\n",
- "name": "thumb_url",
+ "name": "thumbnail_url",
"required": false
},
{
@@ -8719,7 +9576,7 @@
"description": "Thumbnail width",
"html_description": "Optional. Thumbnail width | ",
"rst_description": "*Optional*. Thumbnail width\n",
- "name": "thumb_width",
+ "name": "thumbnail_width",
"required": false
},
{
@@ -8727,7 +9584,7 @@
"description": "Thumbnail height",
"html_description": "Optional. Thumbnail height | ",
"rst_description": "*Optional*. Thumbnail height\n",
- "name": "thumb_height",
+ "name": "thumbnail_height",
"required": false
}
],
@@ -8769,7 +9626,7 @@
"description": "URL of the thumbnail for the photo",
"html_description": "URL of the thumbnail for the photo | ",
"rst_description": "URL of the thumbnail for the photo\n",
- "name": "thumb_url",
+ "name": "thumbnail_url",
"required": true
},
{
@@ -8907,7 +9764,7 @@
"description": "URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result",
"html_description": "URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result | ",
"rst_description": "URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result\n",
- "name": "thumb_url",
+ "name": "thumbnail_url",
"required": true
},
{
@@ -8915,7 +9772,7 @@
"description": "MIME type of the thumbnail, must be one of 'image/jpeg', 'image/gif', or 'video/mp4'. Defaults to 'image/jpeg'",
"html_description": "Optional. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg” | ",
"rst_description": "*Optional*. MIME type of the thumbnail, must be one of 'image/jpeg', 'image/gif', or 'video/mp4'. Defaults to 'image/jpeg'\n",
- "name": "thumb_mime_type",
+ "name": "thumbnail_mime_type",
"required": false
},
{
@@ -9029,7 +9886,7 @@
"description": "URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result",
"html_description": "URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result | ",
"rst_description": "URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result\n",
- "name": "thumb_url",
+ "name": "thumbnail_url",
"required": true
},
{
@@ -9037,7 +9894,7 @@
"description": "MIME type of the thumbnail, must be one of 'image/jpeg', 'image/gif', or 'video/mp4'. Defaults to 'image/jpeg'",
"html_description": "Optional. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg” | ",
"rst_description": "*Optional*. MIME type of the thumbnail, must be one of 'image/jpeg', 'image/gif', or 'video/mp4'. Defaults to 'image/jpeg'\n",
- "name": "thumb_mime_type",
+ "name": "thumbnail_mime_type",
"required": false
},
{
@@ -9135,7 +9992,7 @@
"description": "URL of the thumbnail (JPEG only) for the video",
"html_description": "URL of the thumbnail (JPEG only) for the video | ",
"rst_description": "URL of the thumbnail (JPEG only) for the video\n",
- "name": "thumb_url",
+ "name": "thumbnail_url",
"required": true
},
{
@@ -9509,7 +10366,7 @@
"description": "URL of the thumbnail (JPEG only) for the file",
"html_description": "Optional. URL of the thumbnail (JPEG only) for the file | ",
"rst_description": "*Optional*. URL of the thumbnail (JPEG only) for the file\n",
- "name": "thumb_url",
+ "name": "thumbnail_url",
"required": false
},
{
@@ -9517,7 +10374,7 @@
"description": "Thumbnail width",
"html_description": "Optional. Thumbnail width | ",
"rst_description": "*Optional*. Thumbnail width\n",
- "name": "thumb_width",
+ "name": "thumbnail_width",
"required": false
},
{
@@ -9525,7 +10382,7 @@
"description": "Thumbnail height",
"html_description": "Optional. Thumbnail height | ",
"rst_description": "*Optional*. Thumbnail height\n",
- "name": "thumb_height",
+ "name": "thumbnail_height",
"required": false
}
],
@@ -9631,7 +10488,7 @@
"description": "Url of the thumbnail for the result",
"html_description": "Optional. Url of the thumbnail for the result | ",
"rst_description": "*Optional*. Url of the thumbnail for the result\n",
- "name": "thumb_url",
+ "name": "thumbnail_url",
"required": false
},
{
@@ -9639,7 +10496,7 @@
"description": "Thumbnail width",
"html_description": "Optional. Thumbnail width | ",
"rst_description": "*Optional*. Thumbnail width\n",
- "name": "thumb_width",
+ "name": "thumbnail_width",
"required": false
},
{
@@ -9647,7 +10504,7 @@
"description": "Thumbnail height",
"html_description": "Optional. Thumbnail height | ",
"rst_description": "*Optional*. Thumbnail height\n",
- "name": "thumb_height",
+ "name": "thumbnail_height",
"required": false
}
],
@@ -9761,7 +10618,7 @@
"description": "Url of the thumbnail for the result",
"html_description": "Optional. Url of the thumbnail for the result | ",
"rst_description": "*Optional*. Url of the thumbnail for the result\n",
- "name": "thumb_url",
+ "name": "thumbnail_url",
"required": false
},
{
@@ -9769,7 +10626,7 @@
"description": "Thumbnail width",
"html_description": "Optional. Thumbnail width | ",
"rst_description": "*Optional*. Thumbnail width\n",
- "name": "thumb_width",
+ "name": "thumbnail_width",
"required": false
},
{
@@ -9777,7 +10634,7 @@
"description": "Thumbnail height",
"html_description": "Optional. Thumbnail height | ",
"rst_description": "*Optional*. Thumbnail height\n",
- "name": "thumb_height",
+ "name": "thumbnail_height",
"required": false
}
],
@@ -9859,7 +10716,7 @@
"description": "Url of the thumbnail for the result",
"html_description": "Optional. Url of the thumbnail for the result | ",
"rst_description": "*Optional*. Url of the thumbnail for the result\n",
- "name": "thumb_url",
+ "name": "thumbnail_url",
"required": false
},
{
@@ -9867,7 +10724,7 @@
"description": "Thumbnail width",
"html_description": "Optional. Thumbnail width | ",
"rst_description": "*Optional*. Thumbnail width\n",
- "name": "thumb_width",
+ "name": "thumbnail_width",
"required": false
},
{
@@ -9875,7 +10732,7 @@
"description": "Thumbnail height",
"html_description": "Optional. Thumbnail height | ",
"rst_description": "*Optional*. Thumbnail height\n",
- "name": "thumb_height",
+ "name": "thumbnail_height",
"required": false
}
],
diff --git a/.butcher/types/Animation/entity.json b/.butcher/types/Animation/entity.json
index 2de45c1b..751e38c3 100644
--- a/.butcher/types/Animation/entity.json
+++ b/.butcher/types/Animation/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
@@ -58,7 +56,7 @@
"description": "Animation thumbnail as defined by sender",
"html_description": "Optional. Animation thumbnail as defined by sender | ",
"rst_description": "*Optional*. Animation thumbnail as defined by sender\n",
- "name": "thumb",
+ "name": "thumbnail",
"required": false
},
{
diff --git a/.butcher/types/Audio/entity.json b/.butcher/types/Audio/entity.json
index 4b94b3a1..e0b22adf 100644
--- a/.butcher/types/Audio/entity.json
+++ b/.butcher/types/Audio/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
@@ -82,7 +80,7 @@
"description": "Thumbnail of the album cover to which the music file belongs",
"html_description": "Optional. Thumbnail of the album cover to which the music file belongs | ",
"rst_description": "*Optional*. Thumbnail of the album cover to which the music file belongs\n",
- "name": "thumb",
+ "name": "thumbnail",
"required": false
}
],
diff --git a/.butcher/types/BotCommand/entity.json b/.butcher/types/BotCommand/entity.json
index 54cf79a1..88cf7aea 100644
--- a/.butcher/types/BotCommand/entity.json
+++ b/.butcher/types/BotCommand/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/BotCommandScope/entity.json b/.butcher/types/BotCommandScope/entity.json
index a43e32bd..808c1b16 100644
--- a/.butcher/types/BotCommandScope/entity.json
+++ b/.butcher/types/BotCommandScope/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/BotCommandScopeAllChatAdministrators/entity.json b/.butcher/types/BotCommandScopeAllChatAdministrators/entity.json
index f1d09250..a215fb1a 100644
--- a/.butcher/types/BotCommandScopeAllChatAdministrators/entity.json
+++ b/.butcher/types/BotCommandScopeAllChatAdministrators/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/BotCommandScopeAllGroupChats/entity.json b/.butcher/types/BotCommandScopeAllGroupChats/entity.json
index 9d1698cb..cab68eca 100644
--- a/.butcher/types/BotCommandScopeAllGroupChats/entity.json
+++ b/.butcher/types/BotCommandScopeAllGroupChats/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/BotCommandScopeAllPrivateChats/entity.json b/.butcher/types/BotCommandScopeAllPrivateChats/entity.json
index c7950f92..0c8a1eac 100644
--- a/.butcher/types/BotCommandScopeAllPrivateChats/entity.json
+++ b/.butcher/types/BotCommandScopeAllPrivateChats/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/BotCommandScopeChat/entity.json b/.butcher/types/BotCommandScopeChat/entity.json
index c0189614..09990c4a 100644
--- a/.butcher/types/BotCommandScopeChat/entity.json
+++ b/.butcher/types/BotCommandScopeChat/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/BotCommandScopeChatAdministrators/entity.json b/.butcher/types/BotCommandScopeChatAdministrators/entity.json
index 0f073037..06c96964 100644
--- a/.butcher/types/BotCommandScopeChatAdministrators/entity.json
+++ b/.butcher/types/BotCommandScopeChatAdministrators/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/BotCommandScopeChatMember/entity.json b/.butcher/types/BotCommandScopeChatMember/entity.json
index ea0bb34e..6d75e7d6 100644
--- a/.butcher/types/BotCommandScopeChatMember/entity.json
+++ b/.butcher/types/BotCommandScopeChatMember/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/BotCommandScopeDefault/entity.json b/.butcher/types/BotCommandScopeDefault/entity.json
index a1235132..edc6ca7b 100644
--- a/.butcher/types/BotCommandScopeDefault/entity.json
+++ b/.butcher/types/BotCommandScopeDefault/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/BotDescription/entity.json b/.butcher/types/BotDescription/entity.json
new file mode 100644
index 00000000..5784507a
--- /dev/null
+++ b/.butcher/types/BotDescription/entity.json
@@ -0,0 +1,25 @@
+{
+ "meta": {},
+ "group": {
+ "title": "Available types",
+ "anchor": "available-types"
+ },
+ "object": {
+ "anchor": "botdescription",
+ "name": "BotDescription",
+ "description": "This object represents the bot's description.",
+ "html_description": "This object represents the bot's description.
",
+ "rst_description": "This object represents the bot's description.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "The bot's description",
+ "html_description": "The bot's description | ",
+ "rst_description": "The bot's description\n",
+ "name": "description",
+ "required": true
+ }
+ ],
+ "category": "types"
+ }
+}
diff --git a/.butcher/types/BotShortDescription/entity.json b/.butcher/types/BotShortDescription/entity.json
new file mode 100644
index 00000000..da55449f
--- /dev/null
+++ b/.butcher/types/BotShortDescription/entity.json
@@ -0,0 +1,25 @@
+{
+ "meta": {},
+ "group": {
+ "title": "Available types",
+ "anchor": "available-types"
+ },
+ "object": {
+ "anchor": "botshortdescription",
+ "name": "BotShortDescription",
+ "description": "This object represents the bot's short description.",
+ "html_description": "This object represents the bot's short description.
",
+ "rst_description": "This object represents the bot's short description.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "The bot's short description",
+ "html_description": "The bot's short description | ",
+ "rst_description": "The bot's short description\n",
+ "name": "short_description",
+ "required": true
+ }
+ ],
+ "category": "types"
+ }
+}
diff --git a/.butcher/types/CallbackGame/entity.json b/.butcher/types/CallbackGame/entity.json
index f72d1945..246618f0 100644
--- a/.butcher/types/CallbackGame/entity.json
+++ b/.butcher/types/CallbackGame/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Games",
"anchor": "games"
diff --git a/.butcher/types/CallbackQuery/entity.json b/.butcher/types/CallbackQuery/entity.json
index 760d0e3e..e0b35038 100644
--- a/.butcher/types/CallbackQuery/entity.json
+++ b/.butcher/types/CallbackQuery/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/Chat/entity.json b/.butcher/types/Chat/entity.json
index 49660a75..7aa42c18 100644
--- a/.butcher/types/Chat/entity.json
+++ b/.butcher/types/Chat/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
@@ -181,6 +179,22 @@
"name": "message_auto_delete_time",
"required": false
},
+ {
+ "type": "True",
+ "description": "True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators. Returned only in getChat.",
+ "html_description": "Optional. True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators. Returned only in getChat. | ",
+ "rst_description": "*Optional*. :code:`True`, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
+ "name": "has_aggressive_anti_spam_enabled",
+ "required": false
+ },
+ {
+ "type": "True",
+ "description": "True, if non-administrators can only get the list of bots and administrators in the chat. Returned only in getChat.",
+ "html_description": "Optional. True, if non-administrators can only get the list of bots and administrators in the chat. Returned only in getChat. | ",
+ "rst_description": "*Optional*. :code:`True`, if non-administrators can only get the list of bots and administrators in the chat. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
+ "name": "has_hidden_members",
+ "required": false
+ },
{
"type": "True",
"description": "True, if messages from the chat can't be forwarded to other chats. Returned only in getChat.",
diff --git a/.butcher/types/ChatAdministratorRights/entity.json b/.butcher/types/ChatAdministratorRights/entity.json
index b4374b93..6d5951e8 100644
--- a/.butcher/types/ChatAdministratorRights/entity.json
+++ b/.butcher/types/ChatAdministratorRights/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
@@ -55,9 +53,9 @@
},
{
"type": "Boolean",
- "description": "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 the user)",
- "html_description": "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 the user) | ",
- "rst_description": ":code:`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 the user)\n",
+ "description": "True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user)",
+ "html_description": "True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user) | ",
+ "rst_description": ":code:`True`, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user)\n",
"name": "can_promote_members",
"required": true
},
diff --git a/.butcher/types/ChatInviteLink/entity.json b/.butcher/types/ChatInviteLink/entity.json
index 7b96a2c4..d2441682 100644
--- a/.butcher/types/ChatInviteLink/entity.json
+++ b/.butcher/types/ChatInviteLink/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/ChatJoinRequest/entity.json b/.butcher/types/ChatJoinRequest/entity.json
index 172bd5ab..99fa2d7d 100644
--- a/.butcher/types/ChatJoinRequest/entity.json
+++ b/.butcher/types/ChatJoinRequest/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
@@ -29,6 +27,14 @@
"name": "from",
"required": true
},
+ {
+ "type": "Integer",
+ "description": "Identifier of a private chat with the user who sent the join request. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot can use this identifier for 24 hours to send messages until the join request is processed, assuming no other administrator contacted the user.",
+ "html_description": "Identifier of a private chat with the user who sent the join request. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot can use this identifier for 24 hours to send messages until the join request is processed, assuming no other administrator contacted the user. | ",
+ "rst_description": "Identifier of a private chat with the user who sent the join request. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot can use this identifier for 24 hours to send messages until the join request is processed, assuming no other administrator contacted the user.\n",
+ "name": "user_chat_id",
+ "required": true
+ },
{
"type": "Integer",
"description": "Date the request was sent in Unix time",
diff --git a/.butcher/types/ChatLocation/entity.json b/.butcher/types/ChatLocation/entity.json
index 02db74b8..8b9f1e7d 100644
--- a/.butcher/types/ChatLocation/entity.json
+++ b/.butcher/types/ChatLocation/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/ChatMember/entity.json b/.butcher/types/ChatMember/entity.json
index 1aaccd38..642479cc 100644
--- a/.butcher/types/ChatMember/entity.json
+++ b/.butcher/types/ChatMember/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/ChatMemberAdministrator/entity.json b/.butcher/types/ChatMemberAdministrator/entity.json
index b6e6bd2e..577d9daf 100644
--- a/.butcher/types/ChatMemberAdministrator/entity.json
+++ b/.butcher/types/ChatMemberAdministrator/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
@@ -79,9 +77,9 @@
},
{
"type": "Boolean",
- "description": "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 the user)",
- "html_description": "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 the user) | ",
- "rst_description": ":code:`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 the user)\n",
+ "description": "True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user)",
+ "html_description": "True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user) | ",
+ "rst_description": ":code:`True`, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user)\n",
"name": "can_promote_members",
"required": true
},
diff --git a/.butcher/types/ChatMemberBanned/entity.json b/.butcher/types/ChatMemberBanned/entity.json
index 95f50234..49d42e20 100644
--- a/.butcher/types/ChatMemberBanned/entity.json
+++ b/.butcher/types/ChatMemberBanned/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/ChatMemberLeft/entity.json b/.butcher/types/ChatMemberLeft/entity.json
index f9754ded..6e67d7cc 100644
--- a/.butcher/types/ChatMemberLeft/entity.json
+++ b/.butcher/types/ChatMemberLeft/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/ChatMemberMember/entity.json b/.butcher/types/ChatMemberMember/entity.json
index 43f9cab2..90d6016a 100644
--- a/.butcher/types/ChatMemberMember/entity.json
+++ b/.butcher/types/ChatMemberMember/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/ChatMemberOwner/entity.json b/.butcher/types/ChatMemberOwner/entity.json
index 7a9c439e..2fafed33 100644
--- a/.butcher/types/ChatMemberOwner/entity.json
+++ b/.butcher/types/ChatMemberOwner/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/ChatMemberRestricted/entity.json b/.butcher/types/ChatMemberRestricted/entity.json
index f582df2f..958ad57a 100644
--- a/.butcher/types/ChatMemberRestricted/entity.json
+++ b/.butcher/types/ChatMemberRestricted/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
@@ -37,6 +35,86 @@
"name": "is_member",
"required": true
},
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to send text messages, contacts, invoices, locations and venues",
+ "html_description": "True, if the user is allowed to send text messages, contacts, invoices, locations and venues | ",
+ "rst_description": ":code:`True`, if the user is allowed to send text messages, contacts, invoices, locations and venues\n",
+ "name": "can_send_messages",
+ "required": true
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to send audios",
+ "html_description": "True, if the user is allowed to send audios | ",
+ "rst_description": ":code:`True`, if the user is allowed to send audios\n",
+ "name": "can_send_audios",
+ "required": true
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to send documents",
+ "html_description": "True, if the user is allowed to send documents | ",
+ "rst_description": ":code:`True`, if the user is allowed to send documents\n",
+ "name": "can_send_documents",
+ "required": true
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to send photos",
+ "html_description": "True, if the user is allowed to send photos | ",
+ "rst_description": ":code:`True`, if the user is allowed to send photos\n",
+ "name": "can_send_photos",
+ "required": true
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to send videos",
+ "html_description": "True, if the user is allowed to send videos | ",
+ "rst_description": ":code:`True`, if the user is allowed to send videos\n",
+ "name": "can_send_videos",
+ "required": true
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to send video notes",
+ "html_description": "True, if the user is allowed to send video notes | ",
+ "rst_description": ":code:`True`, if the user is allowed to send video notes\n",
+ "name": "can_send_video_notes",
+ "required": true
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to send voice notes",
+ "html_description": "True, if the user is allowed to send voice notes | ",
+ "rst_description": ":code:`True`, if the user is allowed to send voice notes\n",
+ "name": "can_send_voice_notes",
+ "required": true
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to send polls",
+ "html_description": "True, if the user is allowed to send polls | ",
+ "rst_description": ":code:`True`, if the user is allowed to send polls\n",
+ "name": "can_send_polls",
+ "required": true
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to send animations, games, stickers and use inline bots",
+ "html_description": "True, if the user is allowed to send animations, games, stickers and use inline bots | ",
+ "rst_description": ":code:`True`, if the user is allowed to send animations, games, stickers and use inline bots\n",
+ "name": "can_send_other_messages",
+ "required": true
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to add web page previews to their messages",
+ "html_description": "True, if the user is allowed to add web page previews to their messages | ",
+ "rst_description": ":code:`True`, if the user is allowed to add web page previews to their messages\n",
+ "name": "can_add_web_page_previews",
+ "required": true
+ },
{
"type": "Boolean",
"description": "True, if the user is allowed to change the chat title, photo and other settings",
@@ -69,46 +147,6 @@
"name": "can_manage_topics",
"required": true
},
- {
- "type": "Boolean",
- "description": "True, if the user is allowed to send text messages, contacts, locations and venues",
- "html_description": "True, if the user is allowed to send text messages, contacts, locations and venues | ",
- "rst_description": ":code:`True`, if the user is allowed to send text messages, contacts, locations and venues\n",
- "name": "can_send_messages",
- "required": true
- },
- {
- "type": "Boolean",
- "description": "True, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes",
- "html_description": "True, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes | ",
- "rst_description": ":code:`True`, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes\n",
- "name": "can_send_media_messages",
- "required": true
- },
- {
- "type": "Boolean",
- "description": "True, if the user is allowed to send polls",
- "html_description": "True, if the user is allowed to send polls | ",
- "rst_description": ":code:`True`, if the user is allowed to send polls\n",
- "name": "can_send_polls",
- "required": true
- },
- {
- "type": "Boolean",
- "description": "True, if the user is allowed to send animations, games, stickers and use inline bots",
- "html_description": "True, if the user is allowed to send animations, games, stickers and use inline bots | ",
- "rst_description": ":code:`True`, if the user is allowed to send animations, games, stickers and use inline bots\n",
- "name": "can_send_other_messages",
- "required": true
- },
- {
- "type": "Boolean",
- "description": "True, if the user is allowed to add web page previews to their messages",
- "html_description": "True, if the user is allowed to add web page previews to their messages | ",
- "rst_description": ":code:`True`, if the user is allowed to add web page previews to their messages\n",
- "name": "can_add_web_page_previews",
- "required": true
- },
{
"type": "Integer",
"description": "Date when restrictions will be lifted for this user; unix time. If 0, then the user is restricted forever",
diff --git a/.butcher/types/ChatMemberUpdated/entity.json b/.butcher/types/ChatMemberUpdated/entity.json
index 4bd3bc15..7454b512 100644
--- a/.butcher/types/ChatMemberUpdated/entity.json
+++ b/.butcher/types/ChatMemberUpdated/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/ChatPermissions/entity.json b/.butcher/types/ChatPermissions/entity.json
index 0d7d2548..5a206394 100644
--- a/.butcher/types/ChatPermissions/entity.json
+++ b/.butcher/types/ChatPermissions/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
@@ -15,41 +13,81 @@
"annotations": [
{
"type": "Boolean",
- "description": "True, if the user is allowed to send text messages, contacts, locations and venues",
- "html_description": "Optional. True, if the user is allowed to send text messages, contacts, locations and venues | ",
- "rst_description": "*Optional*. :code:`True`, if the user is allowed to send text messages, contacts, locations and venues\n",
+ "description": "True, if the user is allowed to send text messages, contacts, invoices, locations and venues",
+ "html_description": "Optional. True, if the user is allowed to send text messages, contacts, invoices, locations and venues | ",
+ "rst_description": "*Optional*. :code:`True`, if the user is allowed to send text messages, contacts, invoices, locations and venues\n",
"name": "can_send_messages",
"required": false
},
{
"type": "Boolean",
- "description": "True, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages",
- "html_description": "Optional. True, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages | ",
- "rst_description": "*Optional*. :code:`True`, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages\n",
- "name": "can_send_media_messages",
+ "description": "True, if the user is allowed to send audios",
+ "html_description": "Optional. True, if the user is allowed to send audios | ",
+ "rst_description": "*Optional*. :code:`True`, if the user is allowed to send audios\n",
+ "name": "can_send_audios",
"required": false
},
{
"type": "Boolean",
- "description": "True, if the user is allowed to send polls, implies can_send_messages",
- "html_description": "Optional. True, if the user is allowed to send polls, implies can_send_messages | ",
- "rst_description": "*Optional*. :code:`True`, if the user is allowed to send polls, implies can_send_messages\n",
+ "description": "True, if the user is allowed to send documents",
+ "html_description": "Optional. True, if the user is allowed to send documents | ",
+ "rst_description": "*Optional*. :code:`True`, if the user is allowed to send documents\n",
+ "name": "can_send_documents",
+ "required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to send photos",
+ "html_description": "Optional. True, if the user is allowed to send photos | ",
+ "rst_description": "*Optional*. :code:`True`, if the user is allowed to send photos\n",
+ "name": "can_send_photos",
+ "required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to send videos",
+ "html_description": "Optional. True, if the user is allowed to send videos | ",
+ "rst_description": "*Optional*. :code:`True`, if the user is allowed to send videos\n",
+ "name": "can_send_videos",
+ "required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to send video notes",
+ "html_description": "Optional. True, if the user is allowed to send video notes | ",
+ "rst_description": "*Optional*. :code:`True`, if the user is allowed to send video notes\n",
+ "name": "can_send_video_notes",
+ "required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to send voice notes",
+ "html_description": "Optional. True, if the user is allowed to send voice notes | ",
+ "rst_description": "*Optional*. :code:`True`, if the user is allowed to send voice notes\n",
+ "name": "can_send_voice_notes",
+ "required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to send polls",
+ "html_description": "Optional. True, if the user is allowed to send polls | ",
+ "rst_description": "*Optional*. :code:`True`, if the user is allowed to send polls\n",
"name": "can_send_polls",
"required": false
},
{
"type": "Boolean",
- "description": "True, if the user is allowed to send animations, games, stickers and use inline bots, implies can_send_media_messages",
- "html_description": "Optional. True, if the user is allowed to send animations, games, stickers and use inline bots, implies can_send_media_messages | ",
- "rst_description": "*Optional*. :code:`True`, if the user is allowed to send animations, games, stickers and use inline bots, implies can_send_media_messages\n",
+ "description": "True, if the user is allowed to send animations, games, stickers and use inline bots",
+ "html_description": "Optional. True, if the user is allowed to send animations, games, stickers and use inline bots | ",
+ "rst_description": "*Optional*. :code:`True`, if the user is allowed to send animations, games, stickers and use inline bots\n",
"name": "can_send_other_messages",
"required": false
},
{
"type": "Boolean",
- "description": "True, if the user is allowed to add web page previews to their messages, implies can_send_media_messages",
- "html_description": "Optional. True, if the user is allowed to add web page previews to their messages, implies can_send_media_messages | ",
- "rst_description": "*Optional*. :code:`True`, if the user is allowed to add web page previews to their messages, implies can_send_media_messages\n",
+ "description": "True, if the user is allowed to add web page previews to their messages",
+ "html_description": "Optional. True, if the user is allowed to add web page previews to their messages | ",
+ "rst_description": "*Optional*. :code:`True`, if the user is allowed to add web page previews to their messages\n",
"name": "can_add_web_page_previews",
"required": false
},
diff --git a/.butcher/types/ChatPhoto/entity.json b/.butcher/types/ChatPhoto/entity.json
index eefcb188..50ce7532 100644
--- a/.butcher/types/ChatPhoto/entity.json
+++ b/.butcher/types/ChatPhoto/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/ChatShared/entity.json b/.butcher/types/ChatShared/entity.json
new file mode 100644
index 00000000..ceaeb604
--- /dev/null
+++ b/.butcher/types/ChatShared/entity.json
@@ -0,0 +1,33 @@
+{
+ "meta": {},
+ "group": {
+ "title": "Available types",
+ "anchor": "available-types"
+ },
+ "object": {
+ "anchor": "chatshared",
+ "name": "ChatShared",
+ "description": "This object contains information about the chat whose identifier was shared with the bot using a KeyboardButtonRequestChat button.",
+ "html_description": "This object contains information about the chat whose identifier was shared with the bot using a KeyboardButtonRequestChat button.
",
+ "rst_description": "This object contains information about the chat whose identifier was shared with the bot using a :class:`aiogram.types.keyboard_button_request_chat.KeyboardButtonRequestChat` button.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "description": "Identifier of the request",
+ "html_description": "Identifier of the request | ",
+ "rst_description": "Identifier of the request\n",
+ "name": "request_id",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "Identifier of the shared chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot may not have access to the chat and could be unable to use this identifier, unless the chat is already known to the bot by some other means.",
+ "html_description": "Identifier of the shared chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot may not have access to the chat and could be unable to use this identifier, unless the chat is already known to the bot by some other means. | ",
+ "rst_description": "Identifier of the shared chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot may not have access to the chat and could be unable to use this identifier, unless the chat is already known to the bot by some other means.\n",
+ "name": "chat_id",
+ "required": true
+ }
+ ],
+ "category": "types"
+ }
+}
diff --git a/.butcher/types/ChosenInlineResult/entity.json b/.butcher/types/ChosenInlineResult/entity.json
index d3df812c..66d5eb25 100644
--- a/.butcher/types/ChosenInlineResult/entity.json
+++ b/.butcher/types/ChosenInlineResult/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
diff --git a/.butcher/types/Contact/entity.json b/.butcher/types/Contact/entity.json
index 95081fb0..fbbf72ef 100644
--- a/.butcher/types/Contact/entity.json
+++ b/.butcher/types/Contact/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/Dice/entity.json b/.butcher/types/Dice/entity.json
index 1302cb88..ac9ad417 100644
--- a/.butcher/types/Dice/entity.json
+++ b/.butcher/types/Dice/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/Document/entity.json b/.butcher/types/Document/entity.json
index 65e0386d..c583215d 100644
--- a/.butcher/types/Document/entity.json
+++ b/.butcher/types/Document/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
@@ -34,7 +32,7 @@
"description": "Document thumbnail as defined by sender",
"html_description": "Optional. Document thumbnail as defined by sender | ",
"rst_description": "*Optional*. Document thumbnail as defined by sender\n",
- "name": "thumb",
+ "name": "thumbnail",
"required": false
},
{
diff --git a/.butcher/types/EncryptedCredentials/entity.json b/.butcher/types/EncryptedCredentials/entity.json
index 906910b7..0841cc1d 100644
--- a/.butcher/types/EncryptedCredentials/entity.json
+++ b/.butcher/types/EncryptedCredentials/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Telegram Passport",
"anchor": "telegram-passport"
diff --git a/.butcher/types/EncryptedPassportElement/entity.json b/.butcher/types/EncryptedPassportElement/entity.json
index c098c209..33fd2827 100644
--- a/.butcher/types/EncryptedPassportElement/entity.json
+++ b/.butcher/types/EncryptedPassportElement/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Telegram Passport",
"anchor": "telegram-passport"
diff --git a/.butcher/types/ErrorEvent/replace.yml b/.butcher/types/ErrorEvent/replace.yml
deleted file mode 100644
index aea86aff..00000000
--- a/.butcher/types/ErrorEvent/replace.yml
+++ /dev/null
@@ -1,2 +0,0 @@
-bases:
- - _ErrorEvent
diff --git a/.butcher/types/File/entity.json b/.butcher/types/File/entity.json
index 22170036..dcf7a39c 100644
--- a/.butcher/types/File/entity.json
+++ b/.butcher/types/File/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/ForceReply/entity.json b/.butcher/types/ForceReply/entity.json
index 679e8606..c06b916d 100644
--- a/.butcher/types/ForceReply/entity.json
+++ b/.butcher/types/ForceReply/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/ForumTopic/entity.json b/.butcher/types/ForumTopic/entity.json
index 4dabd630..4198661a 100644
--- a/.butcher/types/ForumTopic/entity.json
+++ b/.butcher/types/ForumTopic/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/ForumTopicClosed/entity.json b/.butcher/types/ForumTopicClosed/entity.json
index 4b54cd59..c06f4f6f 100644
--- a/.butcher/types/ForumTopicClosed/entity.json
+++ b/.butcher/types/ForumTopicClosed/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/ForumTopicCreated/entity.json b/.butcher/types/ForumTopicCreated/entity.json
index 16b90aeb..f1832898 100644
--- a/.butcher/types/ForumTopicCreated/entity.json
+++ b/.butcher/types/ForumTopicCreated/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/ForumTopicEdited/entity.json b/.butcher/types/ForumTopicEdited/entity.json
new file mode 100644
index 00000000..c8f3dd1c
--- /dev/null
+++ b/.butcher/types/ForumTopicEdited/entity.json
@@ -0,0 +1,33 @@
+{
+ "meta": {},
+ "group": {
+ "title": "Available types",
+ "anchor": "available-types"
+ },
+ "object": {
+ "anchor": "forumtopicedited",
+ "name": "ForumTopicEdited",
+ "description": "This object represents a service message about an edited forum topic.",
+ "html_description": "This object represents a service message about an edited forum topic.
",
+ "rst_description": "This object represents a service message about an edited forum topic.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "New name of the topic, if it was edited",
+ "html_description": "Optional. New name of the topic, if it was edited | ",
+ "rst_description": "*Optional*. New name of the topic, if it was edited\n",
+ "name": "name",
+ "required": false
+ },
+ {
+ "type": "String",
+ "description": "New identifier of the custom emoji shown as the topic icon, if it was edited; an empty string if the icon was removed",
+ "html_description": "Optional. New identifier of the custom emoji shown as the topic icon, if it was edited; an empty string if the icon was removed | ",
+ "rst_description": "*Optional*. New identifier of the custom emoji shown as the topic icon, if it was edited; an empty string if the icon was removed\n",
+ "name": "icon_custom_emoji_id",
+ "required": false
+ }
+ ],
+ "category": "types"
+ }
+}
diff --git a/.butcher/types/ForumTopicReopened/entity.json b/.butcher/types/ForumTopicReopened/entity.json
index 6b701c95..f9527ce0 100644
--- a/.butcher/types/ForumTopicReopened/entity.json
+++ b/.butcher/types/ForumTopicReopened/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/Game/entity.json b/.butcher/types/Game/entity.json
index 9a0ebe64..45ce4f08 100644
--- a/.butcher/types/Game/entity.json
+++ b/.butcher/types/Game/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Games",
"anchor": "games"
diff --git a/.butcher/types/GameHighScore/entity.json b/.butcher/types/GameHighScore/entity.json
index 291fc839..ce3f52d2 100644
--- a/.butcher/types/GameHighScore/entity.json
+++ b/.butcher/types/GameHighScore/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Games",
"anchor": "games"
diff --git a/.butcher/types/GeneralForumTopicHidden/entity.json b/.butcher/types/GeneralForumTopicHidden/entity.json
new file mode 100644
index 00000000..ec288ac1
--- /dev/null
+++ b/.butcher/types/GeneralForumTopicHidden/entity.json
@@ -0,0 +1,16 @@
+{
+ "meta": {},
+ "group": {
+ "title": "Available types",
+ "anchor": "available-types"
+ },
+ "object": {
+ "anchor": "generalforumtopichidden",
+ "name": "GeneralForumTopicHidden",
+ "description": "This object represents a service message about General forum topic hidden in the chat. Currently holds no information.",
+ "html_description": "This object represents a service message about General forum topic hidden in the chat. Currently holds no information.
",
+ "rst_description": "This object represents a service message about General forum topic hidden in the chat. Currently holds no information.",
+ "annotations": [],
+ "category": "types"
+ }
+}
diff --git a/.butcher/types/GeneralForumTopicUnhidden/entity.json b/.butcher/types/GeneralForumTopicUnhidden/entity.json
new file mode 100644
index 00000000..415d75a5
--- /dev/null
+++ b/.butcher/types/GeneralForumTopicUnhidden/entity.json
@@ -0,0 +1,16 @@
+{
+ "meta": {},
+ "group": {
+ "title": "Available types",
+ "anchor": "available-types"
+ },
+ "object": {
+ "anchor": "generalforumtopicunhidden",
+ "name": "GeneralForumTopicUnhidden",
+ "description": "This object represents a service message about General forum topic unhidden in the chat. Currently holds no information.",
+ "html_description": "This object represents a service message about General forum topic unhidden in the chat. Currently holds no information.
",
+ "rst_description": "This object represents a service message about General forum topic unhidden in the chat. Currently holds no information.",
+ "annotations": [],
+ "category": "types"
+ }
+}
diff --git a/.butcher/types/InlineKeyboardButton/entity.json b/.butcher/types/InlineKeyboardButton/entity.json
index 3b243461..e73ff4dc 100644
--- a/.butcher/types/InlineKeyboardButton/entity.json
+++ b/.butcher/types/InlineKeyboardButton/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/InlineKeyboardMarkup/entity.json b/.butcher/types/InlineKeyboardMarkup/entity.json
index 8e8d3708..e641e20a 100644
--- a/.butcher/types/InlineKeyboardMarkup/entity.json
+++ b/.butcher/types/InlineKeyboardMarkup/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/InlineQuery/entity.json b/.butcher/types/InlineQuery/entity.json
index 56284893..e34ce5bc 100644
--- a/.butcher/types/InlineQuery/entity.json
+++ b/.butcher/types/InlineQuery/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
diff --git a/.butcher/types/InlineQueryResult/entity.json b/.butcher/types/InlineQueryResult/entity.json
index 71c5a3b4..f75078ee 100644
--- a/.butcher/types/InlineQueryResult/entity.json
+++ b/.butcher/types/InlineQueryResult/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
diff --git a/.butcher/types/InlineQueryResultArticle/entity.json b/.butcher/types/InlineQueryResultArticle/entity.json
index 93c397e7..eba5d318 100644
--- a/.butcher/types/InlineQueryResultArticle/entity.json
+++ b/.butcher/types/InlineQueryResultArticle/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
@@ -82,7 +80,7 @@
"description": "Url of the thumbnail for the result",
"html_description": "Optional. Url of the thumbnail for the result | ",
"rst_description": "*Optional*. Url of the thumbnail for the result\n",
- "name": "thumb_url",
+ "name": "thumbnail_url",
"required": false
},
{
@@ -90,7 +88,7 @@
"description": "Thumbnail width",
"html_description": "Optional. Thumbnail width | ",
"rst_description": "*Optional*. Thumbnail width\n",
- "name": "thumb_width",
+ "name": "thumbnail_width",
"required": false
},
{
@@ -98,7 +96,7 @@
"description": "Thumbnail height",
"html_description": "Optional. Thumbnail height | ",
"rst_description": "*Optional*. Thumbnail height\n",
- "name": "thumb_height",
+ "name": "thumbnail_height",
"required": false
}
],
diff --git a/.butcher/types/InlineQueryResultAudio/entity.json b/.butcher/types/InlineQueryResultAudio/entity.json
index 83170481..9e995562 100644
--- a/.butcher/types/InlineQueryResultAudio/entity.json
+++ b/.butcher/types/InlineQueryResultAudio/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
diff --git a/.butcher/types/InlineQueryResultAudio/replace.yml b/.butcher/types/InlineQueryResultAudio/replace.yml
index b877a94d..cd89306d 100644
--- a/.butcher/types/InlineQueryResultAudio/replace.yml
+++ b/.butcher/types/InlineQueryResultAudio/replace.yml
@@ -3,4 +3,4 @@ bases:
annotations:
parse_mode:
- value: UNSET
+ value: UNSET_PARSE_MODE
diff --git a/.butcher/types/InlineQueryResultCachedAudio/entity.json b/.butcher/types/InlineQueryResultCachedAudio/entity.json
index ec759647..0b5abf32 100644
--- a/.butcher/types/InlineQueryResultCachedAudio/entity.json
+++ b/.butcher/types/InlineQueryResultCachedAudio/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
diff --git a/.butcher/types/InlineQueryResultCachedAudio/replace.yml b/.butcher/types/InlineQueryResultCachedAudio/replace.yml
index b877a94d..cd89306d 100644
--- a/.butcher/types/InlineQueryResultCachedAudio/replace.yml
+++ b/.butcher/types/InlineQueryResultCachedAudio/replace.yml
@@ -3,4 +3,4 @@ bases:
annotations:
parse_mode:
- value: UNSET
+ value: UNSET_PARSE_MODE
diff --git a/.butcher/types/InlineQueryResultCachedDocument/entity.json b/.butcher/types/InlineQueryResultCachedDocument/entity.json
index a00bf785..3f49dc6d 100644
--- a/.butcher/types/InlineQueryResultCachedDocument/entity.json
+++ b/.butcher/types/InlineQueryResultCachedDocument/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
diff --git a/.butcher/types/InlineQueryResultCachedDocument/replace.yml b/.butcher/types/InlineQueryResultCachedDocument/replace.yml
index b877a94d..cd89306d 100644
--- a/.butcher/types/InlineQueryResultCachedDocument/replace.yml
+++ b/.butcher/types/InlineQueryResultCachedDocument/replace.yml
@@ -3,4 +3,4 @@ bases:
annotations:
parse_mode:
- value: UNSET
+ value: UNSET_PARSE_MODE
diff --git a/.butcher/types/InlineQueryResultCachedGif/entity.json b/.butcher/types/InlineQueryResultCachedGif/entity.json
index 5d18e4cb..51c90620 100644
--- a/.butcher/types/InlineQueryResultCachedGif/entity.json
+++ b/.butcher/types/InlineQueryResultCachedGif/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
diff --git a/.butcher/types/InlineQueryResultCachedGif/replace.yml b/.butcher/types/InlineQueryResultCachedGif/replace.yml
index b877a94d..cd89306d 100644
--- a/.butcher/types/InlineQueryResultCachedGif/replace.yml
+++ b/.butcher/types/InlineQueryResultCachedGif/replace.yml
@@ -3,4 +3,4 @@ bases:
annotations:
parse_mode:
- value: UNSET
+ value: UNSET_PARSE_MODE
diff --git a/.butcher/types/InlineQueryResultCachedMpeg4Gif/entity.json b/.butcher/types/InlineQueryResultCachedMpeg4Gif/entity.json
index 8dbef2eb..bd91435e 100644
--- a/.butcher/types/InlineQueryResultCachedMpeg4Gif/entity.json
+++ b/.butcher/types/InlineQueryResultCachedMpeg4Gif/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
diff --git a/.butcher/types/InlineQueryResultCachedMpeg4Gif/replace.yml b/.butcher/types/InlineQueryResultCachedMpeg4Gif/replace.yml
index b877a94d..cd89306d 100644
--- a/.butcher/types/InlineQueryResultCachedMpeg4Gif/replace.yml
+++ b/.butcher/types/InlineQueryResultCachedMpeg4Gif/replace.yml
@@ -3,4 +3,4 @@ bases:
annotations:
parse_mode:
- value: UNSET
+ value: UNSET_PARSE_MODE
diff --git a/.butcher/types/InlineQueryResultCachedPhoto/entity.json b/.butcher/types/InlineQueryResultCachedPhoto/entity.json
index 460c3274..d0bc2b9b 100644
--- a/.butcher/types/InlineQueryResultCachedPhoto/entity.json
+++ b/.butcher/types/InlineQueryResultCachedPhoto/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
diff --git a/.butcher/types/InlineQueryResultCachedPhoto/replace.yml b/.butcher/types/InlineQueryResultCachedPhoto/replace.yml
index b877a94d..cd89306d 100644
--- a/.butcher/types/InlineQueryResultCachedPhoto/replace.yml
+++ b/.butcher/types/InlineQueryResultCachedPhoto/replace.yml
@@ -3,4 +3,4 @@ bases:
annotations:
parse_mode:
- value: UNSET
+ value: UNSET_PARSE_MODE
diff --git a/.butcher/types/InlineQueryResultCachedSticker/entity.json b/.butcher/types/InlineQueryResultCachedSticker/entity.json
index 7f3f4e47..eb0b717b 100644
--- a/.butcher/types/InlineQueryResultCachedSticker/entity.json
+++ b/.butcher/types/InlineQueryResultCachedSticker/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
diff --git a/.butcher/types/InlineQueryResultCachedVideo/entity.json b/.butcher/types/InlineQueryResultCachedVideo/entity.json
index c7e60fea..2b35ddc6 100644
--- a/.butcher/types/InlineQueryResultCachedVideo/entity.json
+++ b/.butcher/types/InlineQueryResultCachedVideo/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
diff --git a/.butcher/types/InlineQueryResultCachedVideo/replace.yml b/.butcher/types/InlineQueryResultCachedVideo/replace.yml
index b877a94d..cd89306d 100644
--- a/.butcher/types/InlineQueryResultCachedVideo/replace.yml
+++ b/.butcher/types/InlineQueryResultCachedVideo/replace.yml
@@ -3,4 +3,4 @@ bases:
annotations:
parse_mode:
- value: UNSET
+ value: UNSET_PARSE_MODE
diff --git a/.butcher/types/InlineQueryResultCachedVoice/entity.json b/.butcher/types/InlineQueryResultCachedVoice/entity.json
index 6dd0ea0d..3c576fbb 100644
--- a/.butcher/types/InlineQueryResultCachedVoice/entity.json
+++ b/.butcher/types/InlineQueryResultCachedVoice/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
diff --git a/.butcher/types/InlineQueryResultCachedVoice/replace.yml b/.butcher/types/InlineQueryResultCachedVoice/replace.yml
index b877a94d..cd89306d 100644
--- a/.butcher/types/InlineQueryResultCachedVoice/replace.yml
+++ b/.butcher/types/InlineQueryResultCachedVoice/replace.yml
@@ -3,4 +3,4 @@ bases:
annotations:
parse_mode:
- value: UNSET
+ value: UNSET_PARSE_MODE
diff --git a/.butcher/types/InlineQueryResultContact/entity.json b/.butcher/types/InlineQueryResultContact/entity.json
index 3b9b65fa..10d12e2b 100644
--- a/.butcher/types/InlineQueryResultContact/entity.json
+++ b/.butcher/types/InlineQueryResultContact/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
@@ -82,7 +80,7 @@
"description": "Url of the thumbnail for the result",
"html_description": "Optional. Url of the thumbnail for the result | ",
"rst_description": "*Optional*. Url of the thumbnail for the result\n",
- "name": "thumb_url",
+ "name": "thumbnail_url",
"required": false
},
{
@@ -90,7 +88,7 @@
"description": "Thumbnail width",
"html_description": "Optional. Thumbnail width | ",
"rst_description": "*Optional*. Thumbnail width\n",
- "name": "thumb_width",
+ "name": "thumbnail_width",
"required": false
},
{
@@ -98,7 +96,7 @@
"description": "Thumbnail height",
"html_description": "Optional. Thumbnail height | ",
"rst_description": "*Optional*. Thumbnail height\n",
- "name": "thumb_height",
+ "name": "thumbnail_height",
"required": false
}
],
diff --git a/.butcher/types/InlineQueryResultDocument/entity.json b/.butcher/types/InlineQueryResultDocument/entity.json
index 76a1bb70..286fd9b7 100644
--- a/.butcher/types/InlineQueryResultDocument/entity.json
+++ b/.butcher/types/InlineQueryResultDocument/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
@@ -106,7 +104,7 @@
"description": "URL of the thumbnail (JPEG only) for the file",
"html_description": "Optional. URL of the thumbnail (JPEG only) for the file | ",
"rst_description": "*Optional*. URL of the thumbnail (JPEG only) for the file\n",
- "name": "thumb_url",
+ "name": "thumbnail_url",
"required": false
},
{
@@ -114,7 +112,7 @@
"description": "Thumbnail width",
"html_description": "Optional. Thumbnail width | ",
"rst_description": "*Optional*. Thumbnail width\n",
- "name": "thumb_width",
+ "name": "thumbnail_width",
"required": false
},
{
@@ -122,7 +120,7 @@
"description": "Thumbnail height",
"html_description": "Optional. Thumbnail height | ",
"rst_description": "*Optional*. Thumbnail height\n",
- "name": "thumb_height",
+ "name": "thumbnail_height",
"required": false
}
],
diff --git a/.butcher/types/InlineQueryResultDocument/replace.yml b/.butcher/types/InlineQueryResultDocument/replace.yml
index b877a94d..cd89306d 100644
--- a/.butcher/types/InlineQueryResultDocument/replace.yml
+++ b/.butcher/types/InlineQueryResultDocument/replace.yml
@@ -3,4 +3,4 @@ bases:
annotations:
parse_mode:
- value: UNSET
+ value: UNSET_PARSE_MODE
diff --git a/.butcher/types/InlineQueryResultGame/entity.json b/.butcher/types/InlineQueryResultGame/entity.json
index 00728d78..918bff7b 100644
--- a/.butcher/types/InlineQueryResultGame/entity.json
+++ b/.butcher/types/InlineQueryResultGame/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
diff --git a/.butcher/types/InlineQueryResultGif/entity.json b/.butcher/types/InlineQueryResultGif/entity.json
index 89f56afc..7824368a 100644
--- a/.butcher/types/InlineQueryResultGif/entity.json
+++ b/.butcher/types/InlineQueryResultGif/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
@@ -66,7 +64,7 @@
"description": "URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result",
"html_description": "URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result | ",
"rst_description": "URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result\n",
- "name": "thumb_url",
+ "name": "thumbnail_url",
"required": true
},
{
@@ -74,7 +72,7 @@
"description": "MIME type of the thumbnail, must be one of 'image/jpeg', 'image/gif', or 'video/mp4'. Defaults to 'image/jpeg'",
"html_description": "Optional. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg” | ",
"rst_description": "*Optional*. MIME type of the thumbnail, must be one of 'image/jpeg', 'image/gif', or 'video/mp4'. Defaults to 'image/jpeg'\n",
- "name": "thumb_mime_type",
+ "name": "thumbnail_mime_type",
"required": false
},
{
diff --git a/.butcher/types/InlineQueryResultGif/replace.yml b/.butcher/types/InlineQueryResultGif/replace.yml
index b877a94d..cd89306d 100644
--- a/.butcher/types/InlineQueryResultGif/replace.yml
+++ b/.butcher/types/InlineQueryResultGif/replace.yml
@@ -3,4 +3,4 @@ bases:
annotations:
parse_mode:
- value: UNSET
+ value: UNSET_PARSE_MODE
diff --git a/.butcher/types/InlineQueryResultLocation/entity.json b/.butcher/types/InlineQueryResultLocation/entity.json
index 7f14565f..a6c30068 100644
--- a/.butcher/types/InlineQueryResultLocation/entity.json
+++ b/.butcher/types/InlineQueryResultLocation/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
@@ -106,7 +104,7 @@
"description": "Url of the thumbnail for the result",
"html_description": "Optional. Url of the thumbnail for the result | ",
"rst_description": "*Optional*. Url of the thumbnail for the result\n",
- "name": "thumb_url",
+ "name": "thumbnail_url",
"required": false
},
{
@@ -114,7 +112,7 @@
"description": "Thumbnail width",
"html_description": "Optional. Thumbnail width | ",
"rst_description": "*Optional*. Thumbnail width\n",
- "name": "thumb_width",
+ "name": "thumbnail_width",
"required": false
},
{
@@ -122,7 +120,7 @@
"description": "Thumbnail height",
"html_description": "Optional. Thumbnail height | ",
"rst_description": "*Optional*. Thumbnail height\n",
- "name": "thumb_height",
+ "name": "thumbnail_height",
"required": false
}
],
diff --git a/.butcher/types/InlineQueryResultMpeg4Gif/entity.json b/.butcher/types/InlineQueryResultMpeg4Gif/entity.json
index 27ebd1e3..c365a134 100644
--- a/.butcher/types/InlineQueryResultMpeg4Gif/entity.json
+++ b/.butcher/types/InlineQueryResultMpeg4Gif/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
@@ -66,7 +64,7 @@
"description": "URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result",
"html_description": "URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result | ",
"rst_description": "URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result\n",
- "name": "thumb_url",
+ "name": "thumbnail_url",
"required": true
},
{
@@ -74,7 +72,7 @@
"description": "MIME type of the thumbnail, must be one of 'image/jpeg', 'image/gif', or 'video/mp4'. Defaults to 'image/jpeg'",
"html_description": "Optional. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg” | ",
"rst_description": "*Optional*. MIME type of the thumbnail, must be one of 'image/jpeg', 'image/gif', or 'video/mp4'. Defaults to 'image/jpeg'\n",
- "name": "thumb_mime_type",
+ "name": "thumbnail_mime_type",
"required": false
},
{
diff --git a/.butcher/types/InlineQueryResultMpeg4Gif/replace.yml b/.butcher/types/InlineQueryResultMpeg4Gif/replace.yml
index b877a94d..cd89306d 100644
--- a/.butcher/types/InlineQueryResultMpeg4Gif/replace.yml
+++ b/.butcher/types/InlineQueryResultMpeg4Gif/replace.yml
@@ -3,4 +3,4 @@ bases:
annotations:
parse_mode:
- value: UNSET
+ value: UNSET_PARSE_MODE
diff --git a/.butcher/types/InlineQueryResultPhoto/entity.json b/.butcher/types/InlineQueryResultPhoto/entity.json
index 9aa12a16..67130359 100644
--- a/.butcher/types/InlineQueryResultPhoto/entity.json
+++ b/.butcher/types/InlineQueryResultPhoto/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
@@ -42,7 +40,7 @@
"description": "URL of the thumbnail for the photo",
"html_description": "URL of the thumbnail for the photo | ",
"rst_description": "URL of the thumbnail for the photo\n",
- "name": "thumb_url",
+ "name": "thumbnail_url",
"required": true
},
{
diff --git a/.butcher/types/InlineQueryResultPhoto/replace.yml b/.butcher/types/InlineQueryResultPhoto/replace.yml
index b877a94d..cd89306d 100644
--- a/.butcher/types/InlineQueryResultPhoto/replace.yml
+++ b/.butcher/types/InlineQueryResultPhoto/replace.yml
@@ -3,4 +3,4 @@ bases:
annotations:
parse_mode:
- value: UNSET
+ value: UNSET_PARSE_MODE
diff --git a/.butcher/types/InlineQueryResultVenue/entity.json b/.butcher/types/InlineQueryResultVenue/entity.json
index af6c2d22..2191ae32 100644
--- a/.butcher/types/InlineQueryResultVenue/entity.json
+++ b/.butcher/types/InlineQueryResultVenue/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
@@ -114,7 +112,7 @@
"description": "Url of the thumbnail for the result",
"html_description": "Optional. Url of the thumbnail for the result | ",
"rst_description": "*Optional*. Url of the thumbnail for the result\n",
- "name": "thumb_url",
+ "name": "thumbnail_url",
"required": false
},
{
@@ -122,7 +120,7 @@
"description": "Thumbnail width",
"html_description": "Optional. Thumbnail width | ",
"rst_description": "*Optional*. Thumbnail width\n",
- "name": "thumb_width",
+ "name": "thumbnail_width",
"required": false
},
{
@@ -130,7 +128,7 @@
"description": "Thumbnail height",
"html_description": "Optional. Thumbnail height | ",
"rst_description": "*Optional*. Thumbnail height\n",
- "name": "thumb_height",
+ "name": "thumbnail_height",
"required": false
}
],
diff --git a/.butcher/types/InlineQueryResultVideo/entity.json b/.butcher/types/InlineQueryResultVideo/entity.json
index 784a8728..7164306c 100644
--- a/.butcher/types/InlineQueryResultVideo/entity.json
+++ b/.butcher/types/InlineQueryResultVideo/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
@@ -50,7 +48,7 @@
"description": "URL of the thumbnail (JPEG only) for the video",
"html_description": "URL of the thumbnail (JPEG only) for the video | ",
"rst_description": "URL of the thumbnail (JPEG only) for the video\n",
- "name": "thumb_url",
+ "name": "thumbnail_url",
"required": true
},
{
diff --git a/.butcher/types/InlineQueryResultVideo/replace.yml b/.butcher/types/InlineQueryResultVideo/replace.yml
index b877a94d..cd89306d 100644
--- a/.butcher/types/InlineQueryResultVideo/replace.yml
+++ b/.butcher/types/InlineQueryResultVideo/replace.yml
@@ -3,4 +3,4 @@ bases:
annotations:
parse_mode:
- value: UNSET
+ value: UNSET_PARSE_MODE
diff --git a/.butcher/types/InlineQueryResultVoice/entity.json b/.butcher/types/InlineQueryResultVoice/entity.json
index ad3d394e..aeec353f 100644
--- a/.butcher/types/InlineQueryResultVoice/entity.json
+++ b/.butcher/types/InlineQueryResultVoice/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
diff --git a/.butcher/types/InlineQueryResultVoice/replace.yml b/.butcher/types/InlineQueryResultVoice/replace.yml
index cd07671d..6c32c60f 100644
--- a/.butcher/types/InlineQueryResultVoice/replace.yml
+++ b/.butcher/types/InlineQueryResultVoice/replace.yml
@@ -2,4 +2,4 @@ bases:
- InlineQueryResult
annotations:
parse_mode:
- value: UNSET
+ value: UNSET_PARSE_MODE
diff --git a/.butcher/types/InputContactMessageContent/entity.json b/.butcher/types/InputContactMessageContent/entity.json
index 6f465e9e..0acb3c07 100644
--- a/.butcher/types/InputContactMessageContent/entity.json
+++ b/.butcher/types/InputContactMessageContent/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
diff --git a/.butcher/types/InputFile/entity.json b/.butcher/types/InputFile/entity.json
index 009d6131..fb12abf0 100644
--- a/.butcher/types/InputFile/entity.json
+++ b/.butcher/types/InputFile/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/InputInvoiceMessageContent/entity.json b/.butcher/types/InputInvoiceMessageContent/entity.json
index bc5c8048..27195732 100644
--- a/.butcher/types/InputInvoiceMessageContent/entity.json
+++ b/.butcher/types/InputInvoiceMessageContent/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
diff --git a/.butcher/types/InputLocationMessageContent/entity.json b/.butcher/types/InputLocationMessageContent/entity.json
index 460ed0d0..ef06ef82 100644
--- a/.butcher/types/InputLocationMessageContent/entity.json
+++ b/.butcher/types/InputLocationMessageContent/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
diff --git a/.butcher/types/InputMedia/entity.json b/.butcher/types/InputMedia/entity.json
index b1965e5c..193520cf 100644
--- a/.butcher/types/InputMedia/entity.json
+++ b/.butcher/types/InputMedia/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/InputMediaAnimation/entity.json b/.butcher/types/InputMediaAnimation/entity.json
index a106d803..1bd2e3b4 100644
--- a/.butcher/types/InputMediaAnimation/entity.json
+++ b/.butcher/types/InputMediaAnimation/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
@@ -34,7 +32,7 @@
"description": "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 information on Sending Files",
"html_description": "Optional. 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://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | ",
"rst_description": "*Optional*. 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 . :ref:`More information on Sending Files » `\n",
- "name": "thumb",
+ "name": "thumbnail",
"required": false
},
{
@@ -84,6 +82,14 @@
"rst_description": "*Optional*. Animation duration in seconds\n",
"name": "duration",
"required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "Pass True if the animation needs to be covered with a spoiler animation",
+ "html_description": "Optional. Pass True if the animation needs to be covered with a spoiler animation | ",
+ "rst_description": "*Optional*. Pass :code:`True` if the animation needs to be covered with a spoiler animation\n",
+ "name": "has_spoiler",
+ "required": false
}
],
"category": "types"
diff --git a/.butcher/types/InputMediaAnimation/replace.yml b/.butcher/types/InputMediaAnimation/replace.yml
index d2375f89..a2756429 100644
--- a/.butcher/types/InputMediaAnimation/replace.yml
+++ b/.butcher/types/InputMediaAnimation/replace.yml
@@ -12,4 +12,4 @@ annotations:
category: types
name: InputFile
parse_mode:
- value: UNSET
+ value: UNSET_PARSE_MODE
diff --git a/.butcher/types/InputMediaAudio/entity.json b/.butcher/types/InputMediaAudio/entity.json
index 43963950..5f10ad67 100644
--- a/.butcher/types/InputMediaAudio/entity.json
+++ b/.butcher/types/InputMediaAudio/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
@@ -34,7 +32,7 @@
"description": "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 information on Sending Files",
"html_description": "Optional. 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://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | ",
"rst_description": "*Optional*. 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 . :ref:`More information on Sending Files » `\n",
- "name": "thumb",
+ "name": "thumbnail",
"required": false
},
{
diff --git a/.butcher/types/InputMediaAudio/replace.yml b/.butcher/types/InputMediaAudio/replace.yml
index d2375f89..a2756429 100644
--- a/.butcher/types/InputMediaAudio/replace.yml
+++ b/.butcher/types/InputMediaAudio/replace.yml
@@ -12,4 +12,4 @@ annotations:
category: types
name: InputFile
parse_mode:
- value: UNSET
+ value: UNSET_PARSE_MODE
diff --git a/.butcher/types/InputMediaDocument/entity.json b/.butcher/types/InputMediaDocument/entity.json
index cd51dea9..676d6947 100644
--- a/.butcher/types/InputMediaDocument/entity.json
+++ b/.butcher/types/InputMediaDocument/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
@@ -34,7 +32,7 @@
"description": "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 information on Sending Files",
"html_description": "Optional. 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://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | ",
"rst_description": "*Optional*. 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 . :ref:`More information on Sending Files » `\n",
- "name": "thumb",
+ "name": "thumbnail",
"required": false
},
{
diff --git a/.butcher/types/InputMediaDocument/replace.yml b/.butcher/types/InputMediaDocument/replace.yml
index d2375f89..a2756429 100644
--- a/.butcher/types/InputMediaDocument/replace.yml
+++ b/.butcher/types/InputMediaDocument/replace.yml
@@ -12,4 +12,4 @@ annotations:
category: types
name: InputFile
parse_mode:
- value: UNSET
+ value: UNSET_PARSE_MODE
diff --git a/.butcher/types/InputMediaPhoto/entity.json b/.butcher/types/InputMediaPhoto/entity.json
index 792f2cd1..3437668f 100644
--- a/.butcher/types/InputMediaPhoto/entity.json
+++ b/.butcher/types/InputMediaPhoto/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
@@ -52,6 +50,14 @@
"rst_description": "*Optional*. List of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"name": "caption_entities",
"required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "Pass True if the photo needs to be covered with a spoiler animation",
+ "html_description": "Optional. Pass True if the photo needs to be covered with a spoiler animation | ",
+ "rst_description": "*Optional*. Pass :code:`True` if the photo needs to be covered with a spoiler animation\n",
+ "name": "has_spoiler",
+ "required": false
}
],
"category": "types"
diff --git a/.butcher/types/InputMediaPhoto/replace.yml b/.butcher/types/InputMediaPhoto/replace.yml
index d2375f89..a2756429 100644
--- a/.butcher/types/InputMediaPhoto/replace.yml
+++ b/.butcher/types/InputMediaPhoto/replace.yml
@@ -12,4 +12,4 @@ annotations:
category: types
name: InputFile
parse_mode:
- value: UNSET
+ value: UNSET_PARSE_MODE
diff --git a/.butcher/types/InputMediaVideo/entity.json b/.butcher/types/InputMediaVideo/entity.json
index 2f200b46..3bfbb06a 100644
--- a/.butcher/types/InputMediaVideo/entity.json
+++ b/.butcher/types/InputMediaVideo/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
@@ -34,7 +32,7 @@
"description": "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 information on Sending Files",
"html_description": "Optional. 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://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | ",
"rst_description": "*Optional*. 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 . :ref:`More information on Sending Files » `\n",
- "name": "thumb",
+ "name": "thumbnail",
"required": false
},
{
@@ -92,6 +90,14 @@
"rst_description": "*Optional*. Pass :code:`True` if the uploaded video is suitable for streaming\n",
"name": "supports_streaming",
"required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "Pass True if the video needs to be covered with a spoiler animation",
+ "html_description": "Optional. Pass True if the video needs to be covered with a spoiler animation | ",
+ "rst_description": "*Optional*. Pass :code:`True` if the video needs to be covered with a spoiler animation\n",
+ "name": "has_spoiler",
+ "required": false
}
],
"category": "types"
diff --git a/.butcher/types/InputMediaVideo/replace.yml b/.butcher/types/InputMediaVideo/replace.yml
index d2375f89..a2756429 100644
--- a/.butcher/types/InputMediaVideo/replace.yml
+++ b/.butcher/types/InputMediaVideo/replace.yml
@@ -12,4 +12,4 @@ annotations:
category: types
name: InputFile
parse_mode:
- value: UNSET
+ value: UNSET_PARSE_MODE
diff --git a/.butcher/types/InputMessageContent/entity.json b/.butcher/types/InputMessageContent/entity.json
index f578b8de..cc9e857e 100644
--- a/.butcher/types/InputMessageContent/entity.json
+++ b/.butcher/types/InputMessageContent/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
diff --git a/.butcher/types/InputSticker/entity.json b/.butcher/types/InputSticker/entity.json
new file mode 100644
index 00000000..a58690aa
--- /dev/null
+++ b/.butcher/types/InputSticker/entity.json
@@ -0,0 +1,49 @@
+{
+ "meta": {},
+ "group": {
+ "title": "Stickers",
+ "anchor": "stickers"
+ },
+ "object": {
+ "anchor": "inputsticker",
+ "name": "InputSticker",
+ "description": "This object describes a sticker to be added to a sticker set.",
+ "html_description": "This object describes a sticker to be added to a sticker set.
",
+ "rst_description": "This object describes a sticker to be added to a sticker set.",
+ "annotations": [
+ {
+ "type": "InputFile or String",
+ "description": "The added sticker. 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 and video stickers can't be uploaded via HTTP URL. More information on Sending Files",
+ "html_description": "The added sticker. 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 and video stickers can't be uploaded via HTTP URL. More information on Sending Files » | ",
+ "rst_description": "The added sticker. 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 and video stickers can't be uploaded via HTTP URL. :ref:`More information on Sending Files » `\n",
+ "name": "sticker",
+ "required": true
+ },
+ {
+ "type": "Array of String",
+ "description": "List of 1-20 emoji associated with the sticker",
+ "html_description": "List of 1-20 emoji associated with the sticker | ",
+ "rst_description": "List of 1-20 emoji associated with the sticker\n",
+ "name": "emoji_list",
+ "required": true
+ },
+ {
+ "type": "MaskPosition",
+ "description": "Position where the mask should be placed on faces. For 'mask' stickers only.",
+ "html_description": "Optional. Position where the mask should be placed on faces. For “mask” stickers only. | ",
+ "rst_description": "*Optional*. Position where the mask should be placed on faces. For 'mask' stickers only.\n",
+ "name": "mask_position",
+ "required": false
+ },
+ {
+ "type": "Array of String",
+ "description": "List of 0-20 search keywords for the sticker with total length of up to 64 characters. For 'regular' and 'custom_emoji' stickers only.",
+ "html_description": "Optional. List of 0-20 search keywords for the sticker with total length of up to 64 characters. For “regular” and “custom_emoji” stickers only. | ",
+ "rst_description": "*Optional*. List of 0-20 search keywords for the sticker with total length of up to 64 characters. For 'regular' and 'custom_emoji' stickers only.\n",
+ "name": "keywords",
+ "required": false
+ }
+ ],
+ "category": "types"
+ }
+}
diff --git a/.butcher/types/InputTextMessageContent/entity.json b/.butcher/types/InputTextMessageContent/entity.json
index 88f794f8..bc4b79d2 100644
--- a/.butcher/types/InputTextMessageContent/entity.json
+++ b/.butcher/types/InputTextMessageContent/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
diff --git a/.butcher/types/InputTextMessageContent/replace.yml b/.butcher/types/InputTextMessageContent/replace.yml
index c79933d0..63741e83 100644
--- a/.butcher/types/InputTextMessageContent/replace.yml
+++ b/.butcher/types/InputTextMessageContent/replace.yml
@@ -3,4 +3,6 @@ bases:
annotations:
parse_mode:
- value: UNSET
+ value: UNSET_PARSE_MODE
+ disable_web_page_preview:
+ value: UNSET_DISABLE_WEB_PAGE_PREVIEW
diff --git a/.butcher/types/InputVenueMessageContent/entity.json b/.butcher/types/InputVenueMessageContent/entity.json
index 34bd84aa..7c9b81a6 100644
--- a/.butcher/types/InputVenueMessageContent/entity.json
+++ b/.butcher/types/InputVenueMessageContent/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
diff --git a/.butcher/types/Invoice/entity.json b/.butcher/types/Invoice/entity.json
index 5cbd0f37..2ae83aa4 100644
--- a/.butcher/types/Invoice/entity.json
+++ b/.butcher/types/Invoice/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Payments",
"anchor": "payments"
diff --git a/.butcher/types/KeyboardButton/entity.json b/.butcher/types/KeyboardButton/entity.json
index 2ecfaca1..2a75141c 100644
--- a/.butcher/types/KeyboardButton/entity.json
+++ b/.butcher/types/KeyboardButton/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
@@ -9,9 +7,9 @@
"object": {
"anchor": "keyboardbutton",
"name": "KeyboardButton",
- "description": "This object represents one button of the reply keyboard. For simple text buttons String can be used instead of this object to specify text of the button. Optional fields web_app, request_contact, request_location, and request_poll are mutually exclusive.\nNote: request_contact and request_location options will only work in Telegram versions released after 9 April, 2016. Older clients will display unsupported message.\nNote: request_poll option will only work in Telegram versions released after 23 January, 2020. Older clients will display unsupported message.\nNote: web_app option will only work in Telegram versions released after 16 April, 2022. Older clients will display unsupported message.",
- "html_description": "This object represents one button of the reply keyboard. For simple text buttons String can be used instead of this object to specify text of the button. Optional fields web_app, request_contact, request_location, and request_poll are mutually exclusive.
Note: request_contact and request_location options will only work in Telegram versions released after 9 April, 2016. Older clients will display unsupported message.
\nNote: request_poll option will only work in Telegram versions released after 23 January, 2020. Older clients will display unsupported message.
\nNote: web_app option will only work in Telegram versions released after 16 April, 2022. Older clients will display unsupported message.
",
- "rst_description": "This object represents one button of the reply keyboard. For simple text buttons *String* can be used instead of this object to specify text of the button. Optional fields *web_app*, *request_contact*, *request_location*, and *request_poll* are mutually exclusive.\n**Note:** *request_contact* and *request_location* options will only work in Telegram versions released after 9 April, 2016. Older clients will display *unsupported message*.\n\n**Note:** *request_poll* option will only work in Telegram versions released after 23 January, 2020. Older clients will display *unsupported message*.\n\n**Note:** *web_app* option will only work in Telegram versions released after 16 April, 2022. Older clients will display *unsupported message*.",
+ "description": "This object represents one button of the reply keyboard. For simple text buttons, String can be used instead of this object to specify the button text. The optional fields web_app, request_user, request_chat, request_contact, request_location, and request_poll are mutually exclusive.\nNote: request_contact and request_location options will only work in Telegram versions released after 9 April, 2016. Older clients will display unsupported message.\nNote: request_poll option will only work in Telegram versions released after 23 January, 2020. Older clients will display unsupported message.\nNote: web_app option will only work in Telegram versions released after 16 April, 2022. Older clients will display unsupported message.\nNote: request_user and request_chat options will only work in Telegram versions released after 3 February, 2023. Older clients will display unsupported message.",
+ "html_description": "This object represents one button of the reply keyboard. For simple text buttons, String can be used instead of this object to specify the button text. The optional fields web_app, request_user, request_chat, request_contact, request_location, and request_poll are mutually exclusive.
Note: request_contact and request_location options will only work in Telegram versions released after 9 April, 2016. Older clients will display unsupported message.
\nNote: request_poll option will only work in Telegram versions released after 23 January, 2020. Older clients will display unsupported message.
\nNote: web_app option will only work in Telegram versions released after 16 April, 2022. Older clients will display unsupported message.
\nNote: request_user and request_chat options will only work in Telegram versions released after 3 February, 2023. Older clients will display unsupported message.
",
+ "rst_description": "This object represents one button of the reply keyboard. For simple text buttons, *String* can be used instead of this object to specify the button text. The optional fields *web_app*, *request_user*, *request_chat*, *request_contact*, *request_location*, and *request_poll* are mutually exclusive.\n**Note:** *request_contact* and *request_location* options will only work in Telegram versions released after 9 April, 2016. Older clients will display *unsupported message*.\n\n**Note:** *request_poll* option will only work in Telegram versions released after 23 January, 2020. Older clients will display *unsupported message*.\n\n**Note:** *web_app* option will only work in Telegram versions released after 16 April, 2022. Older clients will display *unsupported message*.\n\n**Note:** *request_user* and *request_chat* options will only work in Telegram versions released after 3 February, 2023. Older clients will display *unsupported message*.",
"annotations": [
{
"type": "String",
@@ -21,6 +19,22 @@
"name": "text",
"required": true
},
+ {
+ "type": "KeyboardButtonRequestUser",
+ "description": "If specified, pressing the button will open a list of suitable users. Tapping on any user will send their identifier to the bot in a 'user_shared' service message. Available in private chats only.",
+ "html_description": "Optional. If specified, pressing the button will open a list of suitable users. Tapping on any user will send their identifier to the bot in a “user_shared” service message. Available in private chats only. | ",
+ "rst_description": "*Optional.* If specified, pressing the button will open a list of suitable users. Tapping on any user will send their identifier to the bot in a 'user_shared' service message. Available in private chats only.\n",
+ "name": "request_user",
+ "required": false
+ },
+ {
+ "type": "KeyboardButtonRequestChat",
+ "description": "If specified, pressing the button will open a list of suitable chats. Tapping on a chat will send its identifier to the bot in a 'chat_shared' service message. Available in private chats only.",
+ "html_description": "Optional. If specified, pressing the button will open a list of suitable chats. Tapping on a chat will send its identifier to the bot in a “chat_shared” service message. Available in private chats only. | ",
+ "rst_description": "*Optional.* If specified, pressing the button will open a list of suitable chats. Tapping on a chat will send its identifier to the bot in a 'chat_shared' service message. Available in private chats only.\n",
+ "name": "request_chat",
+ "required": false
+ },
{
"type": "Boolean",
"description": "If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only.",
diff --git a/.butcher/types/KeyboardButtonPollType/entity.json b/.butcher/types/KeyboardButtonPollType/entity.json
index 3c1f026e..2681d80b 100644
--- a/.butcher/types/KeyboardButtonPollType/entity.json
+++ b/.butcher/types/KeyboardButtonPollType/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/KeyboardButtonRequestChat/entity.json b/.butcher/types/KeyboardButtonRequestChat/entity.json
new file mode 100644
index 00000000..616025e4
--- /dev/null
+++ b/.butcher/types/KeyboardButtonRequestChat/entity.json
@@ -0,0 +1,81 @@
+{
+ "meta": {},
+ "group": {
+ "title": "Available types",
+ "anchor": "available-types"
+ },
+ "object": {
+ "anchor": "keyboardbuttonrequestchat",
+ "name": "KeyboardButtonRequestChat",
+ "description": "This object defines the criteria used to request a suitable chat. The identifier of the selected chat will be shared with the bot when the corresponding button is pressed.",
+ "html_description": "This object defines the criteria used to request a suitable chat. The identifier of the selected chat will be shared with the bot when the corresponding button is pressed.
",
+ "rst_description": "This object defines the criteria used to request a suitable chat. The identifier of the selected chat will be shared with the bot when the corresponding button is pressed.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "description": "Signed 32-bit identifier of the request, which will be received back in the ChatShared object. Must be unique within the message",
+ "html_description": "Signed 32-bit identifier of the request, which will be received back in the ChatShared object. Must be unique within the message | ",
+ "rst_description": "Signed 32-bit identifier of the request, which will be received back in the :class:`aiogram.types.chat_shared.ChatShared` object. Must be unique within the message\n",
+ "name": "request_id",
+ "required": true
+ },
+ {
+ "type": "Boolean",
+ "description": "Pass True to request a channel chat, pass False to request a group or a supergroup chat.",
+ "html_description": "Pass True to request a channel chat, pass False to request a group or a supergroup chat. | ",
+ "rst_description": "Pass :code:`True` to request a channel chat, pass :code:`False` to request a group or a supergroup chat.\n",
+ "name": "chat_is_channel",
+ "required": true
+ },
+ {
+ "type": "Boolean",
+ "description": "Pass True to request a forum supergroup, pass False to request a non-forum chat. If not specified, no additional restrictions are applied.",
+ "html_description": "Optional. Pass True to request a forum supergroup, pass False to request a non-forum chat. If not specified, no additional restrictions are applied. | ",
+ "rst_description": "*Optional*. Pass :code:`True` to request a forum supergroup, pass :code:`False` to request a non-forum chat. If not specified, no additional restrictions are applied.\n",
+ "name": "chat_is_forum",
+ "required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "Pass True to request a supergroup or a channel with a username, pass False to request a chat without a username. If not specified, no additional restrictions are applied.",
+ "html_description": "Optional. Pass True to request a supergroup or a channel with a username, pass False to request a chat without a username. If not specified, no additional restrictions are applied. | ",
+ "rst_description": "*Optional*. Pass :code:`True` to request a supergroup or a channel with a username, pass :code:`False` to request a chat without a username. If not specified, no additional restrictions are applied.\n",
+ "name": "chat_has_username",
+ "required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "Pass True to request a chat owned by the user. Otherwise, no additional restrictions are applied.",
+ "html_description": "Optional. Pass True to request a chat owned by the user. Otherwise, no additional restrictions are applied. | ",
+ "rst_description": "*Optional*. Pass :code:`True` to request a chat owned by the user. Otherwise, no additional restrictions are applied.\n",
+ "name": "chat_is_created",
+ "required": false
+ },
+ {
+ "type": "ChatAdministratorRights",
+ "description": "A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of bot_administrator_rights. If not specified, no additional restrictions are applied.",
+ "html_description": "Optional. A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of bot_administrator_rights. If not specified, no additional restrictions are applied. | ",
+ "rst_description": "*Optional*. A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of *bot_administrator_rights*. If not specified, no additional restrictions are applied.\n",
+ "name": "user_administrator_rights",
+ "required": false
+ },
+ {
+ "type": "ChatAdministratorRights",
+ "description": "A JSON-serialized object listing the required administrator rights of the bot in the chat. The rights must be a subset of user_administrator_rights. If not specified, no additional restrictions are applied.",
+ "html_description": "Optional. A JSON-serialized object listing the required administrator rights of the bot in the chat. The rights must be a subset of user_administrator_rights. If not specified, no additional restrictions are applied. | ",
+ "rst_description": "*Optional*. A JSON-serialized object listing the required administrator rights of the bot in the chat. The rights must be a subset of *user_administrator_rights*. If not specified, no additional restrictions are applied.\n",
+ "name": "bot_administrator_rights",
+ "required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "Pass True to request a chat with the bot as a member. Otherwise, no additional restrictions are applied.",
+ "html_description": "Optional. Pass True to request a chat with the bot as a member. Otherwise, no additional restrictions are applied. | ",
+ "rst_description": "*Optional*. Pass :code:`True` to request a chat with the bot as a member. Otherwise, no additional restrictions are applied.\n",
+ "name": "bot_is_member",
+ "required": false
+ }
+ ],
+ "category": "types"
+ }
+}
diff --git a/.butcher/types/KeyboardButtonRequestUser/entity.json b/.butcher/types/KeyboardButtonRequestUser/entity.json
new file mode 100644
index 00000000..46f792aa
--- /dev/null
+++ b/.butcher/types/KeyboardButtonRequestUser/entity.json
@@ -0,0 +1,41 @@
+{
+ "meta": {},
+ "group": {
+ "title": "Available types",
+ "anchor": "available-types"
+ },
+ "object": {
+ "anchor": "keyboardbuttonrequestuser",
+ "name": "KeyboardButtonRequestUser",
+ "description": "This object defines the criteria used to request a suitable user. The identifier of the selected user will be shared with the bot when the corresponding button is pressed.",
+ "html_description": "This object defines the criteria used to request a suitable user. The identifier of the selected user will be shared with the bot when the corresponding button is pressed.
",
+ "rst_description": "This object defines the criteria used to request a suitable user. The identifier of the selected user will be shared with the bot when the corresponding button is pressed.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "description": "Signed 32-bit identifier of the request, which will be received back in the UserShared object. Must be unique within the message",
+ "html_description": "Signed 32-bit identifier of the request, which will be received back in the UserShared object. Must be unique within the message | ",
+ "rst_description": "Signed 32-bit identifier of the request, which will be received back in the :class:`aiogram.types.user_shared.UserShared` object. Must be unique within the message\n",
+ "name": "request_id",
+ "required": true
+ },
+ {
+ "type": "Boolean",
+ "description": "Pass True to request a bot, pass False to request a regular user. If not specified, no additional restrictions are applied.",
+ "html_description": "Optional. Pass True to request a bot, pass False to request a regular user. If not specified, no additional restrictions are applied. | ",
+ "rst_description": "*Optional*. Pass :code:`True` to request a bot, pass :code:`False` to request a regular user. If not specified, no additional restrictions are applied.\n",
+ "name": "user_is_bot",
+ "required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "Pass True to request a premium user, pass False to request a non-premium user. If not specified, no additional restrictions are applied.",
+ "html_description": "Optional. Pass True to request a premium user, pass False to request a non-premium user. If not specified, no additional restrictions are applied. | ",
+ "rst_description": "*Optional*. Pass :code:`True` to request a premium user, pass :code:`False` to request a non-premium user. If not specified, no additional restrictions are applied.\n",
+ "name": "user_is_premium",
+ "required": false
+ }
+ ],
+ "category": "types"
+ }
+}
diff --git a/.butcher/types/LabeledPrice/entity.json b/.butcher/types/LabeledPrice/entity.json
index 38963855..97dad650 100644
--- a/.butcher/types/LabeledPrice/entity.json
+++ b/.butcher/types/LabeledPrice/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Payments",
"anchor": "payments"
diff --git a/.butcher/types/Location/entity.json b/.butcher/types/Location/entity.json
index 5ae27da8..c6b36c45 100644
--- a/.butcher/types/Location/entity.json
+++ b/.butcher/types/Location/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/LoginUrl/entity.json b/.butcher/types/LoginUrl/entity.json
index 1085f9c4..7748fe56 100644
--- a/.butcher/types/LoginUrl/entity.json
+++ b/.butcher/types/LoginUrl/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/MaskPosition/entity.json b/.butcher/types/MaskPosition/entity.json
index 24a015d5..98f0c7b7 100644
--- a/.butcher/types/MaskPosition/entity.json
+++ b/.butcher/types/MaskPosition/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Stickers",
"anchor": "stickers"
diff --git a/.butcher/types/MenuButton/entity.json b/.butcher/types/MenuButton/entity.json
index deb0a185..224a5dac 100644
--- a/.butcher/types/MenuButton/entity.json
+++ b/.butcher/types/MenuButton/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/MenuButtonCommands/entity.json b/.butcher/types/MenuButtonCommands/entity.json
index 5ea1805c..25f67474 100644
--- a/.butcher/types/MenuButtonCommands/entity.json
+++ b/.butcher/types/MenuButtonCommands/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/MenuButtonDefault/entity.json b/.butcher/types/MenuButtonDefault/entity.json
index 2760f7b8..ce7f22af 100644
--- a/.butcher/types/MenuButtonDefault/entity.json
+++ b/.butcher/types/MenuButtonDefault/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/MenuButtonWebApp/entity.json b/.butcher/types/MenuButtonWebApp/entity.json
index 63311034..6f763e9e 100644
--- a/.butcher/types/MenuButtonWebApp/entity.json
+++ b/.butcher/types/MenuButtonWebApp/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/Message/entity.json b/.butcher/types/Message/entity.json
index 8ebf773a..cd5e27cb 100644
--- a/.butcher/types/Message/entity.json
+++ b/.butcher/types/Message/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
@@ -269,6 +267,14 @@
"name": "caption_entities",
"required": false
},
+ {
+ "type": "True",
+ "description": "True, if the message media is covered by a spoiler animation",
+ "html_description": "Optional. True, if the message media is covered by a spoiler animation | ",
+ "rst_description": "*Optional*. :code:`True`, if the message media is covered by a spoiler animation\n",
+ "name": "has_media_spoiler",
+ "required": false
+ },
{
"type": "Contact",
"description": "Message is a shared contact, information about the contact",
@@ -429,6 +435,22 @@
"name": "successful_payment",
"required": false
},
+ {
+ "type": "UserShared",
+ "description": "Service message: a user was shared with the bot",
+ "html_description": "Optional. Service message: a user was shared with the bot | ",
+ "rst_description": "*Optional*. Service message: a user was shared with the bot\n",
+ "name": "user_shared",
+ "required": false
+ },
+ {
+ "type": "ChatShared",
+ "description": "Service message: a chat was shared with the bot",
+ "html_description": "Optional. Service message: a chat was shared with the bot | ",
+ "rst_description": "*Optional*. Service message: a chat was shared with the bot\n",
+ "name": "chat_shared",
+ "required": false
+ },
{
"type": "String",
"description": "The domain name of the website on which the user has logged in.",
@@ -437,6 +459,14 @@
"name": "connected_website",
"required": false
},
+ {
+ "type": "WriteAccessAllowed",
+ "description": "Service message: the user allowed the bot added to the attachment menu to write messages",
+ "html_description": "Optional. Service message: the user allowed the bot added to the attachment menu to write messages | ",
+ "rst_description": "*Optional*. Service message: the user allowed the bot added to the attachment menu to write messages\n",
+ "name": "write_access_allowed",
+ "required": false
+ },
{
"type": "PassportData",
"description": "Telegram Passport data",
@@ -461,6 +491,14 @@
"name": "forum_topic_created",
"required": false
},
+ {
+ "type": "ForumTopicEdited",
+ "description": "Service message: forum topic edited",
+ "html_description": "Optional. Service message: forum topic edited | ",
+ "rst_description": "*Optional*. Service message: forum topic edited\n",
+ "name": "forum_topic_edited",
+ "required": false
+ },
{
"type": "ForumTopicClosed",
"description": "Service message: forum topic closed",
@@ -477,6 +515,22 @@
"name": "forum_topic_reopened",
"required": false
},
+ {
+ "type": "GeneralForumTopicHidden",
+ "description": "Service message: the 'General' forum topic hidden",
+ "html_description": "Optional. Service message: the 'General' forum topic hidden | ",
+ "rst_description": "*Optional*. Service message: the 'General' forum topic hidden\n",
+ "name": "general_forum_topic_hidden",
+ "required": false
+ },
+ {
+ "type": "GeneralForumTopicUnhidden",
+ "description": "Service message: the 'General' forum topic unhidden",
+ "html_description": "Optional. Service message: the 'General' forum topic unhidden | ",
+ "rst_description": "*Optional*. Service message: the 'General' forum topic unhidden\n",
+ "name": "general_forum_topic_unhidden",
+ "required": false
+ },
{
"type": "VideoChatScheduled",
"description": "Service message: video chat scheduled",
diff --git a/.butcher/types/MessageAutoDeleteTimerChanged/entity.json b/.butcher/types/MessageAutoDeleteTimerChanged/entity.json
index 5778e75a..3c6bc533 100644
--- a/.butcher/types/MessageAutoDeleteTimerChanged/entity.json
+++ b/.butcher/types/MessageAutoDeleteTimerChanged/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/MessageEntity/entity.json b/.butcher/types/MessageEntity/entity.json
index fa01ab48..663f8957 100644
--- a/.butcher/types/MessageEntity/entity.json
+++ b/.butcher/types/MessageEntity/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/MessageId/entity.json b/.butcher/types/MessageId/entity.json
index 86e988bc..69fce170 100644
--- a/.butcher/types/MessageId/entity.json
+++ b/.butcher/types/MessageId/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/OrderInfo/entity.json b/.butcher/types/OrderInfo/entity.json
index 868ed681..42c6296b 100644
--- a/.butcher/types/OrderInfo/entity.json
+++ b/.butcher/types/OrderInfo/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Payments",
"anchor": "payments"
diff --git a/.butcher/types/PassportData/entity.json b/.butcher/types/PassportData/entity.json
index c00b6b06..2c01dc79 100644
--- a/.butcher/types/PassportData/entity.json
+++ b/.butcher/types/PassportData/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Telegram Passport",
"anchor": "telegram-passport"
diff --git a/.butcher/types/PassportElementError/entity.json b/.butcher/types/PassportElementError/entity.json
index 2a2403e0..3451e40c 100644
--- a/.butcher/types/PassportElementError/entity.json
+++ b/.butcher/types/PassportElementError/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Telegram Passport",
"anchor": "telegram-passport"
diff --git a/.butcher/types/PassportElementErrorDataField/entity.json b/.butcher/types/PassportElementErrorDataField/entity.json
index 9eb32a87..1db574d9 100644
--- a/.butcher/types/PassportElementErrorDataField/entity.json
+++ b/.butcher/types/PassportElementErrorDataField/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Telegram Passport",
"anchor": "telegram-passport"
diff --git a/.butcher/types/PassportElementErrorFile/entity.json b/.butcher/types/PassportElementErrorFile/entity.json
index 71c1c10d..61e45072 100644
--- a/.butcher/types/PassportElementErrorFile/entity.json
+++ b/.butcher/types/PassportElementErrorFile/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Telegram Passport",
"anchor": "telegram-passport"
diff --git a/.butcher/types/PassportElementErrorFiles/entity.json b/.butcher/types/PassportElementErrorFiles/entity.json
index 61fb2ab9..33856a8b 100644
--- a/.butcher/types/PassportElementErrorFiles/entity.json
+++ b/.butcher/types/PassportElementErrorFiles/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Telegram Passport",
"anchor": "telegram-passport"
diff --git a/.butcher/types/PassportElementErrorFrontSide/entity.json b/.butcher/types/PassportElementErrorFrontSide/entity.json
index c9bf175c..6b3d4bae 100644
--- a/.butcher/types/PassportElementErrorFrontSide/entity.json
+++ b/.butcher/types/PassportElementErrorFrontSide/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Telegram Passport",
"anchor": "telegram-passport"
diff --git a/.butcher/types/PassportElementErrorReverseSide/entity.json b/.butcher/types/PassportElementErrorReverseSide/entity.json
index 8d659b16..804ab05c 100644
--- a/.butcher/types/PassportElementErrorReverseSide/entity.json
+++ b/.butcher/types/PassportElementErrorReverseSide/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Telegram Passport",
"anchor": "telegram-passport"
diff --git a/.butcher/types/PassportElementErrorSelfie/entity.json b/.butcher/types/PassportElementErrorSelfie/entity.json
index f79db407..fa8dc591 100644
--- a/.butcher/types/PassportElementErrorSelfie/entity.json
+++ b/.butcher/types/PassportElementErrorSelfie/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Telegram Passport",
"anchor": "telegram-passport"
diff --git a/.butcher/types/PassportElementErrorTranslationFile/entity.json b/.butcher/types/PassportElementErrorTranslationFile/entity.json
index 0b81d6fb..0253dfdd 100644
--- a/.butcher/types/PassportElementErrorTranslationFile/entity.json
+++ b/.butcher/types/PassportElementErrorTranslationFile/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Telegram Passport",
"anchor": "telegram-passport"
diff --git a/.butcher/types/PassportElementErrorTranslationFiles/entity.json b/.butcher/types/PassportElementErrorTranslationFiles/entity.json
index 15bd0a96..98ddf11d 100644
--- a/.butcher/types/PassportElementErrorTranslationFiles/entity.json
+++ b/.butcher/types/PassportElementErrorTranslationFiles/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Telegram Passport",
"anchor": "telegram-passport"
diff --git a/.butcher/types/PassportElementErrorUnspecified/entity.json b/.butcher/types/PassportElementErrorUnspecified/entity.json
index f1a3c4d3..1116a924 100644
--- a/.butcher/types/PassportElementErrorUnspecified/entity.json
+++ b/.butcher/types/PassportElementErrorUnspecified/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Telegram Passport",
"anchor": "telegram-passport"
diff --git a/.butcher/types/PassportFile/entity.json b/.butcher/types/PassportFile/entity.json
index 7c10c6cc..20b7f9c2 100644
--- a/.butcher/types/PassportFile/entity.json
+++ b/.butcher/types/PassportFile/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Telegram Passport",
"anchor": "telegram-passport"
diff --git a/.butcher/types/PhotoSize/entity.json b/.butcher/types/PhotoSize/entity.json
index 67882df0..5bf50009 100644
--- a/.butcher/types/PhotoSize/entity.json
+++ b/.butcher/types/PhotoSize/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/Poll/entity.json b/.butcher/types/Poll/entity.json
index 131e96ea..dcf1bf7c 100644
--- a/.butcher/types/Poll/entity.json
+++ b/.butcher/types/Poll/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/PollAnswer/entity.json b/.butcher/types/PollAnswer/entity.json
index 323577b6..9081b30c 100644
--- a/.butcher/types/PollAnswer/entity.json
+++ b/.butcher/types/PollAnswer/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/PollOption/entity.json b/.butcher/types/PollOption/entity.json
index dfef5817..0b06084a 100644
--- a/.butcher/types/PollOption/entity.json
+++ b/.butcher/types/PollOption/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/PreCheckoutQuery/entity.json b/.butcher/types/PreCheckoutQuery/entity.json
index 349e8172..5fb05a1c 100644
--- a/.butcher/types/PreCheckoutQuery/entity.json
+++ b/.butcher/types/PreCheckoutQuery/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Payments",
"anchor": "payments"
diff --git a/.butcher/types/ProximityAlertTriggered/entity.json b/.butcher/types/ProximityAlertTriggered/entity.json
index d8dc1750..ede85d2b 100644
--- a/.butcher/types/ProximityAlertTriggered/entity.json
+++ b/.butcher/types/ProximityAlertTriggered/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/ReplyKeyboardMarkup/entity.json b/.butcher/types/ReplyKeyboardMarkup/entity.json
index 1ae025ff..d74d741d 100644
--- a/.butcher/types/ReplyKeyboardMarkup/entity.json
+++ b/.butcher/types/ReplyKeyboardMarkup/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
@@ -21,6 +19,14 @@
"name": "keyboard",
"required": true
},
+ {
+ "type": "Boolean",
+ "description": "Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon.",
+ "html_description": "Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon. | ",
+ "rst_description": "*Optional*. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to *false*, in which case the custom keyboard can be hidden and opened with a keyboard icon.\n",
+ "name": "is_persistent",
+ "required": false
+ },
{
"type": "Boolean",
"description": "Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard.",
diff --git a/.butcher/types/ReplyKeyboardRemove/entity.json b/.butcher/types/ReplyKeyboardRemove/entity.json
index 5ca28ce0..57e119d7 100644
--- a/.butcher/types/ReplyKeyboardRemove/entity.json
+++ b/.butcher/types/ReplyKeyboardRemove/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/ResponseParameters/entity.json b/.butcher/types/ResponseParameters/entity.json
index 3166f89d..02abbbad 100644
--- a/.butcher/types/ResponseParameters/entity.json
+++ b/.butcher/types/ResponseParameters/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/SentWebAppMessage/entity.json b/.butcher/types/SentWebAppMessage/entity.json
index 4fbf67d3..a70568af 100644
--- a/.butcher/types/SentWebAppMessage/entity.json
+++ b/.butcher/types/SentWebAppMessage/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
diff --git a/.butcher/types/ShippingAddress/entity.json b/.butcher/types/ShippingAddress/entity.json
index 310cc037..771d2fe1 100644
--- a/.butcher/types/ShippingAddress/entity.json
+++ b/.butcher/types/ShippingAddress/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Payments",
"anchor": "payments"
diff --git a/.butcher/types/ShippingOption/entity.json b/.butcher/types/ShippingOption/entity.json
index 37bc6f18..5288408c 100644
--- a/.butcher/types/ShippingOption/entity.json
+++ b/.butcher/types/ShippingOption/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Payments",
"anchor": "payments"
diff --git a/.butcher/types/ShippingQuery/entity.json b/.butcher/types/ShippingQuery/entity.json
index d0c2d11d..607f7e57 100644
--- a/.butcher/types/ShippingQuery/entity.json
+++ b/.butcher/types/ShippingQuery/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Payments",
"anchor": "payments"
diff --git a/.butcher/types/Sticker/entity.json b/.butcher/types/Sticker/entity.json
index 8d0f1d88..702f84e5 100644
--- a/.butcher/types/Sticker/entity.json
+++ b/.butcher/types/Sticker/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Stickers",
"anchor": "stickers"
@@ -74,7 +72,7 @@
"description": "Sticker thumbnail in the .WEBP or .JPG format",
"html_description": "Optional. Sticker thumbnail in the .WEBP or .JPG format | ",
"rst_description": "*Optional*. Sticker thumbnail in the .WEBP or .JPG format\n",
- "name": "thumb",
+ "name": "thumbnail",
"required": false
},
{
@@ -117,6 +115,14 @@
"name": "custom_emoji_id",
"required": false
},
+ {
+ "type": "True",
+ "description": "True, if the sticker must be repainted to a text color in messages, the color of the Telegram Premium badge in emoji status, white color on chat photos, or another appropriate color in other places",
+ "html_description": "Optional. True, if the sticker must be repainted to a text color in messages, the color of the Telegram Premium badge in emoji status, white color on chat photos, or another appropriate color in other places | ",
+ "rst_description": "*Optional*. :code:`True`, if the sticker must be repainted to a text color in messages, the color of the Telegram Premium badge in emoji status, white color on chat photos, or another appropriate color in other places\n",
+ "name": "needs_repainting",
+ "required": false
+ },
{
"type": "Integer",
"description": "File size in bytes",
diff --git a/.butcher/types/StickerSet/entity.json b/.butcher/types/StickerSet/entity.json
index 4e370e93..d74eb635 100644
--- a/.butcher/types/StickerSet/entity.json
+++ b/.butcher/types/StickerSet/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Stickers",
"anchor": "stickers"
@@ -66,7 +64,7 @@
"description": "Sticker set thumbnail in the .WEBP, .TGS, or .WEBM format",
"html_description": "Optional. Sticker set thumbnail in the .WEBP, .TGS, or .WEBM format | ",
"rst_description": "*Optional*. Sticker set thumbnail in the .WEBP, .TGS, or .WEBM format\n",
- "name": "thumb",
+ "name": "thumbnail",
"required": false
}
],
diff --git a/.butcher/types/SuccessfulPayment/entity.json b/.butcher/types/SuccessfulPayment/entity.json
index 2d9fe818..bbe8b21c 100644
--- a/.butcher/types/SuccessfulPayment/entity.json
+++ b/.butcher/types/SuccessfulPayment/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Payments",
"anchor": "payments"
diff --git a/.butcher/types/Update/entity.json b/.butcher/types/Update/entity.json
index 32c7d35d..1ee46f08 100644
--- a/.butcher/types/Update/entity.json
+++ b/.butcher/types/Update/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Getting updates",
"anchor": "getting-updates"
diff --git a/.butcher/types/User/entity.json b/.butcher/types/User/entity.json
index 3b08c07e..a753bb16 100644
--- a/.butcher/types/User/entity.json
+++ b/.butcher/types/User/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/UserProfilePhotos/entity.json b/.butcher/types/UserProfilePhotos/entity.json
index 4b09b777..d6406d9e 100644
--- a/.butcher/types/UserProfilePhotos/entity.json
+++ b/.butcher/types/UserProfilePhotos/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/UserShared/entity.json b/.butcher/types/UserShared/entity.json
new file mode 100644
index 00000000..1e7f0044
--- /dev/null
+++ b/.butcher/types/UserShared/entity.json
@@ -0,0 +1,33 @@
+{
+ "meta": {},
+ "group": {
+ "title": "Available types",
+ "anchor": "available-types"
+ },
+ "object": {
+ "anchor": "usershared",
+ "name": "UserShared",
+ "description": "This object contains information about the user whose identifier was shared with the bot using a KeyboardButtonRequestUser button.",
+ "html_description": "This object contains information about the user whose identifier was shared with the bot using a KeyboardButtonRequestUser button.
",
+ "rst_description": "This object contains information about the user whose identifier was shared with the bot using a :class:`aiogram.types.keyboard_button_request_user.KeyboardButtonRequestUser` button.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "description": "Identifier of the request",
+ "html_description": "Identifier of the request | ",
+ "rst_description": "Identifier of the request\n",
+ "name": "request_id",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "Identifier of the shared user. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot may not have access to the user and could be unable to use this identifier, unless the user is already known to the bot by some other means.",
+ "html_description": "Identifier of the shared user. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot may not have access to the user and could be unable to use this identifier, unless the user is already known to the bot by some other means. | ",
+ "rst_description": "Identifier of the shared user. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot may not have access to the user and could be unable to use this identifier, unless the user is already known to the bot by some other means.\n",
+ "name": "user_id",
+ "required": true
+ }
+ ],
+ "category": "types"
+ }
+}
diff --git a/.butcher/types/Venue/entity.json b/.butcher/types/Venue/entity.json
index 7ca5f295..3711d325 100644
--- a/.butcher/types/Venue/entity.json
+++ b/.butcher/types/Venue/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/Video/entity.json b/.butcher/types/Video/entity.json
index 65c5594f..b98f44ba 100644
--- a/.butcher/types/Video/entity.json
+++ b/.butcher/types/Video/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
@@ -58,7 +56,7 @@
"description": "Video thumbnail",
"html_description": "Optional. Video thumbnail | ",
"rst_description": "*Optional*. Video thumbnail\n",
- "name": "thumb",
+ "name": "thumbnail",
"required": false
},
{
diff --git a/.butcher/types/VideoChatEnded/entity.json b/.butcher/types/VideoChatEnded/entity.json
index 58d88893..bd3cf1e4 100644
--- a/.butcher/types/VideoChatEnded/entity.json
+++ b/.butcher/types/VideoChatEnded/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/VideoChatParticipantsInvited/entity.json b/.butcher/types/VideoChatParticipantsInvited/entity.json
index 27114659..d0758387 100644
--- a/.butcher/types/VideoChatParticipantsInvited/entity.json
+++ b/.butcher/types/VideoChatParticipantsInvited/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/VideoChatScheduled/entity.json b/.butcher/types/VideoChatScheduled/entity.json
index c67f3af4..37393d7b 100644
--- a/.butcher/types/VideoChatScheduled/entity.json
+++ b/.butcher/types/VideoChatScheduled/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/VideoChatStarted/entity.json b/.butcher/types/VideoChatStarted/entity.json
index 173e71e7..c870523f 100644
--- a/.butcher/types/VideoChatStarted/entity.json
+++ b/.butcher/types/VideoChatStarted/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/VideoNote/entity.json b/.butcher/types/VideoNote/entity.json
index 85dbf566..da99d65c 100644
--- a/.butcher/types/VideoNote/entity.json
+++ b/.butcher/types/VideoNote/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
@@ -50,7 +48,7 @@
"description": "Video thumbnail",
"html_description": "Optional. Video thumbnail | ",
"rst_description": "*Optional*. Video thumbnail\n",
- "name": "thumb",
+ "name": "thumbnail",
"required": false
},
{
diff --git a/.butcher/types/Voice/entity.json b/.butcher/types/Voice/entity.json
index 2be67726..f19f9536 100644
--- a/.butcher/types/Voice/entity.json
+++ b/.butcher/types/Voice/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/WebAppData/entity.json b/.butcher/types/WebAppData/entity.json
index a625d7ca..0a41a879 100644
--- a/.butcher/types/WebAppData/entity.json
+++ b/.butcher/types/WebAppData/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/WebAppInfo/entity.json b/.butcher/types/WebAppInfo/entity.json
index 3a2e882d..a0ec3c45 100644
--- a/.butcher/types/WebAppInfo/entity.json
+++ b/.butcher/types/WebAppInfo/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
diff --git a/.butcher/types/WebhookInfo/entity.json b/.butcher/types/WebhookInfo/entity.json
index 0fbe1ee4..62e578c0 100644
--- a/.butcher/types/WebhookInfo/entity.json
+++ b/.butcher/types/WebhookInfo/entity.json
@@ -1,7 +1,5 @@
{
- "meta": {
- "deprecated": false
- },
+ "meta": {},
"group": {
"title": "Getting updates",
"anchor": "getting-updates"
diff --git a/.butcher/types/WriteAccessAllowed/entity.json b/.butcher/types/WriteAccessAllowed/entity.json
new file mode 100644
index 00000000..2ddeba40
--- /dev/null
+++ b/.butcher/types/WriteAccessAllowed/entity.json
@@ -0,0 +1,16 @@
+{
+ "meta": {},
+ "group": {
+ "title": "Available types",
+ "anchor": "available-types"
+ },
+ "object": {
+ "anchor": "writeaccessallowed",
+ "name": "WriteAccessAllowed",
+ "description": "This object represents a service message about a user allowing a bot added to the attachment menu to write messages. Currently holds no information.",
+ "html_description": "This object represents a service message about a user allowing a bot added to the attachment menu to write messages. Currently holds no information.
",
+ "rst_description": "This object represents a service message about a user allowing a bot added to the attachment menu to write messages. Currently holds no information.",
+ "annotations": [],
+ "category": "types"
+ }
+}
diff --git a/.coveragerc b/.coveragerc
deleted file mode 100644
index e1862099..00000000
--- a/.coveragerc
+++ /dev/null
@@ -1,6 +0,0 @@
-[report]
-exclude_lines =
- pragma: no cover
- if TYPE_CHECKING:
- @abstractmethod
- @overload
diff --git a/.flake8 b/.flake8
deleted file mode 100644
index 9e19cd03..00000000
--- a/.flake8
+++ /dev/null
@@ -1,12 +0,0 @@
-[flake8]
-max-line-length = 99
-select = C,E,F,W,B,B950
-ignore = E501,W503,E203
-exclude =
- .git
- build
- dist
- venv
- docs
- *.egg-info
- experiment.py
diff --git a/.github/workflows/deploy.yml b/.github/workflows/pypi-release.yml
similarity index 65%
rename from .github/workflows/deploy.yml
rename to .github/workflows/pypi-release.yml
index ed978fae..1cfe82b1 100644
--- a/.github/workflows/deploy.yml
+++ b/.github/workflows/pypi-release.yml
@@ -1,4 +1,4 @@
-name: Deploy
+name: "Deploy"
on:
push:
@@ -17,16 +17,12 @@ jobs:
with:
python-version: "3.10"
- - name: Install and configure Poetry
- uses: snok/install-poetry@v1
- with:
- version: 1.2.1
- virtualenvs-create: false
- installer-parallel: true
+ - name: Install build dependencies
+ run: python -m pip install --upgrade build
+
+ - name: Build source distribution
+ run: python -m build .
- - name: Build
- run: |
- poetry build
- name: Try install wheel
run: |
pip install -U virtualenv
@@ -53,17 +49,17 @@ jobs:
name: dist
path: dist
-# - name: Publish a Python distribution to Test PyPI
-# uses: pypa/gh-action-pypi-publish@master
-## if: github.event.action != 'published'
-# with:
-# user: __token__
-# password: ${{ secrets.PYPI_TEST_TOKEN }}
-# repository_url: https://test.pypi.org/legacy/
+ # - name: Publish a Python distribution to Test PyPI
+ # uses: pypa/gh-action-pypi-publish@master
+ ## if: github.event.action != 'published'
+ # with:
+ # user: __token__
+ # password: ${{ secrets.PYPI_TEST_TOKEN }}
+ # repository_url: https://test.pypi.org/legacy/
- name: Publish a Python distribution to PyPI
uses: pypa/gh-action-pypi-publish@master
-# if: github.event.action == 'published'
+ # if: github.event.action == 'published'
with:
user: __token__
password: ${{ secrets.PYPI_TOKEN }}
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
index e94e89d3..e5e85147 100644
--- a/.github/workflows/tests.yml
+++ b/.github/workflows/tests.yml
@@ -8,11 +8,7 @@ on:
- ".github/workflows/tests.yml"
- "aiogram/**"
- "tests/**"
- - ".coveragerc"
- - ".flake8"
- "codecov.yaml"
- - "mypy.ini"
- - "poetry.lock"
- "pyproject.toml"
pull_request:
branches:
@@ -21,11 +17,6 @@ on:
- ".github/workflows/tests.yml"
- "aiogram/**"
- "tests/**"
- - ".coveragerc"
- - ".flake8"
- - "codecov.yaml"
- - "mypy.ini"
- - "poetry.lock"
- "pyproject.toml"
jobs:
@@ -67,30 +58,25 @@ jobs:
steps:
- name: Checkout code
- uses: actions/checkout@master
+ uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version }} on ${{ matrix.os }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
+ cache: "pip"
+ cache-dependency-path: pyproject.toml
- - name: Install and configure Poetry
- uses: snok/install-poetry@v1
- if: "env.IS_PYPY == 'false' || env.IS_WINDOWS == 'false'"
- with:
- version: 1.2.1
- virtualenvs-create: true
- virtualenvs-in-project: true
- installer-parallel: true
-
- - name: Install and configure Poetry (PyPy on Windows)
- if: "env.IS_PYPY == 'true' && env.IS_WINDOWS == 'true'"
+ - name: Install project dependencies
run: |
- set -eu
- pip install "poetry==1.2.1"
- poetry config virtualenvs.create true
- poetry config virtualenvs.in-project true
- poetry config installer.parallel true
+ pip install -e .[dev,test,redis,proxy,i18n,fast]
+
+ - name: Lint code
+ if: "env.IS_PYPY == 'false'"
+ run: |
+ ruff --format=github aiogram examples
+ mypy aiogram
+ black --check --diff aiogram tests
- name: Setup redis
if: ${{ env.IS_WINDOWS == 'false' }}
@@ -98,40 +84,19 @@ jobs:
with:
redis-version: 6
- - name: Load cached venv
- id: cached-poetry-dependencies
- uses: actions/cache@v2
- with:
- path: .venv
- key: venv-${{ matrix.os }}-${{ matrix.python-version }}-${{ hashFiles('**/poetry.lock') }}-${{ secrets.CACHE_VERSION }}
-
- - name: Install project dependencies
- if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
- run: |
- flags=""
- [[ "$IS_PYPY" == "false" ]] && flags="$flags -E fast"
- poetry install --no-interaction -E redis -E proxy -E i18n $flags
-
- - name: Lint code
- if: "env.IS_PYPY == 'false'"
- run: |
- poetry run flake8 aiogram
- poetry run mypy aiogram
- poetry run black --check --diff aiogram tests
-
- name: Run tests
run: |
flags=""
[[ "$IS_PYPY" == "false" ]] && flags="$flags --cov=aiogram --cov-config .coveragerc --cov-report=xml"
[[ "$IS_WINDOWS" == "false" ]] && flags="$flags --redis redis://localhost:6379/0"
- poetry run pytest $flags
+ pytest $flags
- name: Upload coverage data
if: "env.IS_PYPY == 'false'"
- uses: codecov/codecov-action@v1
+ uses: codecov/codecov-action@v3
with:
token: ${{ secrets.CODECOV_TOKEN }}
- file: coverage.xml
+ files: coverage.xml
flags: unittests
name: py-${{ matrix.python-version }}-${{ matrix.os }}
fail_ci_if_error: true
diff --git a/.gitignore b/.gitignore
index c26b2c10..d1dbf6d6 100644
--- a/.gitignore
+++ b/.gitignore
@@ -13,7 +13,7 @@ dist/
site/
*.egg-info/
*.egg
-aiogram/_meta.py
+.ruff_cache
.mypy_cache
.pytest_cache
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index ffe7b117..bf00554d 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -19,34 +19,8 @@ repos:
- id: black
files: &files '^(aiogram|tests|examples)'
- - repo: https://github.com/pre-commit/mirrors-isort
- rev: v5.10.1
+ - repo: https://github.com/charliermarsh/ruff-pre-commit
+ rev: 'v0.0.215'
hooks:
- - id: isort
- additional_dependencies: [ toml ]
- files: *files
-
- - repo: https://gitlab.com/pycqa/flake8
- rev: 3.9.2
- hooks:
- - id: flake8
- args: [ '--config=.flake8' ]
- files: *files
-
- - repo: https://github.com/floatingpurr/sync_with_poetry
- rev: 0.2.0
- hooks:
- - id: sync_with_poetry
-
- - repo: https://github.com/python-poetry/poetry
- rev: '1.2.1'
- hooks:
- - id: poetry-check
- - id: poetry-lock
- args: [ "--no-update" ]
- - id: poetry-export
- args: [ "-f", "requirements.txt", "--without-hashes", "-o", "requirements/base.txt" ]
- - id: poetry-export
- args: [ "-f", "requirements.txt", "--without-hashes", "-o", "requirements/docs.txt",
- "-E", "fast", "-E", "redis", "-E", "proxy", "-E", "i18n",
- "--with", "docs" ]
+ - id: ruff
+ args: [ "--force-exclude" ]
diff --git a/.readthedocs.yml b/.readthedocs.yml
index 8fbc4dc1..41b7a452 100644
--- a/.readthedocs.yml
+++ b/.readthedocs.yml
@@ -5,7 +5,9 @@ python:
install:
- method: pip
path: .
- - requirements: requirements/docs.txt
+ extra_requirements:
+ - docs
+ - redis
sphinx:
configuration: docs/conf.py
diff --git a/CHANGES.rst b/CHANGES.rst
index 86ad5552..afbb2d4a 100644
--- a/CHANGES.rst
+++ b/CHANGES.rst
@@ -16,6 +16,139 @@ Changelog
.. towncrier release notes start
+3.0.0b7 (2023-02-18)
+=====================
+
+.. warning::
+
+ Note that this version has incompatibility with Python 3.8-3.9 in case when you create an instance of Dispatcher outside of the any coroutine.
+
+ Sorry for the inconvenience, it will be fixed in the next version.
+
+ This code will not work:
+
+ .. code-block:: python
+
+ dp = Dispatcher()
+
+ def main():
+ ...
+ dp.run_polling(...)
+
+ main()
+
+ But if you change it like this it should works as well:
+
+ .. code-block:: python
+
+ router = Router()
+
+ async def main():
+ dp = Dispatcher()
+ dp.include_router(router)
+ ...
+ dp.start_polling(...)
+
+ asyncio.run(main())
+
+
+Features
+--------
+
+- Added missing shortcuts, new enums, reworked old stuff
+
+ **Breaking**
+ All previously added enums is re-generated in new place - `aiogram.enums` instead of `aiogram.types`
+
+ **Added enums:** :class:`aiogram.enums.bot_command_scope_type.BotCommandScopeType`,
+ :class:`aiogram.enums.chat_action.ChatAction`,
+ :class:`aiogram.enums.chat_member_status.ChatMemberStatus`,
+ :class:`aiogram.enums.chat_type.ChatType`,
+ :class:`aiogram.enums.content_type.ContentType`,
+ :class:`aiogram.enums.dice_emoji.DiceEmoji`,
+ :class:`aiogram.enums.inline_query_result_type.InlineQueryResultType`,
+ :class:`aiogram.enums.input_media_type.InputMediaType`,
+ :class:`aiogram.enums.mask_position_point.MaskPositionPoint`,
+ :class:`aiogram.enums.menu_button_type.MenuButtonType`,
+ :class:`aiogram.enums.message_entity_type.MessageEntityType`,
+ :class:`aiogram.enums.parse_mode.ParseMode`,
+ :class:`aiogram.enums.poll_type.PollType`,
+ :class:`aiogram.enums.sticker_type.StickerType`,
+ :class:`aiogram.enums.topic_icon_color.TopicIconColor`,
+ :class:`aiogram.enums.update_type.UpdateType`,
+
+ **Added shortcuts**:
+
+ - *Chat* :meth:`aiogram.types.chat.Chat.get_administrators`,
+ :meth:`aiogram.types.chat.Chat.delete_message`,
+ :meth:`aiogram.types.chat.Chat.revoke_invite_link`,
+ :meth:`aiogram.types.chat.Chat.edit_invite_link`,
+ :meth:`aiogram.types.chat.Chat.create_invite_link`,
+ :meth:`aiogram.types.chat.Chat.export_invite_link`,
+ :meth:`aiogram.types.chat.Chat.do`,
+ :meth:`aiogram.types.chat.Chat.delete_sticker_set`,
+ :meth:`aiogram.types.chat.Chat.set_sticker_set`,
+ :meth:`aiogram.types.chat.Chat.get_member`,
+ :meth:`aiogram.types.chat.Chat.get_member_count`,
+ :meth:`aiogram.types.chat.Chat.leave`,
+ :meth:`aiogram.types.chat.Chat.unpin_all_messages`,
+ :meth:`aiogram.types.chat.Chat.unpin_message`,
+ :meth:`aiogram.types.chat.Chat.pin_message`,
+ :meth:`aiogram.types.chat.Chat.set_administrator_custom_title`,
+ :meth:`aiogram.types.chat.Chat.set_permissions`,
+ :meth:`aiogram.types.chat.Chat.promote`,
+ :meth:`aiogram.types.chat.Chat.restrict`,
+ :meth:`aiogram.types.chat.Chat.unban`,
+ :meth:`aiogram.types.chat.Chat.ban`,
+ :meth:`aiogram.types.chat.Chat.set_description`,
+ :meth:`aiogram.types.chat.Chat.set_title`,
+ :meth:`aiogram.types.chat.Chat.delete_photo`,
+ :meth:`aiogram.types.chat.Chat.set_photo`,
+ - *Sticker*: :meth:`aiogram.types.sticker.Sticker.set_position_in_set`,
+ :meth:`aiogram.types.sticker.Sticker.delete_from_set`,
+ - *User*: :meth:`aiogram.types.user.User.get_profile_photos`
+ `#952 `_
+- Added :ref:`callback answer ` feature
+ `#1091 `_
+- Added a method that allows you to compactly register routers
+ `#1117 `_
+
+
+Bugfixes
+--------
+
+- Check status code when downloading file
+ `#816 `_
+- Fixed `ignore_case` parameter in :obj:`aiogram.filters.command.Command` filter
+ `#1106 `_
+
+
+Misc
+----
+
+- Added integration with new code-generator named `Butcher `_
+ `#1069 `_
+- Added full support of `Bot API 6.4 `_
+ `#1088 `_
+- Updated package metadata, moved build internals from Poetry to Hatch, added contributing guides.
+ `#1095 `_
+- Added full support of `Bot API 6.5 `_
+
+ .. danger::
+
+ Note that :obj:`aiogram.types.chat_permissions.ChatPermissions` is updated without
+ backward compatibility, so now this object has no :code:`can_send_media_messages` attribute
+ `#1112 `_
+- Replaced error :code:`TypeError: TelegramEventObserver.__call__() got an unexpected keyword argument ''`
+ with a more understandable one for developers and with a link to the documentation.
+ `#1114 `_
+- Added possibility to reply into webhook with files
+ `#1120 `_
+- Reworked graceful shutdown. Added method to stop polling.
+ Now polling started from dispatcher can be stopped by signals gracefully without errors (on Linux and Mac).
+ `#1124 `_
+
+
3.0.0b6 (2022-11-18)
=====================
diff --git a/CHANGES/1069.misc.rst b/CHANGES/1069.misc.rst
deleted file mode 100644
index a5a1730b..00000000
--- a/CHANGES/1069.misc.rst
+++ /dev/null
@@ -1 +0,0 @@
-Added integration with new code-generator named `Butcher `_
diff --git a/CHANGES/1133.doc.rst b/CHANGES/1133.doc.rst
new file mode 100644
index 00000000..a5ab681d
--- /dev/null
+++ b/CHANGES/1133.doc.rst
@@ -0,0 +1 @@
+Changed small grammar typos for `upload_file`
diff --git a/CHANGES/1139.misc.rst b/CHANGES/1139.misc.rst
new file mode 100644
index 00000000..432607e0
--- /dev/null
+++ b/CHANGES/1139.misc.rst
@@ -0,0 +1,7 @@
+Added full support of `Bot API 6.6 `_
+
+.. danger::
+
+ Note that this issue has breaking changes described in in the Bot API changelog,
+ this changes is not breaking in the API but breaking inside aiogram because
+ Beta stage is not finished.
diff --git a/CHANGES/1142.misc.rst b/CHANGES/1142.misc.rst
new file mode 100644
index 00000000..c17fb588
--- /dev/null
+++ b/CHANGES/1142.misc.rst
@@ -0,0 +1,2 @@
+Added global defaults `disable_web_page_preview` and `protect_content` in addition to `parse_mode` to the Bot instance,
+reworked internal request builder mechanism.
diff --git a/CHANGES/952.feature.rst b/CHANGES/952.feature.rst
deleted file mode 100644
index 86135dc8..00000000
--- a/CHANGES/952.feature.rst
+++ /dev/null
@@ -1,52 +0,0 @@
-Added missing shortcuts, new enums, reworked old stuff
-
-**Breaking**
-All previously added enums is re-generated in new place - `aiogram.enums` instead of `aiogram.types`
-
-**Added enums:** :class:`aiogram.enums.bot_command_scope_type.BotCommandScopeType`,
- :class:`aiogram.enums.chat_action.ChatActions`,
- :class:`aiogram.enums.chat_member_status.ChatMemberStatus`,
- :class:`aiogram.enums.chat_type.ChatType`,
- :class:`aiogram.enums.content_type.ContentType`,
- :class:`aiogram.enums.dice_emoji.DiceEmoji`,
- :class:`aiogram.enums.inline_query_result_type.InlineQueryResultType`,
- :class:`aiogram.enums.input_media_type.InputMediaType`,
- :class:`aiogram.enums.mask_position_point.MaskPositionPoint`,
- :class:`aiogram.enums.menu_button_type.MenuButtonType`,
- :class:`aiogram.enums.message_entity_type.MessageEntityType`,
- :class:`aiogram.enums.parse_mode.ParseMode`,
- :class:`aiogram.enums.poll_type.PollType`,
- :class:`aiogram.enums.sticker_type.StickerType`,
- :class:`aiogram.enums.topic_icon_color.TopicIconColor`,
- :class:`aiogram.enums.update_type.UpdateType`,
-
-**Added shortcuts**:
-
-- *Chat* :meth:`aiogram.types.chat.Chat.get_administrators`,
- :meth:`aiogram.types.chat.Chat.delete_message`,
- :meth:`aiogram.types.chat.Chat.revoke_invite_link`,
- :meth:`aiogram.types.chat.Chat.edit_invite_link`,
- :meth:`aiogram.types.chat.Chat.create_invite_link`,
- :meth:`aiogram.types.chat.Chat.export_invite_link`,
- :meth:`aiogram.types.chat.Chat.do`,
- :meth:`aiogram.types.chat.Chat.delete_sticker_set`,
- :meth:`aiogram.types.chat.Chat.set_sticker_set`,
- :meth:`aiogram.types.chat.Chat.get_member`,
- :meth:`aiogram.types.chat.Chat.get_member_count`,
- :meth:`aiogram.types.chat.Chat.leave`,
- :meth:`aiogram.types.chat.Chat.unpin_all_messages`,
- :meth:`aiogram.types.chat.Chat.unpin_message`,
- :meth:`aiogram.types.chat.Chat.pin_message`,
- :meth:`aiogram.types.chat.Chat.set_administrator_custom_title`,
- :meth:`aiogram.types.chat.Chat.set_permissions`,
- :meth:`aiogram.types.chat.Chat.promote`,
- :meth:`aiogram.types.chat.Chat.restrict`,
- :meth:`aiogram.types.chat.Chat.unban`,
- :meth:`aiogram.types.chat.Chat.ban`,
- :meth:`aiogram.types.chat.Chat.set_description`,
- :meth:`aiogram.types.chat.Chat.set_title`,
- :meth:`aiogram.types.chat.Chat.delete_photo`,
- :meth:`aiogram.types.chat.Chat.set_photo`,
-- *Sticker*: :meth:`aiogram.types.sticker.Sticker.set_position_in_set`,
- :meth:`aiogram.types.sticker.Sticker.delete_from_set`,
-- *User*: :meth:`aiogram.types.user.User.get_profile_photos`
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..ada02324
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1 @@
+Please read the [Contributing](https://docs.aiogram.dev/en/dev-3.x/contributing/) guidelines in the documentation site.
diff --git a/Makefile b/Makefile
index e451a0c4..66dd4eba 100644
--- a/Makefile
+++ b/Makefile
@@ -1,8 +1,4 @@
-.DEFAULT_GOAL := help
-
-base_python := python3
-py := poetry run
-python := $(py) python
+.DEFAULT_GOAL := lint
package_dir := aiogram
tests_dir := tests
@@ -13,43 +9,10 @@ reports_dir := reports
redis_connection := redis://localhost:6379
-.PHONY: help
-help:
- @echo "======================================================================================="
- @echo " aiogram build tools "
- @echo "======================================================================================="
- @echo "Environment:"
- @echo " help: Show this message"
- @echo " install: Install development dependencies"
- @echo " clean: Delete temporary files"
- @echo ""
- @echo "Code quality:"
- @echo " lint: Lint code by isort, black, flake8 and mypy tools"
- @echo " reformat: Reformat code by isort and black tools"
- @echo ""
- @echo "Tests:"
- @echo " test: Run tests"
- @echo " test-coverage: Run tests with HTML reporting (results + coverage)"
- @echo " test-coverage-report: Open coverage report in default system web browser"
- @echo ""
- @echo "Documentation:"
- @echo " docs: Build docs"
- @echo " docs-serve: Serve docs for local development"
- @echo " docs-prepare-reports: Move all HTML reports to docs dir"
- @echo ""
- @echo "Project"
- @echo " build: Run tests build package and docs"
- @echo ""
-
# =================================================================================================
# Environment
# =================================================================================================
-.PHONY: install
-install:
- poetry install --all-extras
- $(py) pre-commit install
-
.PHONY: clean
clean:
rm -rf `find . -name __pycache__`
@@ -60,7 +23,7 @@ clean:
rm -rf *.egg-info
rm -f report.html
rm -f .coverage
- rm -rf {build,dist,site,.cache,.mypy_cache,reports}
+ rm -rf {build,dist,site,.cache,.mypy_cache,.ruff_cache,reports}
# =================================================================================================
# Code quality
@@ -68,16 +31,15 @@ clean:
.PHONY: lint
lint:
- $(py) isort --check-only $(code_dir)
- $(py) black --check --diff $(code_dir)
- $(py) flake8 $(code_dir)
- $(py) mypy $(package_dir)
- # TODO: wemake-python-styleguide
+ isort --check-only $(code_dir)
+ black --check --diff $(code_dir)
+ ruff $(package_dir)
+ mypy $(package_dir)
.PHONY: reformat
reformat:
- $(py) black $(code_dir)
- $(py) isort $(code_dir)
+ black $(code_dir)
+ isort $(code_dir)
# =================================================================================================
# Tests
@@ -88,17 +50,17 @@ test-run-services:
.PHONY: test
test: test-run-services
- $(py) pytest --cov=aiogram --cov-config .coveragerc tests/ --redis $(redis_connection)
+ pytest --cov=aiogram --cov-config .coveragerc tests/ --redis $(redis_connection)
.PHONY: test-coverage
test-coverage: test-run-services
mkdir -p $(reports_dir)/tests/
- $(py) pytest --cov=aiogram --cov-config .coveragerc --html=$(reports_dir)/tests/index.html tests/ --redis $(redis_connection)
- $(py) coverage html -d $(reports_dir)/coverage
+ pytest --cov=aiogram --cov-config .coveragerc --html=$(reports_dir)/tests/index.html tests/ --redis $(redis_connection)
+ coverage html -d $(reports_dir)/coverage
.PHONY: test-coverage-view
test-coverage-view:
- $(py) coverage html -d $(reports_dir)/coverage
+ coverage html -d $(reports_dir)/coverage
python -c "import webbrowser; webbrowser.open('file://$(shell pwd)/reports/coverage/index.html')"
# =================================================================================================
@@ -117,7 +79,7 @@ docs-gettext:
docs-serve:
#rm -rf docs/_build
- $(py) sphinx-autobuild --watch aiogram/ --watch CHANGELOG.rst --watch README.rst docs/ docs/_build/ $(OPTS)
+ sphinx-autobuild --watch aiogram/ --watch CHANGELOG.rst --watch README.rst docs/ docs/_build/ $(OPTS)
.PHONY: docs-serve
$(locale_targets): docs-serve-%:
@@ -129,15 +91,13 @@ $(locale_targets): docs-serve-%:
# =================================================================================================
.PHONY: build
-build: clean flake8-report mypy-report test-coverage
- mkdir -p site/simple
- poetry build
- mv dist site/simple/aiogram
+build: clean
+ hatch build
.PHONY: bump
bump:
- poetry version $(args)
- $(python) scripts/bump_versions.py
+ hatch version $(args)
+ python scripts/bump_versions.py
.PHONY: towncrier-build
towncrier-build:
@@ -159,11 +119,4 @@ prepare-release: bump towncrier-build
release:
git add .
git commit -m "Release $(shell poetry version -s)"
- git tag v$(shell poetry version -s)
-
-_poetry_export_args := --format requirements.txt --without-hashes
-
-.PHONY: export-requirements
-export-requirements:
- poetry export $(_poetry_export_args) --output requirements/base.txt
- poetry export $(_poetry_export_args) --output requirements/docs.txt -E fast -E redis -E proxy -E i18n --with docs
+ git tag v$(shell hatch version -s)
diff --git a/README.rst b/README.rst
index dce1339f..3c2297a8 100644
--- a/README.rst
+++ b/README.rst
@@ -5,37 +5,33 @@ aiogram |beta badge|
.. danger::
This version is still in development!
-.. image:: https://img.shields.io/pypi/l/aiogram.svg
+.. image:: https://img.shields.io/pypi/l/aiogram.svg?style=flat-square
:target: https://opensource.org/licenses/MIT
:alt: MIT License
-.. image:: https://img.shields.io/pypi/pyversions/aiogram.svg
- :target: https://pypi.python.org/pypi/aiogram
- :alt: Supported python versions
-
-.. image:: https://img.shields.io/badge/Telegram%20Bot%20API-6.3-blue.svg?logo=telegram
- :target: https://core.telegram.org/bots/api
- :alt: Telegram Bot API
-
-.. image:: https://github.com/aiogram/aiogram/workflows/Tests/badge.svg?branch=dev-3.x
- :target: https://github.com/aiogram/aiogram/actions
- :alt: Tests
-
-.. image:: https://img.shields.io/pypi/v/aiogram.svg
- :target: https://pypi.python.org/pypi/aiogram
- :alt: PyPi Package Version
-
-.. image:: https://img.shields.io/pypi/status/aiogram.svg
+.. image:: https://img.shields.io/pypi/status/aiogram.svg?style=flat-square
:target: https://pypi.python.org/pypi/aiogram
:alt: PyPi status
-.. image:: https://img.shields.io/pypi/dm/aiogram.svg
+.. image:: https://img.shields.io/pypi/v/aiogram.svg?style=flat-square
+ :target: https://pypi.python.org/pypi/aiogram
+ :alt: PyPi Package Version
+
+.. image:: https://img.shields.io/pypi/dm/aiogram.svg?style=flat-square
:target: https://pypi.python.org/pypi/aiogram
:alt: Downloads
-.. image:: https://img.shields.io/badge/telegram-aiogram-blue.svg
- :target: https://t.me/aiogram_live
- :alt: [Telegram] aiogram live
+.. image:: https://img.shields.io/pypi/pyversions/aiogram.svg?style=flat-square
+ :target: https://pypi.python.org/pypi/aiogram
+ :alt: Supported python versions
+
+.. image:: https://img.shields.io/badge/dynamic/json?color=blue&logo=telegram&label=Telegram%20Bot%20API&query=%24.api.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Faiogram%2Faiogram%2Fdev-3.x%2F.butcher%2Fschema%2Fschema.json&style=flat-square
+ :target: https://core.telegram.org/bots/api
+ :alt: Telegram Bot API
+
+.. image:: https://img.shields.io/github/actions/workflow/status/aiogram/aiogram/tests.yml?branch=dev-3.x&style=flat-square
+ :target: https://github.com/aiogram/aiogram/actions
+ :alt: Tests
.. image:: https://img.shields.io/codecov/c/github/aiogram/aiogram?style=flat-square
:target: https://app.codecov.io/gh/aiogram/aiogram
@@ -67,7 +63,7 @@ Features
- Asynchronous (`asyncio docs `_, :pep:`492`)
- Has type hints (:pep:`484`) and can be used with `mypy `_
- Supports `PyPy `_
-- Supports `Telegram Bot API 6.3 `_ and gets fast updates to the latest versions of the Bot API
+- Supports `Telegram Bot API 6.6 `_ and gets fast updates to the latest versions of the Bot API
- Telegram Bot API integration code was `autogenerated `_ and can be easily re-generated when API gets updated
- Updates router (Blueprints)
- Has Finite State Machine
diff --git a/aiogram/__init__.py b/aiogram/__init__.py
index b74395a8..4ed355fc 100644
--- a/aiogram/__init__.py
+++ b/aiogram/__init__.py
@@ -1,5 +1,8 @@
+from contextlib import suppress
+
from aiogram.dispatcher.flags import FlagGenerator
+from . import enums, methods, types
from .client import session
from .client.bot import Bot
from .dispatcher.dispatcher import Dispatcher
@@ -9,12 +12,10 @@ from .utils.magic_filter import MagicFilter
from .utils.text_decorations import html_decoration as html
from .utils.text_decorations import markdown_decoration as md
-try:
+with suppress(ImportError):
import uvloop as _uvloop
_uvloop.install()
-except ImportError: # pragma: no cover
- pass
F = MagicFilter()
flags = FlagGenerator()
@@ -24,6 +25,7 @@ __all__ = (
"__version__",
"types",
"methods",
+ "enums",
"Bot",
"session",
"Dispatcher",
@@ -35,5 +37,5 @@ __all__ = (
"flags",
)
-__version__ = "3.0.0b7"
-__api_version__ = "6.3"
+__version__ = "3.0.0b8"
+__api_version__ = "6.6"
diff --git a/aiogram/client/bot.py b/aiogram/client/bot.py
index ca06a62d..6f874a88 100644
--- a/aiogram/client/bot.py
+++ b/aiogram/client/bot.py
@@ -33,6 +33,7 @@ from ..methods import (
BanChatSenderChat,
Close,
CloseForumTopic,
+ CloseGeneralForumTopic,
CopyMessage,
CreateChatInviteLink,
CreateForumTopic,
@@ -45,9 +46,11 @@ from ..methods import (
DeleteMessage,
DeleteMyCommands,
DeleteStickerFromSet,
+ DeleteStickerSet,
DeleteWebhook,
EditChatInviteLink,
EditForumTopic,
+ EditGeneralForumTopic,
EditMessageCaption,
EditMessageLiveLocation,
EditMessageMedia,
@@ -67,15 +70,19 @@ from ..methods import (
GetMe,
GetMyCommands,
GetMyDefaultAdministratorRights,
+ GetMyDescription,
+ GetMyShortDescription,
GetStickerSet,
GetUpdates,
GetUserProfilePhotos,
GetWebhookInfo,
+ HideGeneralForumTopic,
LeaveChat,
LogOut,
PinChatMessage,
PromoteChatMember,
ReopenForumTopic,
+ ReopenGeneralForumTopic,
RestrictChatMember,
RevokeChatInviteLink,
SendAnimation,
@@ -103,27 +110,37 @@ from ..methods import (
SetChatPhoto,
SetChatStickerSet,
SetChatTitle,
+ SetCustomEmojiStickerSetThumbnail,
SetGameScore,
SetMyCommands,
SetMyDefaultAdministratorRights,
+ SetMyDescription,
+ SetMyShortDescription,
SetPassportDataErrors,
+ SetStickerEmojiList,
+ SetStickerKeywords,
+ SetStickerMaskPosition,
SetStickerPositionInSet,
- SetStickerSetThumb,
+ SetStickerSetThumbnail,
+ SetStickerSetTitle,
SetWebhook,
StopMessageLiveLocation,
StopPoll,
TelegramMethod,
UnbanChatMember,
UnbanChatSenderChat,
+ UnhideGeneralForumTopic,
UnpinAllChatMessages,
UnpinAllForumTopicMessages,
UnpinChatMessage,
UploadStickerFile,
)
from ..types import (
- UNSET,
+ UNSET_PARSE_MODE,
BotCommand,
BotCommandScope,
+ BotDescription,
+ BotShortDescription,
Chat,
ChatAdministratorRights,
ChatInviteLink,
@@ -147,6 +164,7 @@ from ..types import (
InputMediaDocument,
InputMediaPhoto,
InputMediaVideo,
+ InputSticker,
LabeledPrice,
MaskPosition,
MenuButtonCommands,
@@ -168,6 +186,7 @@ from ..types import (
UserProfilePhotos,
WebhookInfo,
)
+from ..types.base import UNSET_DISABLE_WEB_PAGE_PREVIEW, UNSET_PROTECT_CONTENT
from .session.aiohttp import AiohttpSession
from .session.base import BaseSession
@@ -180,6 +199,8 @@ class Bot(ContextInstanceMixin["Bot"]):
token: str,
session: Optional[BaseSession] = None,
parse_mode: Optional[str] = None,
+ disable_web_page_preview: Optional[bool] = None,
+ protect_content: Optional[bool] = None,
) -> None:
"""
Bot class
@@ -189,6 +210,10 @@ class Bot(ContextInstanceMixin["Bot"]):
If not specified it will be automatically created.
:param parse_mode: Default parse mode.
If specified it will be propagated into the API methods at runtime.
+ :param disable_web_page_preview: Default disable_web_page_preview mode.
+ If specified it will be propagated into the API methods at runtime.
+ :param protect_content: Default protect_content mode.
+ If specified it will be propagated into the API methods at runtime.
:raise TokenValidationError: When token has invalid format this exception will be raised
"""
@@ -199,6 +224,8 @@ class Bot(ContextInstanceMixin["Bot"]):
self.session = session
self.parse_mode = parse_mode
+ self.disable_web_page_preview = disable_web_page_preview
+ self.protect_content = protect_content
self.__token = token
self._me: Optional[User] = None
@@ -299,16 +326,20 @@ class Bot(ContextInstanceMixin["Bot"]):
close_stream = True
else:
url = self.session.api.file_url(self.__token, file_path)
- stream = self.session.stream_content(url=url, timeout=timeout, chunk_size=chunk_size)
+ stream = self.session.stream_content(
+ url=url,
+ timeout=timeout,
+ chunk_size=chunk_size,
+ raise_for_status=True,
+ )
try:
if isinstance(destination, (str, pathlib.Path)):
await self.__download_file(destination=destination, stream=stream)
return None
- else:
- return await self.__download_file_binary_io(
- destination=destination, seek=seek, stream=stream
- )
+ return await self.__download_file_binary_io(
+ destination=destination, seek=seek, stream=stream
+ )
finally:
if close_stream:
await stream.aclose()
@@ -387,23 +418,17 @@ class Bot(ContextInstanceMixin["Bot"]):
self,
user_id: int,
name: str,
- emojis: str,
- png_sticker: Optional[Union[InputFile, str]] = None,
- tgs_sticker: Optional[InputFile] = None,
- webm_sticker: Optional[InputFile] = None,
- mask_position: Optional[MaskPosition] = None,
+ sticker: InputSticker,
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*, *tgs_sticker*, or *webm_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 :code:`True` on success.
+ Use this method to add a new sticker to a set created by the bot. The format of the added sticker must match the format of the other stickers in the set. Emoji sticker sets can have up to 200 stickers. Animated and video sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns :code:`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. :ref:`More information on Sending Files » `
- :param tgs_sticker: **TGS** animation with the sticker, uploaded using multipart/form-data. See `https://core.telegram.org/stickers#animated-sticker-requirements `_`https://core.telegram.org/stickers#animated-sticker-requirements `_ for technical requirements
- :param webm_sticker: **WEBM** video with the sticker, uploaded using multipart/form-data. See `https://core.telegram.org/stickers#video-sticker-requirements `_`https://core.telegram.org/stickers#video-sticker-requirements `_ for technical requirements
- :param mask_position: A JSON-serialized object for position where the mask should be placed on faces
+ :param sticker: A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set isn't changed.
:param request_timeout: Request timeout
:return: Returns :code:`True` on success.
"""
@@ -411,11 +436,7 @@ class Bot(ContextInstanceMixin["Bot"]):
call = AddStickerToSet(
user_id=user_id,
name=name,
- emojis=emojis,
- png_sticker=png_sticker,
- tgs_sticker=tgs_sticker,
- webm_sticker=webm_sticker,
- mask_position=mask_position,
+ sticker=sticker,
)
return await self(call, request_timeout=request_timeout)
@@ -433,6 +454,8 @@ class Bot(ContextInstanceMixin["Bot"]):
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 :code:`True`, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to *false*.
@@ -467,6 +490,8 @@ class Bot(ContextInstanceMixin["Bot"]):
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.
@@ -499,6 +524,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an :class:`aiogram.types.update.Update` with the field *pre_checkout_query*. Use this method to respond to such pre-checkout queries. On success, :code:`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 :code:`True` if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use :code:`False` if there are any problems.
:param error_message: Required if *ok* is :code:`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.
@@ -524,6 +551,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
If you sent an invoice requesting a shipping address and the parameter *is_flexible* was specified, the Bot API will send an :class:`aiogram.types.update.Update` with a *shipping_query* field to the bot. Use this method to reply to shipping queries. On success, :code:`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: Pass :code:`True` if delivery to the specified address is possible and :code:`False` if there are any problems (for example, if delivery to the specified address is not possible)
:param shipping_options: Required if *ok* is :code:`True`. A JSON-serialized array of available shipping options.
@@ -549,6 +578,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to set the result of an interaction with a `Web App `_ and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a :class:`aiogram.types.sent_web_app_message.SentWebAppMessage` object is returned.
+ Source: https://core.telegram.org/bots/api#answerwebappquery
+
:param web_app_query_id: Unique identifier for the query to be answered
:param result: A JSON-serialized object describing the message to be sent
:param request_timeout: Request timeout
@@ -570,6 +601,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the *can_invite_users* administrator right. Returns :code:`True` on success.
+ Source: https://core.telegram.org/bots/api#approvechatjoinrequest
+
: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 request_timeout: Request timeout
@@ -593,6 +626,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to ban a user in 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 administrator rights. Returns :code:`True` on success.
+ Source: https://core.telegram.org/bots/api#banchatmember
+
: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. Applied for supergroups and channels only.
@@ -618,6 +653,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to ban a channel chat in a supergroup or a channel. Until the chat is `unbanned `_, the owner of the banned chat won't be able to send messages on behalf of **any of their channels**. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns :code:`True` on success.
+ Source: https://core.telegram.org/bots/api#banchatsenderchat
+
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param sender_chat_id: Unique identifier of the target sender chat
:param request_timeout: Request timeout
@@ -637,6 +674,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
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 :code:`True` on success. Requires no parameters.
+ Source: https://core.telegram.org/bots/api#close
+
:param request_timeout: Request timeout
:return: Requires no parameters.
"""
@@ -653,6 +692,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights, unless it is the creator of the topic. Returns :code:`True` on success.
+ Source: https://core.telegram.org/bots/api#closeforumtopic
+
:param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)
:param message_thread_id: Unique identifier for the target message thread of the forum topic
:param request_timeout: Request timeout
@@ -672,10 +713,10 @@ class Bot(ContextInstanceMixin["Bot"]):
message_id: int,
message_thread_id: Optional[int] = None,
caption: Optional[str] = None,
- parse_mode: Optional[str] = UNSET,
+ parse_mode: Optional[str] = UNSET_PARSE_MODE,
caption_entities: Optional[List[MessageEntity]] = None,
disable_notification: Optional[bool] = None,
- protect_content: Optional[bool] = None,
+ protect_content: Optional[bool] = UNSET_PROTECT_CONTENT,
reply_to_message_id: Optional[int] = None,
allow_sending_without_reply: Optional[bool] = None,
reply_markup: Optional[
@@ -686,6 +727,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to copy messages of any kind. Service messages and invoice messages can't be copied. A quiz :class:`aiogram.methods.poll.Poll` can be copied only if the value of the field *correct_option_id* is known to the bot. The method is analogous to the method :class:`aiogram.methods.forward_message.ForwardMessage`, but the copied message doesn't have a link to the original message. Returns the :class:`aiogram.types.message_id.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 :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*
@@ -730,6 +773,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method :class:`aiogram.methods.revoke_chat_invite_link.RevokeChatInviteLink`. Returns the new invite link as :class:`aiogram.types.chat_invite_link.ChatInviteLink` object.
+ Source: https://core.telegram.org/bots/api#createchatinvitelink
+
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param name: Invite link name; 0-32 characters
:param expire_date: Point in time (Unix timestamp) when the link will expire
@@ -759,6 +804,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to create a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights. Returns information about the created topic as a :class:`aiogram.types.forum_topic.ForumTopic` object.
+ Source: https://core.telegram.org/bots/api#createforumtopic
+
:param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)
:param name: Topic name, 1-128 characters
:param icon_color: Color of the topic icon in RGB format. Currently, must be one of 7322096 (0x6FB9F0), 16766590 (0xFFD67E), 13338331 (0xCB86DB), 9367192 (0x8EEE98), 16749490 (0xFF93B2), or 16478047 (0xFB6F5F)
@@ -802,6 +849,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to create a link for an invoice. Returns the created invoice link as *String* on success.
+ Source: https://core.telegram.org/bots/api#createinvoicelink
+
: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.
@@ -855,26 +904,24 @@ class Bot(ContextInstanceMixin["Bot"]):
user_id: int,
name: str,
title: str,
- emojis: str,
- png_sticker: Optional[Union[InputFile, str]] = None,
- tgs_sticker: Optional[InputFile] = None,
- webm_sticker: Optional[InputFile] = None,
+ stickers: List[InputSticker],
+ sticker_format: str,
sticker_type: Optional[str] = None,
- mask_position: Optional[MaskPosition] = None,
+ needs_repainting: Optional[bool] = None,
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*, *tgs_sticker*, or *webm_sticker*. Returns :code:`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. Returns :code:`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 :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 :code:`"_by_"`. :code:`` 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. :ref:`More information on Sending Files » `
- :param tgs_sticker: **TGS** animation with the sticker, uploaded using multipart/form-data. See `https://core.telegram.org/stickers#animated-sticker-requirements `_`https://core.telegram.org/stickers#animated-sticker-requirements `_ for technical requirements
- :param webm_sticker: **WEBM** video with the sticker, uploaded using multipart/form-data. See `https://core.telegram.org/stickers#video-sticker-requirements `_`https://core.telegram.org/stickers#video-sticker-requirements `_ for technical requirements
- :param sticker_type: Type of stickers in the set, pass 'regular' or 'mask'. Custom emoji sticker sets can't be created via the Bot API at the moment. By default, a regular sticker set is created.
- :param mask_position: A JSON-serialized object for position where the mask should be placed on faces
+ :param stickers: A JSON-serialized list of 1-50 initial stickers to be added to the sticker set
+ :param sticker_format: Format of stickers in the set, must be one of 'static', 'animated', 'video'
+ :param sticker_type: Type of stickers in the set, pass 'regular', 'mask', or 'custom_emoji'. By default, a regular sticker set is created.
+ :param needs_repainting: Pass :code:`True` if stickers in the sticker set must be repainted to the color of text when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context; for custom emoji sticker sets only
:param request_timeout: Request timeout
:return: Returns :code:`True` on success.
"""
@@ -883,12 +930,10 @@ class Bot(ContextInstanceMixin["Bot"]):
user_id=user_id,
name=name,
title=title,
- emojis=emojis,
- png_sticker=png_sticker,
- tgs_sticker=tgs_sticker,
- webm_sticker=webm_sticker,
+ stickers=stickers,
+ sticker_format=sticker_format,
sticker_type=sticker_type,
- mask_position=mask_position,
+ needs_repainting=needs_repainting,
)
return await self(call, request_timeout=request_timeout)
@@ -901,6 +946,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the *can_invite_users* administrator right. Returns :code:`True` on success.
+ Source: https://core.telegram.org/bots/api#declinechatjoinrequest
+
: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 request_timeout: Request timeout
@@ -921,6 +968,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
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 administrator rights. Returns :code:`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 :code:`@channelusername`)
:param request_timeout: Request timeout
:return: Returns :code:`True` on success.
@@ -939,6 +988,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
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 administrator rights. Use the field *can_set_sticker_set* optionally returned in :class:`aiogram.methods.get_chat.GetChat` requests to check if the bot can use this method. Returns :code:`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 :code:`@supergroupusername`)
:param request_timeout: Request timeout
:return: Returns :code:`True` on success.
@@ -958,6 +1009,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to delete a forum topic along with all its messages in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_delete_messages* administrator rights. Returns :code:`True` on success.
+ Source: https://core.telegram.org/bots/api#deleteforumtopic
+
:param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)
:param message_thread_id: Unique identifier for the target message thread of the forum topic
:param request_timeout: Request timeout
@@ -997,6 +1050,8 @@ class Bot(ContextInstanceMixin["Bot"]):
Returns :code:`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 :code:`@channelusername`)
:param message_id: Identifier of the message to delete
:param request_timeout: Request timeout
@@ -1018,6 +1073,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, `higher level commands `_ will be shown to affected users. Returns :code:`True` on success.
+ Source: https://core.telegram.org/bots/api#deletemycommands
+
:param scope: A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to :class:`aiogram.types.bot_command_scope_default.BotCommandScopeDefault`.
:param language_code: A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands
:param request_timeout: Request timeout
@@ -1038,6 +1095,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to delete a sticker from a set created by the bot. Returns :code:`True` on success.
+ Source: https://core.telegram.org/bots/api#deletestickerfromset
+
:param sticker: File identifier of the sticker
:param request_timeout: Request timeout
:return: Returns :code:`True` on success.
@@ -1056,6 +1115,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to remove webhook integration if you decide to switch back to :class:`aiogram.methods.get_updates.GetUpdates`. Returns :code:`True` on success.
+ Source: https://core.telegram.org/bots/api#deletewebhook
+
:param drop_pending_updates: Pass :code:`True` to drop all pending updates
:param request_timeout: Request timeout
:return: Returns :code:`True` on success.
@@ -1079,6 +1140,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a :class:`aiogram.types.chat_invite_link.ChatInviteLink` object.
+ Source: https://core.telegram.org/bots/api#editchatinvitelink
+
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param invite_link: The invite link to edit
:param name: Invite link name; 0-32 characters
@@ -1103,17 +1166,19 @@ class Bot(ContextInstanceMixin["Bot"]):
self,
chat_id: Union[int, str],
message_thread_id: int,
- name: str,
- icon_custom_emoji_id: str,
+ name: Optional[str] = None,
+ icon_custom_emoji_id: Optional[str] = None,
request_timeout: Optional[int] = None,
) -> bool:
"""
Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have *can_manage_topics* administrator rights, unless it is the creator of the topic. Returns :code:`True` on success.
+ Source: https://core.telegram.org/bots/api#editforumtopic
+
:param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)
:param message_thread_id: Unique identifier for the target message thread of the forum topic
- :param name: New topic name, 1-128 characters
- :param icon_custom_emoji_id: New unique identifier of the custom emoji shown as the topic icon. Use :class:`aiogram.methods.get_forum_topic_icon_stickers.GetForumTopicIconStickers` to get all allowed custom emoji identifiers.
+ :param name: New topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept
+ :param icon_custom_emoji_id: New unique identifier of the custom emoji shown as the topic icon. Use :class:`aiogram.methods.get_forum_topic_icon_stickers.GetForumTopicIconStickers` to get all allowed custom emoji identifiers. Pass an empty string to remove the icon. If not specified, the current icon will be kept
:param request_timeout: Request timeout
:return: Returns :code:`True` on success.
"""
@@ -1132,7 +1197,7 @@ class Bot(ContextInstanceMixin["Bot"]):
message_id: Optional[int] = None,
inline_message_id: Optional[str] = None,
caption: Optional[str] = None,
- parse_mode: Optional[str] = UNSET,
+ parse_mode: Optional[str] = UNSET_PARSE_MODE,
caption_entities: Optional[List[MessageEntity]] = None,
reply_markup: Optional[InlineKeyboardMarkup] = None,
request_timeout: Optional[int] = None,
@@ -1140,6 +1205,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited :class:`aiogram.types.message.Message` is returned, otherwise :code:`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 :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
@@ -1178,6 +1245,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
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 :class:`aiogram.methods.stop_message_live_location.StopMessageLiveLocation`. On success, if the edited message is not an inline message, the edited :class:`aiogram.types.message.Message` is returned, otherwise :code:`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 :code:`@channelusername`)
@@ -1216,6 +1285,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
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 is not an inline message, the edited :class:`aiogram.types.message.Message` is returned, otherwise :code:`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 :code:`@channelusername`)
:param message_id: Required if *inline_message_id* is not specified. Identifier of the message to edit
@@ -1245,6 +1316,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited :class:`aiogram.types.message.Message` is returned, otherwise :code:`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 :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
@@ -1267,15 +1340,17 @@ class Bot(ContextInstanceMixin["Bot"]):
chat_id: Optional[Union[int, str]] = None,
message_id: Optional[int] = None,
inline_message_id: Optional[str] = None,
- parse_mode: Optional[str] = UNSET,
+ parse_mode: Optional[str] = UNSET_PARSE_MODE,
entities: Optional[List[MessageEntity]] = None,
- disable_web_page_preview: Optional[bool] = None,
+ disable_web_page_preview: Optional[bool] = UNSET_DISABLE_WEB_PAGE_PREVIEW,
reply_markup: Optional[InlineKeyboardMarkup] = None,
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 :class:`aiogram.types.message.Message` is returned, otherwise :code:`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 :code:`@channelusername`)
:param message_id: Required if *inline_message_id* is not specified. Identifier of the message to edit
@@ -1310,6 +1385,8 @@ class Bot(ContextInstanceMixin["Bot"]):
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 :class:`aiogram.methods.export_chat_invite_link.ExportChatInviteLink` or by calling the :class:`aiogram.methods.get_chat.GetChat` method. If your bot needs to generate a new primary invite link replacing its previous one, use :class:`aiogram.methods.export_chat_invite_link.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 :code:`@channelusername`)
:param request_timeout: Request timeout
:return: If your bot needs to generate a new primary invite link replacing its previous one, use :class:`aiogram.methods.export_chat_invite_link.ExportChatInviteLink` again.
@@ -1327,12 +1404,14 @@ class Bot(ContextInstanceMixin["Bot"]):
message_id: int,
message_thread_id: Optional[int] = None,
disable_notification: Optional[bool] = None,
- protect_content: Optional[bool] = None,
+ protect_content: Optional[bool] = UNSET_PROTECT_CONTENT,
request_timeout: Optional[int] = None,
) -> Message:
"""
Use this method to forward messages of any kind. Service messages can't be forwarded. On success, the sent :class:`aiogram.types.message.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 :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*
@@ -1361,6 +1440,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
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 :class:`aiogram.types.chat.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 :code:`@channelusername`)
:param request_timeout: Request timeout
:return: Returns a :class:`aiogram.types.chat.Chat` object on success.
@@ -1388,6 +1469,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of :class:`aiogram.types.chat_member.ChatMember` objects.
+ 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 :code:`@channelusername`)
:param request_timeout: Request timeout
:return: Returns an Array of :class:`aiogram.types.chat_member.ChatMember` objects.
@@ -1412,7 +1495,9 @@ class Bot(ContextInstanceMixin["Bot"]):
ChatMemberBanned,
]:
"""
- Use this method to get information about a member of a chat. Returns a :class:`aiogram.types.chat_member.ChatMember` object on success.
+ Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a :class:`aiogram.types.chat_member.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 :code:`@channelusername`)
:param user_id: Unique identifier of the target user
@@ -1434,6 +1519,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to get the number of members in a chat. Returns *Int* on success.
+ Source: https://core.telegram.org/bots/api#getchatmembercount
+
: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.
@@ -1452,6 +1539,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns :class:`aiogram.types.menu_button.MenuButton` on success.
+ Source: https://core.telegram.org/bots/api#getchatmenubutton
+
:param chat_id: Unique identifier for the target private chat. If not specified, default bot's menu button will be returned
:param request_timeout: Request timeout
:return: Returns :class:`aiogram.types.menu_button.MenuButton` on success.
@@ -1470,6 +1559,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of :class:`aiogram.types.sticker.Sticker` objects.
+ Source: https://core.telegram.org/bots/api#getcustomemojistickers
+
:param custom_emoji_ids: List of custom emoji identifiers. At most 200 custom emoji identifiers can be specified.
:param request_timeout: Request timeout
:return: Returns an Array of :class:`aiogram.types.sticker.Sticker` objects.
@@ -1489,6 +1580,8 @@ class Bot(ContextInstanceMixin["Bot"]):
Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a :class:`aiogram.types.file.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 :class:`aiogram.methods.get_file.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
+
:param file_id: File identifier to get information about
:param request_timeout: Request timeout
:return: You should save the file's MIME type and name (if available) when the File object is received.
@@ -1506,6 +1599,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of :class:`aiogram.types.sticker.Sticker` objects.
+ Source: https://core.telegram.org/bots/api#getforumtopiciconstickers
+
:param request_timeout: Request timeout
:return: Returns an Array of :class:`aiogram.types.sticker.Sticker` objects.
"""
@@ -1526,6 +1621,8 @@ class Bot(ContextInstanceMixin["Bot"]):
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 their 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
@@ -1549,6 +1646,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
A simple method for testing your bot's authentication token. Requires no parameters. Returns basic information about the bot in form of a :class:`aiogram.types.user.User` object.
+ Source: https://core.telegram.org/bots/api#getme
+
:param request_timeout: Request timeout
:return: Returns basic information about the bot in form of a :class:`aiogram.types.user.User` object.
"""
@@ -1565,6 +1664,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of :class:`aiogram.types.bot_command.BotCommand` objects. If commands aren't set, an empty list is returned.
+ Source: https://core.telegram.org/bots/api#getmycommands
+
:param scope: A JSON-serialized object, describing scope of users. Defaults to :class:`aiogram.types.bot_command_scope_default.BotCommandScopeDefault`.
:param language_code: A two-letter ISO 639-1 language code or an empty string
:param request_timeout: Request timeout
@@ -1585,6 +1686,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to get the current default administrator rights of the bot. Returns :class:`aiogram.types.chat_administrator_rights.ChatAdministratorRights` on success.
+ Source: https://core.telegram.org/bots/api#getmydefaultadministratorrights
+
:param for_channels: Pass :code:`True` to get default administrator rights of the bot in channels. Otherwise, default administrator rights of the bot for groups and supergroups will be returned.
:param request_timeout: Request timeout
:return: Returns :class:`aiogram.types.chat_administrator_rights.ChatAdministratorRights` on success.
@@ -1603,6 +1706,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to get a sticker set. On success, a :class:`aiogram.types.sticker_set.StickerSet` object is returned.
+ Source: https://core.telegram.org/bots/api#getstickerset
+
:param name: Name of the sticker set
:param request_timeout: Request timeout
:return: On success, a :class:`aiogram.types.sticker_set.StickerSet` object is returned.
@@ -1630,6 +1735,8 @@ class Bot(ContextInstanceMixin["Bot"]):
**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 :class:`aiogram.methods.get_updates.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.
@@ -1656,6 +1763,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to get a list of profile pictures for a user. Returns a :class:`aiogram.types.user_profile_photos.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.
@@ -1677,6 +1786,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to get current webhook status. Requires no parameters. On success, returns a :class:`aiogram.types.webhook_info.WebhookInfo` object. If the bot is using :class:`aiogram.methods.get_updates.GetUpdates`, will return an object with the *url* field empty.
+ Source: https://core.telegram.org/bots/api#getwebhookinfo
+
:param request_timeout: Request timeout
:return: If the bot is using :class:`aiogram.methods.get_updates.GetUpdates`, will return an object with the *url* field empty.
"""
@@ -1692,6 +1803,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method for your bot to leave a group, supergroup or channel. Returns :code:`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 :code:`@channelusername`)
:param request_timeout: Request timeout
:return: Returns :code:`True` on success.
@@ -1709,6 +1822,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
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 :code:`True` on success. Requires no parameters.
+ Source: https://core.telegram.org/bots/api#logout
+
:param request_timeout: Request timeout
:return: Requires no parameters.
"""
@@ -1726,6 +1841,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
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' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns :code:`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 :code:`@channelusername`)
:param message_id: Identifier of a message to pin
:param disable_notification: Pass :code:`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.
@@ -1761,6 +1878,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
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 administrator rights. Pass :code:`False` for all boolean parameters to demote a user. Returns :code:`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 :code:`@channelusername`)
:param user_id: Unique identifier of the target user
:param is_anonymous: Pass :code:`True` if the administrator's presence in the chat is hidden
@@ -1770,7 +1889,7 @@ class Bot(ContextInstanceMixin["Bot"]):
:param can_delete_messages: Pass :code:`True` if the administrator can delete messages of other users
:param can_manage_video_chats: Pass :code:`True` if the administrator can manage video chats
:param can_restrict_members: Pass :code:`True` if the administrator can restrict, ban or unban chat members
- :param can_promote_members: Pass :code:`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_promote_members: Pass :code:`True` if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by him)
:param can_change_info: Pass :code:`True` if the administrator can change chat title, photo and other settings
:param can_invite_users: Pass :code:`True` if the administrator can invite new users to the chat
:param can_pin_messages: Pass :code:`True` if the administrator can pin messages, supergroups only
@@ -1806,6 +1925,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights, unless it is the creator of the topic. Returns :code:`True` on success.
+ Source: https://core.telegram.org/bots/api#reopenforumtopic
+
:param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)
:param message_thread_id: Unique identifier for the target message thread of the forum topic
:param request_timeout: Request timeout
@@ -1823,15 +1944,19 @@ class Bot(ContextInstanceMixin["Bot"]):
chat_id: Union[int, str],
user_id: int,
permissions: ChatPermissions,
+ use_independent_chat_permissions: Optional[bool] = None,
until_date: Optional[Union[datetime.datetime, datetime.timedelta, int]] = None,
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 administrator rights. Pass :code:`True` for all permissions to lift restrictions from a user. Returns :code:`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 :code:`@supergroupusername`)
:param user_id: Unique identifier of the target user
:param permissions: A JSON-serialized object for new user permissions
+ :param use_independent_chat_permissions: Pass :code:`True` if chat permissions are set independently. Otherwise, the *can_send_other_messages* and *can_add_web_page_previews* permissions will imply the *can_send_messages*, *can_send_audios*, *can_send_documents*, *can_send_photos*, *can_send_videos*, *can_send_video_notes*, and *can_send_voice_notes* permissions; the *can_send_polls* permission will imply the *can_send_messages* permission.
: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 :code:`True` on success.
@@ -1841,6 +1966,7 @@ class Bot(ContextInstanceMixin["Bot"]):
chat_id=chat_id,
user_id=user_id,
permissions=permissions,
+ use_independent_chat_permissions=use_independent_chat_permissions,
until_date=until_date,
)
return await self(call, request_timeout=request_timeout)
@@ -1854,6 +1980,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as :class:`aiogram.types.chat_invite_link.ChatInviteLink` object.
+ Source: https://core.telegram.org/bots/api#revokechatinvitelink
+
:param chat_id: Unique identifier of the target chat or username of the target channel (in the format :code:`@channelusername`)
:param invite_link: The invite link to revoke
:param request_timeout: Request timeout
@@ -1874,12 +2002,13 @@ class Bot(ContextInstanceMixin["Bot"]):
duration: Optional[int] = None,
width: Optional[int] = None,
height: Optional[int] = None,
- thumb: Optional[Union[InputFile, str]] = None,
+ thumbnail: Optional[Union[InputFile, str]] = None,
caption: Optional[str] = None,
- parse_mode: Optional[str] = UNSET,
+ parse_mode: Optional[str] = UNSET_PARSE_MODE,
caption_entities: Optional[List[MessageEntity]] = None,
+ has_spoiler: Optional[bool] = None,
disable_notification: Optional[bool] = None,
- protect_content: Optional[bool] = None,
+ protect_content: Optional[bool] = UNSET_PROTECT_CONTENT,
reply_to_message_id: Optional[int] = None,
allow_sending_without_reply: Optional[bool] = None,
reply_markup: Optional[
@@ -1890,16 +2019,19 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent :class:`aiogram.types.message.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 :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. :ref:`More information on Sending Files » `
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
: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 . :ref:`More information on Sending Files » `
+ :param thumbnail: 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 . :ref:`More information 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: A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse_mode*
+ :param has_spoiler: Pass :code:`True` if the animation needs to be covered with a spoiler animation
:param disable_notification: Sends the message `silently `_. Users will receive a notification with no sound.
:param protect_content: Protects the contents of the sent message from forwarding and saving
:param reply_to_message_id: If the message is a reply, ID of the original message
@@ -1916,10 +2048,11 @@ class Bot(ContextInstanceMixin["Bot"]):
duration=duration,
width=width,
height=height,
- thumb=thumb,
+ thumbnail=thumbnail,
caption=caption,
parse_mode=parse_mode,
caption_entities=caption_entities,
+ has_spoiler=has_spoiler,
disable_notification=disable_notification,
protect_content=protect_content,
reply_to_message_id=reply_to_message_id,
@@ -1934,14 +2067,14 @@ class Bot(ContextInstanceMixin["Bot"]):
audio: Union[InputFile, str],
message_thread_id: Optional[int] = None,
caption: Optional[str] = None,
- parse_mode: Optional[str] = UNSET,
+ parse_mode: Optional[str] = UNSET_PARSE_MODE,
caption_entities: Optional[List[MessageEntity]] = None,
duration: Optional[int] = None,
performer: Optional[str] = None,
title: Optional[str] = None,
- thumb: Optional[Union[InputFile, str]] = None,
+ thumbnail: Optional[Union[InputFile, str]] = None,
disable_notification: Optional[bool] = None,
- protect_content: Optional[bool] = None,
+ protect_content: Optional[bool] = UNSET_PROTECT_CONTENT,
reply_to_message_id: Optional[int] = None,
allow_sending_without_reply: Optional[bool] = None,
reply_markup: Optional[
@@ -1953,6 +2086,8 @@ class Bot(ContextInstanceMixin["Bot"]):
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 :class:`aiogram.types.message.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 :class:`aiogram.methods.send_voice.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 :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. :ref:`More information on Sending Files » `
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
@@ -1962,7 +2097,7 @@ class Bot(ContextInstanceMixin["Bot"]):
: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 . :ref:`More information on Sending Files » `
+ :param thumbnail: 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 . :ref:`More information on Sending Files » `
:param disable_notification: Sends the message `silently `_. Users will receive a notification with no sound.
:param protect_content: Protects the contents of the sent message from forwarding and saving
:param reply_to_message_id: If the message is a reply, ID of the original message
@@ -1982,7 +2117,7 @@ class Bot(ContextInstanceMixin["Bot"]):
duration=duration,
performer=performer,
title=title,
- thumb=thumb,
+ thumbnail=thumbnail,
disable_notification=disable_notification,
protect_content=protect_content,
reply_to_message_id=reply_to_message_id,
@@ -1995,6 +2130,7 @@ class Bot(ContextInstanceMixin["Bot"]):
self,
chat_id: Union[int, str],
action: str,
+ message_thread_id: Optional[int] = None,
request_timeout: Optional[int] = None,
) -> bool:
"""
@@ -2004,8 +2140,11 @@ class Bot(ContextInstanceMixin["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 :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 `_, *choose_sticker* for `stickers `_, *find_location* for `location data `_, *record_video_note* or *upload_video_note* for `video notes `_.
+ :param message_thread_id: Unique identifier for the target message thread; supergroups only
:param request_timeout: Request timeout
:return: The user will see a 'sending photo' status for the bot.
"""
@@ -2013,6 +2152,7 @@ class Bot(ContextInstanceMixin["Bot"]):
call = SendChatAction(
chat_id=chat_id,
action=action,
+ message_thread_id=message_thread_id,
)
return await self(call, request_timeout=request_timeout)
@@ -2025,7 +2165,7 @@ class Bot(ContextInstanceMixin["Bot"]):
last_name: Optional[str] = None,
vcard: Optional[str] = None,
disable_notification: Optional[bool] = None,
- protect_content: Optional[bool] = None,
+ protect_content: Optional[bool] = UNSET_PROTECT_CONTENT,
reply_to_message_id: Optional[int] = None,
allow_sending_without_reply: Optional[bool] = None,
reply_markup: Optional[
@@ -2036,6 +2176,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to send phone contacts. On success, the sent :class:`aiogram.types.message.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 :code:`@channelusername`)
:param phone_number: Contact's phone number
:param first_name: Contact's first name
@@ -2072,7 +2214,7 @@ class Bot(ContextInstanceMixin["Bot"]):
message_thread_id: Optional[int] = None,
emoji: Optional[str] = None,
disable_notification: Optional[bool] = None,
- protect_content: Optional[bool] = None,
+ protect_content: Optional[bool] = UNSET_PROTECT_CONTENT,
reply_to_message_id: Optional[int] = None,
allow_sending_without_reply: Optional[bool] = None,
reply_markup: Optional[
@@ -2083,6 +2225,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to send an animated emoji that will display a random value. On success, the sent :class:`aiogram.types.message.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 :code:`@channelusername`)
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
: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 '🎲'
@@ -2112,13 +2256,13 @@ class Bot(ContextInstanceMixin["Bot"]):
chat_id: Union[int, str],
document: Union[InputFile, str],
message_thread_id: Optional[int] = None,
- thumb: Optional[Union[InputFile, str]] = None,
+ thumbnail: Optional[Union[InputFile, str]] = None,
caption: Optional[str] = None,
- parse_mode: Optional[str] = UNSET,
+ parse_mode: Optional[str] = UNSET_PARSE_MODE,
caption_entities: Optional[List[MessageEntity]] = None,
disable_content_type_detection: Optional[bool] = None,
disable_notification: Optional[bool] = None,
- protect_content: Optional[bool] = None,
+ protect_content: Optional[bool] = UNSET_PROTECT_CONTENT,
reply_to_message_id: Optional[int] = None,
allow_sending_without_reply: Optional[bool] = None,
reply_markup: Optional[
@@ -2129,10 +2273,12 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to send general files. On success, the sent :class:`aiogram.types.message.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 :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. :ref:`More information on Sending Files » `
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
- :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 . :ref:`More information on Sending Files » `
+ :param thumbnail: 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 . :ref:`More information 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: A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse_mode*
@@ -2150,7 +2296,7 @@ class Bot(ContextInstanceMixin["Bot"]):
chat_id=chat_id,
document=document,
message_thread_id=message_thread_id,
- thumb=thumb,
+ thumbnail=thumbnail,
caption=caption,
parse_mode=parse_mode,
caption_entities=caption_entities,
@@ -2169,7 +2315,7 @@ class Bot(ContextInstanceMixin["Bot"]):
game_short_name: str,
message_thread_id: Optional[int] = None,
disable_notification: Optional[bool] = None,
- protect_content: Optional[bool] = None,
+ protect_content: Optional[bool] = UNSET_PROTECT_CONTENT,
reply_to_message_id: Optional[int] = None,
allow_sending_without_reply: Optional[bool] = None,
reply_markup: Optional[InlineKeyboardMarkup] = None,
@@ -2178,6 +2324,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to send a game. On success, the sent :class:`aiogram.types.message.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 message_thread_id: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
@@ -2228,7 +2376,7 @@ class Bot(ContextInstanceMixin["Bot"]):
send_email_to_provider: Optional[bool] = None,
is_flexible: Optional[bool] = None,
disable_notification: Optional[bool] = None,
- protect_content: Optional[bool] = None,
+ protect_content: Optional[bool] = UNSET_PROTECT_CONTENT,
reply_to_message_id: Optional[int] = None,
allow_sending_without_reply: Optional[bool] = None,
reply_markup: Optional[InlineKeyboardMarkup] = None,
@@ -2237,6 +2385,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to send invoices. On success, the sent :class:`aiogram.types.message.Message` is returned.
+ Source: https://core.telegram.org/bots/api#sendinvoice
+
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param title: Product name, 1-32 characters
:param description: Product description, 1-255 characters
@@ -2312,7 +2462,7 @@ class Bot(ContextInstanceMixin["Bot"]):
heading: Optional[int] = None,
proximity_alert_radius: Optional[int] = None,
disable_notification: Optional[bool] = None,
- protect_content: Optional[bool] = None,
+ protect_content: Optional[bool] = UNSET_PROTECT_CONTENT,
reply_to_message_id: Optional[int] = None,
allow_sending_without_reply: Optional[bool] = None,
reply_markup: Optional[
@@ -2323,6 +2473,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to send point on the map. On success, the sent :class:`aiogram.types.message.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 :code:`@channelusername`)
:param latitude: Latitude of the location
:param longitude: Longitude of the location
@@ -2363,7 +2515,7 @@ class Bot(ContextInstanceMixin["Bot"]):
media: List[Union[InputMediaAudio, InputMediaDocument, InputMediaPhoto, InputMediaVideo]],
message_thread_id: Optional[int] = None,
disable_notification: Optional[bool] = None,
- protect_content: Optional[bool] = None,
+ protect_content: Optional[bool] = UNSET_PROTECT_CONTENT,
reply_to_message_id: Optional[int] = None,
allow_sending_without_reply: Optional[bool] = None,
request_timeout: Optional[int] = None,
@@ -2371,6 +2523,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
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 :code:`@channelusername`)
:param media: A JSON-serialized array describing messages to be sent, must include 2-10 items
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
@@ -2398,11 +2552,11 @@ class Bot(ContextInstanceMixin["Bot"]):
chat_id: Union[int, str],
text: str,
message_thread_id: Optional[int] = None,
- parse_mode: Optional[str] = UNSET,
+ parse_mode: Optional[str] = UNSET_PARSE_MODE,
entities: Optional[List[MessageEntity]] = None,
- disable_web_page_preview: Optional[bool] = None,
+ disable_web_page_preview: Optional[bool] = UNSET_DISABLE_WEB_PAGE_PREVIEW,
disable_notification: Optional[bool] = None,
- protect_content: Optional[bool] = None,
+ protect_content: Optional[bool] = UNSET_PROTECT_CONTENT,
reply_to_message_id: Optional[int] = None,
allow_sending_without_reply: Optional[bool] = None,
reply_markup: Optional[
@@ -2413,6 +2567,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to send text messages. On success, the sent :class:`aiogram.types.message.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 :code:`@channelusername`)
:param text: Text of the message to be sent, 1-4096 characters after entities parsing
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
@@ -2449,10 +2605,11 @@ class Bot(ContextInstanceMixin["Bot"]):
photo: Union[InputFile, str],
message_thread_id: Optional[int] = None,
caption: Optional[str] = None,
- parse_mode: Optional[str] = UNSET,
+ parse_mode: Optional[str] = UNSET_PARSE_MODE,
caption_entities: Optional[List[MessageEntity]] = None,
+ has_spoiler: Optional[bool] = None,
disable_notification: Optional[bool] = None,
- protect_content: Optional[bool] = None,
+ protect_content: Optional[bool] = UNSET_PROTECT_CONTENT,
reply_to_message_id: Optional[int] = None,
allow_sending_without_reply: Optional[bool] = None,
reply_markup: Optional[
@@ -2463,12 +2620,15 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to send photos. On success, the sent :class:`aiogram.types.message.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 :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. :ref:`More information on Sending Files » `
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
: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: A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse_mode*
+ :param has_spoiler: Pass :code:`True` if the photo needs to be covered with a spoiler animation
:param disable_notification: Sends the message `silently `_. Users will receive a notification with no sound.
:param protect_content: Protects the contents of the sent message from forwarding and saving
:param reply_to_message_id: If the message is a reply, ID of the original message
@@ -2485,6 +2645,7 @@ class Bot(ContextInstanceMixin["Bot"]):
caption=caption,
parse_mode=parse_mode,
caption_entities=caption_entities,
+ has_spoiler=has_spoiler,
disable_notification=disable_notification,
protect_content=protect_content,
reply_to_message_id=reply_to_message_id,
@@ -2504,13 +2665,13 @@ class Bot(ContextInstanceMixin["Bot"]):
allows_multiple_answers: Optional[bool] = None,
correct_option_id: Optional[int] = None,
explanation: Optional[str] = None,
- explanation_parse_mode: Optional[str] = UNSET,
+ explanation_parse_mode: Optional[str] = UNSET_PARSE_MODE,
explanation_entities: Optional[List[MessageEntity]] = None,
open_period: Optional[int] = None,
close_date: Optional[Union[datetime.datetime, datetime.timedelta, int]] = None,
is_closed: Optional[bool] = None,
disable_notification: Optional[bool] = None,
- protect_content: Optional[bool] = None,
+ protect_content: Optional[bool] = UNSET_PROTECT_CONTENT,
reply_to_message_id: Optional[int] = None,
allow_sending_without_reply: Optional[bool] = None,
reply_markup: Optional[
@@ -2521,6 +2682,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to send a native poll. On success, the sent :class:`aiogram.types.message.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 :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
@@ -2572,8 +2735,9 @@ class Bot(ContextInstanceMixin["Bot"]):
chat_id: Union[int, str],
sticker: Union[InputFile, str],
message_thread_id: Optional[int] = None,
+ emoji: Optional[str] = None,
disable_notification: Optional[bool] = None,
- protect_content: Optional[bool] = None,
+ protect_content: Optional[bool] = UNSET_PROTECT_CONTENT,
reply_to_message_id: Optional[int] = None,
allow_sending_without_reply: Optional[bool] = None,
reply_markup: Optional[
@@ -2584,9 +2748,12 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to send static .WEBP, `animated `_ .TGS, or `video `_ .WEBM stickers. On success, the sent :class:`aiogram.types.message.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 :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. :ref:`More information on Sending Files » `
+ :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 sticker from the Internet, or upload a new .WEBP or .TGS sticker using multipart/form-data. :ref:`More information on Sending Files » `. Video stickers can only be sent by a file_id. Animated stickers can't be sent via an HTTP URL.
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
+ :param emoji: Emoji associated with the sticker; only for just uploaded stickers
:param disable_notification: Sends the message `silently `_. Users will receive a notification with no sound.
:param protect_content: Protects the contents of the sent message from forwarding and saving
:param reply_to_message_id: If the message is a reply, ID of the original message
@@ -2600,6 +2767,7 @@ class Bot(ContextInstanceMixin["Bot"]):
chat_id=chat_id,
sticker=sticker,
message_thread_id=message_thread_id,
+ emoji=emoji,
disable_notification=disable_notification,
protect_content=protect_content,
reply_to_message_id=reply_to_message_id,
@@ -2621,7 +2789,7 @@ class Bot(ContextInstanceMixin["Bot"]):
google_place_id: Optional[str] = None,
google_place_type: Optional[str] = None,
disable_notification: Optional[bool] = None,
- protect_content: Optional[bool] = None,
+ protect_content: Optional[bool] = UNSET_PROTECT_CONTENT,
reply_to_message_id: Optional[int] = None,
allow_sending_without_reply: Optional[bool] = None,
reply_markup: Optional[
@@ -2632,6 +2800,8 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to send information about a venue. On success, the sent :class:`aiogram.types.message.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 :code:`@channelusername`)
:param latitude: Latitude of the venue
:param longitude: Longitude of the venue
@@ -2678,13 +2848,14 @@ class Bot(ContextInstanceMixin["Bot"]):
duration: Optional[int] = None,
width: Optional[int] = None,
height: Optional[int] = None,
- thumb: Optional[Union[InputFile, str]] = None,
+ thumbnail: Optional[Union[InputFile, str]] = None,
caption: Optional[str] = None,
- parse_mode: Optional[str] = UNSET,
+ parse_mode: Optional[str] = UNSET_PARSE_MODE,
caption_entities: Optional[List[MessageEntity]] = None,
+ has_spoiler: Optional[bool] = None,
supports_streaming: Optional[bool] = None,
disable_notification: Optional[bool] = None,
- protect_content: Optional[bool] = None,
+ protect_content: Optional[bool] = UNSET_PROTECT_CONTENT,
reply_to_message_id: Optional[int] = None,
allow_sending_without_reply: Optional[bool] = None,
reply_markup: Optional[
@@ -2695,16 +2866,19 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as :class:`aiogram.types.document.Document`). On success, the sent :class:`aiogram.types.message.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 :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. :ref:`More information on Sending Files » `
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
: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 . :ref:`More information on Sending Files » `
+ :param thumbnail: 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 . :ref:`More information 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: A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse_mode*
+ :param has_spoiler: Pass :code:`True` if the video needs to be covered with a spoiler animation
:param supports_streaming: Pass :code:`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 protect_content: Protects the contents of the sent message from forwarding and saving
@@ -2722,10 +2896,11 @@ class Bot(ContextInstanceMixin["Bot"]):
duration=duration,
width=width,
height=height,
- thumb=thumb,
+ thumbnail=thumbnail,
caption=caption,
parse_mode=parse_mode,
caption_entities=caption_entities,
+ has_spoiler=has_spoiler,
supports_streaming=supports_streaming,
disable_notification=disable_notification,
protect_content=protect_content,
@@ -2742,9 +2917,9 @@ class Bot(ContextInstanceMixin["Bot"]):
message_thread_id: Optional[int] = None,
duration: Optional[int] = None,
length: Optional[int] = None,
- thumb: Optional[Union[InputFile, str]] = None,
+ thumbnail: Optional[Union[InputFile, str]] = None,
disable_notification: Optional[bool] = None,
- protect_content: Optional[bool] = None,
+ protect_content: Optional[bool] = UNSET_PROTECT_CONTENT,
reply_to_message_id: Optional[int] = None,
allow_sending_without_reply: Optional[bool] = None,
reply_markup: Optional[
@@ -2755,12 +2930,14 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
As of `v.4.0 `_, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent :class:`aiogram.types.message.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 :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. :ref:`More information on Sending Files » `. Sending video notes by a URL is currently unsupported
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
: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 . :ref:`More information on Sending Files » `
+ :param thumbnail: 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 . :ref:`More information on Sending Files » `
:param disable_notification: Sends the message `silently