python/aiogram
1
0
Fork 0
mirror of https://github.com/aiogram/aiogram.git synced 2025-12-06 16:15:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Full support of Bot API 7.3 (#1480)

Browse source 
* Added full support of Bot API

* Added full support of Bot API

* Fixed tests

* Added changelog

* Bump version
This commit is contained in:
Alex Root Junior 2024-05-06 23:27:54 +03:00 • committed by GitHub
parent 6d655330af
commit cf2980a9c1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
137 changed files with 3422 additions and 929 deletions
Download patch file Download diff file Expand all files Collapse all files

2
.apiversion
View file

@ -1 +1 @@
7.2
7.3

6
.butcher/methods/copyMessage/entity.json
View file

@ -94,9 +94,9 @@
{
"type": "InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
"required": false,
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.",
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove reply keyboard or to force a reply from the user.</td>",
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove reply keyboard or to force a reply from the user.\n",
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
"name": "reply_markup"
},
{

8
.butcher/methods/editMessageLiveLocation/entity.json
View file

@ -51,6 +51,14 @@
"rst_description": "Longitude of new location\n",
"name": "longitude"
},
{
"type": "Integer",
"required": false,
"description": "New period in seconds during which the location can be updated, starting from the message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the new value must not exceed the current live_period by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, then live_period remains unchanged",
"html_description": "<td>New period in seconds during which the location can be updated, starting from the message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the new value must not exceed the current <em>live_period</em> by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, then <em>live_period</em> remains unchanged</td>",
"rst_description": "New period in seconds during which the location can be updated, starting from the message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the new value must not exceed the current *live_period* by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, then *live_period* remains unchanged\n",
"name": "live_period"
},
{
"type": "Float",
"required": false,

6
.butcher/methods/getChat/entity.json
View file

@ -7,9 +7,9 @@
"object": {
"anchor": "getchat",
"name": "getChat",
"description": "Use this method to get up to date information about the chat. Returns a Chat object on success.",
"html_description": "<p>Use this method to get up to date information about the chat. Returns a <a href=\"#chat\">Chat</a> object on success.</p>",
"rst_description": "Use this method to get up to date information about the chat. Returns a :class:`aiogram.types.chat.Chat` object on success.",
"description": "Use this method to get up-to-date information about the chat. Returns a ChatFullInfo object on success.",
"html_description": "<p>Use this method to get up-to-date information about the chat. Returns a <a href=\"#chatfullinfo\">ChatFullInfo</a> object on success.</p>",
"rst_description": "Use this method to get up-to-date information about the chat. Returns a :class:`aiogram.types.chat_full_info.ChatFullInfo` object on success.",
"annotations": [
{
"type": "Integer or String",

6
.butcher/methods/promoteChatMember/entity.json
View file

@ -102,9 +102,9 @@
{
"type": "Boolean",
"required": false,
"description": "Pass True if the administrator can edit stories posted by other users",
"html_description": "<td>Pass <em>True</em> if the administrator can edit stories posted by other users</td>",
"rst_description": "Pass :code:`True` if the administrator can edit stories posted by other users\n",
"description": "Pass True if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive",
"html_description": "<td>Pass <em>True</em> if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive</td>",
"rst_description": "Pass :code:`True` if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive\n",
"name": "can_edit_stories"
},
{

6
.butcher/methods/sendAnimation/entity.json
View file

@ -134,9 +134,9 @@
{
"type": "InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
"required": false,
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account",
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account</td>",
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account\n",
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
"name": "reply_markup"
},
{

6
.butcher/methods/sendAudio/entity.json
View file

@ -126,9 +126,9 @@
{
"type": "InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
"required": false,
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account",
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account</td>",
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account\n",
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
"name": "reply_markup"
},
{

6
.butcher/methods/sendContact/entity.json
View file

@ -94,9 +94,9 @@
{
"type": "InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
"required": false,
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account",
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account</td>",
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account\n",
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
"name": "reply_markup"
},
{

6
.butcher/methods/sendDice/entity.json
View file

@ -70,9 +70,9 @@
{
"type": "InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
"required": false,
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account",
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account</td>",
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account\n",
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
"name": "reply_markup"
},
{

6
.butcher/methods/sendDocument/entity.json
View file

@ -110,9 +110,9 @@
{
"type": "InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
"required": false,
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account",
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account</td>",
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account\n",
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
"name": "reply_markup"
},
{

6
.butcher/methods/sendGame/entity.json
View file

@ -70,9 +70,9 @@
{
"type": "InlineKeyboardMarkup",
"required": false,
"description": "A JSON-serialized object for an inline keyboard. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game. Not supported for messages sent on behalf of a business account.",
"html_description": "<td>A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game. Not supported for messages sent on behalf of a business account.</td>",
"rst_description": "A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game. Not supported for messages sent on behalf of a business account.\n",
"description": "A JSON-serialized object for an inline keyboard. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game.",
"html_description": "<td>A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game.</td>",
"rst_description": "A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game.\n",
"name": "reply_markup"
},
{

12
.butcher/methods/sendLocation/entity.json
View file

@ -62,9 +62,9 @@
{
"type": "Integer",
"required": false,
"description": "Period in seconds for which the location will be updated (see Live Locations, should be between 60 and 86400.",
"html_description": "<td>Period in seconds for which the location will be updated (see <a href=\"https://telegram.org/blog/live-locations\">Live Locations</a>, should be between 60 and 86400.</td>",
"rst_description": "Period in seconds for which the location will be updated (see `Live Locations <https://telegram.org/blog/live-locations>`_, should be between 60 and 86400.\n",
"description": "Period in seconds during which the location will be updated (see Live Locations, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.",
"html_description": "<td>Period in seconds during which the location will be updated (see <a href=\"https://telegram.org/blog/live-locations\">Live Locations</a>, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.</td>",
"rst_description": "Period in seconds during which the location will be updated (see `Live Locations <https://telegram.org/blog/live-locations>`_, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.\n",
"name": "live_period"
},
{
@ -110,9 +110,9 @@
{
"type": "InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
"required": false,
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account",
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account</td>",
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account\n",
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
"name": "reply_markup"
},
{

6
.butcher/methods/sendMessage/entity.json
View file

@ -94,9 +94,9 @@
{
"type": "InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
"required": false,
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account",
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account</td>",
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account\n",
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
"name": "reply_markup"
},
{

6
.butcher/methods/sendPhoto/entity.json
View file

@ -102,9 +102,9 @@
{
"type": "InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
"required": false,
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account",
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account</td>",
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account\n",
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
"name": "reply_markup"
},
{

1
.butcher/methods/sendPoll/default.yml
View file

@ -1,2 +1,3 @@
explanation_parse_mode: parse_mode
question_parse_mode: parse_mode
protect_content: protect_content

36
.butcher/methods/sendPoll/entity.json
View file

@ -44,11 +44,27 @@
"name": "question"
},
{
"type": "Array of String",
"type": "String",
"required": false,
"description": "Mode for parsing entities in the question. See formatting options for more details. Currently, only custom emoji entities are allowed",
"html_description": "<td>Mode for parsing entities in the question. See <a href=\"#formatting-options\">formatting options</a> for more details. Currently, only custom emoji entities are allowed</td>",
"rst_description": "Mode for parsing entities in the question. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details. Currently, only custom emoji entities are allowed\n",
"name": "question_parse_mode"
},
{
"type": "Array of MessageEntity",
"required": false,
"description": "A JSON-serialized list of special entities that appear in the poll question. It can be specified instead of question_parse_mode",
"html_description": "<td>A JSON-serialized list of special entities that appear in the poll question. It can be specified instead of <em>question_parse_mode</em></td>",
"rst_description": "A JSON-serialized list of special entities that appear in the poll question. It can be specified instead of *question_parse_mode*\n",
"name": "question_entities"
},
{
"type": "Array of InputPollOption",
"required": true,
"description": "A JSON-serialized list of answer options, 2-10 strings 1-100 characters each",
"html_description": "<td>A JSON-serialized list of answer options, 2-10 strings 1-100 characters each</td>",
"rst_description": "A JSON-serialized list of answer options, 2-10 strings 1-100 characters each\n",
"description": "A JSON-serialized list of 2-10 answer options",
"html_description": "<td>A JSON-serialized list of 2-10 answer options</td>",
"rst_description": "A JSON-serialized list of 2-10 answer options\n",
"name": "options"
},
{
@ -102,9 +118,9 @@
{
"type": "Array of MessageEntity",
"required": false,
"description": "A JSON-serialized list of special entities that appear in the poll explanation, which can be specified instead of parse_mode",
"html_description": "<td>A JSON-serialized list of special entities that appear in the poll explanation, which can be specified instead of <em>parse_mode</em></td>",
"rst_description": "A JSON-serialized list of special entities that appear in the poll explanation, which can be specified instead of *parse_mode*\n",
"description": "A JSON-serialized list of special entities that appear in the poll explanation. It can be specified instead of explanation_parse_mode",
"html_description": "<td>A JSON-serialized list of special entities that appear in the poll explanation. It can be specified instead of <em>explanation_parse_mode</em></td>",
"rst_description": "A JSON-serialized list of special entities that appear in the poll explanation. It can be specified instead of *explanation_parse_mode*\n",
"name": "explanation_entities"
},
{
@ -158,9 +174,9 @@
{
"type": "InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
"required": false,
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account",
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account</td>",
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account\n",
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
"name": "reply_markup"
},
{

12
.butcher/methods/sendPoll/replace.yml
View file

@ -9,3 +9,15 @@ annotations:
name: datetime.timedelta
- type: std
name: int
options:
parsed_type:
type: array
items:
type: union
items:
- type: entity
references:
category: types
name: InputPollOption
- type: std
name: str

6
.butcher/methods/sendSticker/entity.json
View file

@ -78,9 +78,9 @@
{
"type": "InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
"required": false,
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account.",
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account.</td>",
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account.\n",
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
"name": "reply_markup"
},
{

6
.butcher/methods/sendVenue/entity.json
View file

@ -126,9 +126,9 @@
{
"type": "InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
"required": false,
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account",
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account</td>",
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account\n",
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
"name": "reply_markup"
},
{

6
.butcher/methods/sendVideo/entity.json
View file

@ -142,9 +142,9 @@
{
"type": "InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
"required": false,
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account",
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account</td>",
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account\n",
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
"name": "reply_markup"
},
{

6
.butcher/methods/sendVideoNote/entity.json
View file

@ -94,9 +94,9 @@
{
"type": "InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
"required": false,
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account",
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account</td>",
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account\n",
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
"name": "reply_markup"
},
{

12
.butcher/methods/sendVoice/entity.json
View file

@ -7,9 +7,9 @@
"object": {
"anchor": "sendvoice",
"name": "sendVoice",
"description": "Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.",
"html_description": "<p>Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as <a href=\"#audio\">Audio</a> or <a href=\"#document\">Document</a>). On success, the sent <a href=\"#message\">Message</a> is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.</p>",
"rst_description": "Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as :class:`aiogram.types.audio.Audio` or :class:`aiogram.types.document.Document`). On success, the sent :class:`aiogram.types.message.Message` is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.",
"description": "Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.",
"html_description": "<p>Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other formats may be sent as <a href=\"#audio\">Audio</a> or <a href=\"#document\">Document</a>). On success, the sent <a href=\"#message\">Message</a> is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.</p>",
"rst_description": "Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other formats may be sent as :class:`aiogram.types.audio.Audio` or :class:`aiogram.types.document.Document`). On success, the sent :class:`aiogram.types.message.Message` is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.",
"annotations": [
{
"type": "String",
@ -102,9 +102,9 @@
{
"type": "InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
"required": false,
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account",
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account</td>",
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account\n",
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
"name": "reply_markup"
},
{

964
.butcher/schema/schema.json
View file

File diff suppressed because it is too large Load diff

16
.butcher/types/BackgroundFill/entity.json Normal file
View file

@ -0,0 +1,16 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "backgroundfill",
"name": "BackgroundFill",
"description": "This object describes the way a background is filled based on the selected colors. Currently, it can be one of\n - BackgroundFillSolid\n - BackgroundFillGradient\n - BackgroundFillFreeformGradient",
"html_description": "<p>This object describes the way a background is filled based on the selected colors. Currently, it can be one of</p><ul>\n<li><a href=\"#backgroundfillsolid\">BackgroundFillSolid</a></li>\n<li><a href=\"#backgroundfillgradient\">BackgroundFillGradient</a></li>\n<li><a href=\"#backgroundfillfreeformgradient\">BackgroundFillFreeformGradient</a></li>\n</ul>",
"rst_description": "This object describes the way a background is filled based on the selected colors. Currently, it can be one of\n\n - :class:`aiogram.types.background_fill_solid.BackgroundFillSolid`\n - :class:`aiogram.types.background_fill_gradient.BackgroundFillGradient`\n - :class:`aiogram.types.background_fill_freeform_gradient.BackgroundFillFreeformGradient`",
"annotations": [],
"category": "types"
}
}

1
.butcher/types/BackgroundFill/subtypes.yml Normal file
View file

@ -0,0 +1 @@
discriminator: "type"

33
.butcher/types/BackgroundFillFreeformGradient/entity.json Normal file
View file

@ -0,0 +1,33 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "backgroundfillfreeformgradient",
"name": "BackgroundFillFreeformGradient",
"description": "The background is a freeform gradient that rotates after every message in the chat.",
"html_description": "<p>The background is a freeform gradient that rotates after every message in the chat.</p>",
"rst_description": "The background is a freeform gradient that rotates after every message in the chat.",
"annotations": [
{
"type": "String",
"description": "Type of the background fill, always 'freeform_gradient'",
"html_description": "<td>Type of the background fill, always &#8220;freeform_gradient&#8221;</td>",
"rst_description": "Type of the background fill, always 'freeform_gradient'\n",
"name": "type",
"required": true
},
{
"type": "Array of Integer",
"description": "A list of the 3 or 4 base colors that are used to generate the freeform gradient in the RGB24 format",
"html_description": "<td>A list of the 3 or 4 base colors that are used to generate the freeform gradient in the RGB24 format</td>",
"rst_description": "A list of the 3 or 4 base colors that are used to generate the freeform gradient in the RGB24 format\n",
"name": "colors",
"required": true
}
],
"category": "types"
}
}

49
.butcher/types/BackgroundFillGradient/entity.json Normal file
View file

@ -0,0 +1,49 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "backgroundfillgradient",
"name": "BackgroundFillGradient",
"description": "The background is a gradient fill.",
"html_description": "<p>The background is a gradient fill.</p>",
"rst_description": "The background is a gradient fill.",
"annotations": [
{
"type": "String",
"description": "Type of the background fill, always 'gradient'",
"html_description": "<td>Type of the background fill, always &#8220;gradient&#8221;</td>",
"rst_description": "Type of the background fill, always 'gradient'\n",
"name": "type",
"required": true
},
{
"type": "Integer",
"description": "Top color of the gradient in the RGB24 format",
"html_description": "<td>Top color of the gradient in the RGB24 format</td>",
"rst_description": "Top color of the gradient in the RGB24 format\n",
"name": "top_color",
"required": true
},
{
"type": "Integer",
"description": "Bottom color of the gradient in the RGB24 format",
"html_description": "<td>Bottom color of the gradient in the RGB24 format</td>",
"rst_description": "Bottom color of the gradient in the RGB24 format\n",
"name": "bottom_color",
"required": true
},
{
"type": "Integer",
"description": "Clockwise rotation angle of the background fill in degrees; 0-359",
"html_description": "<td>Clockwise rotation angle of the background fill in degrees; 0-359</td>",
"rst_description": "Clockwise rotation angle of the background fill in degrees; 0-359\n",
"name": "rotation_angle",
"required": true
}
],
"category": "types"
}
}

33
.butcher/types/BackgroundFillSolid/entity.json Normal file
View file

@ -0,0 +1,33 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "backgroundfillsolid",
"name": "BackgroundFillSolid",
"description": "The background is filled using the selected color.",
"html_description": "<p>The background is filled using the selected color.</p>",
"rst_description": "The background is filled using the selected color.",
"annotations": [
{
"type": "String",
"description": "Type of the background fill, always 'solid'",
"html_description": "<td>Type of the background fill, always &#8220;solid&#8221;</td>",
"rst_description": "Type of the background fill, always 'solid'\n",
"name": "type",
"required": true
},
{
"type": "Integer",
"description": "The color of the background fill in the RGB24 format",
"html_description": "<td>The color of the background fill in the RGB24 format</td>",
"rst_description": "The color of the background fill in the RGB24 format\n",
"name": "color",
"required": true
}
],
"category": "types"
}
}

16
.butcher/types/BackgroundType/entity.json Normal file
View file

@ -0,0 +1,16 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "backgroundtype",
"name": "BackgroundType",
"description": "This object describes the type of a background. Currently, it can be one of\n - BackgroundTypeFill\n - BackgroundTypeWallpaper\n - BackgroundTypePattern\n - BackgroundTypeChatTheme",
"html_description": "<p>This object describes the type of a background. Currently, it can be one of</p><ul>\n<li><a href=\"#backgroundtypefill\">BackgroundTypeFill</a></li>\n<li><a href=\"#backgroundtypewallpaper\">BackgroundTypeWallpaper</a></li>\n<li><a href=\"#backgroundtypepattern\">BackgroundTypePattern</a></li>\n<li><a href=\"#backgroundtypechattheme\">BackgroundTypeChatTheme</a></li>\n</ul>",
"rst_description": "This object describes the type of a background. Currently, it can be one of\n\n - :class:`aiogram.types.background_type_fill.BackgroundTypeFill`\n - :class:`aiogram.types.background_type_wallpaper.BackgroundTypeWallpaper`\n - :class:`aiogram.types.background_type_pattern.BackgroundTypePattern`\n - :class:`aiogram.types.background_type_chat_theme.BackgroundTypeChatTheme`",
"annotations": [],
"category": "types"
}
}

1
.butcher/types/BackgroundType/subtypes.yml Normal file
View file

@ -0,0 +1 @@
discriminator: "type"

33
.butcher/types/BackgroundTypeChatTheme/entity.json Normal file
View file

@ -0,0 +1,33 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "backgroundtypechattheme",
"name": "BackgroundTypeChatTheme",
"description": "The background is taken directly from a built-in chat theme.",
"html_description": "<p>The background is taken directly from a built-in chat theme.</p>",
"rst_description": "The background is taken directly from a built-in chat theme.",
"annotations": [
{
"type": "String",
"description": "Type of the background, always 'chat_theme'",
"html_description": "<td>Type of the background, always &#8220;chat_theme&#8221;</td>",
"rst_description": "Type of the background, always 'chat_theme'\n",
"name": "type",
"required": true
},
{
"type": "String",
"description": "Name of the chat theme, which is usually an emoji",
"html_description": "<td>Name of the chat theme, which is usually an emoji</td>",
"rst_description": "Name of the chat theme, which is usually an emoji\n",
"name": "theme_name",
"required": true
}
],
"category": "types"
}
}

41
.butcher/types/BackgroundTypeFill/entity.json Normal file
View file

@ -0,0 +1,41 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "backgroundtypefill",
"name": "BackgroundTypeFill",
"description": "The background is automatically filled based on the selected colors.",
"html_description": "<p>The background is automatically filled based on the selected colors.</p>",
"rst_description": "The background is automatically filled based on the selected colors.",
"annotations": [
{
"type": "String",
"description": "Type of the background, always 'fill'",
"html_description": "<td>Type of the background, always &#8220;fill&#8221;</td>",
"rst_description": "Type of the background, always 'fill'\n",
"name": "type",
"required": true
},
{
"type": "BackgroundFill",
"description": "The background fill",
"html_description": "<td>The background fill</td>",
"rst_description": "The background fill\n",
"name": "fill",
"required": true
},
{
"type": "Integer",
"description": "Dimming of the background in dark themes, as a percentage; 0-100",
"html_description": "<td>Dimming of the background in dark themes, as a percentage; 0-100</td>",
"rst_description": "Dimming of the background in dark themes, as a percentage; 0-100\n",
"name": "dark_theme_dimming",
"required": true
}
],
"category": "types"
}
}

65
.butcher/types/BackgroundTypePattern/entity.json Normal file
View file

@ -0,0 +1,65 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "backgroundtypepattern",
"name": "BackgroundTypePattern",
"description": "The background is a PNG or TGV (gzipped subset of SVG with MIME type 'application/x-tgwallpattern') pattern to be combined with the background fill chosen by the user.",
"html_description": "<p>The background is a PNG or TGV (gzipped subset of SVG with MIME type &#8220;application/x-tgwallpattern&#8221;) pattern to be combined with the background fill chosen by the user.</p>",
"rst_description": "The background is a PNG or TGV (gzipped subset of SVG with MIME type 'application/x-tgwallpattern') pattern to be combined with the background fill chosen by the user.",
"annotations": [
{
"type": "String",
"description": "Type of the background, always 'pattern'",
"html_description": "<td>Type of the background, always &#8220;pattern&#8221;</td>",
"rst_description": "Type of the background, always 'pattern'\n",
"name": "type",
"required": true
},
{
"type": "Document",
"description": "Document with the pattern",
"html_description": "<td>Document with the pattern</td>",
"rst_description": "Document with the pattern\n",
"name": "document",
"required": true
},
{
"type": "BackgroundFill",
"description": "The background fill that is combined with the pattern",
"html_description": "<td>The background fill that is combined with the pattern</td>",
"rst_description": "The background fill that is combined with the pattern\n",
"name": "fill",
"required": true
},
{
"type": "Integer",
"description": "Intensity of the pattern when it is shown above the filled background; 0-100",
"html_description": "<td>Intensity of the pattern when it is shown above the filled background; 0-100</td>",
"rst_description": "Intensity of the pattern when it is shown above the filled background; 0-100\n",
"name": "intensity",
"required": true
},
{
"type": "True",
"description": "True, if the background fill must be applied only to the pattern itself. All other pixels are black in this case. For dark themes only",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the background fill must be applied only to the pattern itself. All other pixels are black in this case. For dark themes only</td>",
"rst_description": "*Optional*. :code:`True`, if the background fill must be applied only to the pattern itself. All other pixels are black in this case. For dark themes only\n",
"name": "is_inverted",
"required": false
},
{
"type": "True",
"description": "True, if the background moves slightly when the device is tilted",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the background moves slightly when the device is tilted</td>",
"rst_description": "*Optional*. :code:`True`, if the background moves slightly when the device is tilted\n",
"name": "is_moving",
"required": false
}
],
"category": "types"
}
}

57
.butcher/types/BackgroundTypeWallpaper/entity.json Normal file
View file

@ -0,0 +1,57 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "backgroundtypewallpaper",
"name": "BackgroundTypeWallpaper",
"description": "The background is a wallpaper in the JPEG format.",
"html_description": "<p>The background is a wallpaper in the JPEG format.</p>",
"rst_description": "The background is a wallpaper in the JPEG format.",
"annotations": [
{
"type": "String",
"description": "Type of the background, always 'wallpaper'",
"html_description": "<td>Type of the background, always &#8220;wallpaper&#8221;</td>",
"rst_description": "Type of the background, always 'wallpaper'\n",
"name": "type",
"required": true
},
{
"type": "Document",
"description": "Document with the wallpaper",
"html_description": "<td>Document with the wallpaper</td>",
"rst_description": "Document with the wallpaper\n",
"name": "document",
"required": true
},
{
"type": "Integer",
"description": "Dimming of the background in dark themes, as a percentage; 0-100",
"html_description": "<td>Dimming of the background in dark themes, as a percentage; 0-100</td>",
"rst_description": "Dimming of the background in dark themes, as a percentage; 0-100\n",
"name": "dark_theme_dimming",
"required": true
},
{
"type": "True",
"description": "True, if the wallpaper is downscaled to fit in a 450x450 square and then box-blurred with radius 12",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the wallpaper is downscaled to fit in a 450x450 square and then box-blurred with radius 12</td>",
"rst_description": "*Optional*. :code:`True`, if the wallpaper is downscaled to fit in a 450x450 square and then box-blurred with radius 12\n",
"name": "is_blurred",
"required": false
},
{
"type": "True",
"description": "True, if the background moves slightly when the device is tilted",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the background moves slightly when the device is tilted</td>",
"rst_description": "*Optional*. :code:`True`, if the background moves slightly when the device is tilted\n",
"name": "is_moving",
"required": false
}
],
"category": "types"
}
}

6
.butcher/types/Birthdate/entity.json
View file

@ -7,9 +7,9 @@
"object": {
"anchor": "birthdate",
"name": "Birthdate",
"description": "",
"html_description": "",
"rst_description": "",
"description": "Describes the birthdate of a user.",
"html_description": "<p>Describes the birthdate of a user.</p>",
"rst_description": "Describes the birthdate of a user.",
"annotations": [
{
"type": "Integer",

6
.butcher/types/BusinessIntro/entity.json
View file

@ -7,9 +7,9 @@
"object": {
"anchor": "businessintro",
"name": "BusinessIntro",
"description": "",
"html_description": "",
"rst_description": "",
"description": "Contains information about the start page settings of a Telegram Business account.",
"html_description": "<p>Contains information about the start page settings of a Telegram Business account.</p>",
"rst_description": "Contains information about the start page settings of a Telegram Business account.",
"annotations": [
{
"type": "String",

6
.butcher/types/BusinessLocation/entity.json
View file

@ -7,9 +7,9 @@
"object": {
"anchor": "businesslocation",
"name": "BusinessLocation",
"description": "",
"html_description": "",
"rst_description": "",
"description": "Contains information about the location of a Telegram Business account.",
"html_description": "<p>Contains information about the location of a Telegram Business account.</p>",
"rst_description": "Contains information about the location of a Telegram Business account.",
"annotations": [
{
"type": "String",

6
.butcher/types/BusinessMessagesDeleted/entity.json
View file

@ -29,9 +29,9 @@
},
{
"type": "Array of Integer",
"description": "A JSON-serialized list of identifiers of deleted messages in the chat of the business account",
"html_description": "<td>A JSON-serialized list of identifiers of deleted messages in the chat of the business account</td>",
"rst_description": "A JSON-serialized list of identifiers of deleted messages in the chat of the business account\n",
"description": "The list of identifiers of deleted messages in the chat of the business account",
"html_description": "<td>The list of identifiers of deleted messages in the chat of the business account</td>",
"rst_description": "The list of identifiers of deleted messages in the chat of the business account\n",
"name": "message_ids",
"required": true
}

6
.butcher/types/BusinessOpeningHours/entity.json
View file

@ -7,9 +7,9 @@
"object": {
"anchor": "businessopeninghours",
"name": "BusinessOpeningHours",
"description": "",
"html_description": "",
"rst_description": "",
"description": "Describes the opening hours of a business.",
"html_description": "<p>Describes the opening hours of a business.</p>",
"rst_description": "Describes the opening hours of a business.",
"annotations": [
{
"type": "String",

6
.butcher/types/BusinessOpeningHoursInterval/entity.json
View file

@ -7,9 +7,9 @@
"object": {
"anchor": "businessopeninghoursinterval",
"name": "BusinessOpeningHoursInterval",
"description": "",
"html_description": "",
"rst_description": "",
"description": "Describes an interval of time during which a business is open.",
"html_description": "<p>Describes an interval of time during which a business is open.</p>",
"rst_description": "Describes an interval of time during which a business is open.",
"annotations": [
{
"type": "Integer",

574
.butcher/types/Chat/entity.json
View file

@ -21,9 +21,9 @@
},
{
"type": "String",
"description": "Type of chat, can be either 'private', 'group', 'supergroup' or 'channel'",
"html_description": "<td>Type of chat, can be either &#8220;private&#8221;, &#8220;group&#8221;, &#8220;supergroup&#8221; or &#8220;channel&#8221;</td>",
"rst_description": "Type of chat, can be either 'private', 'group', 'supergroup' or 'channel'\n",
"description": "Type of the chat, can be either 'private', 'group', 'supergroup' or 'channel'",
"html_description": "<td>Type of the chat, can be either &#8220;private&#8221;, &#8220;group&#8221;, &#8220;supergroup&#8221; or &#8220;channel&#8221;</td>",
"rst_description": "Type of the chat, can be either 'private', 'group', 'supergroup' or 'channel'\n",
"name": "type",
"required": true
},
@ -68,12 +68,16 @@
"required": false
},
{
"type": "ChatPhoto",
"description": "Chat photo. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. Chat photo. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. Chat photo. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "photo",
"required": false
"type": "Integer",
"description": "Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See accent colors for more details. Returned only in getChat. Always returned in getChat.",
"html_description": "<td><em>Optional</em>. Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See <a href=\"#accent-colors\">accent colors</a> for more details. Returned only in <a href=\"#getchat\">getChat</a>. Always returned in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See `accent colors <https://core.telegram.org/bots/api#accent-colors>`_ for more details. Returned only in :class:`aiogram.methods.get_chat.GetChat`. Always returned in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "accent_color_id",
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "Array of String",
@ -81,47 +85,11 @@
"html_description": "<td><em>Optional</em>. If non-empty, the list of all <a href=\"https://telegram.org/blog/topics-in-groups-collectible-usernames#collectible-usernames\">active chat usernames</a>; for private chats, supergroups and channels. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. If non-empty, the list of all `active chat usernames <https://telegram.org/blog/topics-in-groups-collectible-usernames#collectible-usernames>`_; for private chats, supergroups and channels. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "active_usernames",
"required": false
},
{
"type": "Birthdate",
"description": "For private chats, the date of birth of the user. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. For private chats, the date of birth of the user. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. For private chats, the date of birth of the user. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "birthdate",
"required": false
},
{
"type": "BusinessIntro",
"description": "For private chats with business accounts, the intro of the business. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. For private chats with business accounts, the intro of the business. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. For private chats with business accounts, the intro of the business. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "business_intro",
"required": false
},
{
"type": "BusinessLocation",
"description": "For private chats with business accounts, the location of the business. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. For private chats with business accounts, the location of the business. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. For private chats with business accounts, the location of the business. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "business_location",
"required": false
},
{
"type": "BusinessOpeningHours",
"description": "For private chats with business accounts, the opening hours of the business. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. For private chats with business accounts, the opening hours of the business. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. For private chats with business accounts, the opening hours of the business. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "business_opening_hours",
"required": false
},
{
"type": "Chat",
"description": "For private chats, the personal channel of the user. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. For private chats, the personal channel of the user. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. For private chats, the personal channel of the user. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "personal_chat",
"required": false
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "Array of ReactionType",
@ -129,15 +97,11 @@
"html_description": "<td><em>Optional</em>. List of available reactions allowed in the chat. If omitted, then all <a href=\"#reactiontypeemoji\">emoji reactions</a> are allowed. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. List of available reactions allowed in the chat. If omitted, then all `emoji reactions <https://core.telegram.org/bots/api#reactiontypeemoji>`_ are allowed. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "available_reactions",
"required": false
},
{
"type": "Integer",
"description": "Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See accent colors for more details. Returned only in getChat. Always returned in getChat.",
"html_description": "<td><em>Optional</em>. Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See <a href=\"#accent-colors\">accent colors</a> for more details. Returned only in <a href=\"#getchat\">getChat</a>. Always returned in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See `accent colors <https://core.telegram.org/bots/api#accent-colors>`_ for more details. Returned only in :class:`aiogram.methods.get_chat.GetChat`. Always returned in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "accent_color_id",
"required": false
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "String",
@ -145,39 +109,11 @@
"html_description": "<td><em>Optional</em>. Custom emoji identifier of emoji chosen by the chat for the reply header and link preview background. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. Custom emoji identifier of emoji chosen by the chat for the reply header and link preview background. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "background_custom_emoji_id",
"required": false
},
{
"type": "Integer",
"description": "Identifier of the accent color for the chat's profile background. See profile accent colors for more details. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. Identifier of the accent color for the chat's profile background. See <a href=\"#profile-accent-colors\">profile accent colors</a> for more details. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. Identifier of the accent color for the chat's profile background. See `profile accent colors <https://core.telegram.org/bots/api#profile-accent-colors>`_ for more details. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "profile_accent_color_id",
"required": false
},
{
"type": "String",
"description": "Custom emoji identifier of the emoji chosen by the chat for its profile background. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. Custom emoji identifier of the emoji chosen by the chat for its profile background. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. Custom emoji identifier of the emoji chosen by the chat for its profile background. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "profile_background_custom_emoji_id",
"required": false
},
{
"type": "String",
"description": "Custom emoji identifier of the emoji status of the chat or the other party in a private chat. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. Custom emoji identifier of the emoji status of the chat or the other party in a private chat. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. Custom emoji identifier of the emoji status of the chat or the other party in a private chat. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "emoji_status_custom_emoji_id",
"required": false
},
{
"type": "Integer",
"description": "Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "emoji_status_expiration_date",
"required": false
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "String",
@ -185,135 +121,59 @@
"html_description": "<td><em>Optional</em>. Bio of the other party in a private chat. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. Bio of the other party in a private chat. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "bio",
"required": false
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "True",
"description": "True, if privacy settings of the other party in the private chat allows to use tg://user?id=<user_id> links only in chats with the user. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. <em>True</em>, if privacy settings of the other party in the private chat allows to use <code>tg://user?id=&lt;user_id&gt;</code> links only in chats with the user. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. :code:`True`, if privacy settings of the other party in the private chat allows to use :code:`tg://user?id=<user_id>` links only in chats with the user. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "has_private_forwards",
"required": false
"type": "Birthdate",
"description": "For private chats, the date of birth of the user. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. For private chats, the date of birth of the user. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. For private chats, the date of birth of the user. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "birthdate",
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "True",
"description": "True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the privacy settings of the other party restrict sending voice and video note messages in the private chat. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. :code:`True`, if the privacy settings of the other party restrict sending voice and video note messages in the private chat. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "has_restricted_voice_and_video_messages",
"required": false
"type": "BusinessIntro",
"description": "For private chats with business accounts, the intro of the business. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. For private chats with business accounts, the intro of the business. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. For private chats with business accounts, the intro of the business. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "business_intro",
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "True",
"description": "True, if users need to join the supergroup before they can send messages. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. <em>True</em>, if users need to join the supergroup before they can send messages. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. :code:`True`, if users need to join the supergroup before they can send messages. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "join_to_send_messages",
"required": false
"type": "BusinessLocation",
"description": "For private chats with business accounts, the location of the business. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. For private chats with business accounts, the location of the business. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. For private chats with business accounts, the location of the business. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "business_location",
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "True",
"description": "True, if all users directly joining the supergroup need to be approved by supergroup administrators. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. <em>True</em>, if all users directly joining the supergroup need to be approved by supergroup administrators. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. :code:`True`, if all users directly joining the supergroup need to be approved by supergroup administrators. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "join_by_request",
"required": false
},
{
"type": "String",
"description": "Description, for groups, supergroups and channel chats. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. Description, for groups, supergroups and channel chats. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. Description, for groups, supergroups and channel chats. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "description",
"required": false
},
{
"type": "String",
"description": "Primary invite link, for groups, supergroups and channel chats. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. Primary invite link, for groups, supergroups and channel chats. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. Primary invite link, for groups, supergroups and channel chats. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "invite_link",
"required": false
},
{
"type": "Message",
"description": "The most recent pinned message (by sending date). Returned only in getChat.",
"html_description": "<td><em>Optional</em>. The most recent pinned message (by sending date). Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. The most recent pinned message (by sending date). Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "pinned_message",
"required": false
},
{
"type": "ChatPermissions",
"description": "Default chat member permissions, for groups and supergroups. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. Default chat member permissions, for groups and supergroups. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. Default chat member permissions, for groups and supergroups. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "permissions",
"required": false
},
{
"type": "Integer",
"description": "For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "slow_mode_delay",
"required": false
},
{
"type": "Integer",
"description": "For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "unrestrict_boost_count",
"required": false
},
{
"type": "Integer",
"description": "The time after which all messages sent to the chat will be automatically deleted; in seconds. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. The time after which all messages sent to the chat will be automatically deleted; in seconds. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. The time after which all messages sent to the chat will be automatically deleted; in seconds. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"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": "<td><em>Optional</em>. <em>True</em>, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"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": "<td><em>Optional</em>. <em>True</em>, if non-administrators can only get the list of bots and administrators in the chat. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"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.",
"html_description": "<td><em>Optional</em>. <em>True</em>, if messages from the chat can't be forwarded to other chats. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. :code:`True`, if messages from the chat can't be forwarded to other chats. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "has_protected_content",
"required": false
},
{
"type": "True",
"description": "True, if new chat members will have access to old messages; available only to chat administrators. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. <em>True</em>, if new chat members will have access to old messages; available only to chat administrators. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. :code:`True`, if new chat members will have access to old messages; available only to chat administrators. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "has_visible_history",
"required": false
},
{
"type": "String",
"description": "For supergroups, name of group sticker set. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. For supergroups, name of group sticker set. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. For supergroups, name of group sticker set. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "sticker_set_name",
"required": false
"type": "BusinessOpeningHours",
"description": "For private chats with business accounts, the opening hours of the business. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. For private chats with business accounts, the opening hours of the business. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. For private chats with business accounts, the opening hours of the business. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "business_opening_hours",
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "True",
@ -321,7 +181,11 @@
"html_description": "<td><em>Optional</em>. <em>True</em>, if the bot can change the group sticker set. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. :code:`True`, if the bot can change the group sticker set. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "can_set_sticker_set",
"required": false
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "String",
@ -329,7 +193,155 @@
"html_description": "<td><em>Optional</em>. For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "custom_emoji_sticker_set_name",
"required": false
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "String",
"description": "Description, for groups, supergroups and channel chats. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. Description, for groups, supergroups and channel chats. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. Description, for groups, supergroups and channel chats. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "description",
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "String",
"description": "Custom emoji identifier of the emoji status of the chat or the other party in a private chat. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. Custom emoji identifier of the emoji status of the chat or the other party in a private chat. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. Custom emoji identifier of the emoji status of the chat or the other party in a private chat. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "emoji_status_custom_emoji_id",
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "Integer",
"description": "Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "emoji_status_expiration_date",
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"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": "<td><em>Optional</em>. <em>True</em>, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"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,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"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": "<td><em>Optional</em>. <em>True</em>, if non-administrators can only get the list of bots and administrators in the chat. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"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,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "True",
"description": "True, if privacy settings of the other party in the private chat allows to use tg://user?id=<user_id> links only in chats with the user. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. <em>True</em>, if privacy settings of the other party in the private chat allows to use <code>tg://user?id=&lt;user_id&gt;</code> links only in chats with the user. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. :code:`True`, if privacy settings of the other party in the private chat allows to use :code:`tg://user?id=<user_id>` links only in chats with the user. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "has_private_forwards",
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "True",
"description": "True, if messages from the chat can't be forwarded to other chats. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. <em>True</em>, if messages from the chat can't be forwarded to other chats. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. :code:`True`, if messages from the chat can't be forwarded to other chats. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "has_protected_content",
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "True",
"description": "True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the privacy settings of the other party restrict sending voice and video note messages in the private chat. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. :code:`True`, if the privacy settings of the other party restrict sending voice and video note messages in the private chat. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "has_restricted_voice_and_video_messages",
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "True",
"description": "True, if new chat members will have access to old messages; available only to chat administrators. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. <em>True</em>, if new chat members will have access to old messages; available only to chat administrators. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. :code:`True`, if new chat members will have access to old messages; available only to chat administrators. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "has_visible_history",
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "String",
"description": "Primary invite link, for groups, supergroups and channel chats. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. Primary invite link, for groups, supergroups and channel chats. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. Primary invite link, for groups, supergroups and channel chats. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "invite_link",
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "True",
"description": "True, if all users directly joining the supergroup need to be approved by supergroup administrators. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. <em>True</em>, if all users directly joining the supergroup need to be approved by supergroup administrators. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. :code:`True`, if all users directly joining the supergroup need to be approved by supergroup administrators. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "join_by_request",
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "True",
"description": "True, if users need to join the supergroup before they can send messages. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. <em>True</em>, if users need to join the supergroup before they can send messages. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. :code:`True`, if users need to join the supergroup before they can send messages. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "join_to_send_messages",
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "Integer",
@ -337,7 +349,11 @@
"html_description": "<td><em>Optional</em>. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "linked_chat_id",
"required": false
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "ChatLocation",
@ -345,7 +361,131 @@
"html_description": "<td><em>Optional</em>. For supergroups, the location to which the supergroup is connected. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. For supergroups, the location to which the supergroup is connected. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "location",
"required": false
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "Integer",
"description": "The time after which all messages sent to the chat will be automatically deleted; in seconds. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. The time after which all messages sent to the chat will be automatically deleted; in seconds. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. The time after which all messages sent to the chat will be automatically deleted; in seconds. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "message_auto_delete_time",
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "ChatPermissions",
"description": "Default chat member permissions, for groups and supergroups. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. Default chat member permissions, for groups and supergroups. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. Default chat member permissions, for groups and supergroups. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "permissions",
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "Chat",
"description": "For private chats, the personal channel of the user. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. For private chats, the personal channel of the user. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. For private chats, the personal channel of the user. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "personal_chat",
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "ChatPhoto",
"description": "Chat photo. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. Chat photo. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. Chat photo. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "photo",
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "Message",
"description": "The most recent pinned message (by sending date). Returned only in getChat.",
"html_description": "<td><em>Optional</em>. The most recent pinned message (by sending date). Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. The most recent pinned message (by sending date). Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "pinned_message",
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "Integer",
"description": "Identifier of the accent color for the chat's profile background. See profile accent colors for more details. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. Identifier of the accent color for the chat's profile background. See <a href=\"#profile-accent-colors\">profile accent colors</a> for more details. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. Identifier of the accent color for the chat's profile background. See `profile accent colors <https://core.telegram.org/bots/api#profile-accent-colors>`_ for more details. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "profile_accent_color_id",
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "String",
"description": "Custom emoji identifier of the emoji chosen by the chat for its profile background. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. Custom emoji identifier of the emoji chosen by the chat for its profile background. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. Custom emoji identifier of the emoji chosen by the chat for its profile background. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "profile_background_custom_emoji_id",
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "Integer",
"description": "For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "slow_mode_delay",
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "String",
"description": "For supergroups, name of group sticker set. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. For supergroups, name of group sticker set. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. For supergroups, name of group sticker set. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "sticker_set_name",
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
},
{
"type": "Integer",
"description": "For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "unrestrict_boost_count",
"required": false,
"deprecated": {
"version": "7.3",
"release_date": "2024-05-06"
}
}
],
"category": "types"

6
.butcher/types/ChatAdministratorRights/entity.json
View file

@ -85,9 +85,9 @@
},
{
"type": "Boolean",
"description": "True, if the administrator can edit stories posted by other users",
"html_description": "<td><em>True</em>, if the administrator can edit stories posted by other users</td>",
"rst_description": ":code:`True`, if the administrator can edit stories posted by other users\n",
"description": "True, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive",
"html_description": "<td><em>True</em>, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive</td>",
"rst_description": ":code:`True`, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive\n",
"name": "can_edit_stories",
"required": true
},

25
.butcher/types/ChatBackground/entity.json Normal file
View file

@ -0,0 +1,25 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "chatbackground",
"name": "ChatBackground",
"description": "This object represents a chat background.",
"html_description": "<p>This object represents a chat background.</p>",
"rst_description": "This object represents a chat background.",
"annotations": [
{
"type": "BackgroundType",
"description": "Type of the background",
"html_description": "<td>Type of the background</td>",
"rst_description": "Type of the background\n",
"name": "type",
"required": true
}
],
"category": "types"
}
}

361
.butcher/types/ChatFullInfo/entity.json Normal file
View file

@ -0,0 +1,361 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "chatfullinfo",
"name": "ChatFullInfo",
"description": "This object contains full information about a chat.",
"html_description": "<p>This object contains full information about a chat.</p>",
"rst_description": "This object contains full information about a chat.",
"annotations": [
{
"type": "Integer",
"description": "Unique identifier for this 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 signed 64-bit integer or double-precision float type are safe for storing this identifier.",
"html_description": "<td>Unique identifier for this 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 signed 64-bit integer or double-precision float type are safe for storing this identifier.</td>",
"rst_description": "Unique identifier for this 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 signed 64-bit integer or double-precision float type are safe for storing this identifier.\n",
"name": "id",
"required": true
},
{
"type": "String",
"description": "Type of the chat, can be either 'private', 'group', 'supergroup' or 'channel'",
"html_description": "<td>Type of the chat, can be either &#8220;private&#8221;, &#8220;group&#8221;, &#8220;supergroup&#8221; or &#8220;channel&#8221;</td>",
"rst_description": "Type of the chat, can be either 'private', 'group', 'supergroup' or 'channel'\n",
"name": "type",
"required": true
},
{
"type": "String",
"description": "Title, for supergroups, channels and group chats",
"html_description": "<td><em>Optional</em>. Title, for supergroups, channels and group chats</td>",
"rst_description": "*Optional*. Title, for supergroups, channels and group chats\n",
"name": "title",
"required": false
},
{
"type": "String",
"description": "Username, for private chats, supergroups and channels if available",
"html_description": "<td><em>Optional</em>. Username, for private chats, supergroups and channels if available</td>",
"rst_description": "*Optional*. Username, for private chats, supergroups and channels if available\n",
"name": "username",
"required": false
},
{
"type": "String",
"description": "First name of the other party in a private chat",
"html_description": "<td><em>Optional</em>. First name of the other party in a private chat</td>",
"rst_description": "*Optional*. First name of the other party in a private chat\n",
"name": "first_name",
"required": false
},
{
"type": "String",
"description": "Last name of the other party in a private chat",
"html_description": "<td><em>Optional</em>. Last name of the other party in a private chat</td>",
"rst_description": "*Optional*. Last name of the other party in a private chat\n",
"name": "last_name",
"required": false
},
{
"type": "True",
"description": "True, if the supergroup chat is a forum (has topics enabled)",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the supergroup chat is a forum (has <a href=\"https://telegram.org/blog/topics-in-groups-collectible-usernames#topics-in-groups\">topics</a> enabled)</td>",
"rst_description": "*Optional*. :code:`True`, if the supergroup chat is a forum (has `topics <https://telegram.org/blog/topics-in-groups-collectible-usernames#topics-in-groups>`_ enabled)\n",
"name": "is_forum",
"required": false
},
{
"type": "Integer",
"description": "Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See accent colors for more details.",
"html_description": "<td>Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See <a href=\"#accent-colors\">accent colors</a> for more details.</td>",
"rst_description": "Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See `accent colors <https://core.telegram.org/bots/api#accent-colors>`_ for more details.\n",
"name": "accent_color_id",
"required": true
},
{
"type": "Integer",
"description": "The maximum number of reactions that can be set on a message in the chat",
"html_description": "<td>The maximum number of reactions that can be set on a message in the chat</td>",
"rst_description": "The maximum number of reactions that can be set on a message in the chat\n",
"name": "max_reaction_count",
"required": true
},
{
"type": "ChatPhoto",
"description": "Chat photo",
"html_description": "<td><em>Optional</em>. Chat photo</td>",
"rst_description": "*Optional*. Chat photo\n",
"name": "photo",
"required": false
},
{
"type": "Array of String",
"description": "If non-empty, the list of all active chat usernames; for private chats, supergroups and channels",
"html_description": "<td><em>Optional</em>. If non-empty, the list of all <a href=\"https://telegram.org/blog/topics-in-groups-collectible-usernames#collectible-usernames\">active chat usernames</a>; for private chats, supergroups and channels</td>",
"rst_description": "*Optional*. If non-empty, the list of all `active chat usernames <https://telegram.org/blog/topics-in-groups-collectible-usernames#collectible-usernames>`_; for private chats, supergroups and channels\n",
"name": "active_usernames",
"required": false
},
{
"type": "Birthdate",
"description": "For private chats, the date of birth of the user",
"html_description": "<td><em>Optional</em>. For private chats, the date of birth of the user</td>",
"rst_description": "*Optional*. For private chats, the date of birth of the user\n",
"name": "birthdate",
"required": false
},
{
"type": "BusinessIntro",
"description": "For private chats with business accounts, the intro of the business",
"html_description": "<td><em>Optional</em>. For private chats with business accounts, the intro of the business</td>",
"rst_description": "*Optional*. For private chats with business accounts, the intro of the business\n",
"name": "business_intro",
"required": false
},
{
"type": "BusinessLocation",
"description": "For private chats with business accounts, the location of the business",
"html_description": "<td><em>Optional</em>. For private chats with business accounts, the location of the business</td>",
"rst_description": "*Optional*. For private chats with business accounts, the location of the business\n",
"name": "business_location",
"required": false
},
{
"type": "BusinessOpeningHours",
"description": "For private chats with business accounts, the opening hours of the business",
"html_description": "<td><em>Optional</em>. For private chats with business accounts, the opening hours of the business</td>",
"rst_description": "*Optional*. For private chats with business accounts, the opening hours of the business\n",
"name": "business_opening_hours",
"required": false
},
{
"type": "Chat",
"description": "For private chats, the personal channel of the user",
"html_description": "<td><em>Optional</em>. For private chats, the personal channel of the user</td>",
"rst_description": "*Optional*. For private chats, the personal channel of the user\n",
"name": "personal_chat",
"required": false
},
{
"type": "Array of ReactionType",
"description": "List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed.",
"html_description": "<td><em>Optional</em>. List of available reactions allowed in the chat. If omitted, then all <a href=\"#reactiontypeemoji\">emoji reactions</a> are allowed.</td>",
"rst_description": "*Optional*. List of available reactions allowed in the chat. If omitted, then all `emoji reactions <https://core.telegram.org/bots/api#reactiontypeemoji>`_ are allowed.\n",
"name": "available_reactions",
"required": false
},
{
"type": "String",
"description": "Custom emoji identifier of the emoji chosen by the chat for the reply header and link preview background",
"html_description": "<td><em>Optional</em>. Custom emoji identifier of the emoji chosen by the chat for the reply header and link preview background</td>",
"rst_description": "*Optional*. Custom emoji identifier of the emoji chosen by the chat for the reply header and link preview background\n",
"name": "background_custom_emoji_id",
"required": false
},
{
"type": "Integer",
"description": "Identifier of the accent color for the chat's profile background. See profile accent colors for more details.",
"html_description": "<td><em>Optional</em>. Identifier of the accent color for the chat's profile background. See <a href=\"#profile-accent-colors\">profile accent colors</a> for more details.</td>",
"rst_description": "*Optional*. Identifier of the accent color for the chat's profile background. See `profile accent colors <https://core.telegram.org/bots/api#profile-accent-colors>`_ for more details.\n",
"name": "profile_accent_color_id",
"required": false
},
{
"type": "String",
"description": "Custom emoji identifier of the emoji chosen by the chat for its profile background",
"html_description": "<td><em>Optional</em>. Custom emoji identifier of the emoji chosen by the chat for its profile background</td>",
"rst_description": "*Optional*. Custom emoji identifier of the emoji chosen by the chat for its profile background\n",
"name": "profile_background_custom_emoji_id",
"required": false
},
{
"type": "String",
"description": "Custom emoji identifier of the emoji status of the chat or the other party in a private chat",
"html_description": "<td><em>Optional</em>. Custom emoji identifier of the emoji status of the chat or the other party in a private chat</td>",
"rst_description": "*Optional*. Custom emoji identifier of the emoji status of the chat or the other party in a private chat\n",
"name": "emoji_status_custom_emoji_id",
"required": false
},
{
"type": "Integer",
"description": "Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any",
"html_description": "<td><em>Optional</em>. Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any</td>",
"rst_description": "*Optional*. Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any\n",
"name": "emoji_status_expiration_date",
"required": false
},
{
"type": "String",
"description": "Bio of the other party in a private chat",
"html_description": "<td><em>Optional</em>. Bio of the other party in a private chat</td>",
"rst_description": "*Optional*. Bio of the other party in a private chat\n",
"name": "bio",
"required": false
},
{
"type": "True",
"description": "True, if privacy settings of the other party in the private chat allows to use tg://user?id=<user_id> links only in chats with the user",
"html_description": "<td><em>Optional</em>. <em>True</em>, if privacy settings of the other party in the private chat allows to use <code>tg://user?id=&lt;user_id&gt;</code> links only in chats with the user</td>",
"rst_description": "*Optional*. :code:`True`, if privacy settings of the other party in the private chat allows to use :code:`tg://user?id=<user_id>` links only in chats with the user\n",
"name": "has_private_forwards",
"required": false
},
{
"type": "True",
"description": "True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the privacy settings of the other party restrict sending voice and video note messages in the private chat</td>",
"rst_description": "*Optional*. :code:`True`, if the privacy settings of the other party restrict sending voice and video note messages in the private chat\n",
"name": "has_restricted_voice_and_video_messages",
"required": false
},
{
"type": "True",
"description": "True, if users need to join the supergroup before they can send messages",
"html_description": "<td><em>Optional</em>. <em>True</em>, if users need to join the supergroup before they can send messages</td>",
"rst_description": "*Optional*. :code:`True`, if users need to join the supergroup before they can send messages\n",
"name": "join_to_send_messages",
"required": false
},
{
"type": "True",
"description": "True, if all users directly joining the supergroup need to be approved by supergroup administrators",
"html_description": "<td><em>Optional</em>. <em>True</em>, if all users directly joining the supergroup need to be approved by supergroup administrators</td>",
"rst_description": "*Optional*. :code:`True`, if all users directly joining the supergroup need to be approved by supergroup administrators\n",
"name": "join_by_request",
"required": false
},
{
"type": "String",
"description": "Description, for groups, supergroups and channel chats",
"html_description": "<td><em>Optional</em>. Description, for groups, supergroups and channel chats</td>",
"rst_description": "*Optional*. Description, for groups, supergroups and channel chats\n",
"name": "description",
"required": false
},
{
"type": "String",
"description": "Primary invite link, for groups, supergroups and channel chats",
"html_description": "<td><em>Optional</em>. Primary invite link, for groups, supergroups and channel chats</td>",
"rst_description": "*Optional*. Primary invite link, for groups, supergroups and channel chats\n",
"name": "invite_link",
"required": false
},
{
"type": "Message",
"description": "The most recent pinned message (by sending date)",
"html_description": "<td><em>Optional</em>. The most recent pinned message (by sending date)</td>",
"rst_description": "*Optional*. The most recent pinned message (by sending date)\n",
"name": "pinned_message",
"required": false
},
{
"type": "ChatPermissions",
"description": "Default chat member permissions, for groups and supergroups",
"html_description": "<td><em>Optional</em>. Default chat member permissions, for groups and supergroups</td>",
"rst_description": "*Optional*. Default chat member permissions, for groups and supergroups\n",
"name": "permissions",
"required": false
},
{
"type": "Integer",
"description": "For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds",
"html_description": "<td><em>Optional</em>. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds</td>",
"rst_description": "*Optional*. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds\n",
"name": "slow_mode_delay",
"required": false
},
{
"type": "Integer",
"description": "For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions",
"html_description": "<td><em>Optional</em>. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions</td>",
"rst_description": "*Optional*. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions\n",
"name": "unrestrict_boost_count",
"required": false
},
{
"type": "Integer",
"description": "The time after which all messages sent to the chat will be automatically deleted; in seconds",
"html_description": "<td><em>Optional</em>. The time after which all messages sent to the chat will be automatically deleted; in seconds</td>",
"rst_description": "*Optional*. The time after which all messages sent to the chat will be automatically deleted; in seconds\n",
"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.",
"html_description": "<td><em>Optional</em>. <em>True</em>, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators.</td>",
"rst_description": "*Optional*. :code:`True`, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators.\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",
"html_description": "<td><em>Optional</em>. <em>True</em>, if non-administrators can only get the list of bots and administrators in the chat</td>",
"rst_description": "*Optional*. :code:`True`, if non-administrators can only get the list of bots and administrators in the chat\n",
"name": "has_hidden_members",
"required": false
},
{
"type": "True",
"description": "True, if messages from the chat can't be forwarded to other chats",
"html_description": "<td><em>Optional</em>. <em>True</em>, if messages from the chat can't be forwarded to other chats</td>",
"rst_description": "*Optional*. :code:`True`, if messages from the chat can't be forwarded to other chats\n",
"name": "has_protected_content",
"required": false
},
{
"type": "True",
"description": "True, if new chat members will have access to old messages; available only to chat administrators",
"html_description": "<td><em>Optional</em>. <em>True</em>, if new chat members will have access to old messages; available only to chat administrators</td>",
"rst_description": "*Optional*. :code:`True`, if new chat members will have access to old messages; available only to chat administrators\n",
"name": "has_visible_history",
"required": false
},
{
"type": "String",
"description": "For supergroups, name of the group sticker set",
"html_description": "<td><em>Optional</em>. For supergroups, name of the group sticker set</td>",
"rst_description": "*Optional*. For supergroups, name of the group sticker set\n",
"name": "sticker_set_name",
"required": false
},
{
"type": "True",
"description": "True, if the bot can change the group sticker set",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the bot can change the group sticker set</td>",
"rst_description": "*Optional*. :code:`True`, if the bot can change the group sticker set\n",
"name": "can_set_sticker_set",
"required": false
},
{
"type": "String",
"description": "For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group.",
"html_description": "<td><em>Optional</em>. For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group.</td>",
"rst_description": "*Optional*. For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group.\n",
"name": "custom_emoji_sticker_set_name",
"required": false
},
{
"type": "Integer",
"description": "Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier.",
"html_description": "<td><em>Optional</em>. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier.</td>",
"rst_description": "*Optional*. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier.\n",
"name": "linked_chat_id",
"required": false
},
{
"type": "ChatLocation",
"description": "For supergroups, the location to which the supergroup is connected",
"html_description": "<td><em>Optional</em>. For supergroups, the location to which the supergroup is connected</td>",
"rst_description": "*Optional*. For supergroups, the location to which the supergroup is connected\n",
"name": "location",
"required": false
}
],
"category": "types"
}
}

7
.butcher/types/ChatFullInfo/replace.yml Normal file
View file

@ -0,0 +1,7 @@
bases:
- Chat
annotations:
emoji_status_expiration_date:
parsed_type:
type: std
name: DateTime

6
.butcher/types/ChatMemberAdministrator/entity.json
View file

@ -109,9 +109,9 @@
},
{
"type": "Boolean",
"description": "True, if the administrator can edit stories posted by other users",
"html_description": "<td><em>True</em>, if the administrator can edit stories posted by other users</td>",
"rst_description": ":code:`True`, if the administrator can edit stories posted by other users\n",
"description": "True, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive",
"html_description": "<td><em>True</em>, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive</td>",
"rst_description": ":code:`True`, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive\n",
"name": "can_edit_stories",
"required": true
},

8
.butcher/types/ChatMemberUpdated/entity.json
View file

@ -59,6 +59,14 @@
"name": "invite_link",
"required": false
},
{
"type": "Boolean",
"description": "True, if the user joined the chat after sending a direct join request and being approved by an administrator",
"html_description": "<td><em>Optional</em>. True, if the user joined the chat after sending a direct join request and being approved by an administrator</td>",
"rst_description": "*Optional*. True, if the user joined the chat after sending a direct join request and being approved by an administrator\n",
"name": "via_join_request",
"required": false
},
{
"type": "Boolean",
"description": "True, if the user joined the chat via a chat folder invite link",

6
.butcher/types/ForceReply/entity.json
View file

@ -7,9 +7,9 @@
"object": {
"anchor": "forcereply",
"name": "ForceReply",
"description": "Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode.\nExample: A poll bot for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll:\n\nExplain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2). May be appealing for hardcore users but lacks modern day polish.\nGuide the user through a step-by-step process. 'Please send me your question', 'Cool, now let's add the first answer option', 'Great. Keep adding answer options, then send /done when you're ready'.\nThe last option is definitely more attractive. And if you use ForceReply in your bot's questions, it will receive the user's answers even if it only receives replies, commands and mentions - without any extra work for the user.",
"html_description": "<p>Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice <a href=\"/bots/features#privacy-mode\">privacy mode</a>.</p><blockquote>\n<p><strong>Example:</strong> A <a href=\"https://t.me/PollBot\">poll bot</a> for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll:</p>\n<ul>\n<li>Explain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2). May be appealing for hardcore users but lacks modern day polish.</li>\n<li>Guide the user through a step-by-step process. 'Please send me your question', 'Cool, now let's add the first answer option', 'Great. Keep adding answer options, then send /done when you're ready'.</li>\n</ul>\n<p>The last option is definitely more attractive. And if you use <a href=\"#forcereply\">ForceReply</a> in your bot's questions, it will receive the user's answers even if it only receives replies, commands and mentions - without any extra work for the user.</p>\n</blockquote>",
"rst_description": "Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice `privacy mode <https://core.telegram.org/bots/features#privacy-mode>`_.\n\n **Example:** A `poll bot <https://t.me/PollBot>`_ for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll:\n \n - Explain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2). May be appealing for hardcore users but lacks modern day polish.\n - Guide the user through a step-by-step process. 'Please send me your question', 'Cool, now let's add the first answer option', 'Great. Keep adding answer options, then send /done when you're ready'.\n \n The last option is definitely more attractive. And if you use :class:`aiogram.types.force_reply.ForceReply` in your bot's questions, it will receive the user's answers even if it only receives replies, commands and mentions - without any extra work for the user.",
"description": "Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode. Not supported in channels and for messages sent on behalf of a Telegram Business account.\nExample: A poll bot for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll:\n\nExplain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2). May be appealing for hardcore users but lacks modern day polish.\nGuide the user through a step-by-step process. 'Please send me your question', 'Cool, now let's add the first answer option', 'Great. Keep adding answer options, then send /done when you're ready'.\nThe last option is definitely more attractive. And if you use ForceReply in your bot's questions, it will receive the user's answers even if it only receives replies, commands and mentions - without any extra work for the user.",
"html_description": "<p>Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice <a href=\"/bots/features#privacy-mode\">privacy mode</a>. Not supported in channels and for messages sent on behalf of a Telegram Business account.</p><blockquote>\n<p><strong>Example:</strong> A <a href=\"https://t.me/PollBot\">poll bot</a> for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll:</p>\n<ul>\n<li>Explain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2). May be appealing for hardcore users but lacks modern day polish.</li>\n<li>Guide the user through a step-by-step process. 'Please send me your question', 'Cool, now let's add the first answer option', 'Great. Keep adding answer options, then send /done when you're ready'.</li>\n</ul>\n<p>The last option is definitely more attractive. And if you use <a href=\"#forcereply\">ForceReply</a> in your bot's questions, it will receive the user's answers even if it only receives replies, commands and mentions - without any extra work for the user.</p>\n</blockquote>",
"rst_description": "Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice `privacy mode <https://core.telegram.org/bots/features#privacy-mode>`_. Not supported in channels and for messages sent on behalf of a Telegram Business account.\n\n **Example:** A `poll bot <https://t.me/PollBot>`_ for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll:\n \n - Explain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2). May be appealing for hardcore users but lacks modern day polish.\n - Guide the user through a step-by-step process. 'Please send me your question', 'Cool, now let's add the first answer option', 'Great. Keep adding answer options, then send /done when you're ready'.\n \n The last option is definitely more attractive. And if you use :class:`aiogram.types.force_reply.ForceReply` in your bot's questions, it will receive the user's answers even if it only receives replies, commands and mentions - without any extra work for the user.",
"annotations": [
{
"type": "True",

30
.butcher/types/InlineKeyboardButton/entity.json
View file

@ -29,17 +29,17 @@
},
{
"type": "String",
"description": "Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes",
"html_description": "<td><em>Optional</em>. Data to be sent in a <a href=\"#callbackquery\">callback query</a> to the bot when button is pressed, 1-64 bytes</td>",
"rst_description": "*Optional*. Data to be sent in a `callback query <https://core.telegram.org/bots/api#callbackquery>`_ to the bot when button is pressed, 1-64 bytes\n",
"description": "Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes. Not supported for messages sent on behalf of a Telegram Business account.",
"html_description": "<td><em>Optional</em>. Data to be sent in a <a href=\"#callbackquery\">callback query</a> to the bot when button is pressed, 1-64 bytes. Not supported for messages sent on behalf of a Telegram Business account.</td>",
"rst_description": "*Optional*. Data to be sent in a `callback query <https://core.telegram.org/bots/api#callbackquery>`_ to the bot when button is pressed, 1-64 bytes. Not supported for messages sent on behalf of a Telegram Business account.\n",
"name": "callback_data",
"required": false
},
{
"type": "WebAppInfo",
"description": "Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery. Available only in private chats between a user and the bot.",
"html_description": "<td><em>Optional</em>. Description of the <a href=\"/bots/webapps\">Web App</a> that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method <a href=\"#answerwebappquery\">answerWebAppQuery</a>. Available only in private chats between a user and the bot.</td>",
"rst_description": "*Optional*. Description of the `Web App <https://core.telegram.org/bots/webapps>`_ that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method :class:`aiogram.methods.answer_web_app_query.AnswerWebAppQuery`. Available only in private chats between a user and the bot.\n",
"description": "Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery. Available only in private chats between a user and the bot. Not supported for messages sent on behalf of a Telegram Business account.",
"html_description": "<td><em>Optional</em>. Description of the <a href=\"/bots/webapps\">Web App</a> that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method <a href=\"#answerwebappquery\">answerWebAppQuery</a>. Available only in private chats between a user and the bot. Not supported for messages sent on behalf of a Telegram Business account.</td>",
"rst_description": "*Optional*. Description of the `Web App <https://core.telegram.org/bots/webapps>`_ that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method :class:`aiogram.methods.answer_web_app_query.AnswerWebAppQuery`. Available only in private chats between a user and the bot. Not supported for messages sent on behalf of a Telegram Business account.\n",
"name": "web_app",
"required": false
},
@ -53,25 +53,25 @@
},
{
"type": "String",
"description": "If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted.",
"html_description": "<td><em>Optional</em>. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted.</td>",
"rst_description": "*Optional*. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted.\n",
"description": "If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. Not supported for messages sent on behalf of a Telegram Business account.",
"html_description": "<td><em>Optional</em>. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. Not supported for messages sent on behalf of a Telegram Business account.</td>",
"rst_description": "*Optional*. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. Not supported for messages sent on behalf of a Telegram Business account.\n",
"name": "switch_inline_query",
"required": false
},
{
"type": "String",
"description": "If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.\n\nThis offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options.",
"html_description": "<td><em>Optional</em>. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.<br/>\n<br/>\nThis offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options.</td>",
"rst_description": "*Optional*. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.\n\n\n\nThis offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options.\n",
"description": "If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.\n\nThis offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent on behalf of a Telegram Business account.",
"html_description": "<td><em>Optional</em>. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.<br/>\n<br/>\nThis offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent on behalf of a Telegram Business account.</td>",
"rst_description": "*Optional*. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.\n\n\n\nThis offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent on behalf of a Telegram Business account.\n",
"name": "switch_inline_query_current_chat",
"required": false
},
{
"type": "SwitchInlineQueryChosenChat",
"description": "If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field",
"html_description": "<td><em>Optional</em>. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field</td>",
"rst_description": "*Optional*. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field\n",
"description": "If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent on behalf of a Telegram Business account.",
"html_description": "<td><em>Optional</em>. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent on behalf of a Telegram Business account.</td>",
"rst_description": "*Optional*. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent on behalf of a Telegram Business account.\n",
"name": "switch_inline_query_chosen_chat",
"required": false
},

6
.butcher/types/InlineQueryResultLocation/entity.json
View file

@ -61,9 +61,9 @@
},
{
"type": "Integer",
"description": "Period in seconds for which the location can be updated, should be between 60 and 86400.",
"html_description": "<td><em>Optional</em>. Period in seconds for which the location can be updated, should be between 60 and 86400.</td>",
"rst_description": "*Optional*. Period in seconds for which the location can be updated, should be between 60 and 86400.\n",
"description": "Period in seconds during which the location can be updated, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.",
"html_description": "<td><em>Optional</em>. Period in seconds during which the location can be updated, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.</td>",
"rst_description": "*Optional*. Period in seconds during which the location can be updated, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.\n",
"name": "live_period",
"required": false
},

6
.butcher/types/InputLocationMessageContent/entity.json
View file

@ -37,9 +37,9 @@
},
{
"type": "Integer",
"description": "Period in seconds for which the location can be updated, should be between 60 and 86400.",
"html_description": "<td><em>Optional</em>. Period in seconds for which the location can be updated, should be between 60 and 86400.</td>",
"rst_description": "*Optional*. Period in seconds for which the location can be updated, should be between 60 and 86400.\n",
"description": "Period in seconds during which the location can be updated, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.",
"html_description": "<td><em>Optional</em>. Period in seconds during which the location can be updated, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.</td>",
"rst_description": "*Optional*. Period in seconds during which the location can be updated, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.\n",
"name": "live_period",
"required": false
},

1
.butcher/types/InputPollOption/default.yml Normal file
View file

@ -0,0 +1 @@
text_parse_mode: parse_mode

41
.butcher/types/InputPollOption/entity.json Normal file
View file

@ -0,0 +1,41 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "inputpolloption",
"name": "InputPollOption",
"description": "This object contains information about one answer option in a poll to send.",
"html_description": "<p>This object contains information about one answer option in a poll to send.</p>",
"rst_description": "This object contains information about one answer option in a poll to send.",
"annotations": [
{
"type": "String",
"description": "Option text, 1-100 characters",
"html_description": "<td>Option text, 1-100 characters</td>",
"rst_description": "Option text, 1-100 characters\n",
"name": "text",
"required": true
},
{
"type": "String",
"description": "Mode for parsing entities in the text. See formatting options for more details. Currently, only custom emoji entities are allowed",
"html_description": "<td><em>Optional</em>. Mode for parsing entities in the text. See <a href=\"#formatting-options\">formatting options</a> for more details. Currently, only custom emoji entities are allowed</td>",
"rst_description": "*Optional*. Mode for parsing entities in the text. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details. Currently, only custom emoji entities are allowed\n",
"name": "text_parse_mode",
"required": false
},
{
"type": "Array of MessageEntity",
"description": "A JSON-serialized list of special entities that appear in the poll option text. It can be specified instead of text_parse_mode",
"html_description": "<td><em>Optional</em>. A JSON-serialized list of special entities that appear in the poll option text. It can be specified instead of <em>text_parse_mode</em></td>",
"rst_description": "*Optional*. A JSON-serialized list of special entities that appear in the poll option text. It can be specified instead of *text_parse_mode*\n",
"name": "text_entities",
"required": false
}
],
"category": "types"
}
}

6
.butcher/types/KeyboardButtonRequestChat/entity.json
View file

@ -7,9 +7,9 @@
"object": {
"anchor": "keyboardbuttonrequestchat",
"name": "KeyboardButtonRequestChat",
"description": "This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the сhat if appropriate",
"html_description": "<p>This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the &#1089;hat if appropriate <a href=\"/bots/features#chat-and-user-selection\">More about requesting chats &#187;</a></p>",
"rst_description": "This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the сhat if appropriate `More about requesting chats » <https://core.telegram.org/bots/features#chat-and-user-selection>`_",
"description": "This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the chat if appropriate..",
"html_description": "<p>This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the chat if appropriate. <a href=\"/bots/features#chat-and-user-selection\">More about requesting chats &#187;</a>.</p>",
"rst_description": "This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the chat if appropriate. `More about requesting chats » <https://core.telegram.org/bots/features#chat-and-user-selection>`_.",
"annotations": [
{
"type": "Integer",

18
.butcher/types/KeyboardButtonRequestUsers/entity.json
View file

@ -45,25 +45,25 @@
},
{
"type": "Boolean",
"description": "Pass True to request the users' first and last name",
"html_description": "<td><em>Optional</em>. Pass <em>True</em> to request the users' first and last name</td>",
"rst_description": "*Optional*. Pass :code:`True` to request the users' first and last name\n",
"description": "Pass True to request the users' first and last names",
"html_description": "<td><em>Optional</em>. Pass <em>True</em> to request the users' first and last names</td>",
"rst_description": "*Optional*. Pass :code:`True` to request the users' first and last names\n",
"name": "request_name",
"required": false
},
{
"type": "Boolean",
"description": "Pass True to request the users' username",
"html_description": "<td><em>Optional</em>. Pass <em>True</em> to request the users' username</td>",
"rst_description": "*Optional*. Pass :code:`True` to request the users' username\n",
"description": "Pass True to request the users' usernames",
"html_description": "<td><em>Optional</em>. Pass <em>True</em> to request the users' usernames</td>",
"rst_description": "*Optional*. Pass :code:`True` to request the users' usernames\n",
"name": "request_username",
"required": false
},
{
"type": "Boolean",
"description": "Pass True to request the users' photo",
"html_description": "<td><em>Optional</em>. Pass <em>True</em> to request the users' photo</td>",
"rst_description": "*Optional*. Pass :code:`True` to request the users' photo\n",
"description": "Pass True to request the users' photos",
"html_description": "<td><em>Optional</em>. Pass <em>True</em> to request the users' photos</td>",
"rst_description": "*Optional*. Pass :code:`True` to request the users' photos\n",
"name": "request_photo",
"required": false
}

8
.butcher/types/Message/entity.json
View file

@ -523,6 +523,14 @@
"name": "boost_added",
"required": false
},
{
"type": "ChatBackground",
"description": "Service message: chat background set",
"html_description": "<td><em>Optional</em>. Service message: chat background set</td>",
"rst_description": "*Optional*. Service message: chat background set\n",
"name": "chat_background_set",
"required": false
},
{
"type": "ForumTopicCreated",
"description": "Service message: forum topic created",

8
.butcher/types/Poll/entity.json
View file

@ -27,6 +27,14 @@
"name": "question",
"required": true
},
{
"type": "Array of MessageEntity",
"description": "Special entities that appear in the question. Currently, only custom emoji entities are allowed in poll questions",
"html_description": "<td><em>Optional</em>. Special entities that appear in the <em>question</em>. Currently, only custom emoji entities are allowed in poll questions</td>",
"rst_description": "*Optional*. Special entities that appear in the *question*. Currently, only custom emoji entities are allowed in poll questions\n",
"name": "question_entities",
"required": false
},
{
"type": "Array of PollOption",
"description": "List of poll options",

8
.butcher/types/PollOption/entity.json
View file

@ -19,6 +19,14 @@
"name": "text",
"required": true
},
{
"type": "Array of MessageEntity",
"description": "Special entities that appear in the option text. Currently, only custom emoji entities are allowed in poll option texts",
"html_description": "<td><em>Optional</em>. Special entities that appear in the option <em>text</em>. Currently, only custom emoji entities are allowed in poll option texts</td>",
"rst_description": "*Optional*. Special entities that appear in the option *text*. Currently, only custom emoji entities are allowed in poll option texts\n",
"name": "text_entities",
"required": false
},
{
"type": "Integer",
"description": "Number of users that voted for this option",

6
.butcher/types/ReplyKeyboardMarkup/entity.json
View file

@ -7,9 +7,9 @@
"object": {
"anchor": "replykeyboardmarkup",
"name": "ReplyKeyboardMarkup",
"description": "This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).",
"html_description": "<p>This object represents a <a href=\"/bots/features#keyboards\">custom keyboard</a> with reply options (see <a href=\"/bots/features#keyboards\">Introduction to bots</a> for details and examples).</p>",
"rst_description": "This object represents a `custom keyboard <https://core.telegram.org/bots/features#keyboards>`_ with reply options (see `Introduction to bots <https://core.telegram.org/bots/features#keyboards>`_ for details and examples).",
"description": "This object represents a custom keyboard with reply options (see Introduction to bots for details and examples). Not supported in channels and for messages sent on behalf of a Telegram Business account.",
"html_description": "<p>This object represents a <a href=\"/bots/features#keyboards\">custom keyboard</a> with reply options (see <a href=\"/bots/features#keyboards\">Introduction to bots</a> for details and examples). Not supported in channels and for messages sent on behalf of a Telegram Business account.</p>",
"rst_description": "This object represents a `custom keyboard <https://core.telegram.org/bots/features#keyboards>`_ with reply options (see `Introduction to bots <https://core.telegram.org/bots/features#keyboards>`_ for details and examples). Not supported in channels and for messages sent on behalf of a Telegram Business account.",
"annotations": [
{
"type": "Array of Array of KeyboardButton",

6
.butcher/types/ReplyKeyboardRemove/entity.json
View file

@ -7,9 +7,9 @@
"object": {
"anchor": "replykeyboardremove",
"name": "ReplyKeyboardRemove",
"description": "Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup).",
"html_description": "<p>Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see <a href=\"#replykeyboardmarkup\">ReplyKeyboardMarkup</a>).</p>",
"rst_description": "Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see :class:`aiogram.types.reply_keyboard_markup.ReplyKeyboardMarkup`).",
"description": "Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup). Not supported in channels and for messages sent on behalf of a Telegram Business account.",
"html_description": "<p>Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see <a href=\"#replykeyboardmarkup\">ReplyKeyboardMarkup</a>). Not supported in channels and for messages sent on behalf of a Telegram Business account.</p>",
"rst_description": "Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see :class:`aiogram.types.reply_keyboard_markup.ReplyKeyboardMarkup`). Not supported in channels and for messages sent on behalf of a Telegram Business account.",
"annotations": [
{
"type": "True",

6
.butcher/types/SharedUser/entity.json
View file

@ -7,9 +7,9 @@
"object": {
"anchor": "shareduser",
"name": "SharedUser",
"description": "This object contains information about a user that was shared with the bot using a KeyboardButtonRequestUser button.",
"html_description": "<p>This object contains information about a user that was shared with the bot using a <a href=\"#keyboardbuttonrequestuser\">KeyboardButtonRequestUser</a> button.</p>",
"rst_description": "This object contains information about a user that was shared with the bot using a :class:`aiogram.types.keyboard_button_request_user.KeyboardButtonRequestUser` button.",
"description": "This object contains information about a user that was shared with the bot using a KeyboardButtonRequestUsers button.",
"html_description": "<p>This object contains information about a user that was shared with the bot using a <a href=\"#keyboardbuttonrequestusers\">KeyboardButtonRequestUsers</a> button.</p>",
"rst_description": "This object contains information about a user that was shared with the bot using a :class:`aiogram.types.keyboard_button_request_users.KeyboardButtonRequestUsers` button.",
"annotations": [
{
"type": "Integer",

1
CHANGES/1480.feature.rst Normal file
View file

@ -0,0 +1 @@
Added full support of `Bot API 7.3 <https://core.telegram.org/bots/api-changelog#may-6-2024>`_

2
README.rst
View file

@ -52,7 +52,7 @@ Features
- Asynchronous (`asyncio docs <https://docs.python.org/3/library/asyncio.html>`_, :pep:`492`)
- Has type hints (:pep:`484`) and can be used with `mypy <http://mypy-lang.org/>`_
- Supports `PyPy <https://www.pypy.org/>`_
- Supports `Telegram Bot API 7.2 <https://core.telegram.org/bots/api>`_ and gets fast updates to the latest versions of the Bot API
- Supports `Telegram Bot API 7.3 <https://core.telegram.org/bots/api>`_ and gets fast updates to the latest versions of the Bot API
- Telegram Bot API integration code was `autogenerated <https://github.com/aiogram/tg-codegen>`_ and can be easily re-generated when API gets updated
- Updates router (Blueprints)
- Has Finite State Machine

4
aiogram/__meta__.py
View file

@ -1,2 +1,2 @@
__version__ = "3.5.0"
__api_version__ = "7.2"
__version__ = "3.6.0"
__api_version__ = "7.3"

62
aiogram/client/bot.py
View file

@ -160,8 +160,8 @@ from ..types import (
BotName,
BotShortDescription,
BusinessConnection,
Chat,
ChatAdministratorRights,
ChatFullInfo,
ChatInviteLink,
ChatMemberAdministrator,
ChatMemberBanned,
@ -203,6 +203,7 @@ from ..types import (
InputMediaDocument,
InputMediaPhoto,
InputMediaVideo,
InputPollOption,
InputSticker,
LabeledPrice,
LinkPreviewOptions,
@ -899,7 +900,7 @@ class Bot:
:param disable_notification: Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.
:param protect_content: Protects the contents of the sent message from forwarding and saving
:param reply_parameters: Description of the message to reply to
:param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove reply keyboard or to force a reply from the user.
:param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user
:param allow_sending_without_reply: Pass :code:`True` if the message should be sent even if the specified replied-to message is not found
:param reply_to_message_id: If the message is a reply, ID of the original message
:param request_timeout: Request timeout
@ -1408,6 +1409,7 @@ class Bot:
chat_id: Optional[Union[int, str]] = None,
message_id: Optional[int] = None,
inline_message_id: Optional[str] = None,
live_period: Optional[int] = None,
horizontal_accuracy: Optional[float] = None,
heading: Optional[int] = None,
proximity_alert_radius: Optional[int] = None,
@ -1424,6 +1426,7 @@ class Bot:
:param chat_id: Required if *inline_message_id* is not specified. Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param message_id: Required if *inline_message_id* is not specified. Identifier of the message to edit
:param inline_message_id: Required if *chat_id* and *message_id* are not specified. Identifier of the inline message
:param live_period: New period in seconds during which the location can be updated, starting from the message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the new value must not exceed the current *live_period* by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, then *live_period* remains unchanged
:param horizontal_accuracy: The radius of uncertainty for the location, measured in meters; 0-1500
:param heading: Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.
:param proximity_alert_radius: The maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.
@ -1438,6 +1441,7 @@ class Bot:
chat_id=chat_id,
message_id=message_id,
inline_message_id=inline_message_id,
live_period=live_period,
horizontal_accuracy=horizontal_accuracy,
heading=heading,
proximity_alert_radius=proximity_alert_radius,
@ -1619,15 +1623,15 @@ class Bot:
self,
chat_id: Union[int, str],
request_timeout: Optional[int] = None,
) -> Chat:
) -> ChatFullInfo:
"""
Use this method to get up to date information about the chat. Returns a :class:`aiogram.types.chat.Chat` object on success.
Use this method to get up-to-date information about the chat. Returns a :class:`aiogram.types.chat_full_info.ChatFullInfo` 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.
:return: Returns a :class:`aiogram.types.chat_full_info.ChatFullInfo` object on success.
"""
call = GetChat(
@ -2087,7 +2091,7 @@ class Bot:
: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_post_stories: Pass :code:`True` if the administrator can post stories to the chat
:param can_edit_stories: Pass :code:`True` if the administrator can edit stories posted by other users
:param can_edit_stories: Pass :code:`True` if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive
:param can_delete_stories: Pass :code:`True` if the administrator can delete stories posted by other users
:param can_post_messages: Pass :code:`True` if the administrator can post messages in the channel, or access channel statistics; for channels only
:param can_edit_messages: Pass :code:`True` if the administrator can edit messages of other users and can pin messages; for channels only
@ -2240,7 +2244,7 @@ class Bot:
:param disable_notification: Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.
:param protect_content: Protects the contents of the sent message from forwarding and saving
:param reply_parameters: Description of the message to reply to
:param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account
:param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user
:param allow_sending_without_reply: Pass :code:`True` if the message should be sent even if the specified replied-to message is not found
:param reply_to_message_id: If the message is a reply, ID of the original message
:param request_timeout: Request timeout
@ -2312,7 +2316,7 @@ class Bot:
:param disable_notification: Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.
:param protect_content: Protects the contents of the sent message from forwarding and saving
:param reply_parameters: Description of the message to reply to
:param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account
:param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user
:param allow_sending_without_reply: Pass :code:`True` if the message should be sent even if the specified replied-to message is not found
:param reply_to_message_id: If the message is a reply, ID of the original message
:param request_timeout: Request timeout
@ -2407,7 +2411,7 @@ class Bot:
:param disable_notification: Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.
:param protect_content: Protects the contents of the sent message from forwarding and saving
:param reply_parameters: Description of the message to reply to
:param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account
:param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user
:param allow_sending_without_reply: Pass :code:`True` if the message should be sent even if the specified replied-to message is not found
:param reply_to_message_id: If the message is a reply, ID of the original message
:param request_timeout: Request timeout
@ -2459,7 +2463,7 @@ class Bot:
:param disable_notification: Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.
:param protect_content: Protects the contents of the sent message from forwarding
:param reply_parameters: Description of the message to reply to
:param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account
:param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user
:param allow_sending_without_reply: Pass :code:`True` if the message should be sent even if the specified replied-to message is not found
:param reply_to_message_id: If the message is a reply, ID of the original message
:param request_timeout: Request timeout
@ -2518,7 +2522,7 @@ class Bot:
:param disable_notification: Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.
:param protect_content: Protects the contents of the sent message from forwarding and saving
:param reply_parameters: Description of the message to reply to
:param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account
:param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user
:param allow_sending_without_reply: Pass :code:`True` if the message should be sent even if the specified replied-to message is not found
:param reply_to_message_id: If the message is a reply, ID of the original message
:param request_timeout: Request timeout
@ -2570,7 +2574,7 @@ class Bot:
:param disable_notification: Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.
:param protect_content: Protects the contents of the sent message from forwarding and saving
:param reply_parameters: Description of the message to reply to
:param reply_markup: A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game. Not supported for messages sent on behalf of a business account.
:param reply_markup: A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game.
:param allow_sending_without_reply: Pass :code:`True` if the message should be sent even if the specified replied-to message is not found
:param reply_to_message_id: If the message is a reply, ID of the original message
:param request_timeout: Request timeout
@ -2727,13 +2731,13 @@ class Bot:
:param business_connection_id: Unique identifier of the business connection on behalf of which the message will be sent
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
:param horizontal_accuracy: The radius of uncertainty for the location, measured in meters; 0-1500
:param live_period: Period in seconds for which the location will be updated (see `Live Locations <https://telegram.org/blog/live-locations>`_, should be between 60 and 86400.
:param live_period: Period in seconds during which the location will be updated (see `Live Locations <https://telegram.org/blog/live-locations>`_, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.
:param heading: For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.
:param proximity_alert_radius: For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.
:param disable_notification: Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.
:param protect_content: Protects the contents of the sent message from forwarding and saving
:param reply_parameters: Description of the message to reply to
:param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account
:param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user
:param allow_sending_without_reply: Pass :code:`True` if the message should be sent even if the specified replied-to message is not found
:param reply_to_message_id: If the message is a reply, ID of the original message
:param request_timeout: Request timeout
@ -2842,7 +2846,7 @@ class Bot:
:param disable_notification: Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.
:param protect_content: Protects the contents of the sent message from forwarding and saving
:param reply_parameters: Description of the message to reply to
:param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account
:param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user
:param allow_sending_without_reply: Pass :code:`True` if the message should be sent even if the specified replied-to message is not found
:param disable_web_page_preview: Disables link previews for links in this message
:param reply_to_message_id: If the message is a reply, ID of the original message
@ -2904,7 +2908,7 @@ class Bot:
:param disable_notification: Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.
:param protect_content: Protects the contents of the sent message from forwarding and saving
:param reply_parameters: Description of the message to reply to
:param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account
:param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user
:param allow_sending_without_reply: Pass :code:`True` if the message should be sent even if the specified replied-to message is not found
:param reply_to_message_id: If the message is a reply, ID of the original message
:param request_timeout: Request timeout
@ -2933,9 +2937,11 @@ class Bot:
self,
chat_id: Union[int, str],
question: str,
options: List[str],
options: List[Union[InputPollOption, str]],
business_connection_id: Optional[str] = None,
message_thread_id: Optional[int] = None,
question_parse_mode: Optional[Union[str, Default]] = Default("parse_mode"),
question_entities: Optional[List[MessageEntity]] = None,
is_anonymous: Optional[bool] = None,
type: Optional[str] = None,
allows_multiple_answers: Optional[bool] = None,
@ -2963,23 +2969,25 @@ class Bot:
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param question: Poll question, 1-300 characters
:param options: A JSON-serialized list of answer options, 2-10 strings 1-100 characters each
:param options: A JSON-serialized list of 2-10 answer options
:param business_connection_id: Unique identifier of the business connection on behalf of which the message will be sent
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
:param question_parse_mode: Mode for parsing entities in the question. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details. Currently, only custom emoji entities are allowed
:param question_entities: A JSON-serialized list of special entities that appear in the poll question. It can be specified instead of *question_parse_mode*
:param is_anonymous: :code:`True`, if the poll needs to be anonymous, defaults to :code:`True`
:param type: Poll type, 'quiz' or 'regular', defaults to 'regular'
:param allows_multiple_answers: :code:`True`, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to :code:`False`
:param correct_option_id: 0-based identifier of the correct answer option, required for polls in quiz mode
:param explanation: Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after entities parsing
:param explanation_parse_mode: Mode for parsing entities in the explanation. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.
:param explanation_entities: A JSON-serialized list of special entities that appear in the poll explanation, which can be specified instead of *parse_mode*
:param explanation_entities: A JSON-serialized list of special entities that appear in the poll explanation. It can be specified instead of *explanation_parse_mode*
:param open_period: Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with *close_date*.
:param close_date: Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can't be used together with *open_period*.
:param is_closed: Pass :code:`True` if the poll needs to be immediately closed. This can be useful for poll preview.
:param disable_notification: Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.
:param protect_content: Protects the contents of the sent message from forwarding and saving
:param reply_parameters: Description of the message to reply to
:param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account
:param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user
:param allow_sending_without_reply: Pass :code:`True` if the message should be sent even if the specified replied-to message is not found
:param reply_to_message_id: If the message is a reply, ID of the original message
:param request_timeout: Request timeout
@ -2992,6 +3000,8 @@ class Bot:
options=options,
business_connection_id=business_connection_id,
message_thread_id=message_thread_id,
question_parse_mode=question_parse_mode,
question_entities=question_entities,
is_anonymous=is_anonymous,
type=type,
allows_multiple_answers=allows_multiple_answers,
@ -3041,7 +3051,7 @@ class Bot:
:param disable_notification: Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.
:param protect_content: Protects the contents of the sent message from forwarding and saving
:param reply_parameters: Description of the message to reply to
:param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account.
:param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user
:param allow_sending_without_reply: Pass :code:`True` if the message should be sent even if the specified replied-to message is not found
:param reply_to_message_id: If the message is a reply, ID of the original message
:param request_timeout: Request timeout
@ -3105,7 +3115,7 @@ class Bot:
:param disable_notification: Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.
:param protect_content: Protects the contents of the sent message from forwarding and saving
:param reply_parameters: Description of the message to reply to
:param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account
:param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user
:param allow_sending_without_reply: Pass :code:`True` if the message should be sent even if the specified replied-to message is not found
:param reply_to_message_id: If the message is a reply, ID of the original message
:param request_timeout: Request timeout
@ -3179,7 +3189,7 @@ class Bot:
:param disable_notification: Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.
:param protect_content: Protects the contents of the sent message from forwarding and saving
:param reply_parameters: Description of the message to reply to
:param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account
:param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user
:param allow_sending_without_reply: Pass :code:`True` if the message should be sent even if the specified replied-to message is not found
:param reply_to_message_id: If the message is a reply, ID of the original message
:param request_timeout: Request timeout
@ -3243,7 +3253,7 @@ class Bot:
:param disable_notification: Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.
:param protect_content: Protects the contents of the sent message from forwarding and saving
:param reply_parameters: Description of the message to reply to
:param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account
:param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user
:param allow_sending_without_reply: Pass :code:`True` if the message should be sent even if the specified replied-to message is not found
:param reply_to_message_id: If the message is a reply, ID of the original message
:param request_timeout: Request timeout
@ -3288,7 +3298,7 @@ class Bot:
request_timeout: Optional[int] = None,
) -> Message:
"""
Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as :class:`aiogram.types.audio.Audio` or :class:`aiogram.types.document.Document`). On success, the sent :class:`aiogram.types.message.Message` is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.
Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other formats may be sent as :class:`aiogram.types.audio.Audio` or :class:`aiogram.types.document.Document`). On success, the sent :class:`aiogram.types.message.Message` is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.
Source: https://core.telegram.org/bots/api#sendvoice
@ -3303,7 +3313,7 @@ class Bot:
:param disable_notification: Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.
:param protect_content: Protects the contents of the sent message from forwarding and saving
:param reply_parameters: Description of the message to reply to
:param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account
:param reply_markup: Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user
:param allow_sending_without_reply: Pass :code:`True` if the message should be sent even if the specified replied-to message is not found
:param reply_to_message_id: If the message is a reply, ID of the original message
:param request_timeout: Request timeout

1
aiogram/enums/content_type.py
View file

@ -45,6 +45,7 @@ class ContentType(str, Enum):
PASSPORT_DATA = "passport_data"
PROXIMITY_ALERT_TRIGGERED = "proximity_alert_triggered"
BOOST_ADDED = "boost_added"
CHAT_BACKGROUND_SET = "chat_background_set"
FORUM_TOPIC_CREATED = "forum_topic_created"
FORUM_TOPIC_EDITED = "forum_topic_edited"
FORUM_TOPIC_CLOSED = "forum_topic_closed"

2
aiogram/methods/copy_message.py
View file

@ -50,7 +50,7 @@ class CopyMessage(TelegramMethod[MessageId]):
reply_markup: Optional[
Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply]
] = None
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove reply keyboard or to force a reply from the user."""
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user"""
allow_sending_without_reply: Optional[bool] = Field(
None, json_schema_extra={"deprecated": True}
)

4
aiogram/methods/edit_message_live_location.py
View file

@ -26,6 +26,8 @@ class EditMessageLiveLocation(TelegramMethod[Union[Message, bool]]):
"""Required if *inline_message_id* is not specified. Identifier of the message to edit"""
inline_message_id: Optional[str] = None
"""Required if *chat_id* and *message_id* are not specified. Identifier of the inline message"""
live_period: Optional[int] = None
"""New period in seconds during which the location can be updated, starting from the message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the new value must not exceed the current *live_period* by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, then *live_period* remains unchanged"""
horizontal_accuracy: Optional[float] = None
"""The radius of uncertainty for the location, measured in meters; 0-1500"""
heading: Optional[int] = None
@ -47,6 +49,7 @@ class EditMessageLiveLocation(TelegramMethod[Union[Message, bool]]):
chat_id: Optional[Union[int, str]] = None,
message_id: Optional[int] = None,
inline_message_id: Optional[str] = None,
live_period: Optional[int] = None,
horizontal_accuracy: Optional[float] = None,
heading: Optional[int] = None,
proximity_alert_radius: Optional[int] = None,
@ -63,6 +66,7 @@ class EditMessageLiveLocation(TelegramMethod[Union[Message, bool]]):
chat_id=chat_id,
message_id=message_id,
inline_message_id=inline_message_id,
live_period=live_period,
horizontal_accuracy=horizontal_accuracy,
heading=heading,
proximity_alert_radius=proximity_alert_radius,

8
aiogram/methods/get_chat.py
View file

@ -2,18 +2,18 @@ from __future__ import annotations
from typing import TYPE_CHECKING, Any, Union
from ..types import Chat
from ..types import ChatFullInfo
from .base import TelegramMethod
class GetChat(TelegramMethod[Chat]):
class GetChat(TelegramMethod[ChatFullInfo]):
"""
Use this method to get up to date information about the chat. Returns a :class:`aiogram.types.chat.Chat` object on success.
Use this method to get up-to-date information about the chat. Returns a :class:`aiogram.types.chat_full_info.ChatFullInfo` object on success.
Source: https://core.telegram.org/bots/api#getchat
"""
__returning__ = Chat
__returning__ = ChatFullInfo
__api_method__ = "getChat"
chat_id: Union[int, str]

2
aiogram/methods/promote_chat_member.py
View file

@ -38,7 +38,7 @@ class PromoteChatMember(TelegramMethod[bool]):
can_post_stories: Optional[bool] = None
"""Pass :code:`True` if the administrator can post stories to the chat"""
can_edit_stories: Optional[bool] = None
"""Pass :code:`True` if the administrator can edit stories posted by other users"""
"""Pass :code:`True` if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive"""
can_delete_stories: Optional[bool] = None
"""Pass :code:`True` if the administrator can delete stories posted by other users"""
can_post_messages: Optional[bool] = None

3
aiogram/methods/send_animation.py
View file

@ -6,7 +6,6 @@ from pydantic import Field
from ..client.default import Default
from ..types import (
UNSET_PARSE_MODE,
ForceReply,
InlineKeyboardMarkup,
InputFile,
@ -62,7 +61,7 @@ class SendAnimation(TelegramMethod[Message]):
reply_markup: Optional[
Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply]
] = None
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account"""
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user"""
allow_sending_without_reply: Optional[bool] = Field(
None, json_schema_extra={"deprecated": True}
)

2
aiogram/methods/send_audio.py
View file

@ -60,7 +60,7 @@ class SendAudio(TelegramMethod[Message]):
reply_markup: Optional[
Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply]
] = None
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account"""
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user"""
allow_sending_without_reply: Optional[bool] = Field(
None, json_schema_extra={"deprecated": True}
)

2
aiogram/methods/send_contact.py
View file

@ -49,7 +49,7 @@ class SendContact(TelegramMethod[Message]):
reply_markup: Optional[
Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply]
] = None
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account"""
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user"""
allow_sending_without_reply: Optional[bool] = Field(
None, json_schema_extra={"deprecated": True}
)

2
aiogram/methods/send_dice.py
View file

@ -43,7 +43,7 @@ class SendDice(TelegramMethod[Message]):
reply_markup: Optional[
Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply]
] = None
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account"""
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user"""
allow_sending_without_reply: Optional[bool] = Field(
None, json_schema_extra={"deprecated": True}
)

3
aiogram/methods/send_document.py
View file

@ -6,7 +6,6 @@ from pydantic import Field
from ..client.default import Default
from ..types import (
UNSET_PARSE_MODE,
ForceReply,
InlineKeyboardMarkup,
InputFile,
@ -56,7 +55,7 @@ class SendDocument(TelegramMethod[Message]):
reply_markup: Optional[
Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply]
] = None
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account"""
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user"""
allow_sending_without_reply: Optional[bool] = Field(
None, json_schema_extra={"deprecated": True}
)

2
aiogram/methods/send_game.py
View file

@ -34,7 +34,7 @@ class SendGame(TelegramMethod[Message]):
reply_parameters: Optional[ReplyParameters] = None
"""Description of the message to reply to"""
reply_markup: Optional[InlineKeyboardMarkup] = None
"""A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game. Not supported for messages sent on behalf of a business account."""
"""A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game."""
allow_sending_without_reply: Optional[bool] = Field(
None, json_schema_extra={"deprecated": True}
)

4
aiogram/methods/send_location.py
View file

@ -39,7 +39,7 @@ class SendLocation(TelegramMethod[Message]):
horizontal_accuracy: Optional[float] = None
"""The radius of uncertainty for the location, measured in meters; 0-1500"""
live_period: Optional[int] = None
"""Period in seconds for which the location will be updated (see `Live Locations <https://telegram.org/blog/live-locations>`_, should be between 60 and 86400."""
"""Period in seconds during which the location will be updated (see `Live Locations <https://telegram.org/blog/live-locations>`_, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely."""
heading: Optional[int] = None
"""For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified."""
proximity_alert_radius: Optional[int] = None
@ -53,7 +53,7 @@ class SendLocation(TelegramMethod[Message]):
reply_markup: Optional[
Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply]
] = None
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account"""
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user"""
allow_sending_without_reply: Optional[bool] = Field(
None, json_schema_extra={"deprecated": True}
)

2
aiogram/methods/send_message.py
View file

@ -51,7 +51,7 @@ class SendMessage(TelegramMethod[Message]):
reply_markup: Optional[
Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply]
] = None
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account"""
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user"""
allow_sending_without_reply: Optional[bool] = Field(
None, json_schema_extra={"deprecated": True}
)

3
aiogram/methods/send_photo.py
View file

@ -6,7 +6,6 @@ from pydantic import Field
from ..client.default import Default
from ..types import (
UNSET_PARSE_MODE,
ForceReply,
InlineKeyboardMarkup,
InputFile,
@ -54,7 +53,7 @@ class SendPhoto(TelegramMethod[Message]):
reply_markup: Optional[
Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply]
] = None
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account"""
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user"""
allow_sending_without_reply: Optional[bool] = Field(
None, json_schema_extra={"deprecated": True}
)

20
aiogram/methods/send_poll.py
View file

@ -7,9 +7,9 @@ from pydantic import Field
from ..client.default import Default
from ..types import (
UNSET_PARSE_MODE,
ForceReply,
InlineKeyboardMarkup,
InputPollOption,
Message,
MessageEntity,
ReplyKeyboardMarkup,
@ -33,12 +33,16 @@ class SendPoll(TelegramMethod[Message]):
"""Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)"""
question: str
"""Poll question, 1-300 characters"""
options: List[str]
"""A JSON-serialized list of answer options, 2-10 strings 1-100 characters each"""
options: List[Union[InputPollOption, str]]
"""A JSON-serialized list of 2-10 answer options"""
business_connection_id: Optional[str] = None
"""Unique identifier of the business connection on behalf of which the message will be sent"""
message_thread_id: Optional[int] = None
"""Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"""
question_parse_mode: Optional[Union[str, Default]] = Default("parse_mode")
"""Mode for parsing entities in the question. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details. Currently, only custom emoji entities are allowed"""
question_entities: Optional[List[MessageEntity]] = None
"""A JSON-serialized list of special entities that appear in the poll question. It can be specified instead of *question_parse_mode*"""
is_anonymous: Optional[bool] = None
""":code:`True`, if the poll needs to be anonymous, defaults to :code:`True`"""
type: Optional[str] = None
@ -52,7 +56,7 @@ class SendPoll(TelegramMethod[Message]):
explanation_parse_mode: Optional[Union[str, Default]] = Default("parse_mode")
"""Mode for parsing entities in the explanation. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details."""
explanation_entities: Optional[List[MessageEntity]] = None
"""A JSON-serialized list of special entities that appear in the poll explanation, which can be specified instead of *parse_mode*"""
"""A JSON-serialized list of special entities that appear in the poll explanation. It can be specified instead of *explanation_parse_mode*"""
open_period: Optional[int] = None
"""Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with *close_date*."""
close_date: Optional[Union[datetime.datetime, datetime.timedelta, int]] = None
@ -68,7 +72,7 @@ class SendPoll(TelegramMethod[Message]):
reply_markup: Optional[
Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply]
] = None
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account"""
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user"""
allow_sending_without_reply: Optional[bool] = Field(
None, json_schema_extra={"deprecated": True}
)
@ -91,9 +95,11 @@ class SendPoll(TelegramMethod[Message]):
*,
chat_id: Union[int, str],
question: str,
options: List[str],
options: List[Union[InputPollOption, str]],
business_connection_id: Optional[str] = None,
message_thread_id: Optional[int] = None,
question_parse_mode: Optional[Union[str, Default]] = Default("parse_mode"),
question_entities: Optional[List[MessageEntity]] = None,
is_anonymous: Optional[bool] = None,
type: Optional[str] = None,
allows_multiple_answers: Optional[bool] = None,
@ -124,6 +130,8 @@ class SendPoll(TelegramMethod[Message]):
options=options,
business_connection_id=business_connection_id,
message_thread_id=message_thread_id,
question_parse_mode=question_parse_mode,
question_entities=question_entities,
is_anonymous=is_anonymous,
type=type,
allows_multiple_answers=allows_multiple_answers,

2
aiogram/methods/send_sticker.py
View file

@ -46,7 +46,7 @@ class SendSticker(TelegramMethod[Message]):
reply_markup: Optional[
Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply]
] = None
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account."""
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user"""
allow_sending_without_reply: Optional[bool] = Field(
None, json_schema_extra={"deprecated": True}
)

2
aiogram/methods/send_venue.py
View file

@ -57,7 +57,7 @@ class SendVenue(TelegramMethod[Message]):
reply_markup: Optional[
Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply]
] = None
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account"""
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user"""
allow_sending_without_reply: Optional[bool] = Field(
None, json_schema_extra={"deprecated": True}
)

3
aiogram/methods/send_video.py
View file

@ -6,7 +6,6 @@ from pydantic import Field
from ..client.default import Default
from ..types import (
UNSET_PARSE_MODE,
ForceReply,
InlineKeyboardMarkup,
InputFile,
@ -64,7 +63,7 @@ class SendVideo(TelegramMethod[Message]):
reply_markup: Optional[
Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply]
] = None
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account"""
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user"""
allow_sending_without_reply: Optional[bool] = Field(
None, json_schema_extra={"deprecated": True}
)

2
aiogram/methods/send_video_note.py
View file

@ -50,7 +50,7 @@ class SendVideoNote(TelegramMethod[Message]):
reply_markup: Optional[
Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply]
] = None
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account"""
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user"""
allow_sending_without_reply: Optional[bool] = Field(
None, json_schema_extra={"deprecated": True}
)

5
aiogram/methods/send_voice.py
View file

@ -6,7 +6,6 @@ from pydantic import Field
from ..client.default import Default
from ..types import (
UNSET_PARSE_MODE,
ForceReply,
InlineKeyboardMarkup,
InputFile,
@ -21,7 +20,7 @@ from .base import TelegramMethod
class SendVoice(TelegramMethod[Message]):
"""
Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as :class:`aiogram.types.audio.Audio` or :class:`aiogram.types.document.Document`). On success, the sent :class:`aiogram.types.message.Message` is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.
Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other formats may be sent as :class:`aiogram.types.audio.Audio` or :class:`aiogram.types.document.Document`). On success, the sent :class:`aiogram.types.message.Message` is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.
Source: https://core.telegram.org/bots/api#sendvoice
"""
@ -54,7 +53,7 @@ class SendVoice(TelegramMethod[Message]):
reply_markup: Optional[
Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply]
] = None
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account"""
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user"""
allow_sending_without_reply: Optional[bool] = Field(
None, json_schema_extra={"deprecated": True}
)

24
aiogram/types/__init__.py
View file

@ -2,6 +2,15 @@ from typing import List, Literal, Optional, Union
from .animation import Animation
from .audio import Audio
from .background_fill import BackgroundFill
from .background_fill_freeform_gradient import BackgroundFillFreeformGradient
from .background_fill_gradient import BackgroundFillGradient
from .background_fill_solid import BackgroundFillSolid
from .background_type import BackgroundType
from .background_type_chat_theme import BackgroundTypeChatTheme
from .background_type_fill import BackgroundTypeFill
from .background_type_pattern import BackgroundTypePattern
from .background_type_wallpaper import BackgroundTypeWallpaper
from .base import UNSET_PARSE_MODE, TelegramObject
from .birthdate import Birthdate
from .bot_command import BotCommand
@ -28,6 +37,7 @@ from .callback_game import CallbackGame
from .callback_query import CallbackQuery
from .chat import Chat
from .chat_administrator_rights import ChatAdministratorRights
from .chat_background import ChatBackground
from .chat_boost import ChatBoost
from .chat_boost_added import ChatBoostAdded
from .chat_boost_removed import ChatBoostRemoved
@ -36,6 +46,7 @@ from .chat_boost_source_gift_code import ChatBoostSourceGiftCode
from .chat_boost_source_giveaway import ChatBoostSourceGiveaway
from .chat_boost_source_premium import ChatBoostSourcePremium
from .chat_boost_updated import ChatBoostUpdated
from .chat_full_info import ChatFullInfo
from .chat_invite_link import ChatInviteLink
from .chat_join_request import ChatJoinRequest
from .chat_location import ChatLocation
@ -112,6 +123,7 @@ from .input_media_document import InputMediaDocument
from .input_media_photo import InputMediaPhoto
from .input_media_video import InputMediaVideo
from .input_message_content import InputMessageContent
from .input_poll_option import InputPollOption
from .input_sticker import InputSticker
from .input_text_message_content import InputTextMessageContent
from .input_venue_message_content import InputVenueMessageContent
@ -204,6 +216,15 @@ from .write_access_allowed import WriteAccessAllowed
__all__ = (
"Animation",
"Audio",
"BackgroundFill",
"BackgroundFillFreeformGradient",
"BackgroundFillGradient",
"BackgroundFillSolid",
"BackgroundType",
"BackgroundTypeChatTheme",
"BackgroundTypeFill",
"BackgroundTypePattern",
"BackgroundTypeWallpaper",
"Birthdate",
"BotCommand",
"BotCommandScope",
@ -228,6 +249,7 @@ __all__ = (
"CallbackQuery",
"Chat",
"ChatAdministratorRights",
"ChatBackground",
"ChatBoost",
"ChatBoostAdded",
"ChatBoostRemoved",
@ -236,6 +258,7 @@ __all__ = (
"ChatBoostSourceGiveaway",
"ChatBoostSourcePremium",
"ChatBoostUpdated",
"ChatFullInfo",
"ChatInviteLink",
"ChatJoinRequest",
"ChatLocation",
@ -314,6 +337,7 @@ __all__ = (
"InputMediaPhoto",
"InputMediaVideo",
"InputMessageContent",
"InputPollOption",
"InputSticker",
"InputTextMessageContent",
"InputVenueMessageContent",

13
aiogram/types/background_fill.py Normal file
View file

@ -0,0 +1,13 @@
from .base import TelegramObject
class BackgroundFill(TelegramObject):
"""
This object describes the way a background is filled based on the selected colors. Currently, it can be one of
- :class:`aiogram.types.background_fill_solid.BackgroundFillSolid`
- :class:`aiogram.types.background_fill_gradient.BackgroundFillGradient`
- :class:`aiogram.types.background_fill_freeform_gradient.BackgroundFillFreeformGradient`
Source: https://core.telegram.org/bots/api#backgroundfill
"""

33
aiogram/types/background_fill_freeform_gradient.py Normal file
View file

@ -0,0 +1,33 @@
from typing import TYPE_CHECKING, Any, List, Literal
from .background_fill import BackgroundFill
class BackgroundFillFreeformGradient(BackgroundFill):
"""
The background is a freeform gradient that rotates after every message in the chat.
Source: https://core.telegram.org/bots/api#backgroundfillfreeformgradient
"""
type: Literal["freeform_gradient"] = "freeform_gradient"
"""Type of the background fill, always 'freeform_gradient'"""
colors: List[int]
"""A list of the 3 or 4 base colors that are used to generate the freeform gradient in the RGB24 format"""
if TYPE_CHECKING:
# DO NOT EDIT MANUALLY!!!
# This section was auto-generated via `butcher`
def __init__(
__pydantic__self__,
*,
type: Literal["freeform_gradient"] = "freeform_gradient",
colors: List[int],
**__pydantic_kwargs: Any,
) -> None:
# DO NOT EDIT MANUALLY!!!
# This method was auto-generated via `butcher`
# Is needed only for type checking and IDE support without any additional plugins
super().__init__(type=type, colors=colors, **__pydantic_kwargs)

45
aiogram/types/background_fill_gradient.py Normal file
View file

@ -0,0 +1,45 @@
from typing import TYPE_CHECKING, Any, Literal
from .background_fill import BackgroundFill
class BackgroundFillGradient(BackgroundFill):
"""
The background is a gradient fill.
Source: https://core.telegram.org/bots/api#backgroundfillgradient
"""
type: Literal["gradient"] = "gradient"
"""Type of the background fill, always 'gradient'"""
top_color: int
"""Top color of the gradient in the RGB24 format"""
bottom_color: int
"""Bottom color of the gradient in the RGB24 format"""
rotation_angle: int
"""Clockwise rotation angle of the background fill in degrees; 0-359"""
if TYPE_CHECKING:
# DO NOT EDIT MANUALLY!!!
# This section was auto-generated via `butcher`
def __init__(
__pydantic__self__,
*,
type: Literal["gradient"] = "gradient",
top_color: int,
bottom_color: int,
rotation_angle: int,
**__pydantic_kwargs: Any,
) -> None:
# DO NOT EDIT MANUALLY!!!
# This method was auto-generated via `butcher`
# Is needed only for type checking and IDE support without any additional plugins
super().__init__(
type=type,
top_color=top_color,
bottom_color=bottom_color,
rotation_angle=rotation_angle,
**__pydantic_kwargs,
)

33
aiogram/types/background_fill_solid.py Normal file
View file

@ -0,0 +1,33 @@
from typing import TYPE_CHECKING, Any, Literal
from .background_fill import BackgroundFill
class BackgroundFillSolid(BackgroundFill):
"""
The background is filled using the selected color.
Source: https://core.telegram.org/bots/api#backgroundfillsolid
"""
type: Literal["solid"] = "solid"
"""Type of the background fill, always 'solid'"""
color: int
"""The color of the background fill in the RGB24 format"""
if TYPE_CHECKING:
# DO NOT EDIT MANUALLY!!!
# This section was auto-generated via `butcher`
def __init__(
__pydantic__self__,
*,
type: Literal["solid"] = "solid",
color: int,
**__pydantic_kwargs: Any,
) -> None:
# DO NOT EDIT MANUALLY!!!
# This method was auto-generated via `butcher`
# Is needed only for type checking and IDE support without any additional plugins
super().__init__(type=type, color=color, **__pydantic_kwargs)

14
aiogram/types/background_type.py Normal file
View file

@ -0,0 +1,14 @@
from .base import TelegramObject
class BackgroundType(TelegramObject):
"""
This object describes the type of a background. Currently, it can be one of
- :class:`aiogram.types.background_type_fill.BackgroundTypeFill`
- :class:`aiogram.types.background_type_wallpaper.BackgroundTypeWallpaper`
- :class:`aiogram.types.background_type_pattern.BackgroundTypePattern`
- :class:`aiogram.types.background_type_chat_theme.BackgroundTypeChatTheme`
Source: https://core.telegram.org/bots/api#backgroundtype
"""

33
aiogram/types/background_type_chat_theme.py Normal file
View file

@ -0,0 +1,33 @@
from typing import TYPE_CHECKING, Any, Literal
from .background_type import BackgroundType
class BackgroundTypeChatTheme(BackgroundType):
"""
The background is taken directly from a built-in chat theme.
Source: https://core.telegram.org/bots/api#backgroundtypechattheme
"""
type: Literal["chat_theme"] = "chat_theme"
"""Type of the background, always 'chat_theme'"""
theme_name: str
"""Name of the chat theme, which is usually an emoji"""
if TYPE_CHECKING:
# DO NOT EDIT MANUALLY!!!
# This section was auto-generated via `butcher`
def __init__(
__pydantic__self__,
*,
type: Literal["chat_theme"] = "chat_theme",
theme_name: str,
**__pydantic_kwargs: Any,
) -> None:
# DO NOT EDIT MANUALLY!!!
# This method was auto-generated via `butcher`
# Is needed only for type checking and IDE support without any additional plugins
super().__init__(type=type, theme_name=theme_name, **__pydantic_kwargs)

47
aiogram/types/background_type_fill.py Normal file
View file

@ -0,0 +1,47 @@
from __future__ import annotations
from typing import TYPE_CHECKING, Any, Literal, Union
from .background_type import BackgroundType
if TYPE_CHECKING:
from .background_fill_freeform_gradient import BackgroundFillFreeformGradient
from .background_fill_gradient import BackgroundFillGradient
from .background_fill_solid import BackgroundFillSolid
class BackgroundTypeFill(BackgroundType):
"""
The background is automatically filled based on the selected colors.
Source: https://core.telegram.org/bots/api#backgroundtypefill
"""
type: Literal["fill"] = "fill"
"""Type of the background, always 'fill'"""
fill: Union[BackgroundFillSolid, BackgroundFillGradient, BackgroundFillFreeformGradient]
"""The background fill"""
dark_theme_dimming: int
"""Dimming of the background in dark themes, as a percentage; 0-100"""
if TYPE_CHECKING:
# DO NOT EDIT MANUALLY!!!
# This section was auto-generated via `butcher`
def __init__(
__pydantic__self__,
*,
type: Literal["fill"] = "fill",
fill: Union[
BackgroundFillSolid, BackgroundFillGradient, BackgroundFillFreeformGradient
],
dark_theme_dimming: int,
**__pydantic_kwargs: Any,
) -> None:
# DO NOT EDIT MANUALLY!!!
# This method was auto-generated via `butcher`
# Is needed only for type checking and IDE support without any additional plugins
super().__init__(
type=type, fill=fill, dark_theme_dimming=dark_theme_dimming, **__pydantic_kwargs
)

63
aiogram/types/background_type_pattern.py Normal file
View file

@ -0,0 +1,63 @@
from __future__ import annotations
from typing import TYPE_CHECKING, Any, Literal, Optional, Union
from .background_type import BackgroundType
if TYPE_CHECKING:
from .background_fill_freeform_gradient import BackgroundFillFreeformGradient
from .background_fill_gradient import BackgroundFillGradient
from .background_fill_solid import BackgroundFillSolid
from .document import Document
class BackgroundTypePattern(BackgroundType):
"""
The background is a PNG or TGV (gzipped subset of SVG with MIME type 'application/x-tgwallpattern') pattern to be combined with the background fill chosen by the user.
Source: https://core.telegram.org/bots/api#backgroundtypepattern
"""
type: Literal["pattern"] = "pattern"
"""Type of the background, always 'pattern'"""
document: Document
"""Document with the pattern"""
fill: Union[BackgroundFillSolid, BackgroundFillGradient, BackgroundFillFreeformGradient]
"""The background fill that is combined with the pattern"""
intensity: int
"""Intensity of the pattern when it is shown above the filled background; 0-100"""
is_inverted: Optional[bool] = None
"""*Optional*. :code:`True`, if the background fill must be applied only to the pattern itself. All other pixels are black in this case. For dark themes only"""
is_moving: Optional[bool] = None
"""*Optional*. :code:`True`, if the background moves slightly when the device is tilted"""
if TYPE_CHECKING:
# DO NOT EDIT MANUALLY!!!
# This section was auto-generated via `butcher`
def __init__(
__pydantic__self__,
*,
type: Literal["pattern"] = "pattern",
document: Document,
fill: Union[
BackgroundFillSolid, BackgroundFillGradient, BackgroundFillFreeformGradient
],
intensity: int,
is_inverted: Optional[bool] = None,
is_moving: Optional[bool] = None,
**__pydantic_kwargs: Any,
) -> None:
# DO NOT EDIT MANUALLY!!!
# This method was auto-generated via `butcher`
# Is needed only for type checking and IDE support without any additional plugins
super().__init__(
type=type,
document=document,
fill=fill,
intensity=intensity,
is_inverted=is_inverted,
is_moving=is_moving,
**__pydantic_kwargs,
)

54
aiogram/types/background_type_wallpaper.py Normal file
View file

@ -0,0 +1,54 @@
from __future__ import annotations
from typing import TYPE_CHECKING, Any, Literal, Optional
from .background_type import BackgroundType
if TYPE_CHECKING:
from .document import Document
class BackgroundTypeWallpaper(BackgroundType):
"""
The background is a wallpaper in the JPEG format.
Source: https://core.telegram.org/bots/api#backgroundtypewallpaper
"""
type: Literal["wallpaper"] = "wallpaper"
"""Type of the background, always 'wallpaper'"""
document: Document
"""Document with the wallpaper"""
dark_theme_dimming: int
"""Dimming of the background in dark themes, as a percentage; 0-100"""
is_blurred: Optional[bool] = None
"""*Optional*. :code:`True`, if the wallpaper is downscaled to fit in a 450x450 square and then box-blurred with radius 12"""
is_moving: Optional[bool] = None
"""*Optional*. :code:`True`, if the background moves slightly when the device is tilted"""
if TYPE_CHECKING:
# DO NOT EDIT MANUALLY!!!
# This section was auto-generated via `butcher`
def __init__(
__pydantic__self__,
*,
type: Literal["wallpaper"] = "wallpaper",
document: Document,
dark_theme_dimming: int,
is_blurred: Optional[bool] = None,
is_moving: Optional[bool] = None,
**__pydantic_kwargs: Any,
) -> None:
# DO NOT EDIT MANUALLY!!!
# This method was auto-generated via `butcher`
# Is needed only for type checking and IDE support without any additional plugins
super().__init__(
type=type,
document=document,
dark_theme_dimming=dark_theme_dimming,
is_blurred=is_blurred,
is_moving=is_moving,
**__pydantic_kwargs,
)

2
aiogram/types/birthdate.py
View file

@ -7,7 +7,7 @@ from .base import TelegramObject
class Birthdate(TelegramObject):
"""
Describes the birthdate of a user.
Source: https://core.telegram.org/bots/api#birthdate
"""

2
aiogram/types/business_intro.py
View file

@ -10,7 +10,7 @@ if TYPE_CHECKING:
class BusinessIntro(TelegramObject):
"""
Contains information about the start page settings of a Telegram Business account.
Source: https://core.telegram.org/bots/api#businessintro
"""

2
aiogram/types/business_location.py
View file

@ -10,7 +10,7 @@ if TYPE_CHECKING:
class BusinessLocation(TelegramObject):
"""
Contains information about the location of a Telegram Business account.
Source: https://core.telegram.org/bots/api#businesslocation
"""

2
aiogram/types/business_messages_deleted.py
View file

@ -20,7 +20,7 @@ class BusinessMessagesDeleted(TelegramObject):
chat: Chat
"""Information about a chat in the business account. The bot may not have access to the chat or the corresponding user."""
message_ids: List[int]
"""A JSON-serialized list of identifiers of deleted messages in the chat of the business account"""
"""The list of identifiers of deleted messages in the chat of the business account"""
if TYPE_CHECKING:
# DO NOT EDIT MANUALLY!!!

2
aiogram/types/business_opening_hours.py
View file

@ -10,7 +10,7 @@ if TYPE_CHECKING:
class BusinessOpeningHours(TelegramObject):
"""
Describes the opening hours of a business.
Source: https://core.telegram.org/bots/api#businessopeninghours
"""

Some files were not shown because too many files have changed in this diff Show more