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

Added full support for the Bot API 9.0 (#1671)

Browse source 
* Added full support for the Bot API 9.0

* Bump version
This commit is contained in:
Alex Root Junior 2025-04-12 23:29:48 +03:00 • committed by GitHub
parent 25e9127db9
commit 2c2bd61551
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
231 changed files with 9565 additions and 389 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -0,0 +1,49 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "acceptedgifttypes",
"name": "AcceptedGiftTypes",
"description": "This object describes the types of gifts that can be gifted to a user or a chat.",
"html_description": "<p>This object describes the types of gifts that can be gifted to a user or a chat.</p>",
"rst_description": "This object describes the types of gifts that can be gifted to a user or a chat.",
"annotations": [
{
"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",
"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",
"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",
"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",
"name": "premium_subscription",
"required": true
}
],
"category": "types"
}
}

129
.butcher/types/BusinessBotRights/entity.json Normal file
View file

@ -0,0 +1,129 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "businessbotrights",
"name": "BusinessBotRights",
"description": "Represents the rights of a business bot.",
"html_description": "<p>Represents the rights of a business bot.</p>",
"rst_description": "Represents the rights of a business bot.",
"annotations": [
{
"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",
"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",
"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>. 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
}
],
"category": "types"
}
}

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

@ -44,12 +44,12 @@
"required": true
},
{
"type": "Boolean",
"description": "True, if the bot can act on behalf of the business account in chats that were active in the last 24 hours",
"html_description": "<td>True, if the bot can act on behalf of the business account in chats that were active in the last 24 hours</td>",
"rst_description": "True, if the bot can act on behalf of the business account in chats that were active in the last 24 hours\n",
"name": "can_reply",
"required": true
"type": "BusinessBotRights",
"description": "Rights of the business bot",
"html_description": "<td><em>Optional</em>. Rights of the business bot</td>",
"rst_description": "*Optional*. Rights of the business bot\n",
"name": "rights",
"required": false
},
{
"type": "Boolean",
@ -58,6 +58,18 @@
"rst_description": "True, if the connection is active\n",
"name": "is_enabled",
"required": true
},
{
"type": "Boolean",
"description": "True, if the bot can act on behalf of the business account in chats that were active in the last 24 hours",
"html_description": "<td>True, if the bot can act on behalf of the business account in chats that were active in the last 24 hours</td>",
"rst_description": "True, if the bot can act on behalf of the business account in chats that were active in the last 24 hours\n",
"name": "can_reply",
"required": false,
"deprecated": {
"version": "9.0",
"release_date": "2025-04-11"
}
}
],
"category": "types"

24
.butcher/types/ChatFullInfo/entity.json
View file

@ -260,12 +260,12 @@
"required": false
},
{
"type": "True",
"description": "True, if gifts can be sent to the chat",
"html_description": "<td><em>Optional</em>. <em>True</em>, if gifts can be sent to the chat</td>",
"rst_description": "*Optional*. :code:`True`, if gifts can be sent to the chat\n",
"name": "can_send_gift",
"required": false
"type": "AcceptedGiftTypes",
"description": "Information about types of gifts that are accepted by the chat or by the corresponding user for private chats",
"html_description": "<td>Information about types of gifts that are accepted by the chat or by the corresponding user for private chats</td>",
"rst_description": "Information about types of gifts that are accepted by the chat or by the corresponding user for private chats\n",
"name": "accepted_gift_types",
"required": true
},
{
"type": "True",
@ -370,6 +370,18 @@
"rst_description": "*Optional*. For supergroups, the location to which the supergroup is connected\n",
"name": "location",
"required": false
},
{
"type": "True",
"description": "True, if gifts can be sent to the chat",
"html_description": "<td><em>Optional</em>. <em>True</em>, if gifts can be sent to the chat</td>",
"rst_description": "*Optional*. :code:`True`, if gifts can be sent to the chat\n",
"name": "can_send_gift",
"required": false,
"deprecated": {
"version": "9.0",
"release_date": "2025-04-11"
}
}
],
"category": "types"

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

@ -1,8 +1,8 @@
{
"meta": {},
"group": {
"title": "Stickers",
"anchor": "stickers"
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "gift",

81
.butcher/types/GiftInfo/entity.json Normal file
View file

@ -0,0 +1,81 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "giftinfo",
"name": "GiftInfo",
"description": "Describes a service message about a regular gift that was sent or received.",
"html_description": "<p>Describes a service message about a regular gift that was sent or received.</p>",
"rst_description": "Describes a service message about a regular gift that was sent or received.",
"annotations": [
{
"type": "Gift",
"description": "Information about the gift",
"html_description": "<td>Information about the gift</td>",
"rst_description": "Information about the gift\n",
"name": "gift",
"required": true
},
{
"type": "String",
"description": "Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts",
"html_description": "<td><em>Optional</em>. Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts</td>",
"rst_description": "*Optional*. Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts\n",
"name": "owned_gift_id",
"required": false
},
{
"type": "Integer",
"description": "Number of Telegram Stars that can be claimed by the receiver by converting the gift; omitted if conversion to Telegram Stars is impossible",
"html_description": "<td><em>Optional</em>. Number of Telegram Stars that can be claimed by the receiver by converting the gift; omitted if conversion to Telegram Stars is impossible</td>",
"rst_description": "*Optional*. Number of Telegram Stars that can be claimed by the receiver by converting the gift; omitted if conversion to Telegram Stars is impossible\n",
"name": "convert_star_count",
"required": false
},
{
"type": "Integer",
"description": "Number of Telegram Stars that were prepaid by the sender for the ability to upgrade the gift",
"html_description": "<td><em>Optional</em>. Number of Telegram Stars that were prepaid by the sender for the ability to upgrade the gift</td>",
"rst_description": "*Optional*. Number of Telegram Stars that were prepaid by the sender for the ability to upgrade the gift\n",
"name": "prepaid_upgrade_star_count",
"required": false
},
{
"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",
"name": "can_be_upgraded",
"required": false
},
{
"type": "String",
"description": "Text of the message that was added to the gift",
"html_description": "<td><em>Optional</em>. Text of the message that was added to the gift</td>",
"rst_description": "*Optional*. Text of the message that was added to the gift\n",
"name": "text",
"required": false
},
{
"type": "Array of MessageEntity",
"description": "Special entities that appear in the text",
"html_description": "<td><em>Optional</em>. Special entities that appear in the text</td>",
"rst_description": "*Optional*. Special entities that appear in the text\n",
"name": "entities",
"required": false
},
{
"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",
"name": "is_private",
"required": false
}
],
"category": "types"
}
}

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

@ -1,8 +1,8 @@
{
"meta": {},
"group": {
"title": "Stickers",
"anchor": "stickers"
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "gifts",

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

@ -0,0 +1,16 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "inputprofilephoto",
"name": "InputProfilePhoto",
"description": "This object describes a profile photo to set. Currently, it can be one of\n - InputProfilePhotoStatic\n - InputProfilePhotoAnimated",
"html_description": "<p>This object describes a profile photo to set. Currently, it can be one of</p><ul>\n<li><a href=\"#inputprofilephotostatic\">InputProfilePhotoStatic</a></li>\n<li><a href=\"#inputprofilephotoanimated\">InputProfilePhotoAnimated</a></li>\n</ul>",
"rst_description": "This object describes a profile photo to set. Currently, it can be one of\n\n - :class:`aiogram.types.input_profile_photo_static.InputProfilePhotoStatic`\n - :class:`aiogram.types.input_profile_photo_animated.InputProfilePhotoAnimated`",
"annotations": [],
"category": "types"
}
}

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

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

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

@ -0,0 +1,41 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "inputprofilephotoanimated",
"name": "InputProfilePhotoAnimated",
"description": "An animated profile photo in the MPEG4 format.",
"html_description": "<p>An animated profile photo in the MPEG4 format.</p>",
"rst_description": "An animated profile photo in the MPEG4 format.",
"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",
"name": "type",
"required": true
},
{
"type": "String",
"description": "The animated profile photo. Profile photos can't be reused and can only be uploaded as a new file, so you can pass 'attach://<file_attach_name>' if the photo was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files",
"html_description": "<td>The animated profile photo. Profile photos can't be reused and can only be uploaded as a new file, so you can pass &#8220;attach://&lt;file_attach_name&gt;&#8221; if the photo was uploaded using multipart/form-data under &lt;file_attach_name&gt;. <a href=\"#sending-files\">More information on Sending Files &#187;</a></td>",
"rst_description": "The animated profile photo. Profile photos can't be reused and can only be uploaded as a new file, so you can pass 'attach://<file_attach_name>' if the photo was uploaded using multipart/form-data under <file_attach_name>. :ref:`More information on Sending Files » <sending-files>`\n",
"name": "animation",
"required": true
},
{
"type": "Float",
"description": "Timestamp in seconds of the frame that will be used as the static profile photo. Defaults to 0.0.",
"html_description": "<td><em>Optional</em>. Timestamp in seconds of the frame that will be used as the static profile photo. Defaults to 0.0.</td>",
"rst_description": "*Optional*. Timestamp in seconds of the frame that will be used as the static profile photo. Defaults to 0.0.\n",
"name": "main_frame_timestamp",
"required": false
}
],
"category": "types"
}
}

11
.butcher/types/InputProfilePhotoAnimated/replace.yml Normal file
View file

@ -0,0 +1,11 @@
annotations:
animation:
parsed_type:
type: union
items:
- type: std
name: str
- type: entity
references:
category: types
name: InputFile

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

@ -0,0 +1,33 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "inputprofilephotostatic",
"name": "InputProfilePhotoStatic",
"description": "A static profile photo in the .JPG format.",
"html_description": "<p>A static profile photo in the .JPG format.</p>",
"rst_description": "A static profile photo in the .JPG format.",
"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",
"name": "type",
"required": true
},
{
"type": "String",
"description": "The static profile photo. Profile photos can't be reused and can only be uploaded as a new file, so you can pass 'attach://<file_attach_name>' if the photo was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files",
"html_description": "<td>The static profile photo. Profile photos can't be reused and can only be uploaded as a new file, so you can pass &#8220;attach://&lt;file_attach_name&gt;&#8221; if the photo was uploaded using multipart/form-data under &lt;file_attach_name&gt;. <a href=\"#sending-files\">More information on Sending Files &#187;</a></td>",
"rst_description": "The static profile photo. Profile photos can't be reused and can only be uploaded as a new file, so you can pass 'attach://<file_attach_name>' if the photo was uploaded using multipart/form-data under <file_attach_name>. :ref:`More information on Sending Files » <sending-files>`\n",
"name": "photo",
"required": true
}
],
"category": "types"
}
}

11
.butcher/types/InputProfilePhotoStatic/replace.yml Normal file
View file

@ -0,0 +1,11 @@
annotations:
photo:
parsed_type:
type: union
items:
- type: std
name: str
- type: entity
references:
category: types
name: InputFile

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

@ -12,10 +12,10 @@
"rst_description": "This object describes a sticker to be added to a sticker set.",
"annotations": [
{
"type": "InputFile or String",
"description": "The added sticker. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, upload a new one using multipart/form-data, or pass 'attach://<file_attach_name>' to upload a new one using multipart/form-data under <file_attach_name> name. Animated and video stickers can't be uploaded via HTTP URL. More information on Sending Files",
"html_description": "<td>The added sticker. Pass a <em>file_id</em> as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, upload a new one using multipart/form-data, or pass &#8220;attach://&lt;file_attach_name&gt;&#8221; to upload a new one using multipart/form-data under &lt;file_attach_name&gt; name. Animated and video stickers can't be uploaded via HTTP URL. <a href=\"#sending-files\">More information on Sending Files &#187;</a></td>",
"rst_description": "The added sticker. Pass a *file_id* as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, upload a new one using multipart/form-data, or pass 'attach://<file_attach_name>' to upload a new one using multipart/form-data under <file_attach_name> name. Animated and video stickers can't be uploaded via HTTP URL. :ref:`More information on Sending Files » <sending-files>`\n",
"type": "String",
"description": "The added sticker. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or pass 'attach://<file_attach_name>' to upload a new file using multipart/form-data under <file_attach_name> name. Animated and video stickers can't be uploaded via HTTP URL. More information on Sending Files",
"html_description": "<td>The added sticker. Pass a <em>file_id</em> as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or pass &#8220;attach://&lt;file_attach_name&gt;&#8221; to upload a new file using multipart/form-data under &lt;file_attach_name&gt; name. Animated and video stickers can't be uploaded via HTTP URL. <a href=\"#sending-files\">More information on Sending Files &#187;</a></td>",
"rst_description": "The added sticker. Pass a *file_id* as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or pass 'attach://<file_attach_name>' to upload a new file using multipart/form-data under <file_attach_name> name. Animated and video stickers can't be uploaded via HTTP URL. :ref:`More information on Sending Files » <sending-files>`\n",
"name": "sticker",
"required": true
},

11
.butcher/types/InputSticker/replace.yml Normal file
View file

@ -0,0 +1,11 @@
annotations:
sticker:
parsed_type:
type: union
items:
- type: std
name: str
- type: entity
references:
category: types
name: InputFile

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

@ -0,0 +1,16 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "inputstorycontent",
"name": "InputStoryContent",
"description": "This object describes the content of a story to post. Currently, it can be one of\n - InputStoryContentPhoto\n - InputStoryContentVideo",
"html_description": "<p>This object describes the content of a story to post. Currently, it can be one of</p><ul>\n<li><a href=\"#inputstorycontentphoto\">InputStoryContentPhoto</a></li>\n<li><a href=\"#inputstorycontentvideo\">InputStoryContentVideo</a></li>\n</ul>",
"rst_description": "This object describes the content of a story to post. Currently, it can be one of\n\n - :class:`aiogram.types.input_story_content_photo.InputStoryContentPhoto`\n - :class:`aiogram.types.input_story_content_video.InputStoryContentVideo`",
"annotations": [],
"category": "types"
}
}

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

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

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

@ -0,0 +1,33 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "inputstorycontentphoto",
"name": "InputStoryContentPhoto",
"description": "Describes a photo to post as a story.",
"html_description": "<p>Describes a photo to post as a story.</p>",
"rst_description": "Describes a photo to post as a story.",
"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",
"name": "type",
"required": true
},
{
"type": "String",
"description": "The photo to post as a story. The photo must be of the size 1080x1920 and must not exceed 10 MB. The photo can't be reused and can only be uploaded as a new file, so you can pass 'attach://<file_attach_name>' if the photo was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files",
"html_description": "<td>The photo to post as a story. The photo must be of the size 1080x1920 and must not exceed 10 MB. The photo can't be reused and can only be uploaded as a new file, so you can pass &#8220;attach://&lt;file_attach_name&gt;&#8221; if the photo was uploaded using multipart/form-data under &lt;file_attach_name&gt;. <a href=\"#sending-files\">More information on Sending Files &#187;</a></td>",
"rst_description": "The photo to post as a story. The photo must be of the size 1080x1920 and must not exceed 10 MB. The photo can't be reused and can only be uploaded as a new file, so you can pass 'attach://<file_attach_name>' if the photo was uploaded using multipart/form-data under <file_attach_name>. :ref:`More information on Sending Files » <sending-files>`\n",
"name": "photo",
"required": true
}
],
"category": "types"
}
}

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

@ -0,0 +1,57 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "inputstorycontentvideo",
"name": "InputStoryContentVideo",
"description": "Describes a video to post as a story.",
"html_description": "<p>Describes a video to post as a story.</p>",
"rst_description": "Describes a video to post as a story.",
"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",
"name": "type",
"required": true
},
{
"type": "String",
"description": "The video to post as a story. The video must be of the size 720x1280, streamable, encoded with H.265 codec, with key frames added each second in the MPEG4 format, and must not exceed 30 MB. The video can't be reused and can only be uploaded as a new file, so you can pass 'attach://<file_attach_name>' if the video was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files",
"html_description": "<td>The video to post as a story. The video must be of the size 720x1280, streamable, encoded with H.265 codec, with key frames added each second in the MPEG4 format, and must not exceed 30 MB. The video can't be reused and can only be uploaded as a new file, so you can pass &#8220;attach://&lt;file_attach_name&gt;&#8221; if the video was uploaded using multipart/form-data under &lt;file_attach_name&gt;. <a href=\"#sending-files\">More information on Sending Files &#187;</a></td>",
"rst_description": "The video to post as a story. The video must be of the size 720x1280, streamable, encoded with H.265 codec, with key frames added each second in the MPEG4 format, and must not exceed 30 MB. The video can't be reused and can only be uploaded as a new file, so you can pass 'attach://<file_attach_name>' if the video was uploaded using multipart/form-data under <file_attach_name>. :ref:`More information on Sending Files » <sending-files>`\n",
"name": "video",
"required": true
},
{
"type": "Float",
"description": "Precise duration of the video in seconds; 0-60",
"html_description": "<td><em>Optional</em>. Precise duration of the video in seconds; 0-60</td>",
"rst_description": "*Optional*. Precise duration of the video in seconds; 0-60\n",
"name": "duration",
"required": false
},
{
"type": "Float",
"description": "Timestamp in seconds of the frame that will be used as the static cover for the story. Defaults to 0.0.",
"html_description": "<td><em>Optional</em>. Timestamp in seconds of the frame that will be used as the static cover for the story. Defaults to 0.0.</td>",
"rst_description": "*Optional*. Timestamp in seconds of the frame that will be used as the static cover for the story. Defaults to 0.0.\n",
"name": "cover_frame_timestamp",
"required": false
},
{
"type": "Boolean",
"description": "Pass True if the video has no sound",
"html_description": "<td><em>Optional</em>. Pass <em>True</em> if the video has no sound</td>",
"rst_description": "*Optional*. Pass :code:`True` if the video has no sound\n",
"name": "is_animation",
"required": false
}
],
"category": "types"
}
}

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

@ -0,0 +1,49 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "locationaddress",
"name": "LocationAddress",
"description": "Describes the physical address of a location.",
"html_description": "<p>Describes the physical address of a location.</p>",
"rst_description": "Describes the physical address of a location.",
"annotations": [
{
"type": "String",
"description": "The two-letter ISO 3166-1 alpha-2 country code of the country where the location is located",
"html_description": "<td>The two-letter ISO 3166-1 alpha-2 country code of the country where the location is located</td>",
"rst_description": "The two-letter ISO 3166-1 alpha-2 country code of the country where the location is located\n",
"name": "country_code",
"required": true
},
{
"type": "String",
"description": "State of the location",
"html_description": "<td><em>Optional</em>. State of the location</td>",
"rst_description": "*Optional*. State of the location\n",
"name": "state",
"required": false
},
{
"type": "String",
"description": "City of the location",
"html_description": "<td><em>Optional</em>. City of the location</td>",
"rst_description": "*Optional*. City of the location\n",
"name": "city",
"required": false
},
{
"type": "String",
"description": "Street address of the location",
"html_description": "<td><em>Optional</em>. Street address of the location</td>",
"rst_description": "*Optional*. Street address of the location\n",
"name": "street",
"required": false
}
],
"category": "types"
}
}

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

@ -187,6 +187,14 @@
"name": "author_signature",
"required": false
},
{
"type": "Integer",
"description": "The number of Telegram Stars that were paid by the sender of the message to send it",
"html_description": "<td><em>Optional</em>. The number of Telegram Stars that were paid by the sender of the message to send it</td>",
"rst_description": "*Optional*. The number of Telegram Stars that were paid by the sender of the message to send it\n",
"name": "paid_star_count",
"required": false
},
{
"type": "String",
"description": "For text messages, the actual UTF-8 text of the message",
@ -515,6 +523,22 @@
"name": "chat_shared",
"required": false
},
{
"type": "GiftInfo",
"description": "Service message: a regular gift was sent or received",
"html_description": "<td><em>Optional</em>. Service message: a regular gift was sent or received</td>",
"rst_description": "*Optional*. Service message: a regular gift was sent or received\n",
"name": "gift",
"required": false
},
{
"type": "UniqueGiftInfo",
"description": "Service message: a unique gift was sent or received",
"html_description": "<td><em>Optional</em>. Service message: a unique gift was sent or received</td>",
"rst_description": "*Optional*. Service message: a unique gift was sent or received\n",
"name": "unique_gift",
"required": false
},
{
"type": "String",
"description": "The domain name of the website on which the user has logged in.",
@ -643,6 +667,14 @@
"name": "giveaway_completed",
"required": false
},
{
"type": "PaidMessagePriceChanged",
"description": "Service message: the price for paid messages has changed in the chat",
"html_description": "<td><em>Optional</em>. Service message: the price for paid messages has changed in the chat</td>",
"rst_description": "*Optional*. Service message: the price for paid messages has changed in the chat\n",
"name": "paid_message_price_changed",
"required": false
},
{
"type": "VideoChatScheduled",
"description": "Service message: video chat scheduled",

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

@ -0,0 +1,16 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "ownedgift",
"name": "OwnedGift",
"description": "This object describes a gift received and owned by a user or a chat. Currently, it can be one of\n - OwnedGiftRegular\n - OwnedGiftUnique",
"html_description": "<p>This object describes a gift received and owned by a user or a chat. Currently, it can be one of</p><ul>\n<li><a href=\"#ownedgiftregular\">OwnedGiftRegular</a></li>\n<li><a href=\"#ownedgiftunique\">OwnedGiftUnique</a></li>\n</ul>",
"rst_description": "This object describes a gift received and owned by a user or a chat. Currently, it can be one of\n\n - :class:`aiogram.types.owned_gift_regular.OwnedGiftRegular`\n - :class:`aiogram.types.owned_gift_unique.OwnedGiftUnique`",
"annotations": [],
"category": "types"
}
}

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

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

121
.butcher/types/OwnedGiftRegular/entity.json Normal file
View file

@ -0,0 +1,121 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "ownedgiftregular",
"name": "OwnedGiftRegular",
"description": "Describes a regular gift owned by a user or a chat.",
"html_description": "<p>Describes a regular gift owned by a user or a chat.</p>",
"rst_description": "Describes a regular gift owned by a user or a chat.",
"annotations": [
{
"type": "String",
"description": "Type of the gift, always 'regular'",
"html_description": "<td>Type of the gift, always &#8220;regular&#8221;</td>",
"rst_description": "Type of the gift, always 'regular'\n",
"name": "type",
"required": true
},
{
"type": "Gift",
"description": "Information about the regular gift",
"html_description": "<td>Information about the regular gift</td>",
"rst_description": "Information about the regular gift\n",
"name": "gift",
"required": true
},
{
"type": "String",
"description": "Unique identifier of the gift for the bot; for gifts received on behalf of business accounts only",
"html_description": "<td><em>Optional</em>. Unique identifier of the gift for the bot; for gifts received on behalf of business accounts only</td>",
"rst_description": "*Optional*. Unique identifier of the gift for the bot; for gifts received on behalf of business accounts only\n",
"name": "owned_gift_id",
"required": false
},
{
"type": "User",
"description": "Sender of the gift if it is a known user",
"html_description": "<td><em>Optional</em>. Sender of the gift if it is a known user</td>",
"rst_description": "*Optional*. Sender of the gift if it is a known user\n",
"name": "sender_user",
"required": false
},
{
"type": "Integer",
"description": "Date the gift was sent in Unix time",
"html_description": "<td>Date the gift was sent in Unix time</td>",
"rst_description": "Date the gift was sent in Unix time\n",
"name": "send_date",
"required": true
},
{
"type": "String",
"description": "Text of the message that was added to the gift",
"html_description": "<td><em>Optional</em>. Text of the message that was added to the gift</td>",
"rst_description": "*Optional*. Text of the message that was added to the gift\n",
"name": "text",
"required": false
},
{
"type": "Array of MessageEntity",
"description": "Special entities that appear in the text",
"html_description": "<td><em>Optional</em>. Special entities that appear in the text</td>",
"rst_description": "*Optional*. Special entities that appear in the text\n",
"name": "entities",
"required": false
},
{
"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",
"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",
"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",
"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",
"name": "was_refunded",
"required": false
},
{
"type": "Integer",
"description": "Number of Telegram Stars that can be claimed by the receiver instead of the gift; omitted if the gift cannot be converted to Telegram Stars",
"html_description": "<td><em>Optional</em>. Number of Telegram Stars that can be claimed by the receiver instead of the gift; omitted if the gift cannot be converted to Telegram Stars</td>",
"rst_description": "*Optional*. Number of Telegram Stars that can be claimed by the receiver instead of the gift; omitted if the gift cannot be converted to Telegram Stars\n",
"name": "convert_star_count",
"required": false
},
{
"type": "Integer",
"description": "Number of Telegram Stars that were paid by the sender for the ability to upgrade the gift",
"html_description": "<td><em>Optional</em>. Number of Telegram Stars that were paid by the sender for the ability to upgrade the gift</td>",
"rst_description": "*Optional*. Number of Telegram Stars that were paid by the sender for the ability to upgrade the gift\n",
"name": "prepaid_upgrade_star_count",
"required": false
}
],
"category": "types"
}
}

81
.butcher/types/OwnedGiftUnique/entity.json Normal file
View file

@ -0,0 +1,81 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "ownedgiftunique",
"name": "OwnedGiftUnique",
"description": "Describes a unique gift received and owned by a user or a chat.",
"html_description": "<p>Describes a unique gift received and owned by a user or a chat.</p>",
"rst_description": "Describes a unique gift received and owned by a user or a chat.",
"annotations": [
{
"type": "String",
"description": "Type of the gift, always 'unique'",
"html_description": "<td>Type of the gift, always &#8220;unique&#8221;</td>",
"rst_description": "Type of the gift, always 'unique'\n",
"name": "type",
"required": true
},
{
"type": "UniqueGift",
"description": "Information about the unique gift",
"html_description": "<td>Information about the unique gift</td>",
"rst_description": "Information about the unique gift\n",
"name": "gift",
"required": true
},
{
"type": "String",
"description": "Unique identifier of the received gift for the bot; for gifts received on behalf of business accounts only",
"html_description": "<td><em>Optional</em>. Unique identifier of the received gift for the bot; for gifts received on behalf of business accounts only</td>",
"rst_description": "*Optional*. Unique identifier of the received gift for the bot; for gifts received on behalf of business accounts only\n",
"name": "owned_gift_id",
"required": false
},
{
"type": "User",
"description": "Sender of the gift if it is a known user",
"html_description": "<td><em>Optional</em>. Sender of the gift if it is a known user</td>",
"rst_description": "*Optional*. Sender of the gift if it is a known user\n",
"name": "sender_user",
"required": false
},
{
"type": "Integer",
"description": "Date the gift was sent in Unix time",
"html_description": "<td>Date the gift was sent in Unix time</td>",
"rst_description": "Date the gift was sent in Unix time\n",
"name": "send_date",
"required": true
},
{
"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",
"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",
"name": "can_be_transferred",
"required": false
},
{
"type": "Integer",
"description": "Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer the gift",
"html_description": "<td><em>Optional</em>. Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer the gift</td>",
"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
}
],
"category": "types"
}
}

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

@ -0,0 +1,41 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "ownedgifts",
"name": "OwnedGifts",
"description": "Contains the list of gifts received and owned by a user or a chat.",
"html_description": "<p>Contains the list of gifts received and owned by a user or a chat.</p>",
"rst_description": "Contains the list of gifts received and owned by a user or a chat.",
"annotations": [
{
"type": "Integer",
"description": "The total number of gifts owned by the user or the chat",
"html_description": "<td>The total number of gifts owned by the user or the chat</td>",
"rst_description": "The total number of gifts owned by the user or the chat\n",
"name": "total_count",
"required": true
},
{
"type": "Array of OwnedGift",
"description": "The list of gifts",
"html_description": "<td>The list of gifts</td>",
"rst_description": "The list of gifts\n",
"name": "gifts",
"required": true
},
{
"type": "String",
"description": "Offset for the next request. If empty, then there are no more results",
"html_description": "<td><em>Optional</em>. Offset for the next request. If empty, then there are no more results</td>",
"rst_description": "*Optional*. Offset for the next request. If empty, then there are no more results\n",
"name": "next_offset",
"required": false
}
],
"category": "types"
}
}

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

@ -0,0 +1,25 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "paidmessagepricechanged",
"name": "PaidMessagePriceChanged",
"description": "Describes a service message about a change in the price of paid messages within a chat.",
"html_description": "<p>Describes a service message about a change in the price of paid messages within a chat.</p>",
"rst_description": "Describes a service message about a change in the price of paid messages within a chat.",
"annotations": [
{
"type": "Integer",
"description": "The new number of Telegram Stars that must be paid by non-administrator users of the supergroup chat for each sent message",
"html_description": "<td>The new number of Telegram Stars that must be paid by non-administrator users of the supergroup chat for each sent message</td>",
"rst_description": "The new number of Telegram Stars that must be paid by non-administrator users of the supergroup chat for each sent message\n",
"name": "paid_message_star_count",
"required": true
}
],
"category": "types"
}
}

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

@ -0,0 +1,33 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "staramount",
"name": "StarAmount",
"description": "Describes an amount of Telegram Stars.",
"html_description": "<p>Describes an amount of Telegram Stars.</p>",
"rst_description": "Describes an amount of Telegram Stars.",
"annotations": [
{
"type": "Integer",
"description": "Integer amount of Telegram Stars, rounded to 0; can be negative",
"html_description": "<td>Integer amount of Telegram Stars, rounded to 0; can be negative</td>",
"rst_description": "Integer amount of Telegram Stars, rounded to 0; can be negative\n",
"name": "amount",
"required": true
},
{
"type": "Integer",
"description": "The number of 1/1000000000 shares of Telegram Stars; from -999999999 to 999999999; can be negative if and only if amount is non-positive",
"html_description": "<td><em>Optional</em>. The number of 1/1000000000 shares of Telegram Stars; from -999999999 to 999999999; can be negative if and only if <em>amount</em> is non-positive</td>",
"rst_description": "*Optional*. The number of 1/1000000000 shares of Telegram Stars; from -999999999 to 999999999; can be negative if and only if *amount* is non-positive\n",
"name": "nanostar_amount",
"required": false
}
],
"category": "types"
}
}

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

@ -0,0 +1,33 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "storyarea",
"name": "StoryArea",
"description": "Describes a clickable area on a story media.",
"html_description": "<p>Describes a clickable area on a story media.</p>",
"rst_description": "Describes a clickable area on a story media.",
"annotations": [
{
"type": "StoryAreaPosition",
"description": "Position of the area",
"html_description": "<td>Position of the area</td>",
"rst_description": "Position of the area\n",
"name": "position",
"required": true
},
{
"type": "StoryAreaType",
"description": "Type of the area",
"html_description": "<td>Type of the area</td>",
"rst_description": "Type of the area\n",
"name": "type",
"required": true
}
],
"category": "types"
}
}

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

@ -0,0 +1,65 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "storyareaposition",
"name": "StoryAreaPosition",
"description": "Describes the position of a clickable area within a story.",
"html_description": "<p>Describes the position of a clickable area within a story.</p>",
"rst_description": "Describes the position of a clickable area within a story.",
"annotations": [
{
"type": "Float",
"description": "The abscissa of the area's center, as a percentage of the media width",
"html_description": "<td>The abscissa of the area's center, as a percentage of the media width</td>",
"rst_description": "The abscissa of the area's center, as a percentage of the media width\n",
"name": "x_percentage",
"required": true
},
{
"type": "Float",
"description": "The ordinate of the area's center, as a percentage of the media height",
"html_description": "<td>The ordinate of the area's center, as a percentage of the media height</td>",
"rst_description": "The ordinate of the area's center, as a percentage of the media height\n",
"name": "y_percentage",
"required": true
},
{
"type": "Float",
"description": "The width of the area's rectangle, as a percentage of the media width",
"html_description": "<td>The width of the area's rectangle, as a percentage of the media width</td>",
"rst_description": "The width of the area's rectangle, as a percentage of the media width\n",
"name": "width_percentage",
"required": true
},
{
"type": "Float",
"description": "The height of the area's rectangle, as a percentage of the media height",
"html_description": "<td>The height of the area's rectangle, as a percentage of the media height</td>",
"rst_description": "The height of the area's rectangle, as a percentage of the media height\n",
"name": "height_percentage",
"required": true
},
{
"type": "Float",
"description": "The clockwise rotation angle of the rectangle, in degrees; 0-360",
"html_description": "<td>The clockwise rotation angle of the rectangle, in degrees; 0-360</td>",
"rst_description": "The clockwise rotation angle of the rectangle, in degrees; 0-360\n",
"name": "rotation_angle",
"required": true
},
{
"type": "Float",
"description": "The radius of the rectangle corner rounding, as a percentage of the media width",
"html_description": "<td>The radius of the rectangle corner rounding, as a percentage of the media width</td>",
"rst_description": "The radius of the rectangle corner rounding, as a percentage of the media width\n",
"name": "corner_radius_percentage",
"required": true
}
],
"category": "types"
}
}

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

@ -0,0 +1,16 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "storyareatype",
"name": "StoryAreaType",
"description": "Describes the type of a clickable area on a story. Currently, it can be one of\n - StoryAreaTypeLocation\n - StoryAreaTypeSuggestedReaction\n - StoryAreaTypeLink\n - StoryAreaTypeWeather\n - StoryAreaTypeUniqueGift",
"html_description": "<p>Describes the type of a clickable area on a story. Currently, it can be one of</p><ul>\n<li><a href=\"#storyareatypelocation\">StoryAreaTypeLocation</a></li>\n<li><a href=\"#storyareatypesuggestedreaction\">StoryAreaTypeSuggestedReaction</a></li>\n<li><a href=\"#storyareatypelink\">StoryAreaTypeLink</a></li>\n<li><a href=\"#storyareatypeweather\">StoryAreaTypeWeather</a></li>\n<li><a href=\"#storyareatypeuniquegift\">StoryAreaTypeUniqueGift</a></li>\n</ul>",
"rst_description": "Describes the type of a clickable area on a story. Currently, it can be one of\n\n - :class:`aiogram.types.story_area_type_location.StoryAreaTypeLocation`\n - :class:`aiogram.types.story_area_type_suggested_reaction.StoryAreaTypeSuggestedReaction`\n - :class:`aiogram.types.story_area_type_link.StoryAreaTypeLink`\n - :class:`aiogram.types.story_area_type_weather.StoryAreaTypeWeather`\n - :class:`aiogram.types.story_area_type_unique_gift.StoryAreaTypeUniqueGift`",
"annotations": [],
"category": "types"
}
}

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

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

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

@ -0,0 +1,33 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "storyareatypelink",
"name": "StoryAreaTypeLink",
"description": "Describes a story area pointing to an HTTP or tg:// link. Currently, a story can have up to 3 link areas.",
"html_description": "<p>Describes a story area pointing to an HTTP or tg:// link. Currently, a story can have up to 3 link areas.</p>",
"rst_description": "Describes a story area pointing to an HTTP or tg:// link. Currently, a story can have up to 3 link areas.",
"annotations": [
{
"type": "String",
"description": "Type of the area, always 'link'",
"html_description": "<td>Type of the area, always &#8220;link&#8221;</td>",
"rst_description": "Type of the area, always 'link'\n",
"name": "type",
"required": true
},
{
"type": "String",
"description": "HTTP or tg:// URL to be opened when the area is clicked",
"html_description": "<td>HTTP or tg:// URL to be opened when the area is clicked</td>",
"rst_description": "HTTP or tg:// URL to be opened when the area is clicked\n",
"name": "url",
"required": true
}
],
"category": "types"
}
}

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

@ -0,0 +1,49 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "storyareatypelocation",
"name": "StoryAreaTypeLocation",
"description": "Describes a story area pointing to a location. Currently, a story can have up to 10 location areas.",
"html_description": "<p>Describes a story area pointing to a location. Currently, a story can have up to 10 location areas.</p>",
"rst_description": "Describes a story area pointing to a location. Currently, a story can have up to 10 location areas.",
"annotations": [
{
"type": "String",
"description": "Type of the area, always 'location'",
"html_description": "<td>Type of the area, always &#8220;location&#8221;</td>",
"rst_description": "Type of the area, always 'location'\n",
"name": "type",
"required": true
},
{
"type": "Float",
"description": "Location latitude in degrees",
"html_description": "<td>Location latitude in degrees</td>",
"rst_description": "Location latitude in degrees\n",
"name": "latitude",
"required": true
},
{
"type": "Float",
"description": "Location longitude in degrees",
"html_description": "<td>Location longitude in degrees</td>",
"rst_description": "Location longitude in degrees\n",
"name": "longitude",
"required": true
},
{
"type": "LocationAddress",
"description": "Address of the location",
"html_description": "<td><em>Optional</em>. Address of the location</td>",
"rst_description": "*Optional*. Address of the location\n",
"name": "address",
"required": false
}
],
"category": "types"
}
}

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

@ -0,0 +1,49 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "storyareatypesuggestedreaction",
"name": "StoryAreaTypeSuggestedReaction",
"description": "Describes a story area pointing to a suggested reaction. Currently, a story can have up to 5 suggested reaction areas.",
"html_description": "<p>Describes a story area pointing to a suggested reaction. Currently, a story can have up to 5 suggested reaction areas.</p>",
"rst_description": "Describes a story area pointing to a suggested reaction. Currently, a story can have up to 5 suggested reaction areas.",
"annotations": [
{
"type": "String",
"description": "Type of the area, always 'suggested_reaction'",
"html_description": "<td>Type of the area, always &#8220;suggested_reaction&#8221;</td>",
"rst_description": "Type of the area, always 'suggested_reaction'\n",
"name": "type",
"required": true
},
{
"type": "ReactionType",
"description": "Type of the reaction",
"html_description": "<td>Type of the reaction</td>",
"rst_description": "Type of the reaction\n",
"name": "reaction_type",
"required": true
},
{
"type": "Boolean",
"description": "Pass True if the reaction area has a dark background",
"html_description": "<td><em>Optional</em>. Pass <em>True</em> if the reaction area has a dark background</td>",
"rst_description": "*Optional*. Pass :code:`True` if the reaction area has a dark background\n",
"name": "is_dark",
"required": false
},
{
"type": "Boolean",
"description": "Pass True if reaction area corner is flipped",
"html_description": "<td><em>Optional</em>. Pass <em>True</em> if reaction area corner is flipped</td>",
"rst_description": "*Optional*. Pass :code:`True` if reaction area corner is flipped\n",
"name": "is_flipped",
"required": false
}
],
"category": "types"
}
}

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

@ -0,0 +1,33 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "storyareatypeuniquegift",
"name": "StoryAreaTypeUniqueGift",
"description": "Describes a story area pointing to a unique gift. Currently, a story can have at most 1 unique gift area.",
"html_description": "<p>Describes a story area pointing to a unique gift. Currently, a story can have at most 1 unique gift area.</p>",
"rst_description": "Describes a story area pointing to a unique gift. Currently, a story can have at most 1 unique gift area.",
"annotations": [
{
"type": "String",
"description": "Type of the area, always 'unique_gift'",
"html_description": "<td>Type of the area, always &#8220;unique_gift&#8221;</td>",
"rst_description": "Type of the area, always 'unique_gift'\n",
"name": "type",
"required": true
},
{
"type": "String",
"description": "Unique name of the gift",
"html_description": "<td>Unique name of the gift</td>",
"rst_description": "Unique name of the gift\n",
"name": "name",
"required": true
}
],
"category": "types"
}
}

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

@ -0,0 +1,49 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "storyareatypeweather",
"name": "StoryAreaTypeWeather",
"description": "Describes a story area containing weather information. Currently, a story can have up to 3 weather areas.",
"html_description": "<p>Describes a story area containing weather information. Currently, a story can have up to 3 weather areas.</p>",
"rst_description": "Describes a story area containing weather information. Currently, a story can have up to 3 weather areas.",
"annotations": [
{
"type": "String",
"description": "Type of the area, always 'weather'",
"html_description": "<td>Type of the area, always &#8220;weather&#8221;</td>",
"rst_description": "Type of the area, always 'weather'\n",
"name": "type",
"required": true
},
{
"type": "Float",
"description": "Temperature, in degree Celsius",
"html_description": "<td>Temperature, in degree Celsius</td>",
"rst_description": "Temperature, in degree Celsius\n",
"name": "temperature",
"required": true
},
{
"type": "String",
"description": "Emoji representing the weather",
"html_description": "<td>Emoji representing the weather</td>",
"rst_description": "Emoji representing the weather\n",
"name": "emoji",
"required": true
},
{
"type": "Integer",
"description": "A color of the area background in the ARGB format",
"html_description": "<td>A color of the area background in the ARGB format</td>",
"rst_description": "A color of the area background in the ARGB format\n",
"name": "background_color",
"required": true
}
],
"category": "types"
}
}

52
.butcher/types/TransactionPartnerUser/entity.json
View file

@ -19,6 +19,14 @@
"name": "type",
"required": true
},
{
"type": "String",
"description": "Type of the transaction, currently one of 'invoice_payment' for payments via invoices, 'paid_media_payment' for payments for paid media, 'gift_purchase' for gifts sent by the bot, 'premium_purchase' for Telegram Premium subscriptions gifted by the bot, 'business_account_transfer' for direct transfers from managed business accounts",
"html_description": "<td>Type of the transaction, currently one of &#8220;invoice_payment&#8221; for payments via invoices, &#8220;paid_media_payment&#8221; for payments for paid media, &#8220;gift_purchase&#8221; for gifts sent by the bot, &#8220;premium_purchase&#8221; for Telegram Premium subscriptions gifted by the bot, &#8220;business_account_transfer&#8221; for direct transfers from managed business accounts</td>",
"rst_description": "Type of the transaction, currently one of 'invoice_payment' for payments via invoices, 'paid_media_payment' for payments for paid media, 'gift_purchase' for gifts sent by the bot, 'premium_purchase' for Telegram Premium subscriptions gifted by the bot, 'business_account_transfer' for direct transfers from managed business accounts\n",
"name": "transaction_type",
"required": true
},
{
"type": "User",
"description": "Information about the user",
@ -29,51 +37,59 @@
},
{
"type": "AffiliateInfo",
"description": "Information about the affiliate that received a commission via this transaction",
"html_description": "<td><em>Optional</em>. Information about the affiliate that received a commission via this transaction</td>",
"rst_description": "*Optional*. Information about the affiliate that received a commission via this transaction\n",
"description": "Information about the affiliate that received a commission via this transaction. Can be available only for 'invoice_payment' and 'paid_media_payment' transactions.",
"html_description": "<td><em>Optional</em>. Information about the affiliate that received a commission via this transaction. Can be available only for &#8220;invoice_payment&#8221; and &#8220;paid_media_payment&#8221; transactions.</td>",
"rst_description": "*Optional*. Information about the affiliate that received a commission via this transaction. Can be available only for 'invoice_payment' and 'paid_media_payment' transactions.\n",
"name": "affiliate",
"required": false
},
{
"type": "String",
"description": "Bot-specified invoice payload",
"html_description": "<td><em>Optional</em>. Bot-specified invoice payload</td>",
"rst_description": "*Optional*. Bot-specified invoice payload\n",
"description": "Bot-specified invoice payload. Can be available only for 'invoice_payment' transactions.",
"html_description": "<td><em>Optional</em>. Bot-specified invoice payload. Can be available only for &#8220;invoice_payment&#8221; transactions.</td>",
"rst_description": "*Optional*. Bot-specified invoice payload. Can be available only for 'invoice_payment' transactions.\n",
"name": "invoice_payload",
"required": false
},
{
"type": "Integer",
"description": "The duration of the paid subscription",
"html_description": "<td><em>Optional</em>. The duration of the paid subscription</td>",
"rst_description": "*Optional*. The duration of the paid subscription\n",
"description": "The duration of the paid subscription. Can be available only for 'invoice_payment' transactions.",
"html_description": "<td><em>Optional</em>. The duration of the paid subscription. Can be available only for &#8220;invoice_payment&#8221; transactions.</td>",
"rst_description": "*Optional*. The duration of the paid subscription. Can be available only for 'invoice_payment' transactions.\n",
"name": "subscription_period",
"required": false
},
{
"type": "Array of PaidMedia",
"description": "Information about the paid media bought by the user",
"html_description": "<td><em>Optional</em>. Information about the paid media bought by the user</td>",
"rst_description": "*Optional*. Information about the paid media bought by the user\n",
"description": "Information about the paid media bought by the user; for 'paid_media_payment' transactions only",
"html_description": "<td><em>Optional</em>. Information about the paid media bought by the user; for &#8220;paid_media_payment&#8221; transactions only</td>",
"rst_description": "*Optional*. Information about the paid media bought by the user; for 'paid_media_payment' transactions only\n",
"name": "paid_media",
"required": false
},
{
"type": "String",
"description": "Bot-specified paid media payload",
"html_description": "<td><em>Optional</em>. Bot-specified paid media payload</td>",
"rst_description": "*Optional*. Bot-specified paid media payload\n",
"description": "Bot-specified paid media payload. Can be available only for 'paid_media_payment' transactions.",
"html_description": "<td><em>Optional</em>. Bot-specified paid media payload. Can be available only for &#8220;paid_media_payment&#8221; transactions.</td>",
"rst_description": "*Optional*. Bot-specified paid media payload. Can be available only for 'paid_media_payment' transactions.\n",
"name": "paid_media_payload",
"required": false
},
{
"type": "Gift",
"description": "The gift sent to the user by the bot",
"html_description": "<td><em>Optional</em>. The gift sent to the user by the bot</td>",
"rst_description": "*Optional*. The gift sent to the user by the bot\n",
"description": "The gift sent to the user by the bot; for 'gift_purchase' transactions only",
"html_description": "<td><em>Optional</em>. The gift sent to the user by the bot; for &#8220;gift_purchase&#8221; transactions only</td>",
"rst_description": "*Optional*. The gift sent to the user by the bot; for 'gift_purchase' transactions only\n",
"name": "gift",
"required": false
},
{
"type": "Integer",
"description": "Number of months the gifted Telegram Premium subscription will be active for; for 'premium_purchase' transactions only",
"html_description": "<td><em>Optional</em>. Number of months the gifted Telegram Premium subscription will be active for; for &#8220;premium_purchase&#8221; transactions only</td>",
"rst_description": "*Optional*. Number of months the gifted Telegram Premium subscription will be active for; for 'premium_purchase' transactions only\n",
"name": "premium_subscription_duration",
"required": false
}
],
"category": "types"

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

@ -0,0 +1,65 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "uniquegift",
"name": "UniqueGift",
"description": "This object describes a unique gift that was upgraded from a regular gift.",
"html_description": "<p>This object describes a unique gift that was upgraded from a regular gift.</p>",
"rst_description": "This object describes a unique gift that was upgraded from a regular gift.",
"annotations": [
{
"type": "String",
"description": "Human-readable name of the regular gift from which this unique gift was upgraded",
"html_description": "<td>Human-readable name of the regular gift from which this unique gift was upgraded</td>",
"rst_description": "Human-readable name of the regular gift from which this unique gift was upgraded\n",
"name": "base_name",
"required": true
},
{
"type": "String",
"description": "Unique name of the gift. This name can be used in https://t.me/nft/... links and story areas",
"html_description": "<td>Unique name of the gift. This name can be used in <code>https://t.me/nft/...</code> links and story areas</td>",
"rst_description": "Unique name of the gift. This name can be used in :code:`https://t.me/nft/...` links and story areas\n",
"name": "name",
"required": true
},
{
"type": "Integer",
"description": "Unique number of the upgraded gift among gifts upgraded from the same regular gift",
"html_description": "<td>Unique number of the upgraded gift among gifts upgraded from the same regular gift</td>",
"rst_description": "Unique number of the upgraded gift among gifts upgraded from the same regular gift\n",
"name": "number",
"required": true
},
{
"type": "UniqueGiftModel",
"description": "Model of the gift",
"html_description": "<td>Model of the gift</td>",
"rst_description": "Model of the gift\n",
"name": "model",
"required": true
},
{
"type": "UniqueGiftSymbol",
"description": "Symbol of the gift",
"html_description": "<td>Symbol of the gift</td>",
"rst_description": "Symbol of the gift\n",
"name": "symbol",
"required": true
},
{
"type": "UniqueGiftBackdrop",
"description": "Backdrop of the gift",
"html_description": "<td>Backdrop of the gift</td>",
"rst_description": "Backdrop of the gift\n",
"name": "backdrop",
"required": true
}
],
"category": "types"
}
}

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

@ -0,0 +1,41 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "uniquegiftbackdrop",
"name": "UniqueGiftBackdrop",
"description": "This object describes the backdrop of a unique gift.",
"html_description": "<p>This object describes the backdrop of a unique gift.</p>",
"rst_description": "This object describes the backdrop of a unique gift.",
"annotations": [
{
"type": "String",
"description": "Name of the backdrop",
"html_description": "<td>Name of the backdrop</td>",
"rst_description": "Name of the backdrop\n",
"name": "name",
"required": true
},
{
"type": "UniqueGiftBackdropColors",
"description": "Colors of the backdrop",
"html_description": "<td>Colors of the backdrop</td>",
"rst_description": "Colors of the backdrop\n",
"name": "colors",
"required": true
},
{
"type": "Integer",
"description": "The number of unique gifts that receive this backdrop for every 1000 gifts upgraded",
"html_description": "<td>The number of unique gifts that receive this backdrop for every 1000 gifts upgraded</td>",
"rst_description": "The number of unique gifts that receive this backdrop for every 1000 gifts upgraded\n",
"name": "rarity_per_mille",
"required": true
}
],
"category": "types"
}
}

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

@ -0,0 +1,49 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "uniquegiftbackdropcolors",
"name": "UniqueGiftBackdropColors",
"description": "This object describes the colors of the backdrop of a unique gift.",
"html_description": "<p>This object describes the colors of the backdrop of a unique gift.</p>",
"rst_description": "This object describes the colors of the backdrop of a unique gift.",
"annotations": [
{
"type": "Integer",
"description": "The color in the center of the backdrop in RGB format",
"html_description": "<td>The color in the center of the backdrop in RGB format</td>",
"rst_description": "The color in the center of the backdrop in RGB format\n",
"name": "center_color",
"required": true
},
{
"type": "Integer",
"description": "The color on the edges of the backdrop in RGB format",
"html_description": "<td>The color on the edges of the backdrop in RGB format</td>",
"rst_description": "The color on the edges of the backdrop in RGB format\n",
"name": "edge_color",
"required": true
},
{
"type": "Integer",
"description": "The color to be applied to the symbol in RGB format",
"html_description": "<td>The color to be applied to the symbol in RGB format</td>",
"rst_description": "The color to be applied to the symbol in RGB format\n",
"name": "symbol_color",
"required": true
},
{
"type": "Integer",
"description": "The color for the text on the backdrop in RGB format",
"html_description": "<td>The color for the text on the backdrop in RGB format</td>",
"rst_description": "The color for the text on the backdrop in RGB format\n",
"name": "text_color",
"required": true
}
],
"category": "types"
}
}

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

@ -0,0 +1,49 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "uniquegiftinfo",
"name": "UniqueGiftInfo",
"description": "Describes a service message about a unique gift that was sent or received.",
"html_description": "<p>Describes a service message about a unique gift that was sent or received.</p>",
"rst_description": "Describes a service message about a unique gift that was sent or received.",
"annotations": [
{
"type": "UniqueGift",
"description": "Information about the gift",
"html_description": "<td>Information about the gift</td>",
"rst_description": "Information about the gift\n",
"name": "gift",
"required": true
},
{
"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",
"name": "origin",
"required": true
},
{
"type": "String",
"description": "Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts",
"html_description": "<td><em>Optional</em>. Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts</td>",
"rst_description": "*Optional*. Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts\n",
"name": "owned_gift_id",
"required": false
},
{
"type": "Integer",
"description": "Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer the gift",
"html_description": "<td><em>Optional</em>. Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer the gift</td>",
"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
}
],
"category": "types"
}
}

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

@ -0,0 +1,41 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "uniquegiftmodel",
"name": "UniqueGiftModel",
"description": "This object describes the model of a unique gift.",
"html_description": "<p>This object describes the model of a unique gift.</p>",
"rst_description": "This object describes the model of a unique gift.",
"annotations": [
{
"type": "String",
"description": "Name of the model",
"html_description": "<td>Name of the model</td>",
"rst_description": "Name of the model\n",
"name": "name",
"required": true
},
{
"type": "Sticker",
"description": "The sticker that represents the unique gift",
"html_description": "<td>The sticker that represents the unique gift</td>",
"rst_description": "The sticker that represents the unique gift\n",
"name": "sticker",
"required": true
},
{
"type": "Integer",
"description": "The number of unique gifts that receive this model for every 1000 gifts upgraded",
"html_description": "<td>The number of unique gifts that receive this model for every 1000 gifts upgraded</td>",
"rst_description": "The number of unique gifts that receive this model for every 1000 gifts upgraded\n",
"name": "rarity_per_mille",
"required": true
}
],
"category": "types"
}
}

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

@ -0,0 +1,41 @@
{
"meta": {},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "uniquegiftsymbol",
"name": "UniqueGiftSymbol",
"description": "This object describes the symbol shown on the pattern of a unique gift.",
"html_description": "<p>This object describes the symbol shown on the pattern of a unique gift.</p>",
"rst_description": "This object describes the symbol shown on the pattern of a unique gift.",
"annotations": [
{
"type": "String",
"description": "Name of the symbol",
"html_description": "<td>Name of the symbol</td>",
"rst_description": "Name of the symbol\n",
"name": "name",
"required": true
},
{
"type": "Sticker",
"description": "The sticker that represents the unique gift",
"html_description": "<td>The sticker that represents the unique gift</td>",
"rst_description": "The sticker that represents the unique gift\n",
"name": "sticker",
"required": true
},
{
"type": "Integer",
"description": "The number of unique gifts that receive this model for every 1000 gifts upgraded",
"html_description": "<td>The number of unique gifts that receive this model for every 1000 gifts upgraded</td>",
"rst_description": "The number of unique gifts that receive this model for every 1000 gifts upgraded\n",
"name": "rarity_per_mille",
"required": true
}
],
"category": "types"
}
}