python/aiogram
1
0
Fork 0
mirror of https://github.com/aiogram/aiogram.git synced 2026-04-08 16:37:47 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Add support for Telegram Bot API 9.1 (#1704)

Browse source 
* Add support for Telegram Bot API 9.1 features, including checklists, gifts, and new methods like `SendChecklist`, `EditMessageChecklist`, and `GetMyStarBalance`. Update changelog and improve `True` field descriptions.

* Bump API Version

* Refactor profile photo types to use `InputProfilePhotoType` enums instead of hardcoded literals

* Refactor imports and clean up redundant code across methods, types, and webhook server classes
This commit is contained in:
Alex Root Junior 2025-07-05 03:02:44 +03:00 • committed by GitHub
parent 77ca49518e
commit f060c08d16
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
117 changed files with 2565 additions and 466 deletions
Download patch file Download diff file Expand all files Collapse all files

2
.butcher/enums/InputProfileType.yml
View file

@ -5,7 +5,7 @@ description: |
Source: https://core.telegram.org/bots/api#inputprofilephoto
multi_parse:
attribute: type
regexp: "must be '([a-z_]+)'"
regexp: "must be *([a-z_]+)*"
entities:
- InputProfilePhotoStatic
- InputProfilePhotoAnimated

2
.butcher/enums/InputStoryContentPhotoType.yml
View file

@ -5,7 +5,7 @@ description: |
Source: https://core.telegram.org/bots/api#inputstorycontentphoto
multi_parse:
attribute: type
regexp: "must be '([a-z_]+)'"
regexp: "must be *([a-z_]+)*"
entities:
- InputStoryContentPhoto
- InputStoryContentVideo

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

@ -7,9 +7,9 @@
"object": {
"anchor": "deletebusinessmessages",
"name": "deleteBusinessMessages",
"description": "Delete messages on behalf of a business account. Requires the can_delete_outgoing_messages business bot right to delete messages sent by the bot itself, or the can_delete_all_messages business bot right to delete any message. Returns True on success.",
"html_description": "<p>Delete messages on behalf of a business account. Requires the <em>can_delete_outgoing_messages</em> business bot right to delete messages sent by the bot itself, or the <em>can_delete_all_messages</em> business bot right to delete any message. Returns <em>True</em> on success.</p>",
"rst_description": "Delete messages on behalf of a business account. Requires the *can_delete_outgoing_messages* business bot right to delete messages sent by the bot itself, or the *can_delete_all_messages* business bot right to delete any message. Returns :code:`True` on success.",
"description": "Delete messages on behalf of a business account. Requires the can_delete_sent_messages business bot right to delete messages sent by the bot itself, or the can_delete_all_messages business bot right to delete any message. Returns True on success.",
"html_description": "<p>Delete messages on behalf of a business account. Requires the <em>can_delete_sent_messages</em> business bot right to delete messages sent by the bot itself, or the <em>can_delete_all_messages</em> business bot right to delete any message. Returns <em>True</em> on success.</p>",
"rst_description": "Delete messages on behalf of a business account. Requires the *can_delete_sent_messages* business bot right to delete messages sent by the bot itself, or the *can_delete_all_messages* business bot right to delete any message. Returns :code:`True` on success.",
"annotations": [
{
"type": "String",

57
.butcher/methods/editMessageChecklist/entity.json Normal file
View file

@ -0,0 +1,57 @@
{
"meta": {},
"group": {
"title": "Updating messages",
"anchor": "updating-messages"
},
"object": {
"anchor": "editmessagechecklist",
"name": "editMessageChecklist",
"description": "Use this method to edit a checklist on behalf of a connected business account. On success, the edited Message is returned.",
"html_description": "<p>Use this method to edit a checklist on behalf of a connected business account. On success, the edited <a href=\"#message\">Message</a> is returned.</p>",
"rst_description": "Use this method to edit a checklist on behalf of a connected business account. On success, the edited :class:`aiogram.types.message.Message` is returned.",
"annotations": [
{
"type": "String",
"required": true,
"description": "Unique identifier of the business connection on behalf of which the message will be sent",
"html_description": "<td>Unique identifier of the business connection on behalf of which the message will be sent</td>",
"rst_description": "Unique identifier of the business connection on behalf of which the message will be sent\n",
"name": "business_connection_id"
},
{
"type": "Integer",
"required": true,
"description": "Unique identifier for the target chat",
"html_description": "<td>Unique identifier for the target chat</td>",
"rst_description": "Unique identifier for the target chat\n",
"name": "chat_id"
},
{
"type": "Integer",
"required": true,
"description": "Unique identifier for the target message",
"html_description": "<td>Unique identifier for the target message</td>",
"rst_description": "Unique identifier for the target message\n",
"name": "message_id"
},
{
"type": "InputChecklist",
"required": true,
"description": "A JSON-serialized object for the new checklist",
"html_description": "<td>A JSON-serialized object for the new checklist</td>",
"rst_description": "A JSON-serialized object for the new checklist\n",
"name": "checklist"
},
{
"type": "InlineKeyboardMarkup",
"required": false,
"description": "A JSON-serialized object for the new inline keyboard for the message",
"html_description": "<td>A JSON-serialized object for the new inline keyboard for the message</td>",
"rst_description": "A JSON-serialized object for the new inline keyboard for the message\n",
"name": "reply_markup"
}
],
"category": "methods"
}
}

24
.butcher/methods/getBusinessAccountGifts/entity.json
View file

@ -23,48 +23,48 @@
"type": "Boolean",
"required": false,
"description": "Pass True to exclude gifts that aren't saved to the account's profile page",
"html_description": "<td>Pass True to exclude gifts that aren't saved to the account's profile page</td>",
"rst_description": "Pass True to exclude gifts that aren't saved to the account's profile page\n",
"html_description": "<td>Pass <em>True</em> to exclude gifts that aren't saved to the account's profile page</td>",
"rst_description": "Pass :code:`True` to exclude gifts that aren't saved to the account's profile page\n",
"name": "exclude_unsaved"
},
{
"type": "Boolean",
"required": false,
"description": "Pass True to exclude gifts that are saved to the account's profile page",
"html_description": "<td>Pass True to exclude gifts that are saved to the account's profile page</td>",
"rst_description": "Pass True to exclude gifts that are saved to the account's profile page\n",
"html_description": "<td>Pass <em>True</em> to exclude gifts that are saved to the account's profile page</td>",
"rst_description": "Pass :code:`True` to exclude gifts that are saved to the account's profile page\n",
"name": "exclude_saved"
},
{
"type": "Boolean",
"required": false,
"description": "Pass True to exclude gifts that can be purchased an unlimited number of times",
"html_description": "<td>Pass True to exclude gifts that can be purchased an unlimited number of times</td>",
"rst_description": "Pass True to exclude gifts that can be purchased an unlimited number of times\n",
"html_description": "<td>Pass <em>True</em> to exclude gifts that can be purchased an unlimited number of times</td>",
"rst_description": "Pass :code:`True` to exclude gifts that can be purchased an unlimited number of times\n",
"name": "exclude_unlimited"
},
{
"type": "Boolean",
"required": false,
"description": "Pass True to exclude gifts that can be purchased a limited number of times",
"html_description": "<td>Pass True to exclude gifts that can be purchased a limited number of times</td>",
"rst_description": "Pass True to exclude gifts that can be purchased a limited number of times\n",
"html_description": "<td>Pass <em>True</em> to exclude gifts that can be purchased a limited number of times</td>",
"rst_description": "Pass :code:`True` to exclude gifts that can be purchased a limited number of times\n",
"name": "exclude_limited"
},
{
"type": "Boolean",
"required": false,
"description": "Pass True to exclude unique gifts",
"html_description": "<td>Pass True to exclude unique gifts</td>",
"rst_description": "Pass True to exclude unique gifts\n",
"html_description": "<td>Pass <em>True</em> to exclude unique gifts</td>",
"rst_description": "Pass :code:`True` to exclude unique gifts\n",
"name": "exclude_unique"
},
{
"type": "Boolean",
"required": false,
"description": "Pass True to sort results by gift price instead of send date. Sorting is applied before pagination.",
"html_description": "<td>Pass True to sort results by gift price instead of send date. Sorting is applied before pagination.</td>",
"rst_description": "Pass True to sort results by gift price instead of send date. Sorting is applied before pagination.\n",
"html_description": "<td>Pass <em>True</em> to sort results by gift price instead of send date. Sorting is applied before pagination.</td>",
"rst_description": "Pass :code:`True` to sort results by gift price instead of send date. Sorting is applied before pagination.\n",
"name": "sort_by_price"
},
{

16
.butcher/methods/getMyStarBalance/entity.json Normal file
View file

@ -0,0 +1,16 @@
{
"meta": {},
"group": {
"title": "Payments",
"anchor": "payments"
},
"object": {
"anchor": "getmystarbalance",
"name": "getMyStarBalance",
"description": "A method to get the current Telegram Stars balance of the bot. Requires no parameters. On success, returns a StarAmount object.",
"html_description": "<p>A method to get the current Telegram Stars balance of the bot. Requires no parameters. On success, returns a <a href=\"#staramount\">StarAmount</a> object.</p>",
"rst_description": "A method to get the current Telegram Stars balance of the bot. Requires no parameters. On success, returns a :class:`aiogram.types.star_amount.StarAmount` object.",
"annotations": [],
"category": "methods"
}
}

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

@ -38,9 +38,9 @@
{
"type": "Boolean",
"required": false,
"description": "Pass True if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege.",
"html_description": "<td>Pass <em>True</em> if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege.</td>",
"rst_description": "Pass :code:`True` if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege.\n",
"description": "Pass True if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.",
"html_description": "<td>Pass <em>True</em> if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.</td>",
"rst_description": "Pass :code:`True` if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.\n",
"name": "can_manage_chat"
},
{
@ -118,9 +118,9 @@
{
"type": "Boolean",
"required": false,
"description": "Pass True if the administrator can post messages in the channel, or access channel statistics; for channels only",
"html_description": "<td>Pass <em>True</em> if the administrator can post messages in the channel, or access channel statistics; for channels only</td>",
"rst_description": "Pass :code:`True` if the administrator can post messages in the channel, or access channel statistics; for channels only\n",
"description": "Pass True if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only",
"html_description": "<td>Pass <em>True</em> if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only</td>",
"rst_description": "Pass :code:`True` if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only\n",
"name": "can_post_messages"
},
{

4
.butcher/methods/removeBusinessAccountProfilePhoto/entity.json
View file

@ -23,8 +23,8 @@
"type": "Boolean",
"required": false,
"description": "Pass True to remove the public photo, which is visible even if the main photo is hidden by the business account's privacy settings. After the main photo is removed, the previous profile photo (if present) becomes the main photo.",
"html_description": "<td>Pass True to remove the public photo, which is visible even if the main photo is hidden by the business account's privacy settings. After the main photo is removed, the previous profile photo (if present) becomes the main photo.</td>",
"rst_description": "Pass True to remove the public photo, which is visible even if the main photo is hidden by the business account's privacy settings. After the main photo is removed, the previous profile photo (if present) becomes the main photo.\n",
"html_description": "<td>Pass <em>True</em> to remove the public photo, which is visible even if the main photo is hidden by the business account's privacy settings. After the main photo is removed, the previous profile photo (if present) becomes the main photo.</td>",
"rst_description": "Pass :code:`True` to remove the public photo, which is visible even if the main photo is hidden by the business account's privacy settings. After the main photo is removed, the previous profile photo (if present) becomes the main photo.\n",
"name": "is_public"
}
],

81
.butcher/methods/sendChecklist/entity.json Normal file
View file

@ -0,0 +1,81 @@
{
"meta": {},
"group": {
"title": "Available methods",
"anchor": "available-methods"
},
"object": {
"anchor": "sendchecklist",
"name": "sendChecklist",
"description": "Use this method to send a checklist on behalf of a connected business account. On success, the sent Message is returned.",
"html_description": "<p>Use this method to send a checklist on behalf of a connected business account. On success, the sent <a href=\"#message\">Message</a> is returned.</p>",
"rst_description": "Use this method to send a checklist on behalf of a connected business account. On success, the sent :class:`aiogram.types.message.Message` is returned.",
"annotations": [
{
"type": "String",
"required": true,
"description": "Unique identifier of the business connection on behalf of which the message will be sent",
"html_description": "<td>Unique identifier of the business connection on behalf of which the message will be sent</td>",
"rst_description": "Unique identifier of the business connection on behalf of which the message will be sent\n",
"name": "business_connection_id"
},
{
"type": "Integer",
"required": true,
"description": "Unique identifier for the target chat",
"html_description": "<td>Unique identifier for the target chat</td>",
"rst_description": "Unique identifier for the target chat\n",
"name": "chat_id"
},
{
"type": "InputChecklist",
"required": true,
"description": "A JSON-serialized object for the checklist to send",
"html_description": "<td>A JSON-serialized object for the checklist to send</td>",
"rst_description": "A JSON-serialized object for the checklist to send\n",
"name": "checklist"
},
{
"type": "Boolean",
"required": false,
"description": "Sends the message silently. Users will receive a notification with no sound.",
"html_description": "<td>Sends the message silently. Users will receive a notification with no sound.</td>",
"rst_description": "Sends the message silently. Users will receive a notification with no sound.\n",
"name": "disable_notification"
},
{
"type": "Boolean",
"required": false,
"description": "Protects the contents of the sent message from forwarding and saving",
"html_description": "<td>Protects the contents of the sent message from forwarding and saving</td>",
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
"name": "protect_content"
},
{
"type": "String",
"required": false,
"description": "Unique identifier of the message effect to be added to the message",
"html_description": "<td>Unique identifier of the message effect to be added to the message</td>",
"rst_description": "Unique identifier of the message effect to be added to the message\n",
"name": "message_effect_id"
},
{
"type": "ReplyParameters",
"required": false,
"description": "A JSON-serialized object for description of the message to reply to",
"html_description": "<td>A JSON-serialized object for description of the message to reply to</td>",
"rst_description": "A JSON-serialized object for description of the message to reply to\n",
"name": "reply_parameters"
},
{
"type": "InlineKeyboardMarkup",
"required": false,
"description": "A JSON-serialized object for an inline keyboard",
"html_description": "<td>A JSON-serialized object for an inline keyboard</td>",
"rst_description": "A JSON-serialized object for an inline keyboard\n",
"name": "reply_markup"
}
],
"category": "methods"
}
}

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

@ -62,9 +62,9 @@
{
"type": "Array of InputPollOption",
"required": true,
"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",
"description": "A JSON-serialized list of 2-12 answer options",
"html_description": "<td>A JSON-serialized list of 2-12 answer options</td>",
"rst_description": "A JSON-serialized list of 2-12 answer options\n",
"name": "options"
},
{

4
.butcher/methods/setBusinessAccountGiftSettings/entity.json
View file

@ -23,8 +23,8 @@
"type": "Boolean",
"required": true,
"description": "Pass True, if a button for sending a gift to the user or by the business account must always be shown in the input field",
"html_description": "<td>Pass True, if a button for sending a gift to the user or by the business account must always be shown in the input field</td>",
"rst_description": "Pass True, if a button for sending a gift to the user or by the business account must always be shown in the input field\n",
"html_description": "<td>Pass <em>True</em>, if a button for sending a gift to the user or by the business account must always be shown in the input field</td>",
"rst_description": "Pass :code:`True`, if a button for sending a gift to the user or by the business account must always be shown in the input field\n",
"name": "show_gift_button"
},
{

4
.butcher/methods/setBusinessAccountProfilePhoto/entity.json
View file

@ -31,8 +31,8 @@
"type": "Boolean",
"required": false,
"description": "Pass True to set the public photo, which will be visible even if the main photo is hidden by the business account's privacy settings. An account can have only one public photo.",
"html_description": "<td>Pass True to set the public photo, which will be visible even if the main photo is hidden by the business account's privacy settings. An account can have only one public photo.</td>",
"rst_description": "Pass True to set the public photo, which will be visible even if the main photo is hidden by the business account's privacy settings. An account can have only one public photo.\n",
"html_description": "<td>Pass <em>True</em> to set the public photo, which will be visible even if the main photo is hidden by the business account's privacy settings. An account can have only one public photo.</td>",
"rst_description": "Pass :code:`True` to set the public photo, which will be visible even if the main photo is hidden by the business account's privacy settings. An account can have only one public photo.\n",
"name": "is_public"
}
],

4
.butcher/methods/upgradeGift/entity.json
View file

@ -31,8 +31,8 @@
"type": "Boolean",
"required": false,
"description": "Pass True to keep the original gift text, sender and receiver in the upgraded gift",
"html_description": "<td>Pass True to keep the original gift text, sender and receiver in the upgraded gift</td>",
"rst_description": "Pass True to keep the original gift text, sender and receiver in the upgraded gift\n",
"html_description": "<td>Pass <em>True</em> to keep the original gift text, sender and receiver in the upgraded gift</td>",
"rst_description": "Pass :code:`True` to keep the original gift text, sender and receiver in the upgraded gift\n",
"name": "keep_original_details"
},
{

787
.butcher/schema/schema.json
View file

File diff suppressed because one or more lines are too long

16
.butcher/types/AcceptedGiftTypes/entity.json
View file

@ -14,32 +14,32 @@
{
"type": "Boolean",
"description": "True, if unlimited regular gifts are accepted",
"html_description": "<td>True, if unlimited regular gifts are accepted</td>",
"rst_description": "True, if unlimited regular gifts are accepted\n",
"html_description": "<td><em>True</em>, if unlimited regular gifts are accepted</td>",
"rst_description": ":code:`True`, if unlimited regular gifts are accepted\n",
"name": "unlimited_gifts",
"required": true
},
{
"type": "Boolean",
"description": "True, if limited regular gifts are accepted",
"html_description": "<td>True, if limited regular gifts are accepted</td>",
"rst_description": "True, if limited regular gifts are accepted\n",
"html_description": "<td><em>True</em>, if limited regular gifts are accepted</td>",
"rst_description": ":code:`True`, if limited regular gifts are accepted\n",
"name": "limited_gifts",
"required": true
},
{
"type": "Boolean",
"description": "True, if unique gifts or gifts that can be upgraded to unique for free are accepted",
"html_description": "<td>True, if unique gifts or gifts that can be upgraded to unique for free are accepted</td>",
"rst_description": "True, if unique gifts or gifts that can be upgraded to unique for free are accepted\n",
"html_description": "<td><em>True</em>, if unique gifts or gifts that can be upgraded to unique for free are accepted</td>",
"rst_description": ":code:`True`, if unique gifts or gifts that can be upgraded to unique for free are accepted\n",
"name": "unique_gifts",
"required": true
},
{
"type": "Boolean",
"description": "True, if a Telegram Premium subscription is accepted",
"html_description": "<td>True, if a Telegram Premium subscription is accepted</td>",
"rst_description": "True, if a Telegram Premium subscription is accepted\n",
"html_description": "<td><em>True</em>, if a Telegram Premium subscription is accepted</td>",
"rst_description": ":code:`True`, if a Telegram Premium subscription is accepted\n",
"name": "premium_subscription",
"required": true
}

198
.butcher/types/BusinessBotRights/entity.json
View file

@ -14,114 +14,126 @@
{
"type": "True",
"description": "True, if the bot can send and edit messages in the private chats that had incoming messages in the last 24 hours",
"html_description": "<td><em>Optional</em>. True, if the bot can send and edit messages in the private chats that had incoming messages in the last 24 hours</td>",
"rst_description": "*Optional*. True, if the bot can send and edit messages in the private chats that had incoming messages in the last 24 hours\n",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the bot can send and edit messages in the private chats that had incoming messages in the last 24 hours</td>",
"rst_description": "*Optional*. :code:`True`, if the bot can send and edit messages in the private chats that had incoming messages in the last 24 hours\n",
"name": "can_reply",
"required": false
},
{
"type": "True",
"description": "True, if the bot can mark incoming private messages as read",
"html_description": "<td><em>Optional</em>. True, if the bot can mark incoming private messages as read</td>",
"rst_description": "*Optional*. True, if the bot can mark incoming private messages as read\n",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the bot can mark incoming private messages as read</td>",
"rst_description": "*Optional*. :code:`True`, if the bot can mark incoming private messages as read\n",
"name": "can_read_messages",
"required": false
},
{
"type": "True",
"description": "True, if the bot can delete messages sent by the bot",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the bot can delete messages sent by the bot</td>",
"rst_description": "*Optional*. :code:`True`, if the bot can delete messages sent by the bot\n",
"name": "can_delete_sent_messages",
"required": false
},
{
"type": "True",
"description": "True, if the bot can delete all private messages in managed chats",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the bot can delete all private messages in managed chats</td>",
"rst_description": "*Optional*. :code:`True`, if the bot can delete all private messages in managed chats\n",
"name": "can_delete_all_messages",
"required": false
},
{
"type": "True",
"description": "True, if the bot can edit the first and last name of the business account",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the bot can edit the first and last name of the business account</td>",
"rst_description": "*Optional*. :code:`True`, if the bot can edit the first and last name of the business account\n",
"name": "can_edit_name",
"required": false
},
{
"type": "True",
"description": "True, if the bot can edit the bio of the business account",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the bot can edit the bio of the business account</td>",
"rst_description": "*Optional*. :code:`True`, if the bot can edit the bio of the business account\n",
"name": "can_edit_bio",
"required": false
},
{
"type": "True",
"description": "True, if the bot can edit the profile photo of the business account",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the bot can edit the profile photo of the business account</td>",
"rst_description": "*Optional*. :code:`True`, if the bot can edit the profile photo of the business account\n",
"name": "can_edit_profile_photo",
"required": false
},
{
"type": "True",
"description": "True, if the bot can edit the username of the business account",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the bot can edit the username of the business account</td>",
"rst_description": "*Optional*. :code:`True`, if the bot can edit the username of the business account\n",
"name": "can_edit_username",
"required": false
},
{
"type": "True",
"description": "True, if the bot can change the privacy settings pertaining to gifts for the business account",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the bot can change the privacy settings pertaining to gifts for the business account</td>",
"rst_description": "*Optional*. :code:`True`, if the bot can change the privacy settings pertaining to gifts for the business account\n",
"name": "can_change_gift_settings",
"required": false
},
{
"type": "True",
"description": "True, if the bot can view gifts and the amount of Telegram Stars owned by the business account",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the bot can view gifts and the amount of Telegram Stars owned by the business account</td>",
"rst_description": "*Optional*. :code:`True`, if the bot can view gifts and the amount of Telegram Stars owned by the business account\n",
"name": "can_view_gifts_and_stars",
"required": false
},
{
"type": "True",
"description": "True, if the bot can convert regular gifts owned by the business account to Telegram Stars",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the bot can convert regular gifts owned by the business account to Telegram Stars</td>",
"rst_description": "*Optional*. :code:`True`, if the bot can convert regular gifts owned by the business account to Telegram Stars\n",
"name": "can_convert_gifts_to_stars",
"required": false
},
{
"type": "True",
"description": "True, if the bot can transfer and upgrade gifts owned by the business account",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the bot can transfer and upgrade gifts owned by the business account</td>",
"rst_description": "*Optional*. :code:`True`, if the bot can transfer and upgrade gifts owned by the business account\n",
"name": "can_transfer_and_upgrade_gifts",
"required": false
},
{
"type": "True",
"description": "True, if the bot can transfer Telegram Stars received by the business account to its own account, or use them to upgrade and transfer gifts",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the bot can transfer Telegram Stars received by the business account to its own account, or use them to upgrade and transfer gifts</td>",
"rst_description": "*Optional*. :code:`True`, if the bot can transfer Telegram Stars received by the business account to its own account, or use them to upgrade and transfer gifts\n",
"name": "can_transfer_stars",
"required": false
},
{
"type": "True",
"description": "True, if the bot can post, edit and delete stories on behalf of the business account",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the bot can post, edit and delete stories on behalf of the business account</td>",
"rst_description": "*Optional*. :code:`True`, if the bot can post, edit and delete stories on behalf of the business account\n",
"name": "can_manage_stories",
"required": false
},
{
"type": "True",
"description": "True, if the bot can delete messages sent by the bot",
"html_description": "<td><em>Optional</em>. True, if the bot can delete messages sent by the bot</td>",
"rst_description": "*Optional*. True, if the bot can delete messages sent by the bot\n",
"name": "can_delete_outgoing_messages",
"required": false
},
{
"type": "True",
"description": "True, if the bot can delete all private messages in managed chats",
"html_description": "<td><em>Optional</em>. True, if the bot can delete all private messages in managed chats</td>",
"rst_description": "*Optional*. True, if the bot can delete all private messages in managed chats\n",
"name": "can_delete_all_messages",
"required": false
},
{
"type": "True",
"description": "True, if the bot can edit the first and last name of the business account",
"html_description": "<td><em>Optional</em>. True, if the bot can edit the first and last name of the business account</td>",
"rst_description": "*Optional*. True, if the bot can edit the first and last name of the business account\n",
"name": "can_edit_name",
"required": false
},
{
"type": "True",
"description": "True, if the bot can edit the bio of the business account",
"html_description": "<td><em>Optional</em>. True, if the bot can edit the bio of the business account</td>",
"rst_description": "*Optional*. True, if the bot can edit the bio of the business account\n",
"name": "can_edit_bio",
"required": false
},
{
"type": "True",
"description": "True, if the bot can edit the profile photo of the business account",
"html_description": "<td><em>Optional</em>. True, if the bot can edit the profile photo of the business account</td>",
"rst_description": "*Optional*. True, if the bot can edit the profile photo of the business account\n",
"name": "can_edit_profile_photo",
"required": false
},
{
"type": "True",
"description": "True, if the bot can edit the username of the business account",
"html_description": "<td><em>Optional</em>. True, if the bot can edit the username of the business account</td>",
"rst_description": "*Optional*. True, if the bot can edit the username of the business account\n",
"name": "can_edit_username",
"required": false
},
{
"type": "True",
"description": "True, if the bot can change the privacy settings pertaining to gifts for the business account",
"html_description": "<td><em>Optional</em>. True, if the bot can change the privacy settings pertaining to gifts for the business account</td>",
"rst_description": "*Optional*. True, if the bot can change the privacy settings pertaining to gifts for the business account\n",
"name": "can_change_gift_settings",
"required": false
},
{
"type": "True",
"description": "True, if the bot can view gifts and the amount of Telegram Stars owned by the business account",
"html_description": "<td><em>Optional</em>. True, if the bot can view gifts and the amount of Telegram Stars owned by the business account</td>",
"rst_description": "*Optional*. True, if the bot can view gifts and the amount of Telegram Stars owned by the business account\n",
"name": "can_view_gifts_and_stars",
"required": false
},
{
"type": "True",
"description": "True, if the bot can convert regular gifts owned by the business account to Telegram Stars",
"html_description": "<td><em>Optional</em>. True, if the bot can convert regular gifts owned by the business account to Telegram Stars</td>",
"rst_description": "*Optional*. True, if the bot can convert regular gifts owned by the business account to Telegram Stars\n",
"name": "can_convert_gifts_to_stars",
"required": false
},
{
"type": "True",
"description": "True, if the bot can transfer and upgrade gifts owned by the business account",
"html_description": "<td><em>Optional</em>. True, if the bot can transfer and upgrade gifts owned by the business account</td>",
"rst_description": "*Optional*. True, if the bot can transfer and upgrade gifts owned by the business account\n",
"name": "can_transfer_and_upgrade_gifts",
"required": false
},
{
"type": "True",
"description": "True, if the bot can transfer Telegram Stars received by the business account to its own account, or use them to upgrade and transfer gifts",
"html_description": "<td><em>Optional</em>. True, if the bot can transfer Telegram Stars received by the business account to its own account, or use them to upgrade and transfer gifts</td>",
"rst_description": "*Optional*. True, if the bot can transfer Telegram Stars received by the business account to its own account, or use them to upgrade and transfer gifts\n",
"name": "can_transfer_stars",
"required": false
},
{
"type": "True",
"description": "True, if the bot can post, edit and delete stories on behalf of the business account",
"html_description": "<td><em>Optional</em>. True, if the bot can post, edit and delete stories on behalf of the business account</td>",
"rst_description": "*Optional*. True, if the bot can post, edit and delete stories on behalf of the business account\n",
"name": "can_manage_stories",
"required": false
"required": false,
"deprecated": {
"version": "9.1",
"release_date": "2025-07-03"
}
}
],
"category": "types"

4
.butcher/types/BusinessConnection/entity.json
View file

@ -54,8 +54,8 @@
{
"type": "Boolean",
"description": "True, if the connection is active",
"html_description": "<td>True, if the connection is active</td>",
"rst_description": "True, if the connection is active\n",
"html_description": "<td><em>True</em>, if the connection is active</td>",
"rst_description": ":code:`True`, if the connection is active\n",
"name": "is_enabled",
"required": true
},

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

@ -21,9 +21,9 @@
},
{
"type": "Boolean",
"description": "True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege.",
"html_description": "<td><em>True</em>, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege.</td>",
"rst_description": ":code:`True`, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege.\n",
"description": "True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.",
"html_description": "<td><em>True</em>, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.</td>",
"rst_description": ":code:`True`, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.\n",
"name": "can_manage_chat",
"required": true
},
@ -101,9 +101,9 @@
},
{
"type": "Boolean",
"description": "True, if the administrator can post messages in the channel, or access channel statistics; for channels only",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the administrator can post messages in the channel, or access channel statistics; for channels only</td>",
"rst_description": "*Optional*. :code:`True`, if the administrator can post messages in the channel, or access channel statistics; for channels only\n",
"description": "True, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only</td>",
"rst_description": "*Optional*. :code:`True`, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only\n",
"name": "can_post_messages",
"required": false
},

4
.butcher/types/ChatBoostSourceGiveaway/entity.json
View file

@ -46,8 +46,8 @@
{
"type": "True",
"description": "True, if the giveaway was completed, but there was no user to win the prize",
"html_description": "<td><em>Optional</em>. True, if the giveaway was completed, but there was no user to win the prize</td>",
"rst_description": "*Optional*. True, if the giveaway was completed, but there was no user to win the prize\n",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the giveaway was completed, but there was no user to win the prize</td>",
"rst_description": "*Optional*. :code:`True`, if the giveaway was completed, but there was no user to win the prize\n",
"name": "is_unclaimed",
"required": false
}

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

@ -45,9 +45,9 @@
},
{
"type": "Boolean",
"description": "True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege.",
"html_description": "<td><em>True</em>, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege.</td>",
"rst_description": ":code:`True`, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege.\n",
"description": "True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.",
"html_description": "<td><em>True</em>, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.</td>",
"rst_description": ":code:`True`, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.\n",
"name": "can_manage_chat",
"required": true
},
@ -125,9 +125,9 @@
},
{
"type": "Boolean",
"description": "True, if the administrator can post messages in the channel, or access channel statistics; for channels only",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the administrator can post messages in the channel, or access channel statistics; for channels only</td>",
"rst_description": "*Optional*. :code:`True`, if the administrator can post messages in the channel, or access channel statistics; for channels only\n",
"description": "True, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only</td>",
"rst_description": "*Optional*. :code:`True`, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only\n",
"name": "can_post_messages",
"required": false
},

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

@ -93,9 +93,9 @@
},
{
"type": "Boolean",
"description": "True, if the user is allowed to send polls",
"html_description": "<td><em>True</em>, if the user is allowed to send polls</td>",
"rst_description": ":code:`True`, if the user is allowed to send polls\n",
"description": "True, if the user is allowed to send polls and checklists",
"html_description": "<td><em>True</em>, if the user is allowed to send polls and checklists</td>",
"rst_description": ":code:`True`, if the user is allowed to send polls and checklists\n",
"name": "can_send_polls",
"required": true
},

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

@ -62,16 +62,16 @@
{
"type": "Boolean",
"description": "True, if the user joined the chat after sending a direct join request without using an invite link 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 without using an invite link and being approved by an administrator</td>",
"rst_description": "*Optional*. True, if the user joined the chat after sending a direct join request without using an invite link and being approved by an administrator\n",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the user joined the chat after sending a direct join request without using an invite link and being approved by an administrator</td>",
"rst_description": "*Optional*. :code:`True`, if the user joined the chat after sending a direct join request without using an invite link 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",
"html_description": "<td><em>Optional</em>. True, if the user joined the chat via a chat folder invite link</td>",
"rst_description": "*Optional*. True, if the user joined the chat via a chat folder invite link\n",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the user joined the chat via a chat folder invite link</td>",
"rst_description": "*Optional*. :code:`True`, if the user joined the chat via a chat folder invite link\n",
"name": "via_chat_folder_invite_link",
"required": false
}

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

@ -69,9 +69,9 @@
},
{
"type": "Boolean",
"description": "True, if the user is allowed to send polls",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the user is allowed to send polls</td>",
"rst_description": "*Optional*. :code:`True`, if the user is allowed to send polls\n",
"description": "True, if the user is allowed to send polls and checklists",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the user is allowed to send polls and checklists</td>",
"rst_description": "*Optional*. :code:`True`, if the user is allowed to send polls and checklists\n",
"name": "can_send_polls",
"required": false
},

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

@ -0,0 +1,57 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "checklist",
"name": "Checklist",
"description": "Describes a checklist.",
"html_description": "<p>Describes a checklist.</p>",
"rst_description": "Describes a checklist.",
"annotations": [
{
"type": "String",
"description": "Title of the checklist",
"html_description": "<td>Title of the checklist</td>",
"rst_description": "Title of the checklist\n",
"name": "title",
"required": true
},
{
"type": "Array of MessageEntity",
"description": "Special entities that appear in the checklist title",
"html_description": "<td><em>Optional</em>. Special entities that appear in the checklist title</td>",
"rst_description": "*Optional*. Special entities that appear in the checklist title\n",
"name": "title_entities",
"required": false
},
{
"type": "Array of ChecklistTask",
"description": "List of tasks in the checklist",
"html_description": "<td>List of tasks in the checklist</td>",
"rst_description": "List of tasks in the checklist\n",
"name": "tasks",
"required": true
},
{
"type": "True",
"description": "True, if users other than the creator of the list can add tasks to the list",
"html_description": "<td><em>Optional</em>. <em>True</em>, if users other than the creator of the list can add tasks to the list</td>",
"rst_description": "*Optional*. :code:`True`, if users other than the creator of the list can add tasks to the list\n",
"name": "others_can_add_tasks",
"required": false
},
{
"type": "True",
"description": "True, if users other than the creator of the list can mark tasks as done or not done",
"html_description": "<td><em>Optional</em>. <em>True</em>, if users other than the creator of the list can mark tasks as done or not done</td>",
"rst_description": "*Optional*. :code:`True`, if users other than the creator of the list can mark tasks as done or not done\n",
"name": "others_can_mark_tasks_as_done",
"required": false
}
],
"category": "types"
}
}

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

@ -0,0 +1,57 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "checklisttask",
"name": "ChecklistTask",
"description": "Describes a task in a checklist.",
"html_description": "<p>Describes a task in a checklist.</p>",
"rst_description": "Describes a task in a checklist.",
"annotations": [
{
"type": "Integer",
"description": "Unique identifier of the task",
"html_description": "<td>Unique identifier of the task</td>",
"rst_description": "Unique identifier of the task\n",
"name": "id",
"required": true
},
{
"type": "String",
"description": "Text of the task",
"html_description": "<td>Text of the task</td>",
"rst_description": "Text of the task\n",
"name": "text",
"required": true
},
{
"type": "Array of MessageEntity",
"description": "Special entities that appear in the task text",
"html_description": "<td><em>Optional</em>. Special entities that appear in the task text</td>",
"rst_description": "*Optional*. Special entities that appear in the task text\n",
"name": "text_entities",
"required": false
},
{
"type": "User",
"description": "User that completed the task; omitted if the task wasn't completed",
"html_description": "<td><em>Optional</em>. User that completed the task; omitted if the task wasn't completed</td>",
"rst_description": "*Optional*. User that completed the task; omitted if the task wasn't completed\n",
"name": "completed_by_user",
"required": false
},
{
"type": "Integer",
"description": "Point in time (Unix timestamp) when the task was completed; 0 if the task wasn't completed",
"html_description": "<td><em>Optional</em>. Point in time (Unix timestamp) when the task was completed; 0 if the task wasn't completed</td>",
"rst_description": "*Optional*. Point in time (Unix timestamp) when the task was completed; 0 if the task wasn't completed\n",
"name": "completion_date",
"required": false
}
],
"category": "types"
}
}

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

@ -0,0 +1,33 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "checklisttasksadded",
"name": "ChecklistTasksAdded",
"description": "Describes a service message about tasks added to a checklist.",
"html_description": "<p>Describes a service message about tasks added to a checklist.</p>",
"rst_description": "Describes a service message about tasks added to a checklist.",
"annotations": [
{
"type": "Message",
"description": "Message containing the checklist to which the tasks were added. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply.",
"html_description": "<td><em>Optional</em>. Message containing the checklist to which the tasks were added. Note that the Message object in this field will not contain the <em>reply_to_message</em> field even if it itself is a reply.</td>",
"rst_description": "*Optional*. Message containing the checklist to which the tasks were added. Note that the Message object in this field will not contain the *reply_to_message* field even if it itself is a reply.\n",
"name": "checklist_message",
"required": false
},
{
"type": "Array of ChecklistTask",
"description": "List of tasks added to the checklist",
"html_description": "<td>List of tasks added to the checklist</td>",
"rst_description": "List of tasks added to the checklist\n",
"name": "tasks",
"required": true
}
],
"category": "types"
}
}

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

@ -0,0 +1,41 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "checklisttasksdone",
"name": "ChecklistTasksDone",
"description": "Describes a service message about checklist tasks marked as done or not done.",
"html_description": "<p>Describes a service message about checklist tasks marked as done or not done.</p>",
"rst_description": "Describes a service message about checklist tasks marked as done or not done.",
"annotations": [
{
"type": "Message",
"description": "Message containing the checklist whose tasks were marked as done or not done. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply.",
"html_description": "<td><em>Optional</em>. Message containing the checklist whose tasks were marked as done or not done. Note that the Message object in this field will not contain the <em>reply_to_message</em> field even if it itself is a reply.</td>",
"rst_description": "*Optional*. Message containing the checklist whose tasks were marked as done or not done. Note that the Message object in this field will not contain the *reply_to_message* field even if it itself is a reply.\n",
"name": "checklist_message",
"required": false
},
{
"type": "Array of Integer",
"description": "Identifiers of the tasks that were marked as done",
"html_description": "<td><em>Optional</em>. Identifiers of the tasks that were marked as done</td>",
"rst_description": "*Optional*. Identifiers of the tasks that were marked as done\n",
"name": "marked_as_done_task_ids",
"required": false
},
{
"type": "Array of Integer",
"description": "Identifiers of the tasks that were marked as not done",
"html_description": "<td><em>Optional</em>. Identifiers of the tasks that were marked as not done</td>",
"rst_description": "*Optional*. Identifiers of the tasks that were marked as not done\n",
"name": "marked_as_not_done_task_ids",
"required": false
}
],
"category": "types"
}
}

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

@ -0,0 +1,33 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "directmessagepricechanged",
"name": "DirectMessagePriceChanged",
"description": "Describes a service message about a change in the price of direct messages sent to a channel chat.",
"html_description": "<p>Describes a service message about a change in the price of direct messages sent to a channel chat.</p>",
"rst_description": "Describes a service message about a change in the price of direct messages sent to a channel chat.",
"annotations": [
{
"type": "Boolean",
"description": "True, if direct messages are enabled for the channel chat; false otherwise",
"html_description": "<td><em>True</em>, if direct messages are enabled for the channel chat; false otherwise</td>",
"rst_description": ":code:`True`, if direct messages are enabled for the channel chat; false otherwise\n",
"name": "are_direct_messages_enabled",
"required": true
},
{
"type": "Integer",
"description": "The new number of Telegram Stars that must be paid by users for each direct message sent to the channel. Does not apply to users who have been exempted by administrators. Defaults to 0.",
"html_description": "<td><em>Optional</em>. The new number of Telegram Stars that must be paid by users for each direct message sent to the channel. Does not apply to users who have been exempted by administrators. Defaults to 0.</td>",
"rst_description": "*Optional*. The new number of Telegram Stars that must be paid by users for each direct message sent to the channel. Does not apply to users who have been exempted by administrators. Defaults to 0.\n",
"name": "direct_message_star_count",
"required": false
}
],
"category": "types"
}
}

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

@ -131,6 +131,14 @@
"name": "has_media_spoiler",
"required": false
},
{
"type": "Checklist",
"description": "Message is a checklist",
"html_description": "<td><em>Optional</em>. Message is a checklist</td>",
"rst_description": "*Optional*. Message is a checklist\n",
"name": "checklist",
"required": false
},
{
"type": "Contact",
"description": "Message is a shared contact, information about the contact",

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

@ -46,8 +46,8 @@
{
"type": "True",
"description": "True, if the gift can be upgraded to a unique gift",
"html_description": "<td><em>Optional</em>. True, if the gift can be upgraded to a unique gift</td>",
"rst_description": "*Optional*. True, if the gift can be upgraded to a unique gift\n",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the gift can be upgraded to a unique gift</td>",
"rst_description": "*Optional*. :code:`True`, if the gift can be upgraded to a unique gift\n",
"name": "can_be_upgraded",
"required": false
},
@ -70,8 +70,8 @@
{
"type": "True",
"description": "True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them",
"html_description": "<td><em>Optional</em>. True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them</td>",
"rst_description": "*Optional*. True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them\n",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them</td>",
"rst_description": "*Optional*. :code:`True`, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them\n",
"name": "is_private",
"required": false
}

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

@ -0,0 +1,65 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "inputchecklist",
"name": "InputChecklist",
"description": "Describes a checklist to create.",
"html_description": "<p>Describes a checklist to create.</p>",
"rst_description": "Describes a checklist to create.",
"annotations": [
{
"type": "String",
"description": "Title of the checklist; 1-255 characters after entities parsing",
"html_description": "<td>Title of the checklist; 1-255 characters after entities parsing</td>",
"rst_description": "Title of the checklist; 1-255 characters after entities parsing\n",
"name": "title",
"required": true
},
{
"type": "String",
"description": "Mode for parsing entities in the title. See formatting options for more details.",
"html_description": "<td>Optional. Mode for parsing entities in the title. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description": "Optional. Mode for parsing entities in the title. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name": "parse_mode",
"required": false
},
{
"type": "Array of MessageEntity",
"description": "List of special entities that appear in the title, which can be specified instead of parse_mode. Currently, only bold, italic, underline, strikethrough, spoiler, and custom_emoji entities are allowed.",
"html_description": "<td><em>Optional</em>. List of special entities that appear in the title, which can be specified instead of parse_mode. Currently, only <em>bold</em>, <em>italic</em>, <em>underline</em>, <em>strikethrough</em>, <em>spoiler</em>, and <em>custom_emoji</em> entities are allowed.</td>",
"rst_description": "*Optional*. List of special entities that appear in the title, which can be specified instead of parse_mode. Currently, only *bold*, *italic*, *underline*, *strikethrough*, *spoiler*, and *custom_emoji* entities are allowed.\n",
"name": "title_entities",
"required": false
},
{
"type": "Array of InputChecklistTask",
"description": "List of 1-30 tasks in the checklist",
"html_description": "<td>List of 1-30 tasks in the checklist</td>",
"rst_description": "List of 1-30 tasks in the checklist\n",
"name": "tasks",
"required": true
},
{
"type": "Boolean",
"description": "Pass True if other users can add tasks to the checklist",
"html_description": "<td><em>Optional</em>. Pass <em>True</em> if other users can add tasks to the checklist</td>",
"rst_description": "*Optional*. Pass :code:`True` if other users can add tasks to the checklist\n",
"name": "others_can_add_tasks",
"required": false
},
{
"type": "True",
"description": "Pass True if other users can mark tasks as done or not done in the checklist",
"html_description": "<td><em>Optional</em>. Pass <em>True</em> if other users can mark tasks as done or not done in the checklist</td>",
"rst_description": "*Optional*. Pass :code:`True` if other users can mark tasks as done or not done in the checklist\n",
"name": "others_can_mark_tasks_as_done",
"required": false
}
],
"category": "types"
}
}

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

@ -0,0 +1,49 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "inputchecklisttask",
"name": "InputChecklistTask",
"description": "Describes a task to add to a checklist.",
"html_description": "<p>Describes a task to add to a checklist.</p>",
"rst_description": "Describes a task to add to a checklist.",
"annotations": [
{
"type": "Integer",
"description": "Unique identifier of the task; must be positive and unique among all task identifiers currently present in the checklist",
"html_description": "<td>Unique identifier of the task; must be positive and unique among all task identifiers currently present in the checklist</td>",
"rst_description": "Unique identifier of the task; must be positive and unique among all task identifiers currently present in the checklist\n",
"name": "id",
"required": true
},
{
"type": "String",
"description": "Text of the task; 1-100 characters after entities parsing",
"html_description": "<td>Text of the task; 1-100 characters after entities parsing</td>",
"rst_description": "Text of the task; 1-100 characters after entities parsing\n",
"name": "text",
"required": true
},
{
"type": "String",
"description": "Mode for parsing entities in the text. See formatting options for more details.",
"html_description": "<td>Optional. Mode for parsing entities in the text. See <a href=\"https://core.telegram.org/bots/api#formatting-options\">formatting options</a> for more details.</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.\n",
"name": "parse_mode",
"required": false
},
{
"type": "Array of MessageEntity",
"description": "List of special entities that appear in the text, which can be specified instead of parse_mode. Currently, only bold, italic, underline, strikethrough, spoiler, and custom_emoji entities are allowed.",
"html_description": "<td><em>Optional</em>. List of special entities that appear in the text, which can be specified instead of parse_mode. Currently, only <em>bold</em>, <em>italic</em>, <em>underline</em>, <em>strikethrough</em>, <em>spoiler</em>, and <em>custom_emoji</em> entities are allowed.</td>",
"rst_description": "*Optional*. List of special entities that appear in the text, which can be specified instead of parse_mode. Currently, only *bold*, *italic*, *underline*, *strikethrough*, *spoiler*, and *custom_emoji* entities are allowed.\n",
"name": "text_entities",
"required": false
}
],
"category": "types"
}
}

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

@ -13,9 +13,9 @@
"annotations": [
{
"type": "String",
"description": "Type of the profile photo, must be 'animated'",
"html_description": "<td>Type of the profile photo, must be &#8220;animated&#8221;</td>",
"rst_description": "Type of the profile photo, must be 'animated'\n",
"description": "Type of the profile photo, must be animated",
"html_description": "<td>Type of the profile photo, must be <em>animated</em></td>",
"rst_description": "Type of the profile photo, must be *animated*\n",
"name": "type",
"required": true
},

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

@ -13,9 +13,9 @@
"annotations": [
{
"type": "String",
"description": "Type of the profile photo, must be 'static'",
"html_description": "<td>Type of the profile photo, must be &#8220;static&#8221;</td>",
"rst_description": "Type of the profile photo, must be 'static'\n",
"description": "Type of the profile photo, must be static",
"html_description": "<td>Type of the profile photo, must be <em>static</em></td>",
"rst_description": "Type of the profile photo, must be *static*\n",
"name": "type",
"required": true
},

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

@ -13,9 +13,9 @@
"annotations": [
{
"type": "String",
"description": "Type of the content, must be 'photo'",
"html_description": "<td>Type of the content, must be &#8220;photo&#8221;</td>",
"rst_description": "Type of the content, must be 'photo'\n",
"description": "Type of the content, must be photo",
"html_description": "<td>Type of the content, must be <em>photo</em></td>",
"rst_description": "Type of the content, must be *photo*\n",
"name": "type",
"required": true
},

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

@ -13,9 +13,9 @@
"annotations": [
{
"type": "String",
"description": "Type of the content, must be 'video'",
"html_description": "<td>Type of the content, must be &#8220;video&#8221;</td>",
"rst_description": "Type of the content, must be 'video'\n",
"description": "Type of the content, must be video",
"html_description": "<td>Type of the content, must be <em>video</em></td>",
"rst_description": "Type of the content, must be *video*\n",
"name": "type",
"required": true
},

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

@ -166,8 +166,8 @@
{
"type": "True",
"description": "True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message",
"html_description": "<td><em>Optional</em>. True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message</td>",
"rst_description": "*Optional*. True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message\n",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message</td>",
"rst_description": "*Optional*. :code:`True`, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message\n",
"name": "is_from_offline",
"required": false
},
@ -326,8 +326,8 @@
{
"type": "True",
"description": "True, if the caption must be shown above the message media",
"html_description": "<td><em>Optional</em>. True, if the caption must be shown above the message media</td>",
"rst_description": "*Optional*. True, if the caption must be shown above the message media\n",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the caption must be shown above the message media</td>",
"rst_description": "*Optional*. :code:`True`, if the caption must be shown above the message media\n",
"name": "show_caption_above_media",
"required": false
},
@ -339,6 +339,14 @@
"name": "has_media_spoiler",
"required": false
},
{
"type": "Checklist",
"description": "Message is a checklist",
"html_description": "<td><em>Optional</em>. Message is a checklist</td>",
"rst_description": "*Optional*. Message is a checklist\n",
"name": "checklist",
"required": false
},
{
"type": "Contact",
"description": "Message is a shared contact, information about the contact",
@ -587,6 +595,30 @@
"name": "chat_background_set",
"required": false
},
{
"type": "ChecklistTasksDone",
"description": "Service message: some tasks in a checklist were marked as done or not done",
"html_description": "<td><em>Optional</em>. Service message: some tasks in a checklist were marked as done or not done</td>",
"rst_description": "*Optional*. Service message: some tasks in a checklist were marked as done or not done\n",
"name": "checklist_tasks_done",
"required": false
},
{
"type": "ChecklistTasksAdded",
"description": "Service message: tasks were added to a checklist",
"html_description": "<td><em>Optional</em>. Service message: tasks were added to a checklist</td>",
"rst_description": "*Optional*. Service message: tasks were added to a checklist\n",
"name": "checklist_tasks_added",
"required": false
},
{
"type": "DirectMessagePriceChanged",
"description": "Service message: the price for paid messages in the corresponding direct messages chat of a channel has changed",
"html_description": "<td><em>Optional</em>. Service message: the price for paid messages in the corresponding direct messages chat of a channel has changed</td>",
"rst_description": "*Optional*. Service message: the price for paid messages in the corresponding direct messages chat of a channel has changed\n",
"name": "direct_message_price_changed",
"required": false
},
{
"type": "ForumTopicCreated",
"description": "Service message: forum topic created",

16
.butcher/types/OwnedGiftRegular/entity.json
View file

@ -70,32 +70,32 @@
{
"type": "True",
"description": "True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them",
"html_description": "<td><em>Optional</em>. True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them</td>",
"rst_description": "*Optional*. True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them\n",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them</td>",
"rst_description": "*Optional*. :code:`True`, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them\n",
"name": "is_private",
"required": false
},
{
"type": "True",
"description": "True, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only",
"html_description": "<td><em>Optional</em>. True, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only</td>",
"rst_description": "*Optional*. True, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only\n",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only</td>",
"rst_description": "*Optional*. :code:`True`, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only\n",
"name": "is_saved",
"required": false
},
{
"type": "True",
"description": "True, if the gift can be upgraded to a unique gift; for gifts received on behalf of business accounts only",
"html_description": "<td><em>Optional</em>. True, if the gift can be upgraded to a unique gift; for gifts received on behalf of business accounts only</td>",
"rst_description": "*Optional*. True, if the gift can be upgraded to a unique gift; for gifts received on behalf of business accounts only\n",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the gift can be upgraded to a unique gift; for gifts received on behalf of business accounts only</td>",
"rst_description": "*Optional*. :code:`True`, if the gift can be upgraded to a unique gift; for gifts received on behalf of business accounts only\n",
"name": "can_be_upgraded",
"required": false
},
{
"type": "True",
"description": "True, if the gift was refunded and isn't available anymore",
"html_description": "<td><em>Optional</em>. True, if the gift was refunded and isn't available anymore</td>",
"rst_description": "*Optional*. True, if the gift was refunded and isn't available anymore\n",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the gift was refunded and isn't available anymore</td>",
"rst_description": "*Optional*. :code:`True`, if the gift was refunded and isn't available anymore\n",
"name": "was_refunded",
"required": false
},

16
.butcher/types/OwnedGiftUnique/entity.json
View file

@ -54,16 +54,16 @@
{
"type": "True",
"description": "True, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only",
"html_description": "<td><em>Optional</em>. True, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only</td>",
"rst_description": "*Optional*. True, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only\n",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only</td>",
"rst_description": "*Optional*. :code:`True`, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only\n",
"name": "is_saved",
"required": false
},
{
"type": "True",
"description": "True, if the gift can be transferred to another owner; for gifts received on behalf of business accounts only",
"html_description": "<td><em>Optional</em>. True, if the gift can be transferred to another owner; for gifts received on behalf of business accounts only</td>",
"rst_description": "*Optional*. True, if the gift can be transferred to another owner; for gifts received on behalf of business accounts only\n",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the gift can be transferred to another owner; for gifts received on behalf of business accounts only</td>",
"rst_description": "*Optional*. :code:`True`, if the gift can be transferred to another owner; for gifts received on behalf of business accounts only\n",
"name": "can_be_transferred",
"required": false
},
@ -74,6 +74,14 @@
"rst_description": "*Optional*. Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer the gift\n",
"name": "transfer_star_count",
"required": false
},
{
"type": "Integer",
"description": "Point in time (Unix timestamp) when the gift can be transferred. If it is in the past, then the gift can be transferred now",
"html_description": "<td><em>Optional</em>. Point in time (Unix timestamp) when the gift can be transferred. If it is in the past, then the gift can be transferred now</td>",
"rst_description": "*Optional*. Point in time (Unix timestamp) when the gift can be transferred. If it is in the past, then the gift can be transferred now\n",
"name": "next_transfer_date",
"required": false
}
],
"category": "types"

5
.butcher/types/OwnedGiftUnique/replace.yml Normal file
View file

@ -0,0 +1,5 @@
annotations:
next_transfer_date:
parsed_type:
type: std
name: DateTime

4
.butcher/types/ReactionTypeEmoji/entity.json
View file

File diff suppressed because one or more lines are too long

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

@ -46,16 +46,16 @@
{
"type": "True",
"description": "True, if the payment is a recurring payment for a subscription",
"html_description": "<td><em>Optional</em>. True, if the payment is a recurring payment for a subscription</td>",
"rst_description": "*Optional*. True, if the payment is a recurring payment for a subscription\n",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the payment is a recurring payment for a subscription</td>",
"rst_description": "*Optional*. :code:`True`, if the payment is a recurring payment for a subscription\n",
"name": "is_recurring",
"required": false
},
{
"type": "True",
"description": "True, if the payment is the first payment for a subscription",
"html_description": "<td><em>Optional</em>. True, if the payment is the first payment for a subscription</td>",
"rst_description": "*Optional*. True, if the payment is the first payment for a subscription\n",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the payment is the first payment for a subscription</td>",
"rst_description": "*Optional*. :code:`True`, if the payment is the first payment for a subscription\n",
"name": "is_first_recurring",
"required": false
},

16
.butcher/types/SwitchInlineQueryChosenChat/entity.json
View file

@ -22,32 +22,32 @@
{
"type": "Boolean",
"description": "True, if private chats with users can be chosen",
"html_description": "<td><em>Optional</em>. True, if private chats with users can be chosen</td>",
"rst_description": "*Optional*. True, if private chats with users can be chosen\n",
"html_description": "<td><em>Optional</em>. <em>True</em>, if private chats with users can be chosen</td>",
"rst_description": "*Optional*. :code:`True`, if private chats with users can be chosen\n",
"name": "allow_user_chats",
"required": false
},
{
"type": "Boolean",
"description": "True, if private chats with bots can be chosen",
"html_description": "<td><em>Optional</em>. True, if private chats with bots can be chosen</td>",
"rst_description": "*Optional*. True, if private chats with bots can be chosen\n",
"html_description": "<td><em>Optional</em>. <em>True</em>, if private chats with bots can be chosen</td>",
"rst_description": "*Optional*. :code:`True`, if private chats with bots can be chosen\n",
"name": "allow_bot_chats",
"required": false
},
{
"type": "Boolean",
"description": "True, if group and supergroup chats can be chosen",
"html_description": "<td><em>Optional</em>. True, if group and supergroup chats can be chosen</td>",
"rst_description": "*Optional*. True, if group and supergroup chats can be chosen\n",
"html_description": "<td><em>Optional</em>. <em>True</em>, if group and supergroup chats can be chosen</td>",
"rst_description": "*Optional*. :code:`True`, if group and supergroup chats can be chosen\n",
"name": "allow_group_chats",
"required": false
},
{
"type": "Boolean",
"description": "True, if channel chats can be chosen",
"html_description": "<td><em>Optional</em>. True, if channel chats can be chosen</td>",
"rst_description": "*Optional*. True, if channel chats can be chosen\n",
"html_description": "<td><em>Optional</em>. <em>True</em>, if channel chats can be chosen</td>",
"rst_description": "*Optional*. :code:`True`, if channel chats can be chosen\n",
"name": "allow_channel_chats",
"required": false
}

4
.butcher/types/TextQuote/entity.json
View file

@ -38,8 +38,8 @@
{
"type": "True",
"description": "True, if the quote was chosen manually by the message sender. Otherwise, the quote was added automatically by the server.",
"html_description": "<td><em>Optional</em>. True, if the quote was chosen manually by the message sender. Otherwise, the quote was added automatically by the server.</td>",
"rst_description": "*Optional*. True, if the quote was chosen manually by the message sender. Otherwise, the quote was added automatically by the server.\n",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the quote was chosen manually by the message sender. Otherwise, the quote was added automatically by the server.</td>",
"rst_description": "*Optional*. :code:`True`, if the quote was chosen manually by the message sender. Otherwise, the quote was added automatically by the server.\n",
"name": "is_manual",
"required": false
}

22
.butcher/types/UniqueGiftInfo/entity.json
View file

@ -21,12 +21,20 @@
},
{
"type": "String",
"description": "Origin of the gift. Currently, either 'upgrade' or 'transfer'",
"html_description": "<td>Origin of the gift. Currently, either &#8220;upgrade&#8221; or &#8220;transfer&#8221;</td>",
"rst_description": "Origin of the gift. Currently, either 'upgrade' or 'transfer'\n",
"description": "Origin of the gift. Currently, either 'upgrade' for gifts upgraded from regular gifts, 'transfer' for gifts transferred from other users or channels, or 'resale' for gifts bought from other users",
"html_description": "<td>Origin of the gift. Currently, either &#8220;upgrade&#8221; for gifts upgraded from regular gifts, &#8220;transfer&#8221; for gifts transferred from other users or channels, or &#8220;resale&#8221; for gifts bought from other users</td>",
"rst_description": "Origin of the gift. Currently, either 'upgrade' for gifts upgraded from regular gifts, 'transfer' for gifts transferred from other users or channels, or 'resale' for gifts bought from other users\n",
"name": "origin",
"required": true
},
{
"type": "Integer",
"description": "For gifts bought from other users, the price paid for the gift",
"html_description": "<td><em>Optional</em>. For gifts bought from other users, the price paid for the gift</td>",
"rst_description": "*Optional*. For gifts bought from other users, the price paid for the gift\n",
"name": "last_resale_star_count",
"required": false
},
{
"type": "String",
"description": "Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts",
@ -42,6 +50,14 @@
"rst_description": "*Optional*. Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer the gift\n",
"name": "transfer_star_count",
"required": false
},
{
"type": "Integer",
"description": "Point in time (Unix timestamp) when the gift can be transferred. If it is in the past, then the gift can be transferred now",
"html_description": "<td><em>Optional</em>. Point in time (Unix timestamp) when the gift can be transferred. If it is in the past, then the gift can be transferred now</td>",
"rst_description": "*Optional*. Point in time (Unix timestamp) when the gift can be transferred. If it is in the past, then the gift can be transferred now\n",
"name": "next_transfer_date",
"required": false
}
],
"category": "types"

5
.butcher/types/UniqueGiftInfo/replace.yml Normal file
View file

@ -0,0 +1,5 @@
annotations:
next_transfer_date:
parsed_type:
type: std
name: DateTime

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

@ -14,8 +14,8 @@
{
"type": "Boolean",
"description": "True, if the access was granted after the user accepted an explicit request from a Web App sent by the method requestWriteAccess",
"html_description": "<td><em>Optional</em>. True, if the access was granted after the user accepted an explicit request from a Web App sent by the method <a href=\"/bots/webapps#initializing-mini-apps\">requestWriteAccess</a></td>",
"rst_description": "*Optional*. True, if the access was granted after the user accepted an explicit request from a Web App sent by the method `requestWriteAccess <https://core.telegram.org/bots/webapps#initializing-mini-apps>`_\n",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the access was granted after the user accepted an explicit request from a Web App sent by the method <a href=\"/bots/webapps#initializing-mini-apps\">requestWriteAccess</a></td>",
"rst_description": "*Optional*. :code:`True`, if the access was granted after the user accepted an explicit request from a Web App sent by the method `requestWriteAccess <https://core.telegram.org/bots/webapps#initializing-mini-apps>`_\n",
"name": "from_request",
"required": false
},
@ -30,8 +30,8 @@
{
"type": "Boolean",
"description": "True, if the access was granted when the bot was added to the attachment or side menu",
"html_description": "<td><em>Optional</em>. True, if the access was granted when the bot was added to the attachment or side menu</td>",
"rst_description": "*Optional*. True, if the access was granted when the bot was added to the attachment or side menu\n",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the access was granted when the bot was added to the attachment or side menu</td>",
"rst_description": "*Optional*. :code:`True`, if the access was granted when the bot was added to the attachment or side menu\n",
"name": "from_attachment_menu",
"required": false
}