can be used to mention a user by their identifier without using a username, if this is allowed by their privacy settings.",
@@ -4760,28 +6113,36 @@
},
{
"type": "String",
- "description": "If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. Not supported for messages sent on behalf of a Telegram Business account.",
- "html_description": "| Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. Not supported for messages sent on behalf of a Telegram Business account. | ",
- "rst_description": "*Optional*. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. Not supported for messages sent on behalf of a Telegram Business account.\n",
+ "description": "If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. Not supported for messages sent in channel direct messages chats and on behalf of a Telegram Business account.",
+ "html_description": "Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. Not supported for messages sent in channel direct messages chats and on behalf of a Telegram Business account. | ",
+ "rst_description": "*Optional*. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. Not supported for messages sent in channel direct messages chats and on behalf of a Telegram Business account.\n",
"name": "switch_inline_query",
"required": false
},
{
"type": "String",
- "description": "If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.\n\nThis offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent on behalf of a Telegram Business account.",
- "html_description": "Optional. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.
\n
\nThis offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent on behalf of a Telegram Business account. | ",
- "rst_description": "*Optional*. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.\n\n\n\nThis offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent on behalf of a Telegram Business account.\n",
+ "description": "If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.\n\nThis offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent in channel direct messages chats and on behalf of a Telegram Business account.",
+ "html_description": "Optional. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.
\n
\nThis offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent in channel direct messages chats and on behalf of a Telegram Business account. | ",
+ "rst_description": "*Optional*. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.\n\n\n\nThis offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent in channel direct messages chats and on behalf of a Telegram Business account.\n",
"name": "switch_inline_query_current_chat",
"required": false
},
{
"type": "SwitchInlineQueryChosenChat",
- "description": "If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent on behalf of a Telegram Business account.",
- "html_description": "Optional. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent on behalf of a Telegram Business account. | ",
- "rst_description": "*Optional*. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent on behalf of a Telegram Business account.\n",
+ "description": "If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent in channel direct messages chats and on behalf of a Telegram Business account.",
+ "html_description": "Optional. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent in channel direct messages chats and on behalf of a Telegram Business account. | ",
+ "rst_description": "*Optional*. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent in channel direct messages chats and on behalf of a Telegram Business account.\n",
"name": "switch_inline_query_chosen_chat",
"required": false
},
+ {
+ "type": "CopyTextButton",
+ "description": "Description of the button that copies the specified text to the clipboard.",
+ "html_description": "Optional. Description of the button that copies the specified text to the clipboard. | ",
+ "rst_description": "*Optional*. Description of the button that copies the specified text to the clipboard.\n",
+ "name": "copy_text",
+ "required": false
+ },
{
"type": "CallbackGame",
"description": "Description of the game that will be launched when the user presses the button.\n\nNOTE: This type of button must always be the first button in the first row.",
@@ -4861,38 +6222,56 @@
{
"type": "Boolean",
"description": "True, if private chats with users can be chosen",
- "html_description": "Optional. True, if private chats with users can be chosen | ",
- "rst_description": "*Optional*. True, if private chats with users can be chosen\n",
+ "html_description": "Optional. True, if private chats with users can be chosen | ",
+ "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": "Optional. True, if private chats with bots can be chosen | ",
- "rst_description": "*Optional*. True, if private chats with bots can be chosen\n",
+ "html_description": "Optional. True, if private chats with bots can be chosen | ",
+ "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": "Optional. True, if group and supergroup chats can be chosen | ",
- "rst_description": "*Optional*. True, if group and supergroup chats can be chosen\n",
+ "html_description": "Optional. True, if group and supergroup chats can be chosen | ",
+ "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": "Optional. True, if channel chats can be chosen | ",
- "rst_description": "*Optional*. True, if channel chats can be chosen\n",
+ "html_description": "Optional. True, if channel chats can be chosen | ",
+ "rst_description": "*Optional*. :code:`True`, if channel chats can be chosen\n",
"name": "allow_channel_chats",
"required": false
}
],
"category": "types"
},
+ {
+ "anchor": "copytextbutton",
+ "name": "CopyTextButton",
+ "description": "This object represents an inline keyboard button that copies specified text to the clipboard.",
+ "html_description": "This object represents an inline keyboard button that copies specified text to the clipboard.
",
+ "rst_description": "This object represents an inline keyboard button that copies specified text to the clipboard.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "The text to be copied to the clipboard; 1-256 characters",
+ "html_description": "The text to be copied to the clipboard; 1-256 characters | ",
+ "rst_description": "The text to be copied to the clipboard; 1-256 characters\n",
+ "name": "text",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
{
"anchor": "callbackquery",
"name": "CallbackQuery",
@@ -5113,6 +6492,22 @@
"rst_description": "*Optional*. Number of pending join requests created using this link\n",
"name": "pending_join_request_count",
"required": false
+ },
+ {
+ "type": "Integer",
+ "description": "The number of seconds the subscription will be active for before the next payment",
+ "html_description": "Optional. The number of seconds the subscription will be active for before the next payment | ",
+ "rst_description": "*Optional*. The number of seconds the subscription will be active for before the next payment\n",
+ "name": "subscription_period",
+ "required": false
+ },
+ {
+ "type": "Integer",
+ "description": "The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat using the link",
+ "html_description": "Optional. The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat using the link | ",
+ "rst_description": "*Optional*. The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat using the link\n",
+ "name": "subscription_price",
+ "required": false
}
],
"category": "types"
@@ -5134,9 +6529,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": "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. | ",
- "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": "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. | ",
+ "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
},
@@ -5214,9 +6609,9 @@
},
{
"type": "Boolean",
- "description": "True, if the administrator can post messages in the channel, or access channel statistics; for channels only",
- "html_description": "Optional. True, if the administrator can post messages in the channel, or access channel statistics; for channels only | ",
- "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": "Optional. True, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only | ",
+ "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
},
@@ -5243,6 +6638,22 @@
"rst_description": "*Optional*. :code:`True`, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only\n",
"name": "can_manage_topics",
"required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only",
+ "html_description": "Optional. True, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only | ",
+ "rst_description": "*Optional*. :code:`True`, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only\n",
+ "name": "can_manage_direct_messages",
+ "required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted defaults to the value of can_pin_messages.",
+ "html_description": "Optional. True, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted defaults to the value of can_pin_messages. | ",
+ "rst_description": "*Optional*. :code:`True`, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted defaults to the value of can_pin_messages.\n",
+ "name": "can_manage_tags",
+ "required": false
}
],
"category": "types"
@@ -5305,16 +6716,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": "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 | ",
- "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": "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 | ",
+ "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": "Optional. True, if the user joined the chat via a chat folder invite link | ",
- "rst_description": "*Optional*. True, if the user joined the chat via a chat folder invite link\n",
+ "html_description": "Optional. True, if the user joined the chat via a chat folder invite link | ",
+ "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
}
@@ -5413,9 +6824,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": "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. | ",
- "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": "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. | ",
+ "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
},
@@ -5493,9 +6904,9 @@
},
{
"type": "Boolean",
- "description": "True, if the administrator can post messages in the channel, or access channel statistics; for channels only",
- "html_description": "Optional. True, if the administrator can post messages in the channel, or access channel statistics; for channels only | ",
- "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": "Optional. True, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only | ",
+ "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
},
@@ -5523,6 +6934,22 @@
"name": "can_manage_topics",
"required": false
},
+ {
+ "type": "Boolean",
+ "description": "True, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only",
+ "html_description": "Optional. True, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only | ",
+ "rst_description": "*Optional*. :code:`True`, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only\n",
+ "name": "can_manage_direct_messages",
+ "required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted defaults to the value of can_pin_messages.",
+ "html_description": "Optional. True, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted defaults to the value of can_pin_messages. | ",
+ "rst_description": "*Optional*. :code:`True`, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted defaults to the value of can_pin_messages.\n",
+ "name": "can_manage_tags",
+ "required": false
+ },
{
"type": "String",
"description": "Custom title for this user",
@@ -5549,6 +6976,14 @@
"name": "status",
"required": true
},
+ {
+ "type": "String",
+ "description": "Tag of the member",
+ "html_description": "Optional. Tag of the member | ",
+ "rst_description": "*Optional*. Tag of the member\n",
+ "name": "tag",
+ "required": false
+ },
{
"type": "User",
"description": "Information about the user",
@@ -5556,6 +6991,14 @@
"rst_description": "Information about the user\n",
"name": "user",
"required": true
+ },
+ {
+ "type": "Integer",
+ "description": "Date when the user's subscription will expire; Unix time",
+ "html_description": "Optional. Date when the user's subscription will expire; Unix time | ",
+ "rst_description": "*Optional*. Date when the user's subscription will expire; Unix time\n",
+ "name": "until_date",
+ "required": false
}
],
"category": "types"
@@ -5575,6 +7018,14 @@
"name": "status",
"required": true
},
+ {
+ "type": "String",
+ "description": "Tag of the member",
+ "html_description": "Optional. Tag of the member | ",
+ "rst_description": "*Optional*. Tag of the member\n",
+ "name": "tag",
+ "required": false
+ },
{
"type": "User",
"description": "Information about the user",
@@ -5649,9 +7100,9 @@
},
{
"type": "Boolean",
- "description": "True, if the user is allowed to send polls",
- "html_description": "True, if the user is allowed to send polls | ",
- "rst_description": ":code:`True`, if the user is allowed to send polls\n",
+ "description": "True, if the user is allowed to send polls and checklists",
+ "html_description": "True, if the user is allowed to send polls and checklists | ",
+ "rst_description": ":code:`True`, if the user is allowed to send polls and checklists\n",
"name": "can_send_polls",
"required": true
},
@@ -5671,6 +7122,14 @@
"name": "can_add_web_page_previews",
"required": true
},
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to edit their own tag",
+ "html_description": "True, if the user is allowed to edit their own tag | ",
+ "rst_description": ":code:`True`, if the user is allowed to edit their own tag\n",
+ "name": "can_edit_tag",
+ "required": true
+ },
{
"type": "Boolean",
"description": "True, if the user is allowed to change the chat title, photo and other settings",
@@ -5897,9 +7356,9 @@
},
{
"type": "Boolean",
- "description": "True, if the user is allowed to send polls",
- "html_description": "Optional. True, if the user is allowed to send polls | ",
- "rst_description": "*Optional*. :code:`True`, if the user is allowed to send polls\n",
+ "description": "True, if the user is allowed to send polls and checklists",
+ "html_description": "Optional. True, if the user is allowed to send polls and checklists | ",
+ "rst_description": "*Optional*. :code:`True`, if the user is allowed to send polls and checklists\n",
"name": "can_send_polls",
"required": false
},
@@ -5919,6 +7378,14 @@
"name": "can_add_web_page_previews",
"required": false
},
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to edit their own tag",
+ "html_description": "Optional. True, if the user is allowed to edit their own tag | ",
+ "rst_description": "*Optional*. :code:`True`, if the user is allowed to edit their own tag\n",
+ "name": "can_edit_tag",
+ "required": false
+ },
{
"type": "Boolean",
"description": "True, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups",
@@ -6100,6 +7567,361 @@
],
"category": "types"
},
+ {
+ "anchor": "userrating",
+ "name": "UserRating",
+ "description": "This object describes the rating of a user based on their Telegram Star spendings.",
+ "html_description": "This object describes the rating of a user based on their Telegram Star spendings.
",
+ "rst_description": "This object describes the rating of a user based on their Telegram Star spendings.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "description": "Current level of the user, indicating their reliability when purchasing digital goods and services. A higher level suggests a more trustworthy customer; a negative level is likely reason for concern.",
+ "html_description": "Current level of the user, indicating their reliability when purchasing digital goods and services. A higher level suggests a more trustworthy customer; a negative level is likely reason for concern. | ",
+ "rst_description": "Current level of the user, indicating their reliability when purchasing digital goods and services. A higher level suggests a more trustworthy customer; a negative level is likely reason for concern.\n",
+ "name": "level",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "Numerical value of the user's rating; the higher the rating, the better",
+ "html_description": "Numerical value of the user's rating; the higher the rating, the better | ",
+ "rst_description": "Numerical value of the user's rating; the higher the rating, the better\n",
+ "name": "rating",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "The rating value required to get the current level",
+ "html_description": "The rating value required to get the current level | ",
+ "rst_description": "The rating value required to get the current level\n",
+ "name": "current_level_rating",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "The rating value required to get to the next level; omitted if the maximum level was reached",
+ "html_description": "Optional. The rating value required to get to the next level; omitted if the maximum level was reached | ",
+ "rst_description": "*Optional*. The rating value required to get to the next level; omitted if the maximum level was reached\n",
+ "name": "next_level_rating",
+ "required": false
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "storyareaposition",
+ "name": "StoryAreaPosition",
+ "description": "Describes the position of a clickable area within a story.",
+ "html_description": "Describes the position of a clickable area within a story.
",
+ "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": "The abscissa of the area's center, as a percentage of the media width | ",
+ "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": "The ordinate of the area's center, as a percentage of the media height | ",
+ "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": "The width of the area's rectangle, as a percentage of the media width | ",
+ "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": "The height of the area's rectangle, as a percentage of the media height | ",
+ "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": "The clockwise rotation angle of the rectangle, in degrees; 0-360 | ",
+ "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": "The radius of the rectangle corner rounding, as a percentage of the media width | ",
+ "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"
+ },
+ {
+ "anchor": "locationaddress",
+ "name": "LocationAddress",
+ "description": "Describes the physical address of a location.",
+ "html_description": "Describes the physical address of a location.
",
+ "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": "The two-letter ISO 3166-1 alpha-2 country code of the country where the location is located | ",
+ "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": "Optional. State of the location | ",
+ "rst_description": "*Optional*. State of the location\n",
+ "name": "state",
+ "required": false
+ },
+ {
+ "type": "String",
+ "description": "City of the location",
+ "html_description": "Optional. City of the location | ",
+ "rst_description": "*Optional*. City of the location\n",
+ "name": "city",
+ "required": false
+ },
+ {
+ "type": "String",
+ "description": "Street address of the location",
+ "html_description": "Optional. Street address of the location | ",
+ "rst_description": "*Optional*. Street address of the location\n",
+ "name": "street",
+ "required": false
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "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": "Describes the type of a clickable area on a story. Currently, it can be one of
",
+ "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"
+ },
+ {
+ "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": "Describes a story area pointing to a location. Currently, a story can have up to 10 location areas.
",
+ "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": "Type of the area, always “location” | ",
+ "rst_description": "Type of the area, always 'location'\n",
+ "name": "type",
+ "required": true
+ },
+ {
+ "type": "Float",
+ "description": "Location latitude in degrees",
+ "html_description": "Location latitude in degrees | ",
+ "rst_description": "Location latitude in degrees\n",
+ "name": "latitude",
+ "required": true
+ },
+ {
+ "type": "Float",
+ "description": "Location longitude in degrees",
+ "html_description": "Location longitude in degrees | ",
+ "rst_description": "Location longitude in degrees\n",
+ "name": "longitude",
+ "required": true
+ },
+ {
+ "type": "LocationAddress",
+ "description": "Address of the location",
+ "html_description": "Optional. Address of the location | ",
+ "rst_description": "*Optional*. Address of the location\n",
+ "name": "address",
+ "required": false
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "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": "Describes a story area pointing to a suggested reaction. Currently, a story can have up to 5 suggested reaction areas.
",
+ "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": "Type of the area, always “suggested_reaction” | ",
+ "rst_description": "Type of the area, always 'suggested_reaction'\n",
+ "name": "type",
+ "required": true
+ },
+ {
+ "type": "ReactionType",
+ "description": "Type of the reaction",
+ "html_description": "Type of the reaction | ",
+ "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": "Optional. Pass True if the reaction area has a dark background | ",
+ "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": "Optional. Pass True if reaction area corner is flipped | ",
+ "rst_description": "*Optional*. Pass :code:`True` if reaction area corner is flipped\n",
+ "name": "is_flipped",
+ "required": false
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "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": "Describes a story area pointing to an HTTP or tg:// link. Currently, a story can have up to 3 link areas.
",
+ "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": "Type of the area, always “link” | ",
+ "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": "HTTP or tg:// URL to be opened when the area is clicked | ",
+ "rst_description": "HTTP or tg:// URL to be opened when the area is clicked\n",
+ "name": "url",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "storyareatypeweather",
+ "name": "StoryAreaTypeWeather",
+ "description": "Describes a story area containing weather information. Currently, a story can have up to 3 weather areas.",
+ "html_description": "Describes a story area containing weather information. Currently, a story can have up to 3 weather areas.
",
+ "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": "Type of the area, always “weather” | ",
+ "rst_description": "Type of the area, always 'weather'\n",
+ "name": "type",
+ "required": true
+ },
+ {
+ "type": "Float",
+ "description": "Temperature, in degree Celsius",
+ "html_description": "Temperature, in degree Celsius | ",
+ "rst_description": "Temperature, in degree Celsius\n",
+ "name": "temperature",
+ "required": true
+ },
+ {
+ "type": "String",
+ "description": "Emoji representing the weather",
+ "html_description": "Emoji representing the weather | ",
+ "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": "A color of the area background in the ARGB format | ",
+ "rst_description": "A color of the area background in the ARGB format\n",
+ "name": "background_color",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "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": "Describes a story area pointing to a unique gift. Currently, a story can have at most 1 unique gift area.
",
+ "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": "Type of the area, always “unique_gift” | ",
+ "rst_description": "Type of the area, always 'unique_gift'\n",
+ "name": "type",
+ "required": true
+ },
+ {
+ "type": "String",
+ "description": "Unique name of the gift",
+ "html_description": "Unique name of the gift | ",
+ "rst_description": "Unique name of the gift\n",
+ "name": "name",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "storyarea",
+ "name": "StoryArea",
+ "description": "Describes a clickable area on a story media.",
+ "html_description": "Describes a clickable area on a story media.
",
+ "rst_description": "Describes a clickable area on a story media.",
+ "annotations": [
+ {
+ "type": "StoryAreaPosition",
+ "description": "Position of the area",
+ "html_description": "Position of the area | ",
+ "rst_description": "Position of the area\n",
+ "name": "position",
+ "required": true
+ },
+ {
+ "type": "StoryAreaType",
+ "description": "Type of the area",
+ "html_description": "Type of the area | ",
+ "rst_description": "Type of the area\n",
+ "name": "type",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
{
"anchor": "chatlocation",
"name": "ChatLocation",
@@ -6129,9 +7951,9 @@
{
"anchor": "reactiontype",
"name": "ReactionType",
- "description": "This object describes the type of a reaction. Currently, it can be one of\n - ReactionTypeEmoji\n - ReactionTypeCustomEmoji",
- "html_description": "This object describes the type of a reaction. Currently, it can be one of
",
- "rst_description": "This object describes the type of a reaction. Currently, it can be one of\n\n - :class:`aiogram.types.reaction_type_emoji.ReactionTypeEmoji`\n - :class:`aiogram.types.reaction_type_custom_emoji.ReactionTypeCustomEmoji`",
+ "description": "This object describes the type of a reaction. Currently, it can be one of\n - ReactionTypeEmoji\n - ReactionTypeCustomEmoji\n - ReactionTypePaid",
+ "html_description": "This object describes the type of a reaction. Currently, it can be one of
",
+ "rst_description": "This object describes the type of a reaction. Currently, it can be one of\n\n - :class:`aiogram.types.reaction_type_emoji.ReactionTypeEmoji`\n - :class:`aiogram.types.reaction_type_custom_emoji.ReactionTypeCustomEmoji`\n - :class:`aiogram.types.reaction_type_paid.ReactionTypePaid`",
"annotations": [],
"category": "types"
},
@@ -6153,8 +7975,8 @@
{
"type": "String",
"description": "Reaction emoji. Currently, it can be one of \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\"",
- "html_description": "Reaction emoji. Currently, it can be one of \"![\"👍\"/](\"//telegram.org/img/emoji/40/F09F918D.png\") \", \"![\"👎\"/](\"//telegram.org/img/emoji/40/F09F918E.png\") \", \"![\"❤\"/](\"//telegram.org/img/emoji/40/E29DA4.png\") \", \"![\"🔥\"/](\"//telegram.org/img/emoji/40/F09F94A5.png\") \", \"![\"🥰\"/](\"//telegram.org/img/emoji/40/F09FA5B0.png\") \", \"![\"👏\"/](\"//telegram.org/img/emoji/40/F09F918F.png\") \", \"![\"😁\"/](\"//telegram.org/img/emoji/40/F09F9881.png\") \", \"![\"🤔\"/](\"//telegram.org/img/emoji/40/F09FA494.png\") \", \"![\"🤯\"/](\"//telegram.org/img/emoji/40/F09FA4AF.png\") \", \"![\"😱\"/](\"//telegram.org/img/emoji/40/F09F98B1.png\") \", \"![\"🤬\"/](\"//telegram.org/img/emoji/40/F09FA4AC.png\") \", \"![\"😢\"/](\"//telegram.org/img/emoji/40/F09F98A2.png\") \", \"![\"🎉\"/](\"//telegram.org/img/emoji/40/F09F8E89.png\") \", \"![\"🤩\"/](\"//telegram.org/img/emoji/40/F09FA4A9.png\") \", \"![\"🤮\"/](\"//telegram.org/img/emoji/40/F09FA4AE.png\") \", \"![\"💩\"/](\"//telegram.org/img/emoji/40/F09F92A9.png\") \", \"![\"🙏\"/](\"//telegram.org/img/emoji/40/F09F998F.png\") \", \"![\"👌\"/](\"//telegram.org/img/emoji/40/F09F918C.png\") \", \"![\"🕊\"/](\"//telegram.org/img/emoji/40/F09F958A.png\") \", \"![\"🤡\"/](\"//telegram.org/img/emoji/40/F09FA4A1.png\") \", \"![\"🥱\"/](\"//telegram.org/img/emoji/40/F09FA5B1.png\") \", \"![\"🥴\"/](\"//telegram.org/img/emoji/40/F09FA5B4.png\") \", \"![\"😍\"/](\"//telegram.org/img/emoji/40/F09F988D.png\") \", \"![\"🐳\"/](\"//telegram.org/img/emoji/40/F09F90B3.png\") \", \"![\"❤🔥\"/](\"//telegram.org/img/emoji/40/E29DA4E2808DF09F94A5.png\") \", \"![\"🌚\"/](\"//telegram.org/img/emoji/40/F09F8C9A.png\") \", \"![\"🌭\"/](\"//telegram.org/img/emoji/40/F09F8CAD.png\") \", \"![\"💯\"/](\"//telegram.org/img/emoji/40/F09F92AF.png\") \", \"![\"🤣\"/](\"//telegram.org/img/emoji/40/F09FA4A3.png\") \", \"![\"⚡\"/](\"//telegram.org/img/emoji/40/E29AA1.png\") \", \"![\"🍌\"/](\"//telegram.org/img/emoji/40/F09F8D8C.png\") \", \"![\"🏆\"/](\"//telegram.org/img/emoji/40/F09F8F86.png\") \", \"![\"💔\"/](\"//telegram.org/img/emoji/40/F09F9294.png\") \", \"![\"🤨\"/](\"//telegram.org/img/emoji/40/F09FA4A8.png\") \", \"![\"😐\"/](\"//telegram.org/img/emoji/40/F09F9890.png\") \", \"![\"🍓\"/](\"//telegram.org/img/emoji/40/F09F8D93.png\") \", \"![\"🍾\"/](\"//telegram.org/img/emoji/40/F09F8DBE.png\") \", \"![\"💋\"/](\"//telegram.org/img/emoji/40/F09F928B.png\") \", \"![\"🖕\"/](\"//telegram.org/img/emoji/40/F09F9695.png\") \", \"![\"😈\"/](\"//telegram.org/img/emoji/40/F09F9888.png\") \", \"![\"😴\"/](\"//telegram.org/img/emoji/40/F09F98B4.png\") \", \"![\"😭\"/](\"//telegram.org/img/emoji/40/F09F98AD.png\") \", \"![\"🤓\"/](\"//telegram.org/img/emoji/40/F09FA493.png\") \", \"![\"👻\"/](\"//telegram.org/img/emoji/40/F09F91BB.png\") \", \"![\"👨💻\"/](\"//telegram.org/img/emoji/40/F09F91A8E2808DF09F92BB.png\") \", \"![\"👀\"/](\"//telegram.org/img/emoji/40/F09F9180.png\") \", \"![\"🎃\"/](\"//telegram.org/img/emoji/40/F09F8E83.png\") \", \"![\"🙈\"/](\"//telegram.org/img/emoji/40/F09F9988.png\") \", \"![\"😇\"/](\"//telegram.org/img/emoji/40/F09F9887.png\") \", \"![\"😨\"/](\"//telegram.org/img/emoji/40/F09F98A8.png\") \", \"![\"🤝\"/](\"//telegram.org/img/emoji/40/F09FA49D.png\") \", \"![\"✍\"/](\"//telegram.org/img/emoji/40/E29C8D.png\") \", \"![\"🤗\"/](\"//telegram.org/img/emoji/40/F09FA497.png\") \", \"![\"🫡\"/](\"//telegram.org/img/emoji/40/F09FABA1.png\") \", \"![\"🎅\"/](\"//telegram.org/img/emoji/40/F09F8E85.png\") \", \"![\"🎄\"/](\"//telegram.org/img/emoji/40/F09F8E84.png\") \", \"![\"☃\"/](\"//telegram.org/img/emoji/40/E29883.png\") \", \"![\"💅\"/](\"//telegram.org/img/emoji/40/F09F9285.png\") \", \"![\"🤪\"/](\"//telegram.org/img/emoji/40/F09FA4AA.png\") \", \"![\"🗿\"/](\"//telegram.org/img/emoji/40/F09F97BF.png\") \", \"![\"🆒\"/](\"//telegram.org/img/emoji/40/F09F8692.png\") \", \"![\"💘\"/](\"//telegram.org/img/emoji/40/F09F9298.png\") \", \"![\"🙉\"/](\"//telegram.org/img/emoji/40/F09F9989.png\") \", \"![\"🦄\"/](\"//telegram.org/img/emoji/40/F09FA684.png\") \", \"![\"😘\"/](\"//telegram.org/img/emoji/40/F09F9898.png\") \", \"![\"💊\"/](\"//telegram.org/img/emoji/40/F09F928A.png\") \", \"![\"🙊\"/](\"//telegram.org/img/emoji/40/F09F998A.png\") \", \"![\"😎\"/](\"//telegram.org/img/emoji/40/F09F988E.png\") \", \"![\"👾\"/](\"//telegram.org/img/emoji/40/F09F91BE.png\") \", \"![\"🤷♂\"/](\"//telegram.org/img/emoji/40/F09FA4B7E2808DE29982.png\") \", \"![\"🤷\"/](\"//telegram.org/img/emoji/40/F09FA4B7.png\") \", \"![\"🤷♀\"/](\"//telegram.org/img/emoji/40/F09FA4B7E2808DE29980.png\") \", \"![\"😡\"/](\"//telegram.org/img/emoji/40/F09F98A1.png\") \" | ",
- "rst_description": "Reaction emoji. Currently, it can be one of \"👍\", \"👎\", \"❤\", \"🔥\", \"🥰\", \"👏\", \"😁\", \"🤔\", \"🤯\", \"😱\", \"🤬\", \"😢\", \"🎉\", \"🤩\", \"🤮\", \"💩\", \"🙏\", \"👌\", \"🕊\", \"🤡\", \"🥱\", \"🥴\", \"😍\", \"🐳\", \"❤🔥\", \"🌚\", \"🌭\", \"💯\", \"🤣\", \"⚡\", \"🍌\", \"🏆\", \"💔\", \"🤨\", \"😐\", \"🍓\", \"🍾\", \"💋\", \"🖕\", \"😈\", \"😴\", \"😭\", \"🤓\", \"👻\", \"👨💻\", \"👀\", \"🎃\", \"🙈\", \"😇\", \"😨\", \"🤝\", \"✍\", \"🤗\", \"🫡\", \"🎅\", \"🎄\", \"☃\", \"💅\", \"🤪\", \"🗿\", \"🆒\", \"💘\", \"🙉\", \"🦄\", \"😘\", \"💊\", \"🙊\", \"😎\", \"👾\", \"🤷♂\", \"🤷\", \"🤷♀\", \"😡\"\n",
+ "html_description": "Reaction emoji. Currently, it can be one of \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\", \"\" | ",
+ "rst_description": "Reaction emoji. Currently, it can be one of \"❤\", \"👍\", \"👎\", \"🔥\", \"🥰\", \"👏\", \"😁\", \"🤔\", \"🤯\", \"😱\", \"🤬\", \"😢\", \"🎉\", \"🤩\", \"🤮\", \"💩\", \"🙏\", \"👌\", \"🕊\", \"🤡\", \"🥱\", \"🥴\", \"😍\", \"🐳\", \"❤🔥\", \"🌚\", \"🌭\", \"💯\", \"🤣\", \"⚡\", \"🍌\", \"🏆\", \"💔\", \"🤨\", \"😐\", \"🍓\", \"🍾\", \"💋\", \"🖕\", \"😈\", \"😴\", \"😭\", \"🤓\", \"👻\", \"👨💻\", \"👀\", \"🎃\", \"🙈\", \"😇\", \"😨\", \"🤝\", \"✍\", \"🤗\", \"🫡\", \"🎅\", \"🎄\", \"☃\", \"💅\", \"🤪\", \"🗿\", \"🆒\", \"💘\", \"🙉\", \"🦄\", \"😘\", \"💊\", \"🙊\", \"😎\", \"👾\", \"🤷♂\", \"🤷\", \"🤷♀\", \"😡\"\n",
"name": "emoji",
"required": true
}
@@ -6187,6 +8009,24 @@
],
"category": "types"
},
+ {
+ "anchor": "reactiontypepaid",
+ "name": "ReactionTypePaid",
+ "description": "The reaction is paid.",
+ "html_description": "The reaction is paid.
",
+ "rst_description": "The reaction is paid.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Type of the reaction, always 'paid'",
+ "html_description": "Type of the reaction, always “paid” | ",
+ "rst_description": "Type of the reaction, always 'paid'\n",
+ "name": "type",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
{
"anchor": "reactioncount",
"name": "ReactionCount",
@@ -6359,6 +8199,983 @@
"rst_description": "*Optional*. Unique identifier of the custom emoji shown as the topic icon\n",
"name": "icon_custom_emoji_id",
"required": false
+ },
+ {
+ "type": "True",
+ "description": "True, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed by the bot",
+ "html_description": "Optional. True, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed by the bot | ",
+ "rst_description": "*Optional*. :code:`True`, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed by the bot\n",
+ "name": "is_name_implicit",
+ "required": false
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "giftbackground",
+ "name": "GiftBackground",
+ "description": "This object describes the background of a gift.",
+ "html_description": "This object describes the background of a gift.
",
+ "rst_description": "This object describes the background of a gift.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "description": "Center color of the background in RGB format",
+ "html_description": "Center color of the background in RGB format | ",
+ "rst_description": "Center color of the background in RGB format\n",
+ "name": "center_color",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "Edge color of the background in RGB format",
+ "html_description": "Edge color of the background in RGB format | ",
+ "rst_description": "Edge color of the background in RGB format\n",
+ "name": "edge_color",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "Text color of the background in RGB format",
+ "html_description": "Text color of the background in RGB format | ",
+ "rst_description": "Text color of the background in RGB format\n",
+ "name": "text_color",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "gift",
+ "name": "Gift",
+ "description": "This object represents a gift that can be sent by the bot.",
+ "html_description": "This object represents a gift that can be sent by the bot.
",
+ "rst_description": "This object represents a gift that can be sent by the bot.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Unique identifier of the gift",
+ "html_description": "Unique identifier of the gift | ",
+ "rst_description": "Unique identifier of the gift\n",
+ "name": "id",
+ "required": true
+ },
+ {
+ "type": "Sticker",
+ "description": "The sticker that represents the gift",
+ "html_description": "The sticker that represents the gift | ",
+ "rst_description": "The sticker that represents the gift\n",
+ "name": "sticker",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "The number of Telegram Stars that must be paid to send the sticker",
+ "html_description": "The number of Telegram Stars that must be paid to send the sticker | ",
+ "rst_description": "The number of Telegram Stars that must be paid to send the sticker\n",
+ "name": "star_count",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "The number of Telegram Stars that must be paid to upgrade the gift to a unique one",
+ "html_description": "Optional. The number of Telegram Stars that must be paid to upgrade the gift to a unique one | ",
+ "rst_description": "*Optional*. The number of Telegram Stars that must be paid to upgrade the gift to a unique one\n",
+ "name": "upgrade_star_count",
+ "required": false
+ },
+ {
+ "type": "True",
+ "description": "True, if the gift can only be purchased by Telegram Premium subscribers",
+ "html_description": "Optional. True, if the gift can only be purchased by Telegram Premium subscribers | ",
+ "rst_description": "*Optional*. :code:`True`, if the gift can only be purchased by Telegram Premium subscribers\n",
+ "name": "is_premium",
+ "required": false
+ },
+ {
+ "type": "True",
+ "description": "True, if the gift can be used (after being upgraded) to customize a user's appearance",
+ "html_description": "Optional. True, if the gift can be used (after being upgraded) to customize a user's appearance | ",
+ "rst_description": "*Optional*. :code:`True`, if the gift can be used (after being upgraded) to customize a user's appearance\n",
+ "name": "has_colors",
+ "required": false
+ },
+ {
+ "type": "Integer",
+ "description": "The total number of gifts of this type that can be sent by all users; for limited gifts only",
+ "html_description": "Optional. The total number of gifts of this type that can be sent by all users; for limited gifts only | ",
+ "rst_description": "*Optional*. The total number of gifts of this type that can be sent by all users; for limited gifts only\n",
+ "name": "total_count",
+ "required": false
+ },
+ {
+ "type": "Integer",
+ "description": "The number of remaining gifts of this type that can be sent by all users; for limited gifts only",
+ "html_description": "Optional. The number of remaining gifts of this type that can be sent by all users; for limited gifts only | ",
+ "rst_description": "*Optional*. The number of remaining gifts of this type that can be sent by all users; for limited gifts only\n",
+ "name": "remaining_count",
+ "required": false
+ },
+ {
+ "type": "Integer",
+ "description": "The total number of gifts of this type that can be sent by the bot; for limited gifts only",
+ "html_description": "Optional. The total number of gifts of this type that can be sent by the bot; for limited gifts only | ",
+ "rst_description": "*Optional*. The total number of gifts of this type that can be sent by the bot; for limited gifts only\n",
+ "name": "personal_total_count",
+ "required": false
+ },
+ {
+ "type": "Integer",
+ "description": "The number of remaining gifts of this type that can be sent by the bot; for limited gifts only",
+ "html_description": "Optional. The number of remaining gifts of this type that can be sent by the bot; for limited gifts only | ",
+ "rst_description": "*Optional*. The number of remaining gifts of this type that can be sent by the bot; for limited gifts only\n",
+ "name": "personal_remaining_count",
+ "required": false
+ },
+ {
+ "type": "GiftBackground",
+ "description": "Background of the gift",
+ "html_description": "Optional. Background of the gift | ",
+ "rst_description": "*Optional*. Background of the gift\n",
+ "name": "background",
+ "required": false
+ },
+ {
+ "type": "Integer",
+ "description": "The total number of different unique gifts that can be obtained by upgrading the gift",
+ "html_description": "Optional. The total number of different unique gifts that can be obtained by upgrading the gift | ",
+ "rst_description": "*Optional*. The total number of different unique gifts that can be obtained by upgrading the gift\n",
+ "name": "unique_gift_variant_count",
+ "required": false
+ },
+ {
+ "type": "Chat",
+ "description": "Information about the chat that published the gift",
+ "html_description": "Optional. Information about the chat that published the gift | ",
+ "rst_description": "*Optional*. Information about the chat that published the gift\n",
+ "name": "publisher_chat",
+ "required": false
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "gifts",
+ "name": "Gifts",
+ "description": "This object represent a list of gifts.",
+ "html_description": "This object represent a list of gifts.
",
+ "rst_description": "This object represent a list of gifts.",
+ "annotations": [
+ {
+ "type": "Array of Gift",
+ "description": "The list of gifts",
+ "html_description": "The list of gifts | ",
+ "rst_description": "The list of gifts\n",
+ "name": "gifts",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "uniquegiftmodel",
+ "name": "UniqueGiftModel",
+ "description": "This object describes the model of a unique gift.",
+ "html_description": "This object describes the model of a unique gift.
",
+ "rst_description": "This object describes the model of a unique gift.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Name of the model",
+ "html_description": "Name of the model | ",
+ "rst_description": "Name of the model\n",
+ "name": "name",
+ "required": true
+ },
+ {
+ "type": "Sticker",
+ "description": "The sticker that represents the unique gift",
+ "html_description": "The sticker that represents the unique gift | ",
+ "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 gift upgrades. Always 0 for crafted gifts.",
+ "html_description": "The number of unique gifts that receive this model for every 1000 gift upgrades. Always 0 for crafted gifts. | ",
+ "rst_description": "The number of unique gifts that receive this model for every 1000 gift upgrades. Always 0 for crafted gifts.\n",
+ "name": "rarity_per_mille",
+ "required": true
+ },
+ {
+ "type": "String",
+ "description": "Rarity of the model if it is a crafted model. Currently, can be 'uncommon', 'rare', 'epic', or 'legendary'.",
+ "html_description": "Optional. Rarity of the model if it is a crafted model. Currently, can be “uncommon”, “rare”, “epic”, or “legendary”. | ",
+ "rst_description": "*Optional*. Rarity of the model if it is a crafted model. Currently, can be 'uncommon', 'rare', 'epic', or 'legendary'.\n",
+ "name": "rarity",
+ "required": false
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "uniquegiftsymbol",
+ "name": "UniqueGiftSymbol",
+ "description": "This object describes the symbol shown on the pattern of a unique gift.",
+ "html_description": "This object describes the symbol shown on the pattern of a unique gift.
",
+ "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": "Name of the symbol | ",
+ "rst_description": "Name of the symbol\n",
+ "name": "name",
+ "required": true
+ },
+ {
+ "type": "Sticker",
+ "description": "The sticker that represents the unique gift",
+ "html_description": "The sticker that represents the unique gift | ",
+ "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": "The number of unique gifts that receive this model for every 1000 gifts upgraded | ",
+ "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"
+ },
+ {
+ "anchor": "uniquegiftbackdropcolors",
+ "name": "UniqueGiftBackdropColors",
+ "description": "This object describes the colors of the backdrop of a unique gift.",
+ "html_description": "This object describes the colors of the backdrop of a unique gift.
",
+ "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": "The color in the center of the backdrop in RGB format | ",
+ "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": "The color on the edges of the backdrop in RGB format | ",
+ "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": "The color to be applied to the symbol in RGB format | ",
+ "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": "The color for the text on the backdrop in RGB format | ",
+ "rst_description": "The color for the text on the backdrop in RGB format\n",
+ "name": "text_color",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "uniquegiftbackdrop",
+ "name": "UniqueGiftBackdrop",
+ "description": "This object describes the backdrop of a unique gift.",
+ "html_description": "This object describes the backdrop of a unique gift.
",
+ "rst_description": "This object describes the backdrop of a unique gift.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Name of the backdrop",
+ "html_description": "Name of the backdrop | ",
+ "rst_description": "Name of the backdrop\n",
+ "name": "name",
+ "required": true
+ },
+ {
+ "type": "UniqueGiftBackdropColors",
+ "description": "Colors of the backdrop",
+ "html_description": "Colors of the backdrop | ",
+ "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": "The number of unique gifts that receive this backdrop for every 1000 gifts upgraded | ",
+ "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"
+ },
+ {
+ "anchor": "uniquegiftcolors",
+ "name": "UniqueGiftColors",
+ "description": "This object contains information about the color scheme for a user's name, message replies and link previews based on a unique gift.",
+ "html_description": "This object contains information about the color scheme for a user's name, message replies and link previews based on a unique gift.
",
+ "rst_description": "This object contains information about the color scheme for a user's name, message replies and link previews based on a unique gift.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Custom emoji identifier of the unique gift's model",
+ "html_description": "Custom emoji identifier of the unique gift's model | ",
+ "rst_description": "Custom emoji identifier of the unique gift's model\n",
+ "name": "model_custom_emoji_id",
+ "required": true
+ },
+ {
+ "type": "String",
+ "description": "Custom emoji identifier of the unique gift's symbol",
+ "html_description": "Custom emoji identifier of the unique gift's symbol | ",
+ "rst_description": "Custom emoji identifier of the unique gift's symbol\n",
+ "name": "symbol_custom_emoji_id",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "Main color used in light themes; RGB format",
+ "html_description": "Main color used in light themes; RGB format | ",
+ "rst_description": "Main color used in light themes; RGB format\n",
+ "name": "light_theme_main_color",
+ "required": true
+ },
+ {
+ "type": "Array of Integer",
+ "description": "List of 1-3 additional colors used in light themes; RGB format",
+ "html_description": "List of 1-3 additional colors used in light themes; RGB format | ",
+ "rst_description": "List of 1-3 additional colors used in light themes; RGB format\n",
+ "name": "light_theme_other_colors",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "Main color used in dark themes; RGB format",
+ "html_description": "Main color used in dark themes; RGB format | ",
+ "rst_description": "Main color used in dark themes; RGB format\n",
+ "name": "dark_theme_main_color",
+ "required": true
+ },
+ {
+ "type": "Array of Integer",
+ "description": "List of 1-3 additional colors used in dark themes; RGB format",
+ "html_description": "List of 1-3 additional colors used in dark themes; RGB format | ",
+ "rst_description": "List of 1-3 additional colors used in dark themes; RGB format\n",
+ "name": "dark_theme_other_colors",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "uniquegift",
+ "name": "UniqueGift",
+ "description": "This object describes a unique gift that was upgraded from a regular gift.",
+ "html_description": "This object describes a unique gift that was upgraded from a regular gift.
",
+ "rst_description": "This object describes a unique gift that was upgraded from a regular gift.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Identifier of the regular gift from which the gift was upgraded",
+ "html_description": "Identifier of the regular gift from which the gift was upgraded | ",
+ "rst_description": "Identifier of the regular gift from which the gift was upgraded\n",
+ "name": "gift_id",
+ "required": true
+ },
+ {
+ "type": "String",
+ "description": "Human-readable name of the regular gift from which this unique gift was upgraded",
+ "html_description": "Human-readable name of the regular gift from which this unique gift was upgraded | ",
+ "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": "Unique name of the gift. This name can be used in https://t.me/nft/... links and story areas | ",
+ "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": "Unique number of the upgraded gift among gifts upgraded from the same regular gift | ",
+ "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": "Model of the gift | ",
+ "rst_description": "Model of the gift\n",
+ "name": "model",
+ "required": true
+ },
+ {
+ "type": "UniqueGiftSymbol",
+ "description": "Symbol of the gift",
+ "html_description": "Symbol of the gift | ",
+ "rst_description": "Symbol of the gift\n",
+ "name": "symbol",
+ "required": true
+ },
+ {
+ "type": "UniqueGiftBackdrop",
+ "description": "Backdrop of the gift",
+ "html_description": "Backdrop of the gift | ",
+ "rst_description": "Backdrop of the gift\n",
+ "name": "backdrop",
+ "required": true
+ },
+ {
+ "type": "True",
+ "description": "True, if the original regular gift was exclusively purchaseable by Telegram Premium subscribers",
+ "html_description": "Optional. True, if the original regular gift was exclusively purchaseable by Telegram Premium subscribers | ",
+ "rst_description": "*Optional*. :code:`True`, if the original regular gift was exclusively purchaseable by Telegram Premium subscribers\n",
+ "name": "is_premium",
+ "required": false
+ },
+ {
+ "type": "True",
+ "description": "True, if the gift was used to craft another gift and isn't available anymore",
+ "html_description": "Optional. True, if the gift was used to craft another gift and isn't available anymore | ",
+ "rst_description": "*Optional*. :code:`True`, if the gift was used to craft another gift and isn't available anymore\n",
+ "name": "is_burned",
+ "required": false
+ },
+ {
+ "type": "True",
+ "description": "True, if the gift is assigned from the TON blockchain and can't be resold or transferred in Telegram",
+ "html_description": "Optional. True, if the gift is assigned from the TON blockchain and can't be resold or transferred in Telegram | ",
+ "rst_description": "*Optional*. :code:`True`, if the gift is assigned from the TON blockchain and can't be resold or transferred in Telegram\n",
+ "name": "is_from_blockchain",
+ "required": false
+ },
+ {
+ "type": "UniqueGiftColors",
+ "description": "The color scheme that can be used by the gift's owner for the chat's name, replies to messages and link previews; for business account gifts and gifts that are currently on sale only",
+ "html_description": "Optional. The color scheme that can be used by the gift's owner for the chat's name, replies to messages and link previews; for business account gifts and gifts that are currently on sale only | ",
+ "rst_description": "*Optional*. The color scheme that can be used by the gift's owner for the chat's name, replies to messages and link previews; for business account gifts and gifts that are currently on sale only\n",
+ "name": "colors",
+ "required": false
+ },
+ {
+ "type": "Chat",
+ "description": "Information about the chat that published the gift",
+ "html_description": "Optional. Information about the chat that published the gift | ",
+ "rst_description": "*Optional*. Information about the chat that published the gift\n",
+ "name": "publisher_chat",
+ "required": false
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "giftinfo",
+ "name": "GiftInfo",
+ "description": "Describes a service message about a regular gift that was sent or received.",
+ "html_description": "Describes a service message about a regular gift that was sent or received.
",
+ "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": "Information about the gift | ",
+ "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": "Optional. Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts | ",
+ "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": "Optional. Number of Telegram Stars that can be claimed by the receiver by converting the gift; omitted if conversion to Telegram Stars is impossible | ",
+ "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 for the ability to upgrade the gift",
+ "html_description": "Optional. Number of Telegram Stars that were prepaid for the ability to upgrade the gift | ",
+ "rst_description": "*Optional*. Number of Telegram Stars that were prepaid for the ability to upgrade the gift\n",
+ "name": "prepaid_upgrade_star_count",
+ "required": false
+ },
+ {
+ "type": "True",
+ "description": "True, if the gift's upgrade was purchased after the gift was sent",
+ "html_description": "Optional. True, if the gift's upgrade was purchased after the gift was sent | ",
+ "rst_description": "*Optional*. :code:`True`, if the gift's upgrade was purchased after the gift was sent\n",
+ "name": "is_upgrade_separate",
+ "required": false
+ },
+ {
+ "type": "True",
+ "description": "True, if the gift can be upgraded to a unique gift",
+ "html_description": "Optional. True, if the gift can be upgraded to a unique gift | ",
+ "rst_description": "*Optional*. :code:`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": "Optional. Text of the message that was added to the gift | ",
+ "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": "Optional. Special entities that appear in the text | ",
+ "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": "Optional. True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them | ",
+ "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": "Integer",
+ "description": "Unique number reserved for this gift when upgraded. See the number field in UniqueGift",
+ "html_description": "Optional. Unique number reserved for this gift when upgraded. See the number field in UniqueGift | ",
+ "rst_description": "*Optional*. Unique number reserved for this gift when upgraded. See the *number* field in :class:`aiogram.types.unique_gift.UniqueGift`\n",
+ "name": "unique_gift_number",
+ "required": false
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "uniquegiftinfo",
+ "name": "UniqueGiftInfo",
+ "description": "Describes a service message about a unique gift that was sent or received.",
+ "html_description": "Describes a service message about a unique gift that was sent or received.
",
+ "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": "Information about the gift | ",
+ "rst_description": "Information about the gift\n",
+ "name": "gift",
+ "required": true
+ },
+ {
+ "type": "String",
+ "description": "Origin of the gift. Currently, either 'upgrade' for gifts upgraded from regular gifts, 'transfer' for gifts transferred from other users or channels, 'resale' for gifts bought from other users, 'gifted_upgrade' for upgrades purchased after the gift was sent, or 'offer' for gifts bought or sold through gift purchase offers",
+ "html_description": "Origin of the gift. Currently, either “upgrade” for gifts upgraded from regular gifts, “transfer” for gifts transferred from other users or channels, “resale” for gifts bought from other users, “gifted_upgrade” for upgrades purchased after the gift was sent, or “offer” for gifts bought or sold through gift purchase offers | ",
+ "rst_description": "Origin of the gift. Currently, either 'upgrade' for gifts upgraded from regular gifts, 'transfer' for gifts transferred from other users or channels, 'resale' for gifts bought from other users, 'gifted_upgrade' for upgrades purchased after the gift was sent, or 'offer' for gifts bought or sold through gift purchase offers\n",
+ "name": "origin",
+ "required": true
+ },
+ {
+ "type": "String",
+ "description": "For gifts bought from other users, the currency in which the payment for the gift was done. Currently, one of 'XTR' for Telegram Stars or 'TON' for toncoins.",
+ "html_description": "Optional. For gifts bought from other users, the currency in which the payment for the gift was done. Currently, one of “XTR” for Telegram Stars or “TON” for toncoins. | ",
+ "rst_description": "*Optional*. For gifts bought from other users, the currency in which the payment for the gift was done. Currently, one of 'XTR' for Telegram Stars or 'TON' for toncoins.\n",
+ "name": "last_resale_currency",
+ "required": false
+ },
+ {
+ "type": "Integer",
+ "description": "For gifts bought from other users, the price paid for the gift in either Telegram Stars or nanotoncoins",
+ "html_description": "Optional. For gifts bought from other users, the price paid for the gift in either Telegram Stars or nanotoncoins | ",
+ "rst_description": "*Optional*. For gifts bought from other users, the price paid for the gift in either Telegram Stars or nanotoncoins\n",
+ "name": "last_resale_amount",
+ "required": false
+ },
+ {
+ "type": "String",
+ "description": "Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts",
+ "html_description": "Optional. Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts | ",
+ "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": "Optional. Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer the gift | ",
+ "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": "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 | ",
+ "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"
+ },
+ {
+ "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": "This object describes a gift received and owned by a user or a chat. Currently, it can be one of
",
+ "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"
+ },
+ {
+ "anchor": "ownedgiftregular",
+ "name": "OwnedGiftRegular",
+ "description": "Describes a regular gift owned by a user or a chat.",
+ "html_description": "Describes a regular gift owned by a user or a chat.
",
+ "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": "Type of the gift, always “regular” | ",
+ "rst_description": "Type of the gift, always 'regular'\n",
+ "name": "type",
+ "required": true
+ },
+ {
+ "type": "Gift",
+ "description": "Information about the regular gift",
+ "html_description": "Information about the regular gift | ",
+ "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": "Optional. Unique identifier of the gift for the bot; for gifts received on behalf of business accounts only | ",
+ "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": "Optional. Sender of the gift if it is a known user | ",
+ "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": "Date the gift was sent in Unix time | ",
+ "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": "Optional. Text of the message that was added to the gift | ",
+ "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": "Optional. Special entities that appear in the text | ",
+ "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": "Optional. True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them | ",
+ "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": "Optional. True, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only | ",
+ "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": "Optional. True, if the gift can be upgraded to a unique gift; for gifts received on behalf of business accounts only | ",
+ "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": "Optional. True, if the gift was refunded and isn't available anymore | ",
+ "rst_description": "*Optional*. :code:`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; for gifts received on behalf of business accounts only",
+ "html_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; for gifts received on behalf of business accounts only | ",
+ "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; for gifts received on behalf of business accounts only\n",
+ "name": "convert_star_count",
+ "required": false
+ },
+ {
+ "type": "Integer",
+ "description": "Number of Telegram Stars that were paid for the ability to upgrade the gift",
+ "html_description": "Optional. Number of Telegram Stars that were paid for the ability to upgrade the gift | ",
+ "rst_description": "*Optional*. Number of Telegram Stars that were paid for the ability to upgrade the gift\n",
+ "name": "prepaid_upgrade_star_count",
+ "required": false
+ },
+ {
+ "type": "True",
+ "description": "True, if the gift's upgrade was purchased after the gift was sent; for gifts received on behalf of business accounts only",
+ "html_description": "Optional. True, if the gift's upgrade was purchased after the gift was sent; for gifts received on behalf of business accounts only | ",
+ "rst_description": "*Optional*. :code:`True`, if the gift's upgrade was purchased after the gift was sent; for gifts received on behalf of business accounts only\n",
+ "name": "is_upgrade_separate",
+ "required": false
+ },
+ {
+ "type": "Integer",
+ "description": "Unique number reserved for this gift when upgraded. See the number field in UniqueGift",
+ "html_description": "Optional. Unique number reserved for this gift when upgraded. See the number field in UniqueGift | ",
+ "rst_description": "*Optional*. Unique number reserved for this gift when upgraded. See the *number* field in :class:`aiogram.types.unique_gift.UniqueGift`\n",
+ "name": "unique_gift_number",
+ "required": false
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "ownedgiftunique",
+ "name": "OwnedGiftUnique",
+ "description": "Describes a unique gift received and owned by a user or a chat.",
+ "html_description": "Describes a unique gift received and owned by a user or a chat.
",
+ "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": "Type of the gift, always “unique” | ",
+ "rst_description": "Type of the gift, always 'unique'\n",
+ "name": "type",
+ "required": true
+ },
+ {
+ "type": "UniqueGift",
+ "description": "Information about the unique gift",
+ "html_description": "Information about the unique gift | ",
+ "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": "Optional. Unique identifier of the received gift for the bot; for gifts received on behalf of business accounts only | ",
+ "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": "Optional. Sender of the gift if it is a known user | ",
+ "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": "Date the gift was sent in Unix time | ",
+ "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": "Optional. True, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only | ",
+ "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": "Optional. True, if the gift can be transferred to another owner; for gifts received on behalf of business accounts only | ",
+ "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
+ },
+ {
+ "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": "Optional. Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer the gift | ",
+ "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": "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 | ",
+ "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"
+ },
+ {
+ "anchor": "ownedgifts",
+ "name": "OwnedGifts",
+ "description": "Contains the list of gifts received and owned by a user or a chat.",
+ "html_description": "Contains the list of gifts received and owned by a user or a chat.
",
+ "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": "The total number of gifts owned by the user or the chat | ",
+ "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": "The list of gifts | ",
+ "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": "Optional. Offset for the next request. If empty, then there are no more results | ",
+ "rst_description": "*Optional*. Offset for the next request. If empty, then there are no more results\n",
+ "name": "next_offset",
+ "required": false
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "acceptedgifttypes",
+ "name": "AcceptedGiftTypes",
+ "description": "This object describes the types of gifts that can be gifted to a user or a chat.",
+ "html_description": "This object describes the types of gifts that can be gifted to a user or a chat.
",
+ "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": "True, if unlimited regular gifts are accepted | ",
+ "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": "True, if limited regular gifts are accepted | ",
+ "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": "True, if unique gifts or gifts that can be upgraded to unique for free are accepted | ",
+ "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": "True, if a Telegram Premium subscription is accepted | ",
+ "rst_description": ":code:`True`, if a Telegram Premium subscription is accepted\n",
+ "name": "premium_subscription",
+ "required": true
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if transfers of unique gifts from channels are accepted",
+ "html_description": "True, if transfers of unique gifts from channels are accepted | ",
+ "rst_description": ":code:`True`, if transfers of unique gifts from channels are accepted\n",
+ "name": "gifts_from_channels",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "staramount",
+ "name": "StarAmount",
+ "description": "Describes an amount of Telegram Stars.",
+ "html_description": "Describes an amount of Telegram Stars.
",
+ "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": "Integer amount of Telegram Stars, rounded to 0; can be negative | ",
+ "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": "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 | ",
+ "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"
@@ -6487,9 +9304,9 @@
},
{
"type": "Integer or String",
- "description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
- "html_description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) | ",
- "rst_description": "Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
+ "description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername). Channel direct messages chats and channel chats aren't supported.",
+ "html_description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername). Channel direct messages chats and channel chats aren't supported. | ",
+ "rst_description": "Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`). Channel direct messages chats and channel chats aren't supported.\n",
"name": "chat_id",
"required": true
}
@@ -6513,9 +9330,9 @@
},
{
"type": "Integer or String",
- "description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
- "html_description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) | ",
- "rst_description": "Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
+ "description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername). Channel direct messages chats and channel chats aren't supported.",
+ "html_description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername). Channel direct messages chats and channel chats aren't supported. | ",
+ "rst_description": "Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`). Channel direct messages chats and channel chats aren't supported.\n",
"name": "chat_id",
"required": true
}
@@ -6539,9 +9356,9 @@
},
{
"type": "Integer or String",
- "description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
- "html_description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) | ",
- "rst_description": "Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
+ "description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername). Channel direct messages chats and channel chats aren't supported.",
+ "html_description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername). Channel direct messages chats and channel chats aren't supported. | ",
+ "rst_description": "Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`). Channel direct messages chats and channel chats aren't supported.\n",
"name": "chat_id",
"required": true
},
@@ -6753,9 +9570,9 @@
{
"anchor": "chatboostsourcegiveaway",
"name": "ChatBoostSourceGiveaway",
- "description": "The boost was obtained by the creation of a Telegram Premium giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription.",
- "html_description": "The boost was obtained by the creation of a Telegram Premium giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription.
",
- "rst_description": "The boost was obtained by the creation of a Telegram Premium giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription.",
+ "description": "The boost was obtained by the creation of a Telegram Premium or a Telegram Star giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription for Telegram Premium giveaways and prize_star_count / 500 times for one year for Telegram Star giveaways.",
+ "html_description": "The boost was obtained by the creation of a Telegram Premium or a Telegram Star giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription for Telegram Premium giveaways and prize_star_count / 500 times for one year for Telegram Star giveaways.
",
+ "rst_description": "The boost was obtained by the creation of a Telegram Premium or a Telegram Star giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription for Telegram Premium giveaways and *prize_star_count* / 500 times for one year for Telegram Star giveaways.",
"annotations": [
{
"type": "String",
@@ -6775,17 +9592,25 @@
},
{
"type": "User",
- "description": "User that won the prize in the giveaway if any",
- "html_description": "Optional. User that won the prize in the giveaway if any | ",
- "rst_description": "*Optional*. User that won the prize in the giveaway if any\n",
+ "description": "User that won the prize in the giveaway if any; for Telegram Premium giveaways only",
+ "html_description": "Optional. User that won the prize in the giveaway if any; for Telegram Premium giveaways only | ",
+ "rst_description": "*Optional*. User that won the prize in the giveaway if any; for Telegram Premium giveaways only\n",
"name": "user",
"required": false
},
+ {
+ "type": "Integer",
+ "description": "The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only",
+ "html_description": "Optional. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only | ",
+ "rst_description": "*Optional*. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only\n",
+ "name": "prize_star_count",
+ "required": false
+ },
{
"type": "True",
"description": "True, if the giveaway was completed, but there was no user to win the prize",
- "html_description": "Optional. True, if the giveaway was completed, but there was no user to win the prize | ",
- "rst_description": "*Optional*. True, if the giveaway was completed, but there was no user to win the prize\n",
+ "html_description": "Optional. True, if the giveaway was completed, but there was no user to win the prize | ",
+ "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
}
@@ -6902,6 +9727,42 @@
],
"category": "types"
},
+ {
+ "anchor": "chatownerleft",
+ "name": "ChatOwnerLeft",
+ "description": "Describes a service message about the chat owner leaving the chat.",
+ "html_description": "Describes a service message about the chat owner leaving the chat.
",
+ "rst_description": "Describes a service message about the chat owner leaving the chat.",
+ "annotations": [
+ {
+ "type": "User",
+ "description": "The user which will be the new owner of the chat if the previous owner does not return to the chat",
+ "html_description": "Optional. The user which will be the new owner of the chat if the previous owner does not return to the chat | ",
+ "rst_description": "*Optional*. The user which will be the new owner of the chat if the previous owner does not return to the chat\n",
+ "name": "new_owner",
+ "required": false
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "chatownerchanged",
+ "name": "ChatOwnerChanged",
+ "description": "Describes a service message about an ownership change in the chat.",
+ "html_description": "Describes a service message about an ownership change in the chat.
",
+ "rst_description": "Describes a service message about an ownership change in the chat.",
+ "annotations": [
+ {
+ "type": "User",
+ "description": "The new owner of the chat",
+ "html_description": "The new owner of the chat | ",
+ "rst_description": "The new owner of the chat\n",
+ "name": "new_owner",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
{
"anchor": "userchatboosts",
"name": "UserChatBoosts",
@@ -6920,6 +9781,128 @@
],
"category": "types"
},
+ {
+ "anchor": "businessbotrights",
+ "name": "BusinessBotRights",
+ "description": "Represents the rights of a business bot.",
+ "html_description": "Represents the rights of a business bot.
",
+ "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": "Optional. True, if the bot can send and edit messages in the private chats that had incoming messages in the last 24 hours | ",
+ "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": "Optional. True, if the bot can mark incoming private messages as read | ",
+ "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": "Optional. True, if the bot can delete messages sent by the bot | ",
+ "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": "Optional. True, if the bot can delete all private messages in managed chats | ",
+ "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": "Optional. True, if the bot can edit the first and last name of the business account | ",
+ "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": "Optional. True, if the bot can edit the bio of the business account | ",
+ "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": "Optional. True, if the bot can edit the profile photo of the business account | ",
+ "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": "Optional. True, if the bot can edit the username of the business account | ",
+ "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": "Optional. True, if the bot can change the privacy settings pertaining to gifts for the business account | ",
+ "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": "Optional. True, if the bot can view gifts and the amount of Telegram Stars owned by the business account | ",
+ "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": "Optional. True, if the bot can convert regular gifts owned by the business account to Telegram Stars | ",
+ "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": "Optional. True, if the bot can transfer and upgrade gifts owned by the business account | ",
+ "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": "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 | ",
+ "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": "Optional. True, if the bot can post, edit and delete stories on behalf of the business account | ",
+ "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
+ }
+ ],
+ "category": "types"
+ },
{
"anchor": "businessconnection",
"name": "BusinessConnection",
@@ -6960,18 +9943,18 @@
"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": "True, if the bot can act on behalf of the business account in chats that were active in the last 24 hours | ",
- "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": "Optional. Rights of the business bot | ",
+ "rst_description": "*Optional*. Rights of the business bot\n",
+ "name": "rights",
+ "required": false
},
{
"type": "Boolean",
"description": "True, if the connection is active",
- "html_description": "True, if the connection is active | ",
- "rst_description": "True, if the connection is active\n",
+ "html_description": "True, if the connection is active | ",
+ "rst_description": ":code:`True`, if the connection is active\n",
"name": "is_enabled",
"required": true
}
@@ -7012,6 +9995,68 @@
],
"category": "types"
},
+ {
+ "anchor": "sentwebappmessage",
+ "name": "SentWebAppMessage",
+ "description": "Describes an inline message sent by a Web App on behalf of a user.",
+ "html_description": "Describes an inline message sent by a Web App on behalf of a user.
",
+ "rst_description": "Describes an inline message sent by a `Web App `_ on behalf of a user.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message.",
+ "html_description": "Optional. Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message. | ",
+ "rst_description": "*Optional*. Identifier of the sent inline message. Available only if there is an `inline keyboard `_ attached to the message.\n",
+ "name": "inline_message_id",
+ "required": false
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "preparedinlinemessage",
+ "name": "PreparedInlineMessage",
+ "description": "Describes an inline message to be sent by a user of a Mini App.",
+ "html_description": "Describes an inline message to be sent by a user of a Mini App.
",
+ "rst_description": "Describes an inline message to be sent by a user of a Mini App.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Unique identifier of the prepared message",
+ "html_description": "Unique identifier of the prepared message | ",
+ "rst_description": "Unique identifier of the prepared message\n",
+ "name": "id",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "Expiration date of the prepared message, in Unix time. Expired prepared messages can no longer be used",
+ "html_description": "Expiration date of the prepared message, in Unix time. Expired prepared messages can no longer be used | ",
+ "rst_description": "Expiration date of the prepared message, in Unix time. Expired prepared messages can no longer be used\n",
+ "name": "expiration_date",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "preparedkeyboardbutton",
+ "name": "PreparedKeyboardButton",
+ "description": "Describes a keyboard button to be used by a user of a Mini App.",
+ "html_description": "Describes a keyboard button to be used by a user of a Mini App.
",
+ "rst_description": "Describes a keyboard button to be used by a user of a Mini App.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Unique identifier of the keyboard button",
+ "html_description": "Unique identifier of the keyboard button | ",
+ "rst_description": "Unique identifier of the keyboard button\n",
+ "name": "id",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
{
"anchor": "responseparameters",
"name": "ResponseParameters",
@@ -7137,13 +10182,29 @@
"required": true
},
{
- "type": "InputFile or String",
+ "type": "String",
"description": "Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files",
"html_description": "Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | ",
"rst_description": "*Optional*. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . :ref:`More information on Sending Files » `\n",
"name": "thumbnail",
"required": false
},
+ {
+ "type": "String",
+ "description": "Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://' to upload a new one using multipart/form-data under name. More information on Sending Files",
+ "html_description": "Optional. Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files » | ",
+ "rst_description": "*Optional*. Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://' to upload a new one using multipart/form-data under name. :ref:`More information on Sending Files » `\n",
+ "name": "cover",
+ "required": false
+ },
+ {
+ "type": "Integer",
+ "description": "Start timestamp for the video in the message",
+ "html_description": "Optional. Start timestamp for the video in the message | ",
+ "rst_description": "*Optional*. Start timestamp for the video in the message\n",
+ "name": "start_timestamp",
+ "required": false
+ },
{
"type": "String",
"description": "Caption of the video to be sent, 0-1024 characters after entities parsing",
@@ -7243,7 +10304,7 @@
"required": true
},
{
- "type": "InputFile or String",
+ "type": "String",
"description": "Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files",
"html_description": "Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | ",
"rst_description": "*Optional*. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . :ref:`More information on Sending Files » `\n",
@@ -7341,7 +10402,7 @@
"required": true
},
{
- "type": "InputFile or String",
+ "type": "String",
"description": "Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files",
"html_description": "Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | ",
"rst_description": "*Optional*. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . :ref:`More information on Sending Files » `\n",
@@ -7423,7 +10484,7 @@
"required": true
},
{
- "type": "InputFile or String",
+ "type": "String",
"description": "Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files",
"html_description": "Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | ",
"rst_description": "*Optional*. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . :ref:`More information on Sending Files » `\n",
@@ -7533,13 +10594,29 @@
"required": true
},
{
- "type": "InputFile or String",
+ "type": "String",
"description": "Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files",
"html_description": "Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | ",
"rst_description": "*Optional*. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . :ref:`More information on Sending Files » `\n",
"name": "thumbnail",
"required": false
},
+ {
+ "type": "String",
+ "description": "Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://' to upload a new one using multipart/form-data under name. More information on Sending Files",
+ "html_description": "Optional. Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files » | ",
+ "rst_description": "*Optional*. Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://' to upload a new one using multipart/form-data under name. :ref:`More information on Sending Files » `\n",
+ "name": "cover",
+ "required": false
+ },
+ {
+ "type": "Integer",
+ "description": "Start timestamp for the video in the message",
+ "html_description": "Optional. Start timestamp for the video in the message | ",
+ "rst_description": "*Optional*. Start timestamp for the video in the message\n",
+ "name": "start_timestamp",
+ "required": false
+ },
{
"type": "Integer",
"description": "Video width",
@@ -7574,6 +10651,160 @@
}
],
"category": "types"
+ },
+ {
+ "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": "This object describes a profile photo to set. Currently, it can be one of
",
+ "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"
+ },
+ {
+ "anchor": "inputprofilephotostatic",
+ "name": "InputProfilePhotoStatic",
+ "description": "A static profile photo in the .JPG format.",
+ "html_description": "A static profile photo in the .JPG format.
",
+ "rst_description": "A static profile photo in the .JPG format.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Type of the profile photo, must be static",
+ "html_description": "Type of the profile photo, must be static | ",
+ "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://' if the photo was uploaded using multipart/form-data under . More information on Sending Files",
+ "html_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 » | ",
+ "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://' if the photo was uploaded using multipart/form-data under . :ref:`More information on Sending Files » `\n",
+ "name": "photo",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "inputprofilephotoanimated",
+ "name": "InputProfilePhotoAnimated",
+ "description": "An animated profile photo in the MPEG4 format.",
+ "html_description": "An animated profile photo in the MPEG4 format.
",
+ "rst_description": "An animated profile photo in the MPEG4 format.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Type of the profile photo, must be animated",
+ "html_description": "Type of the profile photo, must be animated | ",
+ "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://' if the photo was uploaded using multipart/form-data under . More information on Sending Files",
+ "html_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 » | ",
+ "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://' if the photo was uploaded using multipart/form-data under . :ref:`More information on 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": "Optional. Timestamp in seconds of the frame that will be used as the static profile photo. Defaults to 0.0. | ",
+ "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"
+ },
+ {
+ "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": "This object describes the content of a story to post. Currently, it can be one of
",
+ "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"
+ },
+ {
+ "anchor": "inputstorycontentphoto",
+ "name": "InputStoryContentPhoto",
+ "description": "Describes a photo to post as a story.",
+ "html_description": "Describes a photo to post as a story.
",
+ "rst_description": "Describes a photo to post as a story.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Type of the content, must be photo",
+ "html_description": "Type of the content, must be photo | ",
+ "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://' if the photo was uploaded using multipart/form-data under . More information on Sending Files",
+ "html_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 » | ",
+ "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://' if the photo was uploaded using multipart/form-data under . :ref:`More information on Sending Files » `\n",
+ "name": "photo",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "inputstorycontentvideo",
+ "name": "InputStoryContentVideo",
+ "description": "Describes a video to post as a story.",
+ "html_description": "Describes a video to post as a story.
",
+ "rst_description": "Describes a video to post as a story.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Type of the content, must be video",
+ "html_description": "Type of the content, must be video | ",
+ "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://' if the video was uploaded using multipart/form-data under . More information on Sending Files",
+ "html_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 » | ",
+ "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://' if the video was uploaded using multipart/form-data under . :ref:`More information on Sending Files » `\n",
+ "name": "video",
+ "required": true
+ },
+ {
+ "type": "Float",
+ "description": "Precise duration of the video in seconds; 0-60",
+ "html_description": "Optional. Precise duration of the video in seconds; 0-60 | ",
+ "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": "Optional. Timestamp in seconds of the frame that will be used as the static cover for the story. Defaults to 0.0. | ",
+ "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": "Optional. Pass True if the video has no sound | ",
+ "rst_description": "*Optional*. Pass :code:`True` if the video has no sound\n",
+ "name": "is_animation",
+ "required": false
+ }
+ ],
+ "category": "types"
}
],
"description": "All types used in the Bot API responses are represented as JSON-objects.\nIt is safe to use 32-bit signed integers for storing all Integer fields unless otherwise noted.\nOptional fields may be not returned when irrelevant."
@@ -7635,11 +10866,19 @@
{
"type": "Integer",
"required": false,
- "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
- "html_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ",
- "rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
+ "description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
+ "html_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | ",
+ "rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"name": "message_thread_id"
},
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
+ "html_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | ",
+ "rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
+ "name": "direct_messages_topic_id"
+ },
{
"type": "String",
"required": true,
@@ -7688,6 +10927,14 @@
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
+ "html_description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | ",
+ "rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits `_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
+ "name": "allow_paid_broadcast"
+ },
{
"type": "String",
"required": false,
@@ -7696,6 +10943,14 @@
"rst_description": "Unique identifier of the message effect to be added to the message; for private chats only\n",
"name": "message_effect_id"
},
+ {
+ "type": "SuggestedPostParameters",
+ "required": false,
+ "description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
+ "html_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | ",
+ "rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
+ "name": "suggested_post_parameters"
+ },
{
"type": "ReplyParameters",
"required": false,
@@ -7733,11 +10988,19 @@
{
"type": "Integer",
"required": false,
- "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
- "html_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ",
- "rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
+ "description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
+ "html_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | ",
+ "rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"name": "message_thread_id"
},
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Identifier of the direct messages topic to which the message will be forwarded; required if the message is forwarded to a direct messages chat",
+ "html_description": "Identifier of the direct messages topic to which the message will be forwarded; required if the message is forwarded to a direct messages chat | ",
+ "rst_description": "Identifier of the direct messages topic to which the message will be forwarded; required if the message is forwarded to a direct messages chat\n",
+ "name": "direct_messages_topic_id"
+ },
{
"type": "Integer or String",
"required": true,
@@ -7746,6 +11009,14 @@
"rst_description": "Unique identifier for the chat where the original message was sent (or channel username in the format :code:`@channelusername`)\n",
"name": "from_chat_id"
},
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "New start timestamp for the forwarded video in the message",
+ "html_description": "New start timestamp for the forwarded video in the message | ",
+ "rst_description": "New start timestamp for the forwarded video in the message\n",
+ "name": "video_start_timestamp"
+ },
{
"type": "Boolean",
"required": false,
@@ -7762,6 +11033,22 @@
"rst_description": "Protects the contents of the forwarded 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; only available when forwarding to private chats",
+ "html_description": "Unique identifier of the message effect to be added to the message; only available when forwarding to private chats | ",
+ "rst_description": "Unique identifier of the message effect to be added to the message; only available when forwarding to private chats\n",
+ "name": "message_effect_id"
+ },
+ {
+ "type": "SuggestedPostParameters",
+ "required": false,
+ "description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only",
+ "html_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only | ",
+ "rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only\n",
+ "name": "suggested_post_parameters"
+ },
{
"type": "Integer",
"required": true,
@@ -7791,11 +11078,19 @@
{
"type": "Integer",
"required": false,
- "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
- "html_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ",
- "rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
+ "description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
+ "html_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | ",
+ "rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"name": "message_thread_id"
},
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Identifier of the direct messages topic to which the messages will be forwarded; required if the messages are forwarded to a direct messages chat",
+ "html_description": "Identifier of the direct messages topic to which the messages will be forwarded; required if the messages are forwarded to a direct messages chat | ",
+ "rst_description": "Identifier of the direct messages topic to which the messages will be forwarded; required if the messages are forwarded to a direct messages chat\n",
+ "name": "direct_messages_topic_id"
+ },
{
"type": "Integer or String",
"required": true,
@@ -7849,11 +11144,19 @@
{
"type": "Integer",
"required": false,
- "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
- "html_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ",
- "rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
+ "description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
+ "html_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | ",
+ "rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"name": "message_thread_id"
},
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
+ "html_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | ",
+ "rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
+ "name": "direct_messages_topic_id"
+ },
{
"type": "Integer or String",
"required": true,
@@ -7870,6 +11173,14 @@
"rst_description": "Message identifier in the chat specified in *from_chat_id*\n",
"name": "message_id"
},
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "New start timestamp for the copied video in the message",
+ "html_description": "New start timestamp for the copied video in the message | ",
+ "rst_description": "New start timestamp for the copied video in the message\n",
+ "name": "video_start_timestamp"
+ },
{
"type": "String",
"required": false,
@@ -7918,6 +11229,30 @@
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
+ "html_description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | ",
+ "rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits `_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
+ "name": "allow_paid_broadcast"
+ },
+ {
+ "type": "String",
+ "required": false,
+ "description": "Unique identifier of the message effect to be added to the message; only available when copying to private chats",
+ "html_description": "Unique identifier of the message effect to be added to the message; only available when copying to private chats | ",
+ "rst_description": "Unique identifier of the message effect to be added to the message; only available when copying to private chats\n",
+ "name": "message_effect_id"
+ },
+ {
+ "type": "SuggestedPostParameters",
+ "required": false,
+ "description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
+ "html_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | ",
+ "rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
+ "name": "suggested_post_parameters"
+ },
{
"type": "ReplyParameters",
"required": false,
@@ -7955,11 +11290,19 @@
{
"type": "Integer",
"required": false,
- "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
- "html_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ",
- "rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
+ "description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
+ "html_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | ",
+ "rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"name": "message_thread_id"
},
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat",
+ "html_description": "Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat | ",
+ "rst_description": "Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat\n",
+ "name": "direct_messages_topic_id"
+ },
{
"type": "Integer or String",
"required": true,
@@ -8029,11 +11372,19 @@
{
"type": "Integer",
"required": false,
- "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
- "html_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ",
- "rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
+ "description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
+ "html_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | ",
+ "rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"name": "message_thread_id"
},
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
+ "html_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | ",
+ "rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
+ "name": "direct_messages_topic_id"
+ },
{
"type": "InputFile or String",
"required": true,
@@ -8098,6 +11449,14 @@
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
+ "html_description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | ",
+ "rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits `_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
+ "name": "allow_paid_broadcast"
+ },
{
"type": "String",
"required": false,
@@ -8106,6 +11465,14 @@
"rst_description": "Unique identifier of the message effect to be added to the message; for private chats only\n",
"name": "message_effect_id"
},
+ {
+ "type": "SuggestedPostParameters",
+ "required": false,
+ "description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
+ "html_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | ",
+ "rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
+ "name": "suggested_post_parameters"
+ },
{
"type": "ReplyParameters",
"required": false,
@@ -8151,11 +11518,19 @@
{
"type": "Integer",
"required": false,
- "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
- "html_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ",
- "rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
+ "description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
+ "html_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | ",
+ "rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"name": "message_thread_id"
},
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
+ "html_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | ",
+ "rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
+ "name": "direct_messages_topic_id"
+ },
{
"type": "InputFile or String",
"required": true,
@@ -8236,6 +11611,14 @@
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
+ "html_description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | ",
+ "rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits `_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
+ "name": "allow_paid_broadcast"
+ },
{
"type": "String",
"required": false,
@@ -8244,6 +11627,14 @@
"rst_description": "Unique identifier of the message effect to be added to the message; for private chats only\n",
"name": "message_effect_id"
},
+ {
+ "type": "SuggestedPostParameters",
+ "required": false,
+ "description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
+ "html_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | ",
+ "rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
+ "name": "suggested_post_parameters"
+ },
{
"type": "ReplyParameters",
"required": false,
@@ -8289,11 +11680,19 @@
{
"type": "Integer",
"required": false,
- "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
- "html_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ",
- "rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
+ "description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
+ "html_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | ",
+ "rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"name": "message_thread_id"
},
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
+ "html_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | ",
+ "rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
+ "name": "direct_messages_topic_id"
+ },
{
"type": "InputFile or String",
"required": true,
@@ -8358,6 +11757,14 @@
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
+ "html_description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | ",
+ "rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits `_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
+ "name": "allow_paid_broadcast"
+ },
{
"type": "String",
"required": false,
@@ -8366,6 +11773,14 @@
"rst_description": "Unique identifier of the message effect to be added to the message; for private chats only\n",
"name": "message_effect_id"
},
+ {
+ "type": "SuggestedPostParameters",
+ "required": false,
+ "description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
+ "html_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | ",
+ "rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
+ "name": "suggested_post_parameters"
+ },
{
"type": "ReplyParameters",
"required": false,
@@ -8411,11 +11826,19 @@
{
"type": "Integer",
"required": false,
- "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
- "html_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ",
- "rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
+ "description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
+ "html_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | ",
+ "rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"name": "message_thread_id"
},
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
+ "html_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | ",
+ "rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
+ "name": "direct_messages_topic_id"
+ },
{
"type": "InputFile or String",
"required": true,
@@ -8456,6 +11879,22 @@
"rst_description": "Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . :ref:`More information on Sending Files » `\n",
"name": "thumbnail"
},
+ {
+ "type": "InputFile or String",
+ "required": false,
+ "description": "Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://' to upload a new one using multipart/form-data under name. More information on Sending Files",
+ "html_description": "Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files » | ",
+ "rst_description": "Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://' to upload a new one using multipart/form-data under name. :ref:`More information on Sending Files » `\n",
+ "name": "cover"
+ },
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Start timestamp for the video in the message",
+ "html_description": "Start timestamp for the video in the message | ",
+ "rst_description": "Start timestamp for the video in the message\n",
+ "name": "start_timestamp"
+ },
{
"type": "String",
"required": false,
@@ -8520,6 +11959,14 @@
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
+ "html_description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | ",
+ "rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits `_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
+ "name": "allow_paid_broadcast"
+ },
{
"type": "String",
"required": false,
@@ -8528,6 +11975,14 @@
"rst_description": "Unique identifier of the message effect to be added to the message; for private chats only\n",
"name": "message_effect_id"
},
+ {
+ "type": "SuggestedPostParameters",
+ "required": false,
+ "description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
+ "html_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | ",
+ "rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
+ "name": "suggested_post_parameters"
+ },
{
"type": "ReplyParameters",
"required": false,
@@ -8573,11 +12028,19 @@
{
"type": "Integer",
"required": false,
- "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
- "html_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ",
- "rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
+ "description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
+ "html_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | ",
+ "rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"name": "message_thread_id"
},
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
+ "html_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | ",
+ "rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
+ "name": "direct_messages_topic_id"
+ },
{
"type": "InputFile or String",
"required": true,
@@ -8674,6 +12137,14 @@
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
+ "html_description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | ",
+ "rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits `_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
+ "name": "allow_paid_broadcast"
+ },
{
"type": "String",
"required": false,
@@ -8682,6 +12153,14 @@
"rst_description": "Unique identifier of the message effect to be added to the message; for private chats only\n",
"name": "message_effect_id"
},
+ {
+ "type": "SuggestedPostParameters",
+ "required": false,
+ "description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
+ "html_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | ",
+ "rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
+ "name": "suggested_post_parameters"
+ },
{
"type": "ReplyParameters",
"required": false,
@@ -8727,11 +12206,19 @@
{
"type": "Integer",
"required": false,
- "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
- "html_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ",
- "rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
+ "description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
+ "html_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | ",
+ "rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"name": "message_thread_id"
},
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
+ "html_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | ",
+ "rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
+ "name": "direct_messages_topic_id"
+ },
{
"type": "InputFile or String",
"required": true,
@@ -8788,6 +12275,14 @@
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
+ "html_description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | ",
+ "rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits `_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
+ "name": "allow_paid_broadcast"
+ },
{
"type": "String",
"required": false,
@@ -8796,6 +12291,14 @@
"rst_description": "Unique identifier of the message effect to be added to the message; for private chats only\n",
"name": "message_effect_id"
},
+ {
+ "type": "SuggestedPostParameters",
+ "required": false,
+ "description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
+ "html_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | ",
+ "rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
+ "name": "suggested_post_parameters"
+ },
{
"type": "ReplyParameters",
"required": false,
@@ -8841,11 +12344,19 @@
{
"type": "Integer",
"required": false,
- "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
- "html_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ",
- "rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
+ "description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
+ "html_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | ",
+ "rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"name": "message_thread_id"
},
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
+ "html_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | ",
+ "rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
+ "name": "direct_messages_topic_id"
+ },
{
"type": "InputFile or String",
"required": true,
@@ -8894,6 +12405,14 @@
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
+ "html_description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | ",
+ "rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits `_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
+ "name": "allow_paid_broadcast"
+ },
{
"type": "String",
"required": false,
@@ -8902,6 +12421,14 @@
"rst_description": "Unique identifier of the message effect to be added to the message; for private chats only\n",
"name": "message_effect_id"
},
+ {
+ "type": "SuggestedPostParameters",
+ "required": false,
+ "description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
+ "html_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | ",
+ "rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
+ "name": "suggested_post_parameters"
+ },
{
"type": "ReplyParameters",
"required": false,
@@ -8924,24 +12451,48 @@
{
"anchor": "sendpaidmedia",
"name": "sendPaidMedia",
- "description": "Use this method to send paid media to channel chats. On success, the sent Message is returned.",
- "html_description": "Use this method to send paid media to channel chats. On success, the sent Message is returned.
",
- "rst_description": "Use this method to send paid media to channel chats. On success, the sent :class:`aiogram.types.message.Message` is returned.",
+ "description": "Use this method to send paid media. On success, the sent Message is returned.",
+ "html_description": "Use this method to send paid media. On success, the sent Message is returned.
",
+ "rst_description": "Use this method to send paid media. On success, the sent :class:`aiogram.types.message.Message` is returned.",
"annotations": [
+ {
+ "type": "String",
+ "required": false,
+ "description": "Unique identifier of the business connection on behalf of which the message will be sent",
+ "html_description": "Unique identifier of the business connection on behalf of which the message will be sent | ",
+ "rst_description": "Unique identifier of the business connection on behalf of which the message will be sent\n",
+ "name": "business_connection_id"
+ },
{
"type": "Integer or String",
"required": true,
- "description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
- "html_description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ",
- "rst_description": "Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n",
+ "description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername). If the chat is a channel, all Telegram Star proceeds from this media will be credited to the chat's balance. Otherwise, they will be credited to the bot's balance.",
+ "html_description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername). If the chat is a channel, all Telegram Star proceeds from this media will be credited to the chat's balance. Otherwise, they will be credited to the bot's balance. | ",
+ "rst_description": "Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`). If the chat is a channel, all Telegram Star proceeds from this media will be credited to the chat's balance. Otherwise, they will be credited to the bot's balance.\n",
"name": "chat_id"
},
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
+ "html_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | ",
+ "rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
+ "name": "message_thread_id"
+ },
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
+ "html_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | ",
+ "rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
+ "name": "direct_messages_topic_id"
+ },
{
"type": "Integer",
"required": true,
- "description": "The number of Telegram Stars that must be paid to buy access to the media",
- "html_description": "The number of Telegram Stars that must be paid to buy access to the media | ",
- "rst_description": "The number of Telegram Stars that must be paid to buy access to the media\n",
+ "description": "The number of Telegram Stars that must be paid to buy access to the media; 1-25000",
+ "html_description": "The number of Telegram Stars that must be paid to buy access to the media; 1-25000 | ",
+ "rst_description": "The number of Telegram Stars that must be paid to buy access to the media; 1-25000\n",
"name": "star_count"
},
{
@@ -8952,6 +12503,14 @@
"rst_description": "A JSON-serialized array describing the media to be sent; up to 10 items\n",
"name": "media"
},
+ {
+ "type": "String",
+ "required": false,
+ "description": "Bot-defined paid media payload, 0-128 bytes. This will not be displayed to the user, use it for your internal processes.",
+ "html_description": "Bot-defined paid media payload, 0-128 bytes. This will not be displayed to the user, use it for your internal processes. | ",
+ "rst_description": "Bot-defined paid media payload, 0-128 bytes. This will not be displayed to the user, use it for your internal processes.\n",
+ "name": "payload"
+ },
{
"type": "String",
"required": false,
@@ -9000,6 +12559,22 @@
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
+ "html_description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | ",
+ "rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits `_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
+ "name": "allow_paid_broadcast"
+ },
+ {
+ "type": "SuggestedPostParameters",
+ "required": false,
+ "description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
+ "html_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | ",
+ "rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
+ "name": "suggested_post_parameters"
+ },
{
"type": "ReplyParameters",
"required": false,
@@ -9022,9 +12597,9 @@
{
"anchor": "sendmediagroup",
"name": "sendMediaGroup",
- "description": "Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Messages that were sent is returned.",
- "html_description": "Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Messages that were sent is returned.
",
- "rst_description": "Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of `Messages `_ that were sent is returned.",
+ "description": "Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Message objects that were sent is returned.",
+ "html_description": "Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Message objects that were sent is returned.
",
+ "rst_description": "Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of :class:`aiogram.types.message.Message` objects that were sent is returned.",
"annotations": [
{
"type": "String",
@@ -9045,11 +12620,19 @@
{
"type": "Integer",
"required": false,
- "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
- "html_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ",
- "rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
+ "description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
+ "html_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | ",
+ "rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"name": "message_thread_id"
},
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat",
+ "html_description": "Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat | ",
+ "rst_description": "Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat\n",
+ "name": "direct_messages_topic_id"
+ },
{
"type": "Array of InputMediaAudio, InputMediaDocument, InputMediaPhoto and InputMediaVideo",
"required": true,
@@ -9074,6 +12657,14 @@
"rst_description": "Protects the contents of the sent messages from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
+ "html_description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | ",
+ "rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits `_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
+ "name": "allow_paid_broadcast"
+ },
{
"type": "String",
"required": false,
@@ -9119,11 +12710,19 @@
{
"type": "Integer",
"required": false,
- "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
- "html_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ",
- "rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
+ "description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
+ "html_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | ",
+ "rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"name": "message_thread_id"
},
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
+ "html_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | ",
+ "rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
+ "name": "direct_messages_topic_id"
+ },
{
"type": "Float",
"required": true,
@@ -9188,6 +12787,14 @@
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
+ "html_description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | ",
+ "rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits `_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
+ "name": "allow_paid_broadcast"
+ },
{
"type": "String",
"required": false,
@@ -9196,6 +12803,14 @@
"rst_description": "Unique identifier of the message effect to be added to the message; for private chats only\n",
"name": "message_effect_id"
},
+ {
+ "type": "SuggestedPostParameters",
+ "required": false,
+ "description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
+ "html_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | ",
+ "rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
+ "name": "suggested_post_parameters"
+ },
{
"type": "ReplyParameters",
"required": false,
@@ -9241,11 +12856,19 @@
{
"type": "Integer",
"required": false,
- "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
- "html_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ",
- "rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
+ "description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
+ "html_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | ",
+ "rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"name": "message_thread_id"
},
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
+ "html_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | ",
+ "rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
+ "name": "direct_messages_topic_id"
+ },
{
"type": "Float",
"required": true,
@@ -9326,6 +12949,14 @@
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
+ "html_description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | ",
+ "rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits `_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
+ "name": "allow_paid_broadcast"
+ },
{
"type": "String",
"required": false,
@@ -9334,6 +12965,14 @@
"rst_description": "Unique identifier of the message effect to be added to the message; for private chats only\n",
"name": "message_effect_id"
},
+ {
+ "type": "SuggestedPostParameters",
+ "required": false,
+ "description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
+ "html_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | ",
+ "rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
+ "name": "suggested_post_parameters"
+ },
{
"type": "ReplyParameters",
"required": false,
@@ -9379,11 +13018,19 @@
{
"type": "Integer",
"required": false,
- "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
- "html_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ",
- "rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
+ "description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
+ "html_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | ",
+ "rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"name": "message_thread_id"
},
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
+ "html_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | ",
+ "rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
+ "name": "direct_messages_topic_id"
+ },
{
"type": "String",
"required": true,
@@ -9432,6 +13079,14 @@
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
+ "html_description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | ",
+ "rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits `_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
+ "name": "allow_paid_broadcast"
+ },
{
"type": "String",
"required": false,
@@ -9440,6 +13095,14 @@
"rst_description": "Unique identifier of the message effect to be added to the message; for private chats only\n",
"name": "message_effect_id"
},
+ {
+ "type": "SuggestedPostParameters",
+ "required": false,
+ "description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
+ "html_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | ",
+ "rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
+ "name": "suggested_post_parameters"
+ },
{
"type": "ReplyParameters",
"required": false,
@@ -9477,17 +13140,17 @@
{
"type": "Integer or String",
"required": true,
- "description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
- "html_description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ",
- "rst_description": "Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n",
+ "description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername). Polls can't be sent to channel direct messages chats.",
+ "html_description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername). Polls can't be sent to channel direct messages chats. | ",
+ "rst_description": "Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`). Polls can't be sent to channel direct messages chats.\n",
"name": "chat_id"
},
{
"type": "Integer",
"required": false,
- "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
- "html_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ",
- "rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
+ "description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
+ "html_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | ",
+ "rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"name": "message_thread_id"
},
{
@@ -9517,9 +13180,9 @@
{
"type": "Array of InputPollOption",
"required": true,
- "description": "A JSON-serialized list of 2-10 answer options",
- "html_description": "A JSON-serialized list of 2-10 answer options | ",
- "rst_description": "A JSON-serialized list of 2-10 answer options\n",
+ "description": "A JSON-serialized list of 2-12 answer options",
+ "html_description": "A JSON-serialized list of 2-12 answer options | ",
+ "rst_description": "A JSON-serialized list of 2-12 answer options\n",
"name": "options"
},
{
@@ -9541,18 +13204,50 @@
{
"type": "Boolean",
"required": false,
- "description": "True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False",
- "html_description": "True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False | ",
- "rst_description": ":code:`True`, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to :code:`False`\n",
+ "description": "Pass True, if the poll allows multiple answers, defaults to False",
+ "html_description": "Pass True, if the poll allows multiple answers, defaults to False | ",
+ "rst_description": "Pass :code:`True`, if the poll allows multiple answers, defaults to :code:`False`\n",
"name": "allows_multiple_answers"
},
{
- "type": "Integer",
+ "type": "Boolean",
"required": false,
- "description": "0-based identifier of the correct answer option, required for polls in quiz mode",
- "html_description": "0-based identifier of the correct answer option, required for polls in quiz mode | ",
- "rst_description": "0-based identifier of the correct answer option, required for polls in quiz mode\n",
- "name": "correct_option_id"
+ "description": "Pass True, if the poll allows to change chosen answer options, defaults to False for quizzes and to True for regular polls",
+ "html_description": "Pass True, if the poll allows to change chosen answer options, defaults to False for quizzes and to True for regular polls | ",
+ "rst_description": "Pass :code:`True`, if the poll allows to change chosen answer options, defaults to :code:`False` for quizzes and to :code:`True` for regular polls\n",
+ "name": "allows_revoting"
+ },
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True, if the poll options must be shown in random order",
+ "html_description": "Pass True, if the poll options must be shown in random order | ",
+ "rst_description": "Pass :code:`True`, if the poll options must be shown in random order\n",
+ "name": "shuffle_options"
+ },
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True, if answer options can be added to the poll after creation; not supported for anonymous polls and quizzes",
+ "html_description": "Pass True, if answer options can be added to the poll after creation; not supported for anonymous polls and quizzes | ",
+ "rst_description": "Pass :code:`True`, if answer options can be added to the poll after creation; not supported for anonymous polls and quizzes\n",
+ "name": "allow_adding_options"
+ },
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True, if poll results must be shown only after the poll closes",
+ "html_description": "Pass True, if poll results must be shown only after the poll closes | ",
+ "rst_description": "Pass :code:`True`, if poll results must be shown only after the poll closes\n",
+ "name": "hide_results_until_closes"
+ },
+ {
+ "type": "Array of Integer",
+ "required": false,
+ "description": "A JSON-serialized list of monotonically increasing 0-based identifiers of the correct answer options, required for polls in quiz mode",
+ "html_description": "A JSON-serialized list of monotonically increasing 0-based identifiers of the correct answer options, required for polls in quiz mode | ",
+ "rst_description": "A JSON-serialized list of monotonically increasing 0-based identifiers of the correct answer options, required for polls in quiz mode\n",
+ "name": "correct_option_ids"
},
{
"type": "String",
@@ -9581,17 +13276,17 @@
{
"type": "Integer",
"required": false,
- "description": "Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close_date.",
- "html_description": "Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close_date. | ",
- "rst_description": "Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with *close_date*.\n",
+ "description": "Amount of time in seconds the poll will be active after creation, 5-2628000. Can't be used together with close_date.",
+ "html_description": "Amount of time in seconds the poll will be active after creation, 5-2628000. Can't be used together with close_date. | ",
+ "rst_description": "Amount of time in seconds the poll will be active after creation, 5-2628000. Can't be used together with *close_date*.\n",
"name": "open_period"
},
{
"type": "Integer",
"required": false,
- "description": "Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can't be used together with open_period.",
- "html_description": "Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can't be used together with open_period. | ",
- "rst_description": "Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can't be used together with *open_period*.\n",
+ "description": "Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 2628000 seconds in the future. Can't be used together with open_period.",
+ "html_description": "Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 2628000 seconds in the future. Can't be used together with open_period. | ",
+ "rst_description": "Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 2628000 seconds in the future. Can't be used together with *open_period*.\n",
"name": "close_date"
},
{
@@ -9602,6 +13297,30 @@
"rst_description": "Pass :code:`True` if the poll needs to be immediately closed. This can be useful for poll preview.\n",
"name": "is_closed"
},
+ {
+ "type": "String",
+ "required": false,
+ "description": "Description of the poll to be sent, 0-1024 characters after entities parsing",
+ "html_description": "Description of the poll to be sent, 0-1024 characters after entities parsing | ",
+ "rst_description": "Description of the poll to be sent, 0-1024 characters after entities parsing\n",
+ "name": "description"
+ },
+ {
+ "type": "String",
+ "required": false,
+ "description": "Mode for parsing entities in the poll description. See formatting options for more details.",
+ "html_description": "Mode for parsing entities in the poll description. See formatting options for more details. | ",
+ "rst_description": "Mode for parsing entities in the poll description. See `formatting options `_ for more details.\n",
+ "name": "description_parse_mode"
+ },
+ {
+ "type": "Array of MessageEntity",
+ "required": false,
+ "description": "A JSON-serialized list of special entities that appear in the poll description, which can be specified instead of description_parse_mode",
+ "html_description": "A JSON-serialized list of special entities that appear in the poll description, which can be specified instead of description_parse_mode | ",
+ "rst_description": "A JSON-serialized list of special entities that appear in the poll description, which can be specified instead of *description_parse_mode*\n",
+ "name": "description_entities"
+ },
{
"type": "Boolean",
"required": false,
@@ -9618,6 +13337,14 @@
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
+ "html_description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | ",
+ "rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits `_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
+ "name": "allow_paid_broadcast"
+ },
{
"type": "String",
"required": false,
@@ -9645,6 +13372,80 @@
],
"category": "methods"
},
+ {
+ "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": "Use this method to send a checklist on behalf of a connected business account. On success, the sent Message is returned.
",
+ "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": "Unique identifier of the business connection on behalf of which the message will be sent | ",
+ "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": "Unique identifier for the target chat | ",
+ "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": "A JSON-serialized object for the checklist to send | ",
+ "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": "Sends the message silently. Users will receive a notification with no sound. | ",
+ "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": "Protects the contents of the sent message from forwarding and saving | ",
+ "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": "Unique identifier of the message effect to be added to the message | ",
+ "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": "A JSON-serialized object for description of the message to reply to | ",
+ "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": "A JSON-serialized object for an inline keyboard | ",
+ "rst_description": "A JSON-serialized object for an `inline keyboard `_\n",
+ "name": "reply_markup"
+ }
+ ],
+ "category": "methods"
+ },
{
"anchor": "senddice",
"name": "sendDice",
@@ -9671,11 +13472,19 @@
{
"type": "Integer",
"required": false,
- "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
- "html_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ",
- "rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
+ "description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
+ "html_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | ",
+ "rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"name": "message_thread_id"
},
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
+ "html_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | ",
+ "rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
+ "name": "direct_messages_topic_id"
+ },
{
"type": "String",
"required": false,
@@ -9700,6 +13509,14 @@
"rst_description": "Protects the contents of the sent message from forwarding\n",
"name": "protect_content"
},
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
+ "html_description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | ",
+ "rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits `_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
+ "name": "allow_paid_broadcast"
+ },
{
"type": "String",
"required": false,
@@ -9708,6 +13525,14 @@
"rst_description": "Unique identifier of the message effect to be added to the message; for private chats only\n",
"name": "message_effect_id"
},
+ {
+ "type": "SuggestedPostParameters",
+ "required": false,
+ "description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
+ "html_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | ",
+ "rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
+ "name": "suggested_post_parameters"
+ },
{
"type": "ReplyParameters",
"required": false,
@@ -9727,6 +13552,64 @@
],
"category": "methods"
},
+ {
+ "anchor": "sendmessagedraft",
+ "name": "sendMessageDraft",
+ "description": "Use this method to stream a partial message to a user while the message is being generated. Returns True on success.",
+ "html_description": "Use this method to stream a partial message to a user while the message is being generated. Returns True on success.
",
+ "rst_description": "Use this method to stream a partial message to a user while the message is being generated. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "Unique identifier for the target private chat",
+ "html_description": "Unique identifier for the target private chat | ",
+ "rst_description": "Unique identifier for the target private chat\n",
+ "name": "chat_id"
+ },
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Unique identifier for the target message thread",
+ "html_description": "Unique identifier for the target message thread | ",
+ "rst_description": "Unique identifier for the target message thread\n",
+ "name": "message_thread_id"
+ },
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "Unique identifier of the message draft; must be non-zero. Changes of drafts with the same identifier are animated",
+ "html_description": "Unique identifier of the message draft; must be non-zero. Changes of drafts with the same identifier are animated | ",
+ "rst_description": "Unique identifier of the message draft; must be non-zero. Changes of drafts with the same identifier are animated\n",
+ "name": "draft_id"
+ },
+ {
+ "type": "String",
+ "required": true,
+ "description": "Text of the message to be sent, 1-4096 characters after entities parsing",
+ "html_description": "Text of the message to be sent, 1-4096 characters after entities parsing | ",
+ "rst_description": "Text of the message to be sent, 1-4096 characters after entities parsing\n",
+ "name": "text"
+ },
+ {
+ "type": "String",
+ "required": false,
+ "description": "Mode for parsing entities in the message text. See formatting options for more details.",
+ "html_description": "Mode for parsing entities in the message text. See formatting options for more details. | ",
+ "rst_description": "Mode for parsing entities in the message text. See `formatting options `_ for more details.\n",
+ "name": "parse_mode"
+ },
+ {
+ "type": "Array of MessageEntity",
+ "required": false,
+ "description": "A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode",
+ "html_description": "A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode | ",
+ "rst_description": "A JSON-serialized list of special entities that appear in message text, which can be specified instead of *parse_mode*\n",
+ "name": "entities"
+ }
+ ],
+ "category": "methods"
+ },
{
"anchor": "sendchataction",
"name": "sendChatAction",
@@ -9745,17 +13628,17 @@
{
"type": "Integer or String",
"required": true,
- "description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
- "html_description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ",
- "rst_description": "Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n",
+ "description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername). Channel chats and channel direct messages chats aren't supported.",
+ "html_description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername). Channel chats and channel direct messages chats aren't supported. | ",
+ "rst_description": "Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`). Channel chats and channel direct messages chats aren't supported.\n",
"name": "chat_id"
},
{
"type": "Integer",
"required": false,
- "description": "Unique identifier for the target message thread; for supergroups only",
- "html_description": "Unique identifier for the target message thread; for supergroups only | ",
- "rst_description": "Unique identifier for the target message thread; for supergroups only\n",
+ "description": "Unique identifier for the target message thread or topic of a forum; for supergroups and private chats of bots with forum topic mode enabled only",
+ "html_description": "Unique identifier for the target message thread or topic of a forum; for supergroups and private chats of bots with forum topic mode enabled only | ",
+ "rst_description": "Unique identifier for the target message thread or topic of a forum; for supergroups and private chats of bots with forum topic mode enabled only\n",
"name": "message_thread_id"
},
{
@@ -9772,9 +13655,9 @@
{
"anchor": "setmessagereaction",
"name": "setMessageReaction",
- "description": "Use this method to change the chosen reactions on a message. Service messages can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Returns True on success.",
- "html_description": "Use this method to change the chosen reactions on a message. Service messages can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Returns True on success.
",
- "rst_description": "Use this method to change the chosen reactions on a message. Service messages can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Returns :code:`True` on success.",
+ "description": "Use this method to change the chosen reactions on a message. Service messages of some types can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Bots can't use paid reactions. Returns True on success.",
+ "html_description": "Use this method to change the chosen reactions on a message. Service messages of some types can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Bots can't use paid reactions. Returns True on success.
",
+ "rst_description": "Use this method to change the chosen reactions on a message. Service messages of some types can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Bots can't use paid reactions. Returns :code:`True` on success.",
"annotations": [
{
"type": "Integer or String",
@@ -9795,9 +13678,9 @@
{
"type": "Array of ReactionType",
"required": false,
- "description": "A JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators.",
- "html_description": "A JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators. | ",
- "rst_description": "A JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators.\n",
+ "description": "A JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators. Paid reactions can't be used by bots.",
+ "html_description": "A JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators. Paid reactions can't be used by bots. | ",
+ "rst_description": "A JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators. Paid reactions can't be used by bots.\n",
"name": "reaction"
},
{
@@ -9845,6 +13728,74 @@
],
"category": "methods"
},
+ {
+ "anchor": "getuserprofileaudios",
+ "name": "getUserProfileAudios",
+ "description": "Use this method to get a list of profile audios for a user. Returns a UserProfileAudios object.",
+ "html_description": "Use this method to get a list of profile audios for a user. Returns a UserProfileAudios object.
",
+ "rst_description": "Use this method to get a list of profile audios for a user. Returns a :class:`aiogram.types.user_profile_audios.UserProfileAudios` object.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "Unique identifier of the target user",
+ "html_description": "Unique identifier of the target user | ",
+ "rst_description": "Unique identifier of the target user\n",
+ "name": "user_id"
+ },
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Sequential number of the first audio to be returned. By default, all audios are returned.",
+ "html_description": "Sequential number of the first audio to be returned. By default, all audios are returned. | ",
+ "rst_description": "Sequential number of the first audio to be returned. By default, all audios are returned.\n",
+ "name": "offset"
+ },
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Limits the number of audios to be retrieved. Values between 1-100 are accepted. Defaults to 100.",
+ "html_description": "Limits the number of audios to be retrieved. Values between 1-100 are accepted. Defaults to 100. | ",
+ "rst_description": "Limits the number of audios to be retrieved. Values between 1-100 are accepted. Defaults to 100.\n",
+ "name": "limit"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "setuseremojistatus",
+ "name": "setUserEmojiStatus",
+ "description": "Changes the emoji status for a given user that previously allowed the bot to manage their emoji status via the Mini App method requestEmojiStatusAccess. Returns True on success.",
+ "html_description": "Changes the emoji status for a given user that previously allowed the bot to manage their emoji status via the Mini App method requestEmojiStatusAccess. Returns True on success.
",
+ "rst_description": "Changes the emoji status for a given user that previously allowed the bot to manage their emoji status via the Mini App method `requestEmojiStatusAccess `_. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "Unique identifier of the target user",
+ "html_description": "Unique identifier of the target user | ",
+ "rst_description": "Unique identifier of the target user\n",
+ "name": "user_id"
+ },
+ {
+ "type": "String",
+ "required": false,
+ "description": "Custom emoji identifier of the emoji status to set. Pass an empty string to remove the status.",
+ "html_description": "Custom emoji identifier of the emoji status to set. Pass an empty string to remove the status. | ",
+ "rst_description": "Custom emoji identifier of the emoji status to set. Pass an empty string to remove the status.\n",
+ "name": "emoji_status_custom_emoji_id"
+ },
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Expiration date of the emoji status, if any",
+ "html_description": "Expiration date of the emoji status, if any | ",
+ "rst_description": "Expiration date of the emoji status, if any\n",
+ "name": "emoji_status_expiration_date"
+ }
+ ],
+ "category": "methods"
+ },
{
"anchor": "getfile",
"name": "getFile",
@@ -10023,9 +13974,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": "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. | ",
- "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": "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. | ",
+ "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"
},
{
@@ -10047,9 +13998,9 @@
{
"type": "Boolean",
"required": false,
- "description": "Pass True if the administrator can restrict, ban or unban chat members, or access supergroup statistics",
- "html_description": "Pass True if the administrator can restrict, ban or unban chat members, or access supergroup statistics | ",
- "rst_description": "Pass :code:`True` if the administrator can restrict, ban or unban chat members, or access supergroup statistics\n",
+ "description": "Pass True if the administrator can restrict, ban or unban chat members, or access supergroup statistics. For backward compatibility, defaults to True for promotions of channel administrators",
+ "html_description": "Pass True if the administrator can restrict, ban or unban chat members, or access supergroup statistics. For backward compatibility, defaults to True for promotions of channel administrators | ",
+ "rst_description": "Pass :code:`True` if the administrator can restrict, ban or unban chat members, or access supergroup statistics. For backward compatibility, defaults to :code:`True` for promotions of channel administrators\n",
"name": "can_restrict_members"
},
{
@@ -10103,9 +14054,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": "Pass True if the administrator can post messages in the channel, or access channel statistics; for channels only | ",
- "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": "Pass True if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only | ",
+ "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"
},
{
@@ -10131,6 +14082,22 @@
"html_description": "Pass True if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only | ",
"rst_description": "Pass :code:`True` if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only\n",
"name": "can_manage_topics"
+ },
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True if the administrator can manage direct messages within the channel and decline suggested posts; for channels only",
+ "html_description": "Pass True if the administrator can manage direct messages within the channel and decline suggested posts; for channels only | ",
+ "rst_description": "Pass :code:`True` if the administrator can manage direct messages within the channel and decline suggested posts; for channels only\n",
+ "name": "can_manage_direct_messages"
+ },
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True if the administrator can edit the tags of regular members; for groups and supergroups only",
+ "html_description": "Pass True if the administrator can edit the tags of regular members; for groups and supergroups only | ",
+ "rst_description": "Pass :code:`True` if the administrator can edit the tags of regular members; for groups and supergroups only\n",
+ "name": "can_manage_tags"
}
],
"category": "methods"
@@ -10169,6 +14136,40 @@
],
"category": "methods"
},
+ {
+ "anchor": "setchatmembertag",
+ "name": "setChatMemberTag",
+ "description": "Use this method to set a tag for a regular member in a group or a supergroup. The bot must be an administrator in the chat for this to work and must have the can_manage_tags administrator right. Returns True on success.",
+ "html_description": "Use this method to set a tag for a regular member in a group or a supergroup. The bot must be an administrator in the chat for this to work and must have the can_manage_tags administrator right. Returns True on success.
",
+ "rst_description": "Use this method to set a tag for a regular member in a group or a supergroup. The bot must be an administrator in the chat for this to work and must have the *can_manage_tags* administrator right. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "Integer or String",
+ "required": true,
+ "description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
+ "html_description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) | ",
+ "rst_description": "Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
+ "name": "chat_id"
+ },
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "Unique identifier of the target user",
+ "html_description": "Unique identifier of the target user | ",
+ "rst_description": "Unique identifier of the target user\n",
+ "name": "user_id"
+ },
+ {
+ "type": "String",
+ "required": false,
+ "description": "New tag for the member; 0-16 characters, emoji are not allowed",
+ "html_description": "New tag for the member; 0-16 characters, emoji are not allowed | ",
+ "rst_description": "New tag for the member; 0-16 characters, emoji are not allowed\n",
+ "name": "tag"
+ }
+ ],
+ "category": "methods"
+ },
{
"anchor": "banchatsenderchat",
"name": "banChatSenderChat",
@@ -10381,6 +14382,82 @@
],
"category": "methods"
},
+ {
+ "anchor": "createchatsubscriptioninvitelink",
+ "name": "createChatSubscriptionInviteLink",
+ "description": "Use this method to create a subscription invite link for a channel chat. The bot must have the can_invite_users administrator rights. The link can be edited using the method editChatSubscriptionInviteLink or revoked using the method revokeChatInviteLink. Returns the new invite link as a ChatInviteLink object.",
+ "html_description": "Use this method to create a subscription invite link for a channel chat. The bot must have the can_invite_users administrator rights. The link can be edited using the method editChatSubscriptionInviteLink or revoked using the method revokeChatInviteLink. Returns the new invite link as a ChatInviteLink object.
",
+ "rst_description": "Use this method to create a `subscription invite link `_ for a channel chat. The bot must have the *can_invite_users* administrator rights. The link can be edited using the method :class:`aiogram.methods.edit_chat_subscription_invite_link.EditChatSubscriptionInviteLink` or revoked using the method :class:`aiogram.methods.revoke_chat_invite_link.RevokeChatInviteLink`. Returns the new invite link as a :class:`aiogram.types.chat_invite_link.ChatInviteLink` object.",
+ "annotations": [
+ {
+ "type": "Integer or String",
+ "required": true,
+ "description": "Unique identifier for the target channel chat or username of the target channel (in the format @channelusername)",
+ "html_description": "Unique identifier for the target channel chat or username of the target channel (in the format @channelusername) | ",
+ "rst_description": "Unique identifier for the target channel chat or username of the target channel (in the format :code:`@channelusername`)\n",
+ "name": "chat_id"
+ },
+ {
+ "type": "String",
+ "required": false,
+ "description": "Invite link name; 0-32 characters",
+ "html_description": "Invite link name; 0-32 characters | ",
+ "rst_description": "Invite link name; 0-32 characters\n",
+ "name": "name"
+ },
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "The number of seconds the subscription will be active for before the next payment. Currently, it must always be 2592000 (30 days).",
+ "html_description": "The number of seconds the subscription will be active for before the next payment. Currently, it must always be 2592000 (30 days). | ",
+ "rst_description": "The number of seconds the subscription will be active for before the next payment. Currently, it must always be 2592000 (30 days).\n",
+ "name": "subscription_period"
+ },
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat; 1-10000",
+ "html_description": "The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat; 1-10000 | ",
+ "rst_description": "The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat; 1-10000\n",
+ "name": "subscription_price"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "editchatsubscriptioninvitelink",
+ "name": "editChatSubscriptionInviteLink",
+ "description": "Use this method to edit a subscription invite link created by the bot. The bot must have the can_invite_users administrator rights. Returns the edited invite link as a ChatInviteLink object.",
+ "html_description": "Use this method to edit a subscription invite link created by the bot. The bot must have the can_invite_users administrator rights. Returns the edited invite link as a ChatInviteLink object.
",
+ "rst_description": "Use this method to edit a subscription invite link created by the bot. The bot must have the *can_invite_users* administrator rights. Returns the edited invite link as a :class:`aiogram.types.chat_invite_link.ChatInviteLink` object.",
+ "annotations": [
+ {
+ "type": "Integer or String",
+ "required": true,
+ "description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
+ "html_description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ",
+ "rst_description": "Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n",
+ "name": "chat_id"
+ },
+ {
+ "type": "String",
+ "required": true,
+ "description": "The invite link to edit",
+ "html_description": "The invite link to edit | ",
+ "rst_description": "The invite link to edit\n",
+ "name": "invite_link"
+ },
+ {
+ "type": "String",
+ "required": false,
+ "description": "Invite link name; 0-32 characters",
+ "html_description": "Invite link name; 0-32 characters | ",
+ "rst_description": "Invite link name; 0-32 characters\n",
+ "name": "name"
+ }
+ ],
+ "category": "methods"
+ },
{
"anchor": "revokechatinvitelink",
"name": "revokeChatInviteLink",
@@ -10558,10 +14635,18 @@
{
"anchor": "pinchatmessage",
"name": "pinChatMessage",
- "description": "Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.",
- "html_description": "Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.
",
- "rst_description": "Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns :code:`True` on success.",
+ "description": "Use this method to add a message to the list of pinned messages in a chat. In private chats and channel direct messages chats, all non-service messages can be pinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to pin messages in groups and channels respectively. Returns True on success.",
+ "html_description": "Use this method to add a message to the list of pinned messages in a chat. In private chats and channel direct messages chats, all non-service messages can be pinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to pin messages in groups and channels respectively. Returns True on success.
",
+ "rst_description": "Use this method to add a message to the list of pinned messages in a chat. In private chats and channel direct messages chats, all non-service messages can be pinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to pin messages in groups and channels respectively. Returns :code:`True` on success.",
"annotations": [
+ {
+ "type": "String",
+ "required": false,
+ "description": "Unique identifier of the business connection on behalf of which the message will be pinned",
+ "html_description": "Unique identifier of the business connection on behalf of which the message will be pinned | ",
+ "rst_description": "Unique identifier of the business connection on behalf of which the message will be pinned\n",
+ "name": "business_connection_id"
+ },
{
"type": "Integer or String",
"required": true,
@@ -10592,10 +14677,18 @@
{
"anchor": "unpinchatmessage",
"name": "unpinChatMessage",
- "description": "Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.",
- "html_description": "Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.
",
- "rst_description": "Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns :code:`True` on success.",
+ "description": "Use this method to remove a message from the list of pinned messages in a chat. In private chats and channel direct messages chats, all messages can be unpinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin messages in groups and channels respectively. Returns True on success.",
+ "html_description": "Use this method to remove a message from the list of pinned messages in a chat. In private chats and channel direct messages chats, all messages can be unpinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin messages in groups and channels respectively. Returns True on success.
",
+ "rst_description": "Use this method to remove a message from the list of pinned messages in a chat. In private chats and channel direct messages chats, all messages can be unpinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin messages in groups and channels respectively. Returns :code:`True` on success.",
"annotations": [
+ {
+ "type": "String",
+ "required": false,
+ "description": "Unique identifier of the business connection on behalf of which the message will be unpinned",
+ "html_description": "Unique identifier of the business connection on behalf of which the message will be unpinned | ",
+ "rst_description": "Unique identifier of the business connection on behalf of which the message will be unpinned\n",
+ "name": "business_connection_id"
+ },
{
"type": "Integer or String",
"required": true,
@@ -10607,9 +14700,9 @@
{
"type": "Integer",
"required": false,
- "description": "Identifier of a message to unpin. If not specified, the most recent pinned message (by sending date) will be unpinned.",
- "html_description": "Identifier of a message to unpin. If not specified, the most recent pinned message (by sending date) will be unpinned. | ",
- "rst_description": "Identifier of a message to unpin. If not specified, the most recent pinned message (by sending date) will be unpinned.\n",
+ "description": "Identifier of the message to unpin. Required if business_connection_id is specified. If not specified, the most recent pinned message (by sending date) will be unpinned.",
+ "html_description": "Identifier of the message to unpin. Required if business_connection_id is specified. If not specified, the most recent pinned message (by sending date) will be unpinned. | ",
+ "rst_description": "Identifier of the message to unpin. Required if *business_connection_id* is specified. If not specified, the most recent pinned message (by sending date) will be unpinned.\n",
"name": "message_id"
}
],
@@ -10618,9 +14711,9 @@
{
"anchor": "unpinallchatmessages",
"name": "unpinAllChatMessages",
- "description": "Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.",
- "html_description": "Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.
",
- "rst_description": "Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns :code:`True` on success.",
+ "description": "Use this method to clear the list of pinned messages in a chat. In private chats and channel direct messages chats, no additional rights are required to unpin all pinned messages. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin all pinned messages in groups and channels respectively. Returns True on success.",
+ "html_description": "Use this method to clear the list of pinned messages in a chat. In private chats and channel direct messages chats, no additional rights are required to unpin all pinned messages. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin all pinned messages in groups and channels respectively. Returns True on success.
",
+ "rst_description": "Use this method to clear the list of pinned messages in a chat. In private chats and channel direct messages chats, no additional rights are required to unpin all pinned messages. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin all pinned messages in groups and channels respectively. Returns :code:`True` on success.",
"annotations": [
{
"type": "Integer or String",
@@ -10643,9 +14736,9 @@
{
"type": "Integer or String",
"required": true,
- "description": "Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)",
- "html_description": "Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) | ",
- "rst_description": "Unique identifier for the target chat or username of the target supergroup or channel (in the format :code:`@channelusername`)\n",
+ "description": "Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername). Channel direct messages chats aren't supported; leave the corresponding channel instead.",
+ "html_description": "Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername). Channel direct messages chats aren't supported; leave the corresponding channel instead. | ",
+ "rst_description": "Unique identifier for the target chat or username of the target supergroup or channel (in the format :code:`@channelusername`). Channel direct messages chats aren't supported; leave the corresponding channel instead.\n",
"name": "chat_id"
}
],
@@ -10787,9 +14880,9 @@
{
"anchor": "createforumtopic",
"name": "createForumTopic",
- "description": "Use this method to create a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns information about the created topic as a ForumTopic object.",
- "html_description": "Use this method to create a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns information about the created topic as a ForumTopic object.
",
- "rst_description": "Use this method to create a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights. Returns information about the created topic as a :class:`aiogram.types.forum_topic.ForumTopic` object.",
+ "description": "Use this method to create a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator right. Returns information about the created topic as a ForumTopic object.",
+ "html_description": "Use this method to create a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator right. Returns information about the created topic as a ForumTopic object.
",
+ "rst_description": "Use this method to create a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator right. Returns information about the created topic as a :class:`aiogram.types.forum_topic.ForumTopic` object.",
"annotations": [
{
"type": "Integer or String",
@@ -10829,9 +14922,9 @@
{
"anchor": "editforumtopic",
"name": "editForumTopic",
- "description": "Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.",
- "html_description": "Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
",
- "rst_description": "Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have *can_manage_topics* administrator rights, unless it is the creator of the topic. Returns :code:`True` on success.",
+ "description": "Use this method to edit name and icon of a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.",
+ "html_description": "Use this method to edit name and icon of a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
",
+ "rst_description": "Use this method to edit name and icon of a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights, unless it is the creator of the topic. Returns :code:`True` on success.",
"annotations": [
{
"type": "Integer or String",
@@ -10923,9 +15016,9 @@
{
"anchor": "deleteforumtopic",
"name": "deleteForumTopic",
- "description": "Use this method to delete a forum topic along with all its messages in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success.",
- "html_description": "Use this method to delete a forum topic along with all its messages in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success.
",
- "rst_description": "Use this method to delete a forum topic along with all its messages in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_delete_messages* administrator rights. Returns :code:`True` on success.",
+ "description": "Use this method to delete a forum topic along with all its messages in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success.",
+ "html_description": "Use this method to delete a forum topic along with all its messages in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success.
",
+ "rst_description": "Use this method to delete a forum topic along with all its messages in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the *can_delete_messages* administrator rights. Returns :code:`True` on success.",
"annotations": [
{
"type": "Integer or String",
@@ -10949,9 +15042,9 @@
{
"anchor": "unpinallforumtopicmessages",
"name": "unpinAllForumTopicMessages",
- "description": "Use this method to clear the list of pinned messages in a forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.",
- "html_description": "Use this method to clear the list of pinned messages in a forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.
",
- "rst_description": "Use this method to clear the list of pinned messages in a forum topic. The bot must be an administrator in the chat for this to work and must have the *can_pin_messages* administrator right in the supergroup. Returns :code:`True` on success.",
+ "description": "Use this method to clear the list of pinned messages in a forum topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.",
+ "html_description": "Use this method to clear the list of pinned messages in a forum topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.
",
+ "rst_description": "Use this method to clear the list of pinned messages in a forum topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the *can_pin_messages* administrator right in the supergroup. Returns :code:`True` on success.",
"annotations": [
{
"type": "Integer or String",
@@ -10975,9 +15068,9 @@
{
"anchor": "editgeneralforumtopic",
"name": "editGeneralForumTopic",
- "description": "Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success.",
- "html_description": "Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success.
",
- "rst_description": "Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have *can_manage_topics* administrator rights. Returns :code:`True` on success.",
+ "description": "Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.",
+ "html_description": "Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
",
+ "rst_description": "Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights. Returns :code:`True` on success.",
"annotations": [
{
"type": "Integer or String",
@@ -11182,6 +15275,42 @@
],
"category": "methods"
},
+ {
+ "anchor": "getmanagedbottoken",
+ "name": "getManagedBotToken",
+ "description": "Use this method to get the token of a managed bot. Returns the token as String on success.",
+ "html_description": "Use this method to get the token of a managed bot. Returns the token as String on success.
",
+ "rst_description": "Use this method to get the token of a managed bot. Returns the token as *String* on success.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "User identifier of the managed bot whose token will be returned",
+ "html_description": "User identifier of the managed bot whose token will be returned | ",
+ "rst_description": "User identifier of the managed bot whose token will be returned\n",
+ "name": "user_id"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "replacemanagedbottoken",
+ "name": "replaceManagedBotToken",
+ "description": "Use this method to revoke the current token of a managed bot and generate a new one. Returns the new token as String on success.",
+ "html_description": "Use this method to revoke the current token of a managed bot and generate a new one. Returns the new token as String on success.
",
+ "rst_description": "Use this method to revoke the current token of a managed bot and generate a new one. Returns the new token as *String* on success.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "User identifier of the managed bot whose token will be replaced",
+ "html_description": "User identifier of the managed bot whose token will be replaced | ",
+ "rst_description": "User identifier of the managed bot whose token will be replaced\n",
+ "name": "user_id"
+ }
+ ],
+ "category": "methods"
+ },
{
"anchor": "setmycommands",
"name": "setMyCommands",
@@ -11400,6 +15529,33 @@
],
"category": "methods"
},
+ {
+ "anchor": "setmyprofilephoto",
+ "name": "setMyProfilePhoto",
+ "description": "Changes the profile photo of the bot. Returns True on success.",
+ "html_description": "Changes the profile photo of the bot. Returns True on success.
",
+ "rst_description": "Changes the profile photo of the bot. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "InputProfilePhoto",
+ "required": true,
+ "description": "The new profile photo to set",
+ "html_description": "The new profile photo to set | ",
+ "rst_description": "The new profile photo to set\n",
+ "name": "photo"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "removemyprofilephoto",
+ "name": "removeMyProfilePhoto",
+ "description": "Removes the profile photo of the bot. Requires no parameters. Returns True on success.",
+ "html_description": "Removes the profile photo of the bot. Requires no parameters. Returns True on success.
",
+ "rst_description": "Removes the profile photo of the bot. Requires no parameters. Returns :code:`True` on success.",
+ "annotations": [],
+ "category": "methods"
+ },
{
"anchor": "setchatmenubutton",
"name": "setChatMenuButton",
@@ -11487,6 +15643,1241 @@
}
],
"category": "methods"
+ },
+ {
+ "anchor": "getavailablegifts",
+ "name": "getAvailableGifts",
+ "description": "Returns the list of gifts that can be sent by the bot to users and channel chats. Requires no parameters. Returns a Gifts object.",
+ "html_description": "Returns the list of gifts that can be sent by the bot to users and channel chats. Requires no parameters. Returns a Gifts object.
",
+ "rst_description": "Returns the list of gifts that can be sent by the bot to users and channel chats. Requires no parameters. Returns a :class:`aiogram.types.gifts.Gifts` object.",
+ "annotations": [],
+ "category": "methods"
+ },
+ {
+ "anchor": "sendgift",
+ "name": "sendGift",
+ "description": "Sends a gift to the given user or channel chat. The gift can't be converted to Telegram Stars by the receiver. Returns True on success.",
+ "html_description": "Sends a gift to the given user or channel chat. The gift can't be converted to Telegram Stars by the receiver. Returns True on success.
",
+ "rst_description": "Sends a gift to the given user or channel chat. The gift can't be converted to Telegram Stars by the receiver. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Required if chat_id is not specified. Unique identifier of the target user who will receive the gift.",
+ "html_description": "Required if chat_id is not specified. Unique identifier of the target user who will receive the gift. | ",
+ "rst_description": "Required if *chat_id* is not specified. Unique identifier of the target user who will receive the gift.\n",
+ "name": "user_id"
+ },
+ {
+ "type": "Integer or String",
+ "required": false,
+ "description": "Required if user_id is not specified. Unique identifier for the chat or username of the channel (in the format @channelusername) that will receive the gift.",
+ "html_description": "Required if user_id is not specified. Unique identifier for the chat or username of the channel (in the format @channelusername) that will receive the gift. | ",
+ "rst_description": "Required if *user_id* is not specified. Unique identifier for the chat or username of the channel (in the format :code:`@channelusername`) that will receive the gift.\n",
+ "name": "chat_id"
+ },
+ {
+ "type": "String",
+ "required": true,
+ "description": "Identifier of the gift; limited gifts can't be sent to channel chats",
+ "html_description": "Identifier of the gift; limited gifts can't be sent to channel chats | ",
+ "rst_description": "Identifier of the gift; limited gifts can't be sent to channel chats\n",
+ "name": "gift_id"
+ },
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to pay for the gift upgrade from the bot's balance, thereby making the upgrade free for the receiver",
+ "html_description": "Pass True to pay for the gift upgrade from the bot's balance, thereby making the upgrade free for the receiver | ",
+ "rst_description": "Pass :code:`True` to pay for the gift upgrade from the bot's balance, thereby making the upgrade free for the receiver\n",
+ "name": "pay_for_upgrade"
+ },
+ {
+ "type": "String",
+ "required": false,
+ "description": "Text that will be shown along with the gift; 0-128 characters",
+ "html_description": "Text that will be shown along with the gift; 0-128 characters | ",
+ "rst_description": "Text that will be shown along with the gift; 0-128 characters\n",
+ "name": "text"
+ },
+ {
+ "type": "String",
+ "required": false,
+ "description": "Mode for parsing entities in the text. See formatting options for more details. Entities other than 'bold', 'italic', 'underline', 'strikethrough', 'spoiler', 'custom_emoji', and 'date_time' are ignored.",
+ "html_description": "Mode for parsing entities in the text. See formatting options for more details. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored. | ",
+ "rst_description": "Mode for parsing entities in the text. See `formatting options `_ for more details. Entities other than 'bold', 'italic', 'underline', 'strikethrough', 'spoiler', 'custom_emoji', and 'date_time' are ignored.\n",
+ "name": "text_parse_mode"
+ },
+ {
+ "type": "Array of MessageEntity",
+ "required": false,
+ "description": "A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of text_parse_mode. Entities other than 'bold', 'italic', 'underline', 'strikethrough', 'spoiler', 'custom_emoji', and 'date_time' are ignored.",
+ "html_description": "A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of text_parse_mode. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored. | ",
+ "rst_description": "A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of *text_parse_mode*. Entities other than 'bold', 'italic', 'underline', 'strikethrough', 'spoiler', 'custom_emoji', and 'date_time' are ignored.\n",
+ "name": "text_entities"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "giftpremiumsubscription",
+ "name": "giftPremiumSubscription",
+ "description": "Gifts a Telegram Premium subscription to the given user. Returns True on success.",
+ "html_description": "Gifts a Telegram Premium subscription to the given user. Returns True on success.
",
+ "rst_description": "Gifts a Telegram Premium subscription to the given user. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "Unique identifier of the target user who will receive a Telegram Premium subscription",
+ "html_description": "Unique identifier of the target user who will receive a Telegram Premium subscription | ",
+ "rst_description": "Unique identifier of the target user who will receive a Telegram Premium subscription\n",
+ "name": "user_id"
+ },
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "Number of months the Telegram Premium subscription will be active for the user; must be one of 3, 6, or 12",
+ "html_description": "Number of months the Telegram Premium subscription will be active for the user; must be one of 3, 6, or 12 | ",
+ "rst_description": "Number of months the Telegram Premium subscription will be active for the user; must be one of 3, 6, or 12\n",
+ "name": "month_count"
+ },
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "Number of Telegram Stars to pay for the Telegram Premium subscription; must be 1000 for 3 months, 1500 for 6 months, and 2500 for 12 months",
+ "html_description": "Number of Telegram Stars to pay for the Telegram Premium subscription; must be 1000 for 3 months, 1500 for 6 months, and 2500 for 12 months | ",
+ "rst_description": "Number of Telegram Stars to pay for the Telegram Premium subscription; must be 1000 for 3 months, 1500 for 6 months, and 2500 for 12 months\n",
+ "name": "star_count"
+ },
+ {
+ "type": "String",
+ "required": false,
+ "description": "Text that will be shown along with the service message about the subscription; 0-128 characters",
+ "html_description": "Text that will be shown along with the service message about the subscription; 0-128 characters | ",
+ "rst_description": "Text that will be shown along with the service message about the subscription; 0-128 characters\n",
+ "name": "text"
+ },
+ {
+ "type": "String",
+ "required": false,
+ "description": "Mode for parsing entities in the text. See formatting options for more details. Entities other than 'bold', 'italic', 'underline', 'strikethrough', 'spoiler', 'custom_emoji', and 'date_time' are ignored.",
+ "html_description": "Mode for parsing entities in the text. See formatting options for more details. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored. | ",
+ "rst_description": "Mode for parsing entities in the text. See `formatting options `_ for more details. Entities other than 'bold', 'italic', 'underline', 'strikethrough', 'spoiler', 'custom_emoji', and 'date_time' are ignored.\n",
+ "name": "text_parse_mode"
+ },
+ {
+ "type": "Array of MessageEntity",
+ "required": false,
+ "description": "A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of text_parse_mode. Entities other than 'bold', 'italic', 'underline', 'strikethrough', 'spoiler', 'custom_emoji', and 'date_time' are ignored.",
+ "html_description": "A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of text_parse_mode. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored. | ",
+ "rst_description": "A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of *text_parse_mode*. Entities other than 'bold', 'italic', 'underline', 'strikethrough', 'spoiler', 'custom_emoji', and 'date_time' are ignored.\n",
+ "name": "text_entities"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "verifyuser",
+ "name": "verifyUser",
+ "description": "Verifies a user on behalf of the organization which is represented by the bot. Returns True on success.",
+ "html_description": "Verifies a user on behalf of the organization which is represented by the bot. Returns True on success.
",
+ "rst_description": "Verifies a user `on behalf of the organization `_ which is represented by the bot. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "Unique identifier of the target user",
+ "html_description": "Unique identifier of the target user | ",
+ "rst_description": "Unique identifier of the target user\n",
+ "name": "user_id"
+ },
+ {
+ "type": "String",
+ "required": false,
+ "description": "Custom description for the verification; 0-70 characters. Must be empty if the organization isn't allowed to provide a custom verification description.",
+ "html_description": "Custom description for the verification; 0-70 characters. Must be empty if the organization isn't allowed to provide a custom verification description. | ",
+ "rst_description": "Custom description for the verification; 0-70 characters. Must be empty if the organization isn't allowed to provide a custom verification description.\n",
+ "name": "custom_description"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "verifychat",
+ "name": "verifyChat",
+ "description": "Verifies a chat on behalf of the organization which is represented by the bot. Returns True on success.",
+ "html_description": "Verifies a chat on behalf of the organization which is represented by the bot. Returns True on success.
",
+ "rst_description": "Verifies a chat `on behalf of the organization `_ which is represented by the bot. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "Integer or String",
+ "required": true,
+ "description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername). Channel direct messages chats can't be verified.",
+ "html_description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername). Channel direct messages chats can't be verified. | ",
+ "rst_description": "Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`). Channel direct messages chats can't be verified.\n",
+ "name": "chat_id"
+ },
+ {
+ "type": "String",
+ "required": false,
+ "description": "Custom description for the verification; 0-70 characters. Must be empty if the organization isn't allowed to provide a custom verification description.",
+ "html_description": "Custom description for the verification; 0-70 characters. Must be empty if the organization isn't allowed to provide a custom verification description. | ",
+ "rst_description": "Custom description for the verification; 0-70 characters. Must be empty if the organization isn't allowed to provide a custom verification description.\n",
+ "name": "custom_description"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "removeuserverification",
+ "name": "removeUserVerification",
+ "description": "Removes verification from a user who is currently verified on behalf of the organization represented by the bot. Returns True on success.",
+ "html_description": "Removes verification from a user who is currently verified on behalf of the organization represented by the bot. Returns True on success.
",
+ "rst_description": "Removes verification from a user who is currently verified `on behalf of the organization `_ represented by the bot. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "Unique identifier of the target user",
+ "html_description": "Unique identifier of the target user | ",
+ "rst_description": "Unique identifier of the target user\n",
+ "name": "user_id"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "removechatverification",
+ "name": "removeChatVerification",
+ "description": "Removes verification from a chat that is currently verified on behalf of the organization represented by the bot. Returns True on success.",
+ "html_description": "Removes verification from a chat that is currently verified on behalf of the organization represented by the bot. Returns True on success.
",
+ "rst_description": "Removes verification from a chat that is currently verified `on behalf of the organization `_ represented by the bot. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "Integer or String",
+ "required": true,
+ "description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
+ "html_description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ",
+ "rst_description": "Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n",
+ "name": "chat_id"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "readbusinessmessage",
+ "name": "readBusinessMessage",
+ "description": "Marks incoming message as read on behalf of a business account. Requires the can_read_messages business bot right. Returns True on success.",
+ "html_description": "Marks incoming message as read on behalf of a business account. Requires the can_read_messages business bot right. Returns True on success.
",
+ "rst_description": "Marks incoming message as read on behalf of a business account. Requires the *can_read_messages* business bot right. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "String",
+ "required": true,
+ "description": "Unique identifier of the business connection on behalf of which to read the message",
+ "html_description": "Unique identifier of the business connection on behalf of which to read the message | ",
+ "rst_description": "Unique identifier of the business connection on behalf of which to read the message\n",
+ "name": "business_connection_id"
+ },
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "Unique identifier of the chat in which the message was received. The chat must have been active in the last 24 hours.",
+ "html_description": "Unique identifier of the chat in which the message was received. The chat must have been active in the last 24 hours. | ",
+ "rst_description": "Unique identifier of the chat in which the message was received. The chat must have been active in the last 24 hours.\n",
+ "name": "chat_id"
+ },
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "Unique identifier of the message to mark as read",
+ "html_description": "Unique identifier of the message to mark as read | ",
+ "rst_description": "Unique identifier of the message to mark as read\n",
+ "name": "message_id"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "deletebusinessmessages",
+ "name": "deleteBusinessMessages",
+ "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": "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.
",
+ "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",
+ "required": true,
+ "description": "Unique identifier of the business connection on behalf of which to delete the messages",
+ "html_description": "Unique identifier of the business connection on behalf of which to delete the messages | ",
+ "rst_description": "Unique identifier of the business connection on behalf of which to delete the messages\n",
+ "name": "business_connection_id"
+ },
+ {
+ "type": "Array of Integer",
+ "required": true,
+ "description": "A JSON-serialized list of 1-100 identifiers of messages to delete. All messages must be from the same chat. See deleteMessage for limitations on which messages can be deleted",
+ "html_description": "A JSON-serialized list of 1-100 identifiers of messages to delete. All messages must be from the same chat. See deleteMessage for limitations on which messages can be deleted | ",
+ "rst_description": "A JSON-serialized list of 1-100 identifiers of messages to delete. All messages must be from the same chat. See :class:`aiogram.methods.delete_message.DeleteMessage` for limitations on which messages can be deleted\n",
+ "name": "message_ids"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "setbusinessaccountname",
+ "name": "setBusinessAccountName",
+ "description": "Changes the first and last name of a managed business account. Requires the can_change_name business bot right. Returns True on success.",
+ "html_description": "Changes the first and last name of a managed business account. Requires the can_change_name business bot right. Returns True on success.
",
+ "rst_description": "Changes the first and last name of a managed business account. Requires the *can_change_name* business bot right. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "String",
+ "required": true,
+ "description": "Unique identifier of the business connection",
+ "html_description": "Unique identifier of the business connection | ",
+ "rst_description": "Unique identifier of the business connection\n",
+ "name": "business_connection_id"
+ },
+ {
+ "type": "String",
+ "required": true,
+ "description": "The new value of the first name for the business account; 1-64 characters",
+ "html_description": "The new value of the first name for the business account; 1-64 characters | ",
+ "rst_description": "The new value of the first name for the business account; 1-64 characters\n",
+ "name": "first_name"
+ },
+ {
+ "type": "String",
+ "required": false,
+ "description": "The new value of the last name for the business account; 0-64 characters",
+ "html_description": "The new value of the last name for the business account; 0-64 characters | ",
+ "rst_description": "The new value of the last name for the business account; 0-64 characters\n",
+ "name": "last_name"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "setbusinessaccountusername",
+ "name": "setBusinessAccountUsername",
+ "description": "Changes the username of a managed business account. Requires the can_change_username business bot right. Returns True on success.",
+ "html_description": "Changes the username of a managed business account. Requires the can_change_username business bot right. Returns True on success.
",
+ "rst_description": "Changes the username of a managed business account. Requires the *can_change_username* business bot right. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "String",
+ "required": true,
+ "description": "Unique identifier of the business connection",
+ "html_description": "Unique identifier of the business connection | ",
+ "rst_description": "Unique identifier of the business connection\n",
+ "name": "business_connection_id"
+ },
+ {
+ "type": "String",
+ "required": false,
+ "description": "The new value of the username for the business account; 0-32 characters",
+ "html_description": "The new value of the username for the business account; 0-32 characters | ",
+ "rst_description": "The new value of the username for the business account; 0-32 characters\n",
+ "name": "username"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "setbusinessaccountbio",
+ "name": "setBusinessAccountBio",
+ "description": "Changes the bio of a managed business account. Requires the can_change_bio business bot right. Returns True on success.",
+ "html_description": "Changes the bio of a managed business account. Requires the can_change_bio business bot right. Returns True on success.
",
+ "rst_description": "Changes the bio of a managed business account. Requires the *can_change_bio* business bot right. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "String",
+ "required": true,
+ "description": "Unique identifier of the business connection",
+ "html_description": "Unique identifier of the business connection | ",
+ "rst_description": "Unique identifier of the business connection\n",
+ "name": "business_connection_id"
+ },
+ {
+ "type": "String",
+ "required": false,
+ "description": "The new value of the bio for the business account; 0-140 characters",
+ "html_description": "The new value of the bio for the business account; 0-140 characters | ",
+ "rst_description": "The new value of the bio for the business account; 0-140 characters\n",
+ "name": "bio"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "setbusinessaccountprofilephoto",
+ "name": "setBusinessAccountProfilePhoto",
+ "description": "Changes the profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.",
+ "html_description": "Changes the profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.
",
+ "rst_description": "Changes the profile photo of a managed business account. Requires the *can_edit_profile_photo* business bot right. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "String",
+ "required": true,
+ "description": "Unique identifier of the business connection",
+ "html_description": "Unique identifier of the business connection | ",
+ "rst_description": "Unique identifier of the business connection\n",
+ "name": "business_connection_id"
+ },
+ {
+ "type": "InputProfilePhoto",
+ "required": true,
+ "description": "The new profile photo to set",
+ "html_description": "The new profile photo to set | ",
+ "rst_description": "The new profile photo to set\n",
+ "name": "photo"
+ },
+ {
+ "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": "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. | ",
+ "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"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "removebusinessaccountprofilephoto",
+ "name": "removeBusinessAccountProfilePhoto",
+ "description": "Removes the current profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.",
+ "html_description": "Removes the current profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.
",
+ "rst_description": "Removes the current profile photo of a managed business account. Requires the *can_edit_profile_photo* business bot right. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "String",
+ "required": true,
+ "description": "Unique identifier of the business connection",
+ "html_description": "Unique identifier of the business connection | ",
+ "rst_description": "Unique identifier of the business connection\n",
+ "name": "business_connection_id"
+ },
+ {
+ "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": "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. | ",
+ "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"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "setbusinessaccountgiftsettings",
+ "name": "setBusinessAccountGiftSettings",
+ "description": "Changes the privacy settings pertaining to incoming gifts in a managed business account. Requires the can_change_gift_settings business bot right. Returns True on success.",
+ "html_description": "Changes the privacy settings pertaining to incoming gifts in a managed business account. Requires the can_change_gift_settings business bot right. Returns True on success.
",
+ "rst_description": "Changes the privacy settings pertaining to incoming gifts in a managed business account. Requires the *can_change_gift_settings* business bot right. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "String",
+ "required": true,
+ "description": "Unique identifier of the business connection",
+ "html_description": "Unique identifier of the business connection | ",
+ "rst_description": "Unique identifier of the business connection\n",
+ "name": "business_connection_id"
+ },
+ {
+ "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": "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 | ",
+ "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"
+ },
+ {
+ "type": "AcceptedGiftTypes",
+ "required": true,
+ "description": "Types of gifts accepted by the business account",
+ "html_description": "Types of gifts accepted by the business account | ",
+ "rst_description": "Types of gifts accepted by the business account\n",
+ "name": "accepted_gift_types"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "getbusinessaccountstarbalance",
+ "name": "getBusinessAccountStarBalance",
+ "description": "Returns the amount of Telegram Stars owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns StarAmount on success.",
+ "html_description": "Returns the amount of Telegram Stars owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns StarAmount on success.
",
+ "rst_description": "Returns the amount of Telegram Stars owned by a managed business account. Requires the *can_view_gifts_and_stars* business bot right. Returns :class:`aiogram.types.star_amount.StarAmount` on success.",
+ "annotations": [
+ {
+ "type": "String",
+ "required": true,
+ "description": "Unique identifier of the business connection",
+ "html_description": "Unique identifier of the business connection | ",
+ "rst_description": "Unique identifier of the business connection\n",
+ "name": "business_connection_id"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "transferbusinessaccountstars",
+ "name": "transferBusinessAccountStars",
+ "description": "Transfers Telegram Stars from the business account balance to the bot's balance. Requires the can_transfer_stars business bot right. Returns True on success.",
+ "html_description": "Transfers Telegram Stars from the business account balance to the bot's balance. Requires the can_transfer_stars business bot right. Returns True on success.
",
+ "rst_description": "Transfers Telegram Stars from the business account balance to the bot's balance. Requires the *can_transfer_stars* business bot right. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "String",
+ "required": true,
+ "description": "Unique identifier of the business connection",
+ "html_description": "Unique identifier of the business connection | ",
+ "rst_description": "Unique identifier of the business connection\n",
+ "name": "business_connection_id"
+ },
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "Number of Telegram Stars to transfer; 1-10000",
+ "html_description": "Number of Telegram Stars to transfer; 1-10000 | ",
+ "rst_description": "Number of Telegram Stars to transfer; 1-10000\n",
+ "name": "star_count"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "getbusinessaccountgifts",
+ "name": "getBusinessAccountGifts",
+ "description": "Returns the gifts received and owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns OwnedGifts on success.",
+ "html_description": "Returns the gifts received and owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns OwnedGifts on success.
",
+ "rst_description": "Returns the gifts received and owned by a managed business account. Requires the *can_view_gifts_and_stars* business bot right. Returns :class:`aiogram.types.owned_gifts.OwnedGifts` on success.",
+ "annotations": [
+ {
+ "type": "String",
+ "required": true,
+ "description": "Unique identifier of the business connection",
+ "html_description": "Unique identifier of the business connection | ",
+ "rst_description": "Unique identifier of the business connection\n",
+ "name": "business_connection_id"
+ },
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to exclude gifts that aren't saved to the account's profile page",
+ "html_description": "Pass True to exclude gifts that aren't saved to the account's profile page | ",
+ "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": "Pass True to exclude gifts that are saved to the account's profile page | ",
+ "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": "Pass True to exclude gifts that can be purchased an unlimited number of times | ",
+ "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 and can be upgraded to unique",
+ "html_description": "Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique | ",
+ "rst_description": "Pass :code:`True` to exclude gifts that can be purchased a limited number of times and can be upgraded to unique\n",
+ "name": "exclude_limited_upgradable"
+ },
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique",
+ "html_description": "Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique | ",
+ "rst_description": "Pass :code:`True` to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique\n",
+ "name": "exclude_limited_non_upgradable"
+ },
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to exclude unique gifts",
+ "html_description": "Pass True to exclude unique gifts | ",
+ "rst_description": "Pass :code:`True` to exclude unique gifts\n",
+ "name": "exclude_unique"
+ },
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram",
+ "html_description": "Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram | ",
+ "rst_description": "Pass :code:`True` to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram\n",
+ "name": "exclude_from_blockchain"
+ },
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to sort results by gift price instead of send date. Sorting is applied before pagination.",
+ "html_description": "Pass True to sort results by gift price instead of send date. Sorting is applied before pagination. | ",
+ "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"
+ },
+ {
+ "type": "String",
+ "required": false,
+ "description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results",
+ "html_description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results | ",
+ "rst_description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results\n",
+ "name": "offset"
+ },
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "The maximum number of gifts to be returned; 1-100. Defaults to 100",
+ "html_description": "The maximum number of gifts to be returned; 1-100. Defaults to 100 | ",
+ "rst_description": "The maximum number of gifts to be returned; 1-100. Defaults to 100\n",
+ "name": "limit"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "getusergifts",
+ "name": "getUserGifts",
+ "description": "Returns the gifts owned and hosted by a user. Returns OwnedGifts on success.",
+ "html_description": "Returns the gifts owned and hosted by a user. Returns OwnedGifts on success.
",
+ "rst_description": "Returns the gifts owned and hosted by a user. Returns :class:`aiogram.types.owned_gifts.OwnedGifts` on success.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "Unique identifier of the user",
+ "html_description": "Unique identifier of the user | ",
+ "rst_description": "Unique identifier of the user\n",
+ "name": "user_id"
+ },
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to exclude gifts that can be purchased an unlimited number of times",
+ "html_description": "Pass True to exclude gifts that can be purchased an unlimited number of times | ",
+ "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 and can be upgraded to unique",
+ "html_description": "Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique | ",
+ "rst_description": "Pass :code:`True` to exclude gifts that can be purchased a limited number of times and can be upgraded to unique\n",
+ "name": "exclude_limited_upgradable"
+ },
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique",
+ "html_description": "Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique | ",
+ "rst_description": "Pass :code:`True` to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique\n",
+ "name": "exclude_limited_non_upgradable"
+ },
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram",
+ "html_description": "Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram | ",
+ "rst_description": "Pass :code:`True` to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram\n",
+ "name": "exclude_from_blockchain"
+ },
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to exclude unique gifts",
+ "html_description": "Pass True to exclude unique gifts | ",
+ "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": "Pass True to sort results by gift price instead of send date. Sorting is applied before pagination. | ",
+ "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"
+ },
+ {
+ "type": "String",
+ "required": false,
+ "description": "Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results",
+ "html_description": "Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results | ",
+ "rst_description": "Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results\n",
+ "name": "offset"
+ },
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "The maximum number of gifts to be returned; 1-100. Defaults to 100",
+ "html_description": "The maximum number of gifts to be returned; 1-100. Defaults to 100 | ",
+ "rst_description": "The maximum number of gifts to be returned; 1-100. Defaults to 100\n",
+ "name": "limit"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "getchatgifts",
+ "name": "getChatGifts",
+ "description": "Returns the gifts owned by a chat. Returns OwnedGifts on success.",
+ "html_description": "Returns the gifts owned by a chat. Returns OwnedGifts on success.
",
+ "rst_description": "Returns the gifts owned by a chat. Returns :class:`aiogram.types.owned_gifts.OwnedGifts` on success.",
+ "annotations": [
+ {
+ "type": "Integer or String",
+ "required": true,
+ "description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
+ "html_description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ",
+ "rst_description": "Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n",
+ "name": "chat_id"
+ },
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to exclude gifts that aren't saved to the chat's profile page. Always True, unless the bot has the can_post_messages administrator right in the channel.",
+ "html_description": "Pass True to exclude gifts that aren't saved to the chat's profile page. Always True, unless the bot has the can_post_messages administrator right in the channel. | ",
+ "rst_description": "Pass :code:`True` to exclude gifts that aren't saved to the chat's profile page. Always :code:`True`, unless the bot has the *can_post_messages* administrator right in the channel.\n",
+ "name": "exclude_unsaved"
+ },
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to exclude gifts that are saved to the chat's profile page. Always False, unless the bot has the can_post_messages administrator right in the channel.",
+ "html_description": "Pass True to exclude gifts that are saved to the chat's profile page. Always False, unless the bot has the can_post_messages administrator right in the channel. | ",
+ "rst_description": "Pass :code:`True` to exclude gifts that are saved to the chat's profile page. Always :code:`False`, unless the bot has the *can_post_messages* administrator right in the channel.\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": "Pass True to exclude gifts that can be purchased an unlimited number of times | ",
+ "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 and can be upgraded to unique",
+ "html_description": "Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique | ",
+ "rst_description": "Pass :code:`True` to exclude gifts that can be purchased a limited number of times and can be upgraded to unique\n",
+ "name": "exclude_limited_upgradable"
+ },
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique",
+ "html_description": "Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique | ",
+ "rst_description": "Pass :code:`True` to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique\n",
+ "name": "exclude_limited_non_upgradable"
+ },
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram",
+ "html_description": "Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram | ",
+ "rst_description": "Pass :code:`True` to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram\n",
+ "name": "exclude_from_blockchain"
+ },
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to exclude unique gifts",
+ "html_description": "Pass True to exclude unique gifts | ",
+ "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": "Pass True to sort results by gift price instead of send date. Sorting is applied before pagination. | ",
+ "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"
+ },
+ {
+ "type": "String",
+ "required": false,
+ "description": "Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results",
+ "html_description": "Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results | ",
+ "rst_description": "Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results\n",
+ "name": "offset"
+ },
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "The maximum number of gifts to be returned; 1-100. Defaults to 100",
+ "html_description": "The maximum number of gifts to be returned; 1-100. Defaults to 100 | ",
+ "rst_description": "The maximum number of gifts to be returned; 1-100. Defaults to 100\n",
+ "name": "limit"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "convertgifttostars",
+ "name": "convertGiftToStars",
+ "description": "Converts a given regular gift to Telegram Stars. Requires the can_convert_gifts_to_stars business bot right. Returns True on success.",
+ "html_description": "Converts a given regular gift to Telegram Stars. Requires the can_convert_gifts_to_stars business bot right. Returns True on success.
",
+ "rst_description": "Converts a given regular gift to Telegram Stars. Requires the *can_convert_gifts_to_stars* business bot right. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "String",
+ "required": true,
+ "description": "Unique identifier of the business connection",
+ "html_description": "Unique identifier of the business connection | ",
+ "rst_description": "Unique identifier of the business connection\n",
+ "name": "business_connection_id"
+ },
+ {
+ "type": "String",
+ "required": true,
+ "description": "Unique identifier of the regular gift that should be converted to Telegram Stars",
+ "html_description": "Unique identifier of the regular gift that should be converted to Telegram Stars | ",
+ "rst_description": "Unique identifier of the regular gift that should be converted to Telegram Stars\n",
+ "name": "owned_gift_id"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "upgradegift",
+ "name": "upgradeGift",
+ "description": "Upgrades a given regular gift to a unique gift. Requires the can_transfer_and_upgrade_gifts business bot right. Additionally requires the can_transfer_stars business bot right if the upgrade is paid. Returns True on success.",
+ "html_description": "Upgrades a given regular gift to a unique gift. Requires the can_transfer_and_upgrade_gifts business bot right. Additionally requires the can_transfer_stars business bot right if the upgrade is paid. Returns True on success.
",
+ "rst_description": "Upgrades a given regular gift to a unique gift. Requires the *can_transfer_and_upgrade_gifts* business bot right. Additionally requires the *can_transfer_stars* business bot right if the upgrade is paid. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "String",
+ "required": true,
+ "description": "Unique identifier of the business connection",
+ "html_description": "Unique identifier of the business connection | ",
+ "rst_description": "Unique identifier of the business connection\n",
+ "name": "business_connection_id"
+ },
+ {
+ "type": "String",
+ "required": true,
+ "description": "Unique identifier of the regular gift that should be upgraded to a unique one",
+ "html_description": "Unique identifier of the regular gift that should be upgraded to a unique one | ",
+ "rst_description": "Unique identifier of the regular gift that should be upgraded to a unique one\n",
+ "name": "owned_gift_id"
+ },
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to keep the original gift text, sender and receiver in the upgraded gift",
+ "html_description": "Pass True to keep the original gift text, sender and receiver in the upgraded gift | ",
+ "rst_description": "Pass :code:`True` to keep the original gift text, sender and receiver in the upgraded gift\n",
+ "name": "keep_original_details"
+ },
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "The amount of Telegram Stars that will be paid for the upgrade from the business account balance. If gift.prepaid_upgrade_star_count > 0, then pass 0, otherwise, the can_transfer_stars business bot right is required and gift.upgrade_star_count must be passed.",
+ "html_description": "The amount of Telegram Stars that will be paid for the upgrade from the business account balance. If gift.prepaid_upgrade_star_count > 0, then pass 0, otherwise, the can_transfer_stars business bot right is required and gift.upgrade_star_count must be passed. | ",
+ "rst_description": "The amount of Telegram Stars that will be paid for the upgrade from the business account balance. If :code:`gift.prepaid_upgrade_star_count > 0`, then pass 0, otherwise, the *can_transfer_stars* business bot right is required and :code:`gift.upgrade_star_count` must be passed.\n",
+ "name": "star_count"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "transfergift",
+ "name": "transferGift",
+ "description": "Transfers an owned unique gift to another user. Requires the can_transfer_and_upgrade_gifts business bot right. Requires can_transfer_stars business bot right if the transfer is paid. Returns True on success.",
+ "html_description": "Transfers an owned unique gift to another user. Requires the can_transfer_and_upgrade_gifts business bot right. Requires can_transfer_stars business bot right if the transfer is paid. Returns True on success.
",
+ "rst_description": "Transfers an owned unique gift to another user. Requires the *can_transfer_and_upgrade_gifts* business bot right. Requires *can_transfer_stars* business bot right if the transfer is paid. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "String",
+ "required": true,
+ "description": "Unique identifier of the business connection",
+ "html_description": "Unique identifier of the business connection | ",
+ "rst_description": "Unique identifier of the business connection\n",
+ "name": "business_connection_id"
+ },
+ {
+ "type": "String",
+ "required": true,
+ "description": "Unique identifier of the regular gift that should be transferred",
+ "html_description": "Unique identifier of the regular gift that should be transferred | ",
+ "rst_description": "Unique identifier of the regular gift that should be transferred\n",
+ "name": "owned_gift_id"
+ },
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "Unique identifier of the chat which will own the gift. The chat must be active in the last 24 hours.",
+ "html_description": "Unique identifier of the chat which will own the gift. The chat must be active in the last 24 hours. | ",
+ "rst_description": "Unique identifier of the chat which will own the gift. The chat must be active in the last 24 hours.\n",
+ "name": "new_owner_chat_id"
+ },
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "The amount of Telegram Stars that will be paid for the transfer from the business account balance. If positive, then the can_transfer_stars business bot right is required.",
+ "html_description": "The amount of Telegram Stars that will be paid for the transfer from the business account balance. If positive, then the can_transfer_stars business bot right is required. | ",
+ "rst_description": "The amount of Telegram Stars that will be paid for the transfer from the business account balance. If positive, then the *can_transfer_stars* business bot right is required.\n",
+ "name": "star_count"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "poststory",
+ "name": "postStory",
+ "description": "Posts a story on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success.",
+ "html_description": "Posts a story on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success.
",
+ "rst_description": "Posts a story on behalf of a managed business account. Requires the *can_manage_stories* business bot right. Returns :class:`aiogram.types.story.Story` on success.",
+ "annotations": [
+ {
+ "type": "String",
+ "required": true,
+ "description": "Unique identifier of the business connection",
+ "html_description": "Unique identifier of the business connection | ",
+ "rst_description": "Unique identifier of the business connection\n",
+ "name": "business_connection_id"
+ },
+ {
+ "type": "InputStoryContent",
+ "required": true,
+ "description": "Content of the story",
+ "html_description": "Content of the story | ",
+ "rst_description": "Content of the story\n",
+ "name": "content"
+ },
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "Period after which the story is moved to the archive, in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400",
+ "html_description": "Period after which the story is moved to the archive, in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400 | ",
+ "rst_description": "Period after which the story is moved to the archive, in seconds; must be one of :code:`6 * 3600`, :code:`12 * 3600`, :code:`86400`, or :code:`2 * 86400`\n",
+ "name": "active_period"
+ },
+ {
+ "type": "String",
+ "required": false,
+ "description": "Caption of the story, 0-2048 characters after entities parsing",
+ "html_description": "Caption of the story, 0-2048 characters after entities parsing | ",
+ "rst_description": "Caption of the story, 0-2048 characters after entities parsing\n",
+ "name": "caption"
+ },
+ {
+ "type": "String",
+ "required": false,
+ "description": "Mode for parsing entities in the story caption. See formatting options for more details.",
+ "html_description": "Mode for parsing entities in the story caption. See formatting options for more details. | ",
+ "rst_description": "Mode for parsing entities in the story caption. See `formatting options `_ for more details.\n",
+ "name": "parse_mode"
+ },
+ {
+ "type": "Array of MessageEntity",
+ "required": false,
+ "description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode",
+ "html_description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | ",
+ "rst_description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
+ "name": "caption_entities"
+ },
+ {
+ "type": "Array of StoryArea",
+ "required": false,
+ "description": "A JSON-serialized list of clickable areas to be shown on the story",
+ "html_description": "A JSON-serialized list of clickable areas to be shown on the story | ",
+ "rst_description": "A JSON-serialized list of clickable areas to be shown on the story\n",
+ "name": "areas"
+ },
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to keep the story accessible after it expires",
+ "html_description": "Pass True to keep the story accessible after it expires | ",
+ "rst_description": "Pass :code:`True` to keep the story accessible after it expires\n",
+ "name": "post_to_chat_page"
+ },
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True if the content of the story must be protected from forwarding and screenshotting",
+ "html_description": "Pass True if the content of the story must be protected from forwarding and screenshotting | ",
+ "rst_description": "Pass :code:`True` if the content of the story must be protected from forwarding and screenshotting\n",
+ "name": "protect_content"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "repoststory",
+ "name": "repostStory",
+ "description": "Reposts a story on behalf of a business account from another business account. Both business accounts must be managed by the same bot, and the story on the source account must have been posted (or reposted) by the bot. Requires the can_manage_stories business bot right for both business accounts. Returns Story on success.",
+ "html_description": "Reposts a story on behalf of a business account from another business account. Both business accounts must be managed by the same bot, and the story on the source account must have been posted (or reposted) by the bot. Requires the can_manage_stories business bot right for both business accounts. Returns Story on success.
",
+ "rst_description": "Reposts a story on behalf of a business account from another business account. Both business accounts must be managed by the same bot, and the story on the source account must have been posted (or reposted) by the bot. Requires the *can_manage_stories* business bot right for both business accounts. Returns :class:`aiogram.types.story.Story` on success.",
+ "annotations": [
+ {
+ "type": "String",
+ "required": true,
+ "description": "Unique identifier of the business connection",
+ "html_description": "Unique identifier of the business connection | ",
+ "rst_description": "Unique identifier of the business connection\n",
+ "name": "business_connection_id"
+ },
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "Unique identifier of the chat which posted the story that should be reposted",
+ "html_description": "Unique identifier of the chat which posted the story that should be reposted | ",
+ "rst_description": "Unique identifier of the chat which posted the story that should be reposted\n",
+ "name": "from_chat_id"
+ },
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "Unique identifier of the story that should be reposted",
+ "html_description": "Unique identifier of the story that should be reposted | ",
+ "rst_description": "Unique identifier of the story that should be reposted\n",
+ "name": "from_story_id"
+ },
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "Period after which the story is moved to the archive, in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400",
+ "html_description": "Period after which the story is moved to the archive, in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400 | ",
+ "rst_description": "Period after which the story is moved to the archive, in seconds; must be one of :code:`6 * 3600`, :code:`12 * 3600`, :code:`86400`, or :code:`2 * 86400`\n",
+ "name": "active_period"
+ },
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to keep the story accessible after it expires",
+ "html_description": "Pass True to keep the story accessible after it expires | ",
+ "rst_description": "Pass :code:`True` to keep the story accessible after it expires\n",
+ "name": "post_to_chat_page"
+ },
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True if the content of the story must be protected from forwarding and screenshotting",
+ "html_description": "Pass True if the content of the story must be protected from forwarding and screenshotting | ",
+ "rst_description": "Pass :code:`True` if the content of the story must be protected from forwarding and screenshotting\n",
+ "name": "protect_content"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "editstory",
+ "name": "editStory",
+ "description": "Edits a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success.",
+ "html_description": "Edits a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success.
",
+ "rst_description": "Edits a story previously posted by the bot on behalf of a managed business account. Requires the *can_manage_stories* business bot right. Returns :class:`aiogram.types.story.Story` on success.",
+ "annotations": [
+ {
+ "type": "String",
+ "required": true,
+ "description": "Unique identifier of the business connection",
+ "html_description": "Unique identifier of the business connection | ",
+ "rst_description": "Unique identifier of the business connection\n",
+ "name": "business_connection_id"
+ },
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "Unique identifier of the story to edit",
+ "html_description": "Unique identifier of the story to edit | ",
+ "rst_description": "Unique identifier of the story to edit\n",
+ "name": "story_id"
+ },
+ {
+ "type": "InputStoryContent",
+ "required": true,
+ "description": "Content of the story",
+ "html_description": "Content of the story | ",
+ "rst_description": "Content of the story\n",
+ "name": "content"
+ },
+ {
+ "type": "String",
+ "required": false,
+ "description": "Caption of the story, 0-2048 characters after entities parsing",
+ "html_description": "Caption of the story, 0-2048 characters after entities parsing | ",
+ "rst_description": "Caption of the story, 0-2048 characters after entities parsing\n",
+ "name": "caption"
+ },
+ {
+ "type": "String",
+ "required": false,
+ "description": "Mode for parsing entities in the story caption. See formatting options for more details.",
+ "html_description": "Mode for parsing entities in the story caption. See formatting options for more details. | ",
+ "rst_description": "Mode for parsing entities in the story caption. See `formatting options `_ for more details.\n",
+ "name": "parse_mode"
+ },
+ {
+ "type": "Array of MessageEntity",
+ "required": false,
+ "description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode",
+ "html_description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | ",
+ "rst_description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
+ "name": "caption_entities"
+ },
+ {
+ "type": "Array of StoryArea",
+ "required": false,
+ "description": "A JSON-serialized list of clickable areas to be shown on the story",
+ "html_description": "A JSON-serialized list of clickable areas to be shown on the story | ",
+ "rst_description": "A JSON-serialized list of clickable areas to be shown on the story\n",
+ "name": "areas"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "deletestory",
+ "name": "deleteStory",
+ "description": "Deletes a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns True on success.",
+ "html_description": "Deletes a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns True on success.
",
+ "rst_description": "Deletes a story previously posted by the bot on behalf of a managed business account. Requires the *can_manage_stories* business bot right. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "String",
+ "required": true,
+ "description": "Unique identifier of the business connection",
+ "html_description": "Unique identifier of the business connection | ",
+ "rst_description": "Unique identifier of the business connection\n",
+ "name": "business_connection_id"
+ },
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "Unique identifier of the story to delete",
+ "html_description": "Unique identifier of the story to delete | ",
+ "rst_description": "Unique identifier of the story to delete\n",
+ "name": "story_id"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "answerwebappquery",
+ "name": "answerWebAppQuery",
+ "description": "Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a SentWebAppMessage object is returned.",
+ "html_description": "Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a SentWebAppMessage object is returned.
",
+ "rst_description": "Use this method to set the result of an interaction with a `Web App `_ and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a :class:`aiogram.types.sent_web_app_message.SentWebAppMessage` object is returned.",
+ "annotations": [
+ {
+ "type": "String",
+ "required": true,
+ "description": "Unique identifier for the query to be answered",
+ "html_description": "Unique identifier for the query to be answered | ",
+ "rst_description": "Unique identifier for the query to be answered\n",
+ "name": "web_app_query_id"
+ },
+ {
+ "type": "InlineQueryResult",
+ "required": true,
+ "description": "A JSON-serialized object describing the message to be sent",
+ "html_description": "A JSON-serialized object describing the message to be sent | ",
+ "rst_description": "A JSON-serialized object describing the message to be sent\n",
+ "name": "result"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "savepreparedinlinemessage",
+ "name": "savePreparedInlineMessage",
+ "description": "Stores a message that can be sent by a user of a Mini App. Returns a PreparedInlineMessage object.",
+ "html_description": "Stores a message that can be sent by a user of a Mini App. Returns a PreparedInlineMessage object.
",
+ "rst_description": "Stores a message that can be sent by a user of a Mini App. Returns a :class:`aiogram.types.prepared_inline_message.PreparedInlineMessage` object.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "Unique identifier of the target user that can use the prepared message",
+ "html_description": "Unique identifier of the target user that can use the prepared message | ",
+ "rst_description": "Unique identifier of the target user that can use the prepared message\n",
+ "name": "user_id"
+ },
+ {
+ "type": "InlineQueryResult",
+ "required": true,
+ "description": "A JSON-serialized object describing the message to be sent",
+ "html_description": "A JSON-serialized object describing the message to be sent | ",
+ "rst_description": "A JSON-serialized object describing the message to be sent\n",
+ "name": "result"
+ },
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True if the message can be sent to private chats with users",
+ "html_description": "Pass True if the message can be sent to private chats with users | ",
+ "rst_description": "Pass :code:`True` if the message can be sent to private chats with users\n",
+ "name": "allow_user_chats"
+ },
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True if the message can be sent to private chats with bots",
+ "html_description": "Pass True if the message can be sent to private chats with bots | ",
+ "rst_description": "Pass :code:`True` if the message can be sent to private chats with bots\n",
+ "name": "allow_bot_chats"
+ },
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True if the message can be sent to group and supergroup chats",
+ "html_description": "Pass True if the message can be sent to group and supergroup chats | ",
+ "rst_description": "Pass :code:`True` if the message can be sent to group and supergroup chats\n",
+ "name": "allow_group_chats"
+ },
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True if the message can be sent to channel chats",
+ "html_description": "Pass True if the message can be sent to channel chats | ",
+ "rst_description": "Pass :code:`True` if the message can be sent to channel chats\n",
+ "name": "allow_channel_chats"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "savepreparedkeyboardbutton",
+ "name": "savePreparedKeyboardButton",
+ "description": "Stores a keyboard button that can be used by a user within a Mini App. Returns a PreparedKeyboardButton object.",
+ "html_description": "Stores a keyboard button that can be used by a user within a Mini App. Returns a PreparedKeyboardButton object.
",
+ "rst_description": "Stores a keyboard button that can be used by a user within a Mini App. Returns a :class:`aiogram.types.prepared_keyboard_button.PreparedKeyboardButton` object.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "Unique identifier of the target user that can use the button",
+ "html_description": "Unique identifier of the target user that can use the button | ",
+ "rst_description": "Unique identifier of the target user that can use the button\n",
+ "name": "user_id"
+ },
+ {
+ "type": "KeyboardButton",
+ "required": true,
+ "description": "A JSON-serialized object describing the button to be saved. The button must be of the type request_users, request_chat, or request_managed_bot",
+ "html_description": "A JSON-serialized object describing the button to be saved. The button must be of the type request_users, request_chat, or request_managed_bot | ",
+ "rst_description": "A JSON-serialized object describing the button to be saved. The button must be of the type *request_users*, *request_chat*, or *request_managed_bot*\n",
+ "name": "button"
+ }
+ ],
+ "category": "methods"
}
],
"description": "All methods in the Bot API are case-insensitive. We support GET and POST HTTP methods. Use either URL query string or application/json or application/x-www-form-urlencoded or multipart/form-data for passing parameters in Bot API requests.\nOn successful call, a JSON-object containing the result will be returned."
@@ -11662,9 +17053,9 @@
{
"anchor": "editmessagemedia",
"name": "editMessageMedia",
- "description": "Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.",
- "html_description": "Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.
",
- "rst_description": "Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited :class:`aiogram.types.message.Message` is returned, otherwise :code:`True` is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within **48 hours** from the time they were sent.",
+ "description": "Use this method to edit animation, audio, document, photo, or video messages, or to add media to text messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.",
+ "html_description": "Use this method to edit animation, audio, document, photo, or video messages, or to add media to text messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.
",
+ "rst_description": "Use this method to edit animation, audio, document, photo, or video messages, or to add media to text messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited :class:`aiogram.types.message.Message` is returned, otherwise :code:`True` is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within **48 hours** from the time they were sent.",
"annotations": [
{
"type": "String",
@@ -11865,6 +17256,56 @@
],
"category": "methods"
},
+ {
+ "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": "Use this method to edit a checklist on behalf of a connected business account. On success, the edited Message is returned.
",
+ "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": "Unique identifier of the business connection on behalf of which the message will be sent | ",
+ "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": "Unique identifier for the target chat | ",
+ "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": "Unique identifier for the target message | ",
+ "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": "A JSON-serialized object for the new checklist | ",
+ "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": "A JSON-serialized object for the new inline keyboard for the message | ",
+ "rst_description": "A JSON-serialized object for the new `inline keyboard `_ for the message\n",
+ "name": "reply_markup"
+ }
+ ],
+ "category": "methods"
+ },
{
"anchor": "editmessagereplymarkup",
"name": "editMessageReplyMarkup",
@@ -11957,12 +17398,80 @@
],
"category": "methods"
},
+ {
+ "anchor": "approvesuggestedpost",
+ "name": "approveSuggestedPost",
+ "description": "Use this method to approve a suggested post in a direct messages chat. The bot must have the 'can_post_messages' administrator right in the corresponding channel chat. Returns True on success.",
+ "html_description": "Use this method to approve a suggested post in a direct messages chat. The bot must have the 'can_post_messages' administrator right in the corresponding channel chat. Returns True on success.
",
+ "rst_description": "Use this method to approve a suggested post in a direct messages chat. The bot must have the 'can_post_messages' administrator right in the corresponding channel chat. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "Unique identifier for the target direct messages chat",
+ "html_description": "Unique identifier for the target direct messages chat | ",
+ "rst_description": "Unique identifier for the target direct messages chat\n",
+ "name": "chat_id"
+ },
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "Identifier of a suggested post message to approve",
+ "html_description": "Identifier of a suggested post message to approve | ",
+ "rst_description": "Identifier of a suggested post message to approve\n",
+ "name": "message_id"
+ },
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Point in time (Unix timestamp) when the post is expected to be published; omit if the date has already been specified when the suggested post was created. If specified, then the date must be not more than 2678400 seconds (30 days) in the future",
+ "html_description": "Point in time (Unix timestamp) when the post is expected to be published; omit if the date has already been specified when the suggested post was created. If specified, then the date must be not more than 2678400 seconds (30 days) in the future | ",
+ "rst_description": "Point in time (Unix timestamp) when the post is expected to be published; omit if the date has already been specified when the suggested post was created. If specified, then the date must be not more than 2678400 seconds (30 days) in the future\n",
+ "name": "send_date"
+ }
+ ],
+ "category": "methods"
+ },
+ {
+ "anchor": "declinesuggestedpost",
+ "name": "declineSuggestedPost",
+ "description": "Use this method to decline a suggested post in a direct messages chat. The bot must have the 'can_manage_direct_messages' administrator right in the corresponding channel chat. Returns True on success.",
+ "html_description": "Use this method to decline a suggested post in a direct messages chat. The bot must have the 'can_manage_direct_messages' administrator right in the corresponding channel chat. Returns True on success.
",
+ "rst_description": "Use this method to decline a suggested post in a direct messages chat. The bot must have the 'can_manage_direct_messages' administrator right in the corresponding channel chat. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "Unique identifier for the target direct messages chat",
+ "html_description": "Unique identifier for the target direct messages chat | ",
+ "rst_description": "Unique identifier for the target direct messages chat\n",
+ "name": "chat_id"
+ },
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "Identifier of a suggested post message to decline",
+ "html_description": "Identifier of a suggested post message to decline | ",
+ "rst_description": "Identifier of a suggested post message to decline\n",
+ "name": "message_id"
+ },
+ {
+ "type": "String",
+ "required": false,
+ "description": "Comment for the creator of the suggested post; 0-128 characters",
+ "html_description": "Comment for the creator of the suggested post; 0-128 characters | ",
+ "rst_description": "Comment for the creator of the suggested post; 0-128 characters\n",
+ "name": "comment"
+ }
+ ],
+ "category": "methods"
+ },
{
"anchor": "deletemessage",
"name": "deleteMessage",
- "description": "Use this method to delete a message, including service messages, with the following limitations:\n- A message can only be deleted if it was sent less than 48 hours ago.\n- Service messages about a supergroup, channel, or forum topic creation can't be deleted.\n- A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.\n- Bots can delete outgoing messages in private chats, groups, and supergroups.\n- Bots can delete incoming messages in private chats.\n- Bots granted can_post_messages permissions can delete outgoing messages in channels.\n- If the bot is an administrator of a group, it can delete any message there.\n- If the bot has can_delete_messages permission in a supergroup or a channel, it can delete any message there.\nReturns True on success.",
- "html_description": "Use this method to delete a message, including service messages, with the following limitations:
\n- A message can only be deleted if it was sent less than 48 hours ago.
\n- Service messages about a supergroup, channel, or forum topic creation can't be deleted.
\n- A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.
\n- Bots can delete outgoing messages in private chats, groups, and supergroups.
\n- Bots can delete incoming messages in private chats.
\n- Bots granted can_post_messages permissions can delete outgoing messages in channels.
\n- If the bot is an administrator of a group, it can delete any message there.
\n- If the bot has can_delete_messages permission in a supergroup or a channel, it can delete any message there.
\nReturns True on success.
",
- "rst_description": "Use this method to delete a message, including service messages, with the following limitations:\n\n- A message can only be deleted if it was sent less than 48 hours ago.\n\n- Service messages about a supergroup, channel, or forum topic creation can't be deleted.\n\n- A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.\n\n- Bots can delete outgoing messages in private chats, groups, and supergroups.\n\n- Bots can delete incoming messages in private chats.\n\n- Bots granted *can_post_messages* permissions can delete outgoing messages in channels.\n\n- If the bot is an administrator of a group, it can delete any message there.\n\n- If the bot has *can_delete_messages* permission in a supergroup or a channel, it can delete any message there.\n\nReturns :code:`True` on success.",
+ "description": "Use this method to delete a message, including service messages, with the following limitations:\n- A message can only be deleted if it was sent less than 48 hours ago.\n- Service messages about a supergroup, channel, or forum topic creation can't be deleted.\n- A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.\n- Bots can delete outgoing messages in private chats, groups, and supergroups.\n- Bots can delete incoming messages in private chats.\n- Bots granted can_post_messages permissions can delete outgoing messages in channels.\n- If the bot is an administrator of a group, it can delete any message there.\n- If the bot has can_delete_messages administrator right in a supergroup or a channel, it can delete any message there.\n- If the bot has can_manage_direct_messages administrator right in a channel, it can delete any message in the corresponding direct messages chat.\nReturns True on success.",
+ "html_description": "Use this method to delete a message, including service messages, with the following limitations:
\n- A message can only be deleted if it was sent less than 48 hours ago.
\n- Service messages about a supergroup, channel, or forum topic creation can't be deleted.
\n- A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.
\n- Bots can delete outgoing messages in private chats, groups, and supergroups.
\n- Bots can delete incoming messages in private chats.
\n- Bots granted can_post_messages permissions can delete outgoing messages in channels.
\n- If the bot is an administrator of a group, it can delete any message there.
\n- If the bot has can_delete_messages administrator right in a supergroup or a channel, it can delete any message there.
\n- If the bot has can_manage_direct_messages administrator right in a channel, it can delete any message in the corresponding direct messages chat.
\nReturns True on success.
",
+ "rst_description": "Use this method to delete a message, including service messages, with the following limitations:\n\n- A message can only be deleted if it was sent less than 48 hours ago.\n\n- Service messages about a supergroup, channel, or forum topic creation can't be deleted.\n\n- A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.\n\n- Bots can delete outgoing messages in private chats, groups, and supergroups.\n\n- Bots can delete incoming messages in private chats.\n\n- Bots granted *can_post_messages* permissions can delete outgoing messages in channels.\n\n- If the bot is an administrator of a group, it can delete any message there.\n\n- If the bot has *can_delete_messages* administrator right in a supergroup or a channel, it can delete any message there.\n\n- If the bot has *can_manage_direct_messages* administrator right in a channel, it can delete any message in the corresponding direct messages chat.\n\nReturns :code:`True` on success.",
"annotations": [
{
"type": "Integer or String",
@@ -12246,18 +17755,18 @@
"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://' to upload a new one using multipart/form-data under name. Animated and video stickers can't be uploaded via HTTP URL. More information on Sending Files",
- "html_description": "The added sticker. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, 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 » | ",
- "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://' to upload a new one using multipart/form-data under name. Animated and video stickers can't be uploaded via HTTP URL. :ref:`More information on 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://' to upload a new file using multipart/form-data under name. Animated and video stickers can't be uploaded via HTTP URL. More information on Sending Files",
+ "html_description": "The added sticker. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or 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 » | ",
+ "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://' to upload a new file using multipart/form-data under name. Animated and video stickers can't be uploaded via HTTP URL. :ref:`More information on Sending Files » `\n",
"name": "sticker",
"required": true
},
{
"type": "String",
- "description": "Format of the added sticker, must be one of 'static' for a .WEBP or .PNG image, 'animated' for a .TGS animation, 'video' for a WEBM video",
- "html_description": "Format of the added sticker, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, “video” for a WEBM video | ",
- "rst_description": "Format of the added sticker, must be one of 'static' for a **.WEBP** or **.PNG** image, 'animated' for a **.TGS** animation, 'video' for a **WEBM** video\n",
+ "description": "Format of the added sticker, must be one of 'static' for a .WEBP or .PNG image, 'animated' for a .TGS animation, 'video' for a .WEBM video",
+ "html_description": "Format of the added sticker, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, “video” for a .WEBM video | ",
+ "rst_description": "Format of the added sticker, must be one of 'static' for a **.WEBP** or **.PNG** image, 'animated' for a **.TGS** animation, 'video' for a **.WEBM** video\n",
"name": "format",
"required": true
},
@@ -12314,11 +17823,19 @@
{
"type": "Integer",
"required": false,
- "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
- "html_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ",
- "rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
+ "description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
+ "html_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | ",
+ "rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"name": "message_thread_id"
},
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
+ "html_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | ",
+ "rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
+ "name": "direct_messages_topic_id"
+ },
{
"type": "InputFile or String",
"required": true,
@@ -12351,6 +17868,14 @@
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
+ "html_description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | ",
+ "rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits `_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
+ "name": "allow_paid_broadcast"
+ },
{
"type": "String",
"required": false,
@@ -12359,6 +17884,14 @@
"rst_description": "Unique identifier of the message effect to be added to the message; for private chats only\n",
"name": "message_effect_id"
},
+ {
+ "type": "SuggestedPostParameters",
+ "required": false,
+ "description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
+ "html_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | ",
+ "rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
+ "name": "suggested_post_parameters"
+ },
{
"type": "ReplyParameters",
"required": false,
@@ -12756,17 +18289,17 @@
{
"type": "InputFile or String",
"required": false,
- "description": "A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see https://core.telegram.org/stickers#animated-sticker-requirements for animated sticker technical requirements), or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files. Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.",
- "html_description": "A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see https://core.telegram.org/stickers#animated-sticker-requirements for animated sticker technical requirements), or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files ». Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail. | ",
- "rst_description": "A **.WEBP** or **.PNG** image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a **.TGS** animation with a thumbnail up to 32 kilobytes in size (see `https://core.telegram.org/stickers#animated-sticker-requirements `_`https://core.telegram.org/stickers#animated-sticker-requirements `_ for animated sticker technical requirements), or a **WEBM** video with the thumbnail up to 32 kilobytes in size; see `https://core.telegram.org/stickers#video-sticker-requirements `_`https://core.telegram.org/stickers#video-sticker-requirements `_ for video sticker technical requirements. Pass a *file_id* as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. :ref:`More information on Sending Files » `. Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.\n",
+ "description": "A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see https://core.telegram.org/stickers#animation-requirements for animated sticker technical requirements), or a .WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files. Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.",
+ "html_description": "A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see https://core.telegram.org/stickers#animation-requirements for animated sticker technical requirements), or a .WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files ». Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail. | ",
+ "rst_description": "A **.WEBP** or **.PNG** image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a **.TGS** animation with a thumbnail up to 32 kilobytes in size (see `https://core.telegram.org/stickers#animation-requirements `_`https://core.telegram.org/stickers#animation-requirements `_ for animated sticker technical requirements), or a **.WEBM** video with the thumbnail up to 32 kilobytes in size; see `https://core.telegram.org/stickers#video-requirements `_`https://core.telegram.org/stickers#video-requirements `_ for video sticker technical requirements. Pass a *file_id* as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. :ref:`More information on Sending Files » `. Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.\n",
"name": "thumbnail"
},
{
"type": "String",
"required": true,
- "description": "Format of the thumbnail, must be one of 'static' for a .WEBP or .PNG image, 'animated' for a .TGS animation, or 'video' for a WEBM video",
- "html_description": "Format of the thumbnail, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, or “video” for a WEBM video | ",
- "rst_description": "Format of the thumbnail, must be one of 'static' for a **.WEBP** or **.PNG** image, 'animated' for a **.TGS** animation, or 'video' for a **WEBM** video\n",
+ "description": "Format of the thumbnail, must be one of 'static' for a .WEBP or .PNG image, 'animated' for a .TGS animation, or 'video' for a .WEBM video",
+ "html_description": "Format of the thumbnail, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, or “video” for a .WEBM video | ",
+ "rst_description": "Format of the thumbnail, must be one of 'static' for a **.WEBP** or **.PNG** image, 'animated' for a **.TGS** animation, or 'video' for a **.WEBM** video\n",
"name": "format"
}
],
@@ -13037,14 +18570,6 @@
"name": "url",
"required": false
},
- {
- "type": "Boolean",
- "description": "Pass True if you don't want the URL to be shown in the message",
- "html_description": "Optional. Pass True if you don't want the URL to be shown in the message | ",
- "rst_description": "*Optional*. Pass :code:`True` if you don't want the URL to be shown in the message\n",
- "name": "hide_url",
- "required": false
- },
{
"type": "String",
"description": "Short description of the result",
@@ -13227,9 +18752,9 @@
},
{
"type": "String",
- "description": "A valid URL for the GIF file. File size must not exceed 1MB",
- "html_description": "A valid URL for the GIF file. File size must not exceed 1MB | ",
- "rst_description": "A valid URL for the GIF file. File size must not exceed 1MB\n",
+ "description": "A valid URL for the GIF file",
+ "html_description": "A valid URL for the GIF file | ",
+ "rst_description": "A valid URL for the GIF file\n",
"name": "gif_url",
"required": true
},
@@ -13357,9 +18882,9 @@
},
{
"type": "String",
- "description": "A valid URL for the MPEG4 file. File size must not exceed 1MB",
- "html_description": "A valid URL for the MPEG4 file. File size must not exceed 1MB | ",
- "rst_description": "A valid URL for the MPEG4 file. File size must not exceed 1MB\n",
+ "description": "A valid URL for the MPEG4 file",
+ "html_description": "A valid URL for the MPEG4 file | ",
+ "rst_description": "A valid URL for the MPEG4 file\n",
"name": "mpeg4_url",
"required": true
},
@@ -13870,8 +19395,8 @@
{
"type": "InlineKeyboardMarkup",
"description": "Inline keyboard attached to the message",
- "html_description": "Optional. Inline keyboard attached to the message | ",
- "rst_description": "*Optional*. Inline keyboard attached to the message\n",
+ "html_description": "Optional. Inline keyboard attached to the message | ",
+ "rst_description": "*Optional*. `Inline keyboard `_ attached to the message\n",
"name": "reply_markup",
"required": false
},
@@ -15224,9 +20749,9 @@
},
{
"type": "String",
- "description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.",
- "html_description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. | ",
- "rst_description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.\n",
+ "description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.",
+ "html_description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes. | ",
+ "rst_description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.\n",
"name": "payload",
"required": true
},
@@ -15418,50 +20943,6 @@
}
],
"category": "types"
- },
- {
- "anchor": "answerwebappquery",
- "name": "answerWebAppQuery",
- "description": "Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a SentWebAppMessage object is returned.",
- "html_description": "Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a SentWebAppMessage object is returned.
",
- "rst_description": "Use this method to set the result of an interaction with a `Web App `_ and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a :class:`aiogram.types.sent_web_app_message.SentWebAppMessage` object is returned.",
- "annotations": [
- {
- "type": "String",
- "required": true,
- "description": "Unique identifier for the query to be answered",
- "html_description": "Unique identifier for the query to be answered | ",
- "rst_description": "Unique identifier for the query to be answered\n",
- "name": "web_app_query_id"
- },
- {
- "type": "InlineQueryResult",
- "required": true,
- "description": "A JSON-serialized object describing the message to be sent",
- "html_description": "A JSON-serialized object describing the message to be sent | ",
- "rst_description": "A JSON-serialized object describing the message to be sent\n",
- "name": "result"
- }
- ],
- "category": "methods"
- },
- {
- "anchor": "sentwebappmessage",
- "name": "SentWebAppMessage",
- "description": "Describes an inline message sent by a Web App on behalf of a user.",
- "html_description": "Describes an inline message sent by a Web App on behalf of a user.
",
- "rst_description": "Describes an inline message sent by a `Web App `_ on behalf of a user.",
- "annotations": [
- {
- "type": "String",
- "description": "Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message.",
- "html_description": "Optional. Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message. | ",
- "rst_description": "*Optional*. Identifier of the sent inline message. Available only if there is an `inline keyboard `_ attached to the message.\n",
- "name": "inline_message_id",
- "required": false
- }
- ],
- "category": "types"
}
],
"description": "The following methods and objects allow your bot to work in inline mode.\nPlease see our Introduction to Inline bots for more details.\nTo enable this option, send the /setinline command to @BotFather and provide the placeholder text that the user will see in the input field after typing your bot's name."
@@ -15488,11 +20969,19 @@
{
"type": "Integer",
"required": false,
- "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
- "html_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ",
- "rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
+ "description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
+ "html_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | ",
+ "rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"name": "message_thread_id"
},
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
+ "html_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | ",
+ "rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
+ "name": "direct_messages_topic_id"
+ },
{
"type": "String",
"required": true,
@@ -15512,9 +21001,9 @@
{
"type": "String",
"required": true,
- "description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.",
- "html_description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. | ",
- "rst_description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.\n",
+ "description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.",
+ "html_description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes. | ",
+ "rst_description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.\n",
"name": "payload"
},
{
@@ -15677,6 +21166,14 @@
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
+ "html_description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | ",
+ "rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits `_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
+ "name": "allow_paid_broadcast"
+ },
{
"type": "String",
"required": false,
@@ -15685,6 +21182,14 @@
"rst_description": "Unique identifier of the message effect to be added to the message; for private chats only\n",
"name": "message_effect_id"
},
+ {
+ "type": "SuggestedPostParameters",
+ "required": false,
+ "description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
+ "html_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | ",
+ "rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
+ "name": "suggested_post_parameters"
+ },
{
"type": "ReplyParameters",
"required": false,
@@ -15711,6 +21216,14 @@
"html_description": "Use this method to create a link for an invoice. Returns the created invoice link as String on success.
",
"rst_description": "Use this method to create a link for an invoice. Returns the created invoice link as *String* on success.",
"annotations": [
+ {
+ "type": "String",
+ "required": false,
+ "description": "Unique identifier of the business connection on behalf of which the link will be created. For payments in Telegram Stars only.",
+ "html_description": "Unique identifier of the business connection on behalf of which the link will be created. For payments in Telegram Stars only. | ",
+ "rst_description": "Unique identifier of the business connection on behalf of which the link will be created. For payments in `Telegram Stars `_ only.\n",
+ "name": "business_connection_id"
+ },
{
"type": "String",
"required": true,
@@ -15730,9 +21243,9 @@
{
"type": "String",
"required": true,
- "description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.",
- "html_description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. | ",
- "rst_description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.\n",
+ "description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.",
+ "html_description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes. | ",
+ "rst_description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.\n",
"name": "payload"
},
{
@@ -15759,6 +21272,14 @@
"rst_description": "Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in `Telegram Stars `_.\n",
"name": "prices"
},
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "The number of seconds the subscription will be active for before the next payment. The currency must be set to 'XTR' (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed 10000 Telegram Stars.",
+ "html_description": "The number of seconds the subscription will be active for before the next payment. The currency must be set to “XTR” (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed 10000 Telegram Stars. | ",
+ "rst_description": "The number of seconds the subscription will be active for before the next payment. The currency must be set to 'XTR' (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed 10000 Telegram Stars.\n",
+ "name": "subscription_period"
+ },
{
"type": "Integer",
"required": false,
@@ -15908,9 +21429,9 @@
{
"type": "String",
"required": false,
- "description": "Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. \"Sorry, delivery to your desired address is unavailable'). Telegram will display this message to the user.",
- "html_description": "Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. \"Sorry, delivery to your desired address is unavailable'). Telegram will display this message to the user. | ",
- "rst_description": "Required if *ok* is :code:`False`. Error message in human readable form that explains why it is impossible to complete the order (e.g. \"Sorry, delivery to your desired address is unavailable'). Telegram will display this message to the user.\n",
+ "description": "Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. 'Sorry, delivery to your desired address is unavailable'). Telegram will display this message to the user.",
+ "html_description": "Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. “Sorry, delivery to your desired address is unavailable”). Telegram will display this message to the user. | ",
+ "rst_description": "Required if *ok* is :code:`False`. Error message in human readable form that explains why it is impossible to complete the order (e.g. 'Sorry, delivery to your desired address is unavailable'). Telegram will display this message to the user.\n",
"name": "error_message"
}
],
@@ -15950,6 +21471,15 @@
],
"category": "methods"
},
+ {
+ "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": "A method to get the current Telegram Stars balance of the bot. Requires no parameters. On success, returns a StarAmount object.
",
+ "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"
+ },
{
"anchor": "getstartransactions",
"name": "getStarTransactions",
@@ -16002,6 +21532,40 @@
],
"category": "methods"
},
+ {
+ "anchor": "edituserstarsubscription",
+ "name": "editUserStarSubscription",
+ "description": "Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars. Returns True on success.",
+ "html_description": "Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars. Returns True on success.
",
+ "rst_description": "Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "Identifier of the user whose subscription will be edited",
+ "html_description": "Identifier of the user whose subscription will be edited | ",
+ "rst_description": "Identifier of the user whose subscription will be edited\n",
+ "name": "user_id"
+ },
+ {
+ "type": "String",
+ "required": true,
+ "description": "Telegram payment identifier for the subscription",
+ "html_description": "Telegram payment identifier for the subscription | ",
+ "rst_description": "Telegram payment identifier for the subscription\n",
+ "name": "telegram_payment_charge_id"
+ },
+ {
+ "type": "Boolean",
+ "required": true,
+ "description": "Pass True to cancel extension of the user subscription; the subscription must be active up to the end of the current subscription period. Pass False to allow the user to re-enable a subscription that was previously canceled by the bot.",
+ "html_description": "Pass True to cancel extension of the user subscription; the subscription must be active up to the end of the current subscription period. Pass False to allow the user to re-enable a subscription that was previously canceled by the bot. | ",
+ "rst_description": "Pass :code:`True` to cancel extension of the user subscription; the subscription must be active up to the end of the current subscription period. Pass :code:`False` to allow the user to re-enable a subscription that was previously canceled by the bot.\n",
+ "name": "is_canceled"
+ }
+ ],
+ "category": "methods"
+ },
{
"anchor": "labeledprice",
"name": "LabeledPrice",
@@ -16215,9 +21779,9 @@
{
"anchor": "successfulpayment",
"name": "SuccessfulPayment",
- "description": "This object contains basic information about a successful payment.",
- "html_description": "This object contains basic information about a successful payment.
",
- "rst_description": "This object contains basic information about a successful payment.",
+ "description": "This object contains basic information about a successful payment. Note that if the buyer initiates a chargeback with the relevant payment provider following this transaction, the funds may be debited from your balance. This is outside of Telegram's control.",
+ "html_description": "This object contains basic information about a successful payment. Note that if the buyer initiates a chargeback with the relevant payment provider following this transaction, the funds may be debited from your balance. This is outside of Telegram's control.
",
+ "rst_description": "This object contains basic information about a successful payment. Note that if the buyer initiates a chargeback with the relevant payment provider following this transaction, the funds may be debited from your balance. This is outside of Telegram's control.",
"annotations": [
{
"type": "String",
@@ -16243,6 +21807,30 @@
"name": "invoice_payload",
"required": true
},
+ {
+ "type": "Integer",
+ "description": "Expiration date of the subscription, in Unix time; for recurring payments only",
+ "html_description": "Optional. Expiration date of the subscription, in Unix time; for recurring payments only | ",
+ "rst_description": "*Optional*. Expiration date of the subscription, in Unix time; for recurring payments only\n",
+ "name": "subscription_expiration_date",
+ "required": false
+ },
+ {
+ "type": "True",
+ "description": "True, if the payment is a recurring payment for a subscription",
+ "html_description": "Optional. True, if the payment is a recurring payment for a subscription | ",
+ "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": "Optional. True, if the payment is the first payment for a subscription | ",
+ "rst_description": "*Optional*. :code:`True`, if the payment is the first payment for a subscription\n",
+ "name": "is_first_recurring",
+ "required": false
+ },
{
"type": "String",
"description": "Identifier of the shipping option chosen by the user",
@@ -16278,6 +21866,56 @@
],
"category": "types"
},
+ {
+ "anchor": "refundedpayment",
+ "name": "RefundedPayment",
+ "description": "This object contains basic information about a refunded payment.",
+ "html_description": "This object contains basic information about a refunded payment.
",
+ "rst_description": "This object contains basic information about a refunded payment.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Three-letter ISO 4217 currency code, or 'XTR' for payments in Telegram Stars. Currently, always 'XTR'",
+ "html_description": "Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars. Currently, always “XTR” | ",
+ "rst_description": "Three-letter ISO 4217 `currency `_ code, or 'XTR' for payments in `Telegram Stars `_. Currently, always 'XTR'\n",
+ "name": "currency",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "Total refunded price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45, total_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).",
+ "html_description": "Total refunded price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45, total_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). | ",
+ "rst_description": "Total refunded price in the *smallest units* of the currency (integer, **not** float/double). For example, for a price of :code:`US$ 1.45`, :code:`total_amount = 145`. See the *exp* parameter in `currencies.json `_, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).\n",
+ "name": "total_amount",
+ "required": true
+ },
+ {
+ "type": "String",
+ "description": "Bot-specified invoice payload",
+ "html_description": "Bot-specified invoice payload | ",
+ "rst_description": "Bot-specified invoice payload\n",
+ "name": "invoice_payload",
+ "required": true
+ },
+ {
+ "type": "String",
+ "description": "Telegram payment identifier",
+ "html_description": "Telegram payment identifier | ",
+ "rst_description": "Telegram payment identifier\n",
+ "name": "telegram_payment_charge_id",
+ "required": true
+ },
+ {
+ "type": "String",
+ "description": "Provider payment identifier",
+ "html_description": "Optional. Provider payment identifier | ",
+ "rst_description": "*Optional*. Provider payment identifier\n",
+ "name": "provider_payment_charge_id",
+ "required": false
+ }
+ ],
+ "category": "types"
+ },
{
"anchor": "shippingquery",
"name": "ShippingQuery",
@@ -16386,6 +22024,32 @@
],
"category": "types"
},
+ {
+ "anchor": "paidmediapurchased",
+ "name": "PaidMediaPurchased",
+ "description": "This object contains information about a paid media purchase.",
+ "html_description": "This object contains information about a paid media purchase.
",
+ "rst_description": "This object contains information about a paid media purchase.",
+ "annotations": [
+ {
+ "type": "User",
+ "description": "User who purchased the media",
+ "html_description": "User who purchased the media | ",
+ "rst_description": "User who purchased the media\n",
+ "name": "from",
+ "required": true
+ },
+ {
+ "type": "String",
+ "description": "Bot-specified paid media payload",
+ "html_description": "Bot-specified paid media payload | ",
+ "rst_description": "Bot-specified paid media payload\n",
+ "name": "paid_media_payload",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
{
"anchor": "revenuewithdrawalstate",
"name": "RevenueWithdrawalState",
@@ -16465,12 +22129,62 @@
],
"category": "types"
},
+ {
+ "anchor": "affiliateinfo",
+ "name": "AffiliateInfo",
+ "description": "Contains information about the affiliate that received a commission via this transaction.",
+ "html_description": "Contains information about the affiliate that received a commission via this transaction.
",
+ "rst_description": "Contains information about the affiliate that received a commission via this transaction.",
+ "annotations": [
+ {
+ "type": "User",
+ "description": "The bot or the user that received an affiliate commission if it was received by a bot or a user",
+ "html_description": "Optional. The bot or the user that received an affiliate commission if it was received by a bot or a user | ",
+ "rst_description": "*Optional*. The bot or the user that received an affiliate commission if it was received by a bot or a user\n",
+ "name": "affiliate_user",
+ "required": false
+ },
+ {
+ "type": "Chat",
+ "description": "The chat that received an affiliate commission if it was received by a chat",
+ "html_description": "Optional. The chat that received an affiliate commission if it was received by a chat | ",
+ "rst_description": "*Optional*. The chat that received an affiliate commission if it was received by a chat\n",
+ "name": "affiliate_chat",
+ "required": false
+ },
+ {
+ "type": "Integer",
+ "description": "The number of Telegram Stars received by the affiliate for each 1000 Telegram Stars received by the bot from referred users",
+ "html_description": "The number of Telegram Stars received by the affiliate for each 1000 Telegram Stars received by the bot from referred users | ",
+ "rst_description": "The number of Telegram Stars received by the affiliate for each 1000 Telegram Stars received by the bot from referred users\n",
+ "name": "commission_per_mille",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "Integer amount of Telegram Stars received by the affiliate from the transaction, rounded to 0; can be negative for refunds",
+ "html_description": "Integer amount of Telegram Stars received by the affiliate from the transaction, rounded to 0; can be negative for refunds | ",
+ "rst_description": "Integer amount of Telegram Stars received by the affiliate from the transaction, rounded to 0; can be negative for refunds\n",
+ "name": "amount",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "The number of 1/1000000000 shares of Telegram Stars received by the affiliate; from -999999999 to 999999999; can be negative for refunds",
+ "html_description": "Optional. The number of 1/1000000000 shares of Telegram Stars received by the affiliate; from -999999999 to 999999999; can be negative for refunds | ",
+ "rst_description": "*Optional*. The number of 1/1000000000 shares of Telegram Stars received by the affiliate; from -999999999 to 999999999; can be negative for refunds\n",
+ "name": "nanostar_amount",
+ "required": false
+ }
+ ],
+ "category": "types"
+ },
{
"anchor": "transactionpartner",
"name": "TransactionPartner",
- "description": "This object describes the source of a transaction, or its recipient for outgoing transactions. Currently, it can be one of\n - TransactionPartnerUser\n - TransactionPartnerFragment\n - TransactionPartnerTelegramAds\n - TransactionPartnerOther",
- "html_description": "This object describes the source of a transaction, or its recipient for outgoing transactions. Currently, it can be one of
",
- "rst_description": "This object describes the source of a transaction, or its recipient for outgoing transactions. Currently, it can be one of\n\n - :class:`aiogram.types.transaction_partner_user.TransactionPartnerUser`\n - :class:`aiogram.types.transaction_partner_fragment.TransactionPartnerFragment`\n - :class:`aiogram.types.transaction_partner_telegram_ads.TransactionPartnerTelegramAds`\n - :class:`aiogram.types.transaction_partner_other.TransactionPartnerOther`",
+ "description": "This object describes the source of a transaction, or its recipient for outgoing transactions. Currently, it can be one of\n - TransactionPartnerUser\n - TransactionPartnerChat\n - TransactionPartnerAffiliateProgram\n - TransactionPartnerFragment\n - TransactionPartnerTelegramAds\n - TransactionPartnerTelegramApi\n - TransactionPartnerOther",
+ "html_description": "This object describes the source of a transaction, or its recipient for outgoing transactions. Currently, it can be one of
",
+ "rst_description": "This object describes the source of a transaction, or its recipient for outgoing transactions. Currently, it can be one of\n\n - :class:`aiogram.types.transaction_partner_user.TransactionPartnerUser`\n - :class:`aiogram.types.transaction_partner_chat.TransactionPartnerChat`\n - :class:`aiogram.types.transaction_partner_affiliate_program.TransactionPartnerAffiliateProgram`\n - :class:`aiogram.types.transaction_partner_fragment.TransactionPartnerFragment`\n - :class:`aiogram.types.transaction_partner_telegram_ads.TransactionPartnerTelegramAds`\n - :class:`aiogram.types.transaction_partner_telegram_api.TransactionPartnerTelegramApi`\n - :class:`aiogram.types.transaction_partner_other.TransactionPartnerOther`",
"annotations": [],
"category": "types"
},
@@ -16489,6 +22203,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": "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 | ",
+ "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",
@@ -16497,13 +22219,129 @@
"name": "user",
"required": true
},
+ {
+ "type": "AffiliateInfo",
+ "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": "Optional. Information about the affiliate that received a commission via this transaction. Can be available only for “invoice_payment” and “paid_media_payment” transactions. | ",
+ "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": "Optional. Bot-specified invoice payload | ",
- "rst_description": "*Optional*. Bot-specified invoice payload\n",
+ "description": "Bot-specified invoice payload. Can be available only for 'invoice_payment' transactions.",
+ "html_description": "Optional. Bot-specified invoice payload. Can be available only for “invoice_payment” transactions. | ",
+ "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. Can be available only for 'invoice_payment' transactions.",
+ "html_description": "Optional. The duration of the paid subscription. Can be available only for “invoice_payment” transactions. | ",
+ "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; for 'paid_media_payment' transactions only",
+ "html_description": "Optional. Information about the paid media bought by the user; for “paid_media_payment” transactions only | ",
+ "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. Can be available only for 'paid_media_payment' transactions.",
+ "html_description": "Optional. Bot-specified paid media payload. Can be available only for “paid_media_payment” transactions. | ",
+ "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; for 'gift_purchase' transactions only",
+ "html_description": "Optional. The gift sent to the user by the bot; for “gift_purchase” transactions only | ",
+ "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": "Optional. Number of months the gifted Telegram Premium subscription will be active for; for “premium_purchase” transactions only | ",
+ "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"
+ },
+ {
+ "anchor": "transactionpartnerchat",
+ "name": "TransactionPartnerChat",
+ "description": "Describes a transaction with a chat.",
+ "html_description": "Describes a transaction with a chat.
",
+ "rst_description": "Describes a transaction with a chat.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Type of the transaction partner, always 'chat'",
+ "html_description": "Type of the transaction partner, always “chat” | ",
+ "rst_description": "Type of the transaction partner, always 'chat'\n",
+ "name": "type",
+ "required": true
+ },
+ {
+ "type": "Chat",
+ "description": "Information about the chat",
+ "html_description": "Information about the chat | ",
+ "rst_description": "Information about the chat\n",
+ "name": "chat",
+ "required": true
+ },
+ {
+ "type": "Gift",
+ "description": "The gift sent to the chat by the bot",
+ "html_description": "Optional. The gift sent to the chat by the bot | ",
+ "rst_description": "*Optional*. The gift sent to the chat by the bot\n",
+ "name": "gift",
+ "required": false
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "transactionpartneraffiliateprogram",
+ "name": "TransactionPartnerAffiliateProgram",
+ "description": "Describes the affiliate program that issued the affiliate commission received via this transaction.",
+ "html_description": "Describes the affiliate program that issued the affiliate commission received via this transaction.
",
+ "rst_description": "Describes the affiliate program that issued the affiliate commission received via this transaction.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Type of the transaction partner, always 'affiliate_program'",
+ "html_description": "Type of the transaction partner, always “affiliate_program” | ",
+ "rst_description": "Type of the transaction partner, always 'affiliate_program'\n",
+ "name": "type",
+ "required": true
+ },
+ {
+ "type": "User",
+ "description": "Information about the bot that sponsored the affiliate program",
+ "html_description": "Optional. Information about the bot that sponsored the affiliate program | ",
+ "rst_description": "*Optional*. Information about the bot that sponsored the affiliate program\n",
+ "name": "sponsor_user",
+ "required": false
+ },
+ {
+ "type": "Integer",
+ "description": "The number of Telegram Stars received by the bot for each 1000 Telegram Stars received by the affiliate program sponsor from referred users",
+ "html_description": "The number of Telegram Stars received by the bot for each 1000 Telegram Stars received by the affiliate program sponsor from referred users | ",
+ "rst_description": "The number of Telegram Stars received by the bot for each 1000 Telegram Stars received by the affiliate program sponsor from referred users\n",
+ "name": "commission_per_mille",
+ "required": true
}
],
"category": "types"
@@ -16552,6 +22390,32 @@
],
"category": "types"
},
+ {
+ "anchor": "transactionpartnertelegramapi",
+ "name": "TransactionPartnerTelegramApi",
+ "description": "Describes a transaction with payment for paid broadcasting.",
+ "html_description": "Describes a transaction with payment for paid broadcasting.
",
+ "rst_description": "Describes a transaction with payment for `paid broadcasting `_.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Type of the transaction partner, always 'telegram_api'",
+ "html_description": "Type of the transaction partner, always “telegram_api” | ",
+ "rst_description": "Type of the transaction partner, always 'telegram_api'\n",
+ "name": "type",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "The number of successful requests that exceeded regular limits and were therefore billed",
+ "html_description": "The number of successful requests that exceeded regular limits and were therefore billed | ",
+ "rst_description": "The number of successful requests that exceeded regular limits and were therefore billed\n",
+ "name": "request_count",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
{
"anchor": "transactionpartnerother",
"name": "TransactionPartnerOther",
@@ -16573,26 +22437,34 @@
{
"anchor": "startransaction",
"name": "StarTransaction",
- "description": "Describes a Telegram Star transaction.",
- "html_description": "Describes a Telegram Star transaction.
",
- "rst_description": "Describes a Telegram Star transaction.",
+ "description": "Describes a Telegram Star transaction. Note that if the buyer initiates a chargeback with the payment provider from whom they acquired Stars (e.g., Apple, Google) following this transaction, the refunded Stars will be deducted from the bot's balance. This is outside of Telegram's control.",
+ "html_description": "Describes a Telegram Star transaction. Note that if the buyer initiates a chargeback with the payment provider from whom they acquired Stars (e.g., Apple, Google) following this transaction, the refunded Stars will be deducted from the bot's balance. This is outside of Telegram's control.
",
+ "rst_description": "Describes a Telegram Star transaction. Note that if the buyer initiates a chargeback with the payment provider from whom they acquired Stars (e.g., Apple, Google) following this transaction, the refunded Stars will be deducted from the bot's balance. This is outside of Telegram's control.",
"annotations": [
{
"type": "String",
- "description": "Unique identifier of the transaction. Coincides with the identifer of the original transaction for refund transactions. Coincides with SuccessfulPayment.telegram_payment_charge_id for successful incoming payments from users.",
- "html_description": "Unique identifier of the transaction. Coincides with the identifer of the original transaction for refund transactions. Coincides with SuccessfulPayment.telegram_payment_charge_id for successful incoming payments from users. | ",
- "rst_description": "Unique identifier of the transaction. Coincides with the identifer of the original transaction for refund transactions. Coincides with *SuccessfulPayment.telegram_payment_charge_id* for successful incoming payments from users.\n",
+ "description": "Unique identifier of the transaction. Coincides with the identifier of the original transaction for refund transactions. Coincides with SuccessfulPayment.telegram_payment_charge_id for successful incoming payments from users.",
+ "html_description": "Unique identifier of the transaction. Coincides with the identifier of the original transaction for refund transactions. Coincides with SuccessfulPayment.telegram_payment_charge_id for successful incoming payments from users. | ",
+ "rst_description": "Unique identifier of the transaction. Coincides with the identifier of the original transaction for refund transactions. Coincides with *SuccessfulPayment.telegram_payment_charge_id* for successful incoming payments from users.\n",
"name": "id",
"required": true
},
{
"type": "Integer",
- "description": "Number of Telegram Stars transferred by the transaction",
- "html_description": "Number of Telegram Stars transferred by the transaction | ",
- "rst_description": "Number of Telegram Stars transferred by the transaction\n",
+ "description": "Integer amount of Telegram Stars transferred by the transaction",
+ "html_description": "Integer amount of Telegram Stars transferred by the transaction | ",
+ "rst_description": "Integer amount of Telegram Stars transferred by the transaction\n",
"name": "amount",
"required": true
},
+ {
+ "type": "Integer",
+ "description": "The number of 1/1000000000 shares of Telegram Stars transferred by the transaction; from 0 to 999999999",
+ "html_description": "Optional. The number of 1/1000000000 shares of Telegram Stars transferred by the transaction; from 0 to 999999999 | ",
+ "rst_description": "*Optional*. The number of 1/1000000000 shares of Telegram Stars transferred by the transaction; from 0 to 999999999\n",
+ "name": "nanostar_amount",
+ "required": false
+ },
{
"type": "Integer",
"description": "Date the transaction was created in Unix time",
@@ -17283,17 +23155,17 @@
{
"type": "Integer",
"required": true,
- "description": "Unique identifier for the target chat",
- "html_description": "Unique identifier for the target chat | ",
- "rst_description": "Unique identifier for the target chat\n",
+ "description": "Unique identifier for the target chat. Games can't be sent to channel direct messages chats and channel chats.",
+ "html_description": "Unique identifier for the target chat. Games can't be sent to channel direct messages chats and channel chats. | ",
+ "rst_description": "Unique identifier for the target chat. Games can't be sent to channel direct messages chats and channel chats.\n",
"name": "chat_id"
},
{
"type": "Integer",
"required": false,
- "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
- "html_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ",
- "rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
+ "description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
+ "html_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | ",
+ "rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"name": "message_thread_id"
},
{
@@ -17320,6 +23192,14 @@
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
+ "html_description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | ",
+ "rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits `_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
+ "name": "allow_paid_broadcast"
+ },
{
"type": "String",
"required": false,
@@ -17557,7 +23437,7 @@
"category": "types"
}
],
- "description": "Your bot can offer users HTML5 games to play solo or to compete against each other in groups and one-on-one chats. Create games via @BotFather using the /newgame command. Please note that this kind of power requires responsibility: you will need to accept the terms for each game that your bots will be offering.\n - Games are a new type of content on Telegram, represented by the Game and InlineQueryResultGame objects.\n - Once you've created a game via BotFather, you can send games to chats as regular messages using the sendGame method, or use inline mode with InlineQueryResultGame.\n - If you send the game message without any buttons, it will automatically have a 'Play GameName' button. When this button is pressed, your bot gets a CallbackQuery with the game_short_name of the requested game. You provide the correct URL for this particular user and the app opens the game in the in-app browser.\n - You can manually add multiple buttons to your game message. Please note that the first button in the first row must always launch the game, using the field callback_game in InlineKeyboardButton. You can add extra buttons according to taste: e.g., for a description of the rules, or to open the game's official community.\n - To make your game more attractive, you can upload a GIF animation that demostrates the game to the users via BotFather (see Lumberjack for example).\n - A game message will also display high scores for the current chat. Use setGameScore to post high scores to the chat with the game, add the edit_message parameter to automatically update the message with the current scoreboard.\n - Use getGameHighScores to get data for in-game high score tables.\n - You can also add an extra sharing button for users to share their best score to different chats.\n - For examples of what can be done using this new stuff, check the @gamebot and @gamee bots."
+ "description": "Your bot can offer users HTML5 games to play solo or to compete against each other in groups and one-on-one chats. Create games via @BotFather using the /newgame command. Please note that this kind of power requires responsibility: you will need to accept the terms for each game that your bots will be offering.\n - Games are a new type of content on Telegram, represented by the Game and InlineQueryResultGame objects.\n - Once you've created a game via BotFather, you can send games to chats as regular messages using the sendGame method, or use inline mode with InlineQueryResultGame.\n - If you send the game message without any buttons, it will automatically have a 'Play GameName' button. When this button is pressed, your bot gets a CallbackQuery with the game_short_name of the requested game. You provide the correct URL for this particular user and the app opens the game in the in-app browser.\n - You can manually add multiple buttons to your game message. Please note that the first button in the first row must always launch the game, using the field callback_game in InlineKeyboardButton. You can add extra buttons according to taste: e.g., for a description of the rules, or to open the game's official community.\n - To make your game more attractive, you can upload a GIF animation that demonstrates the game to the users via BotFather (see Lumberjack for example).\n - A game message will also display high scores for the current chat. Use setGameScore to post high scores to the chat with the game, add the disable_edit_message parameter to disable automatic update of the message with the current scoreboard.\n - Use getGameHighScores to get data for in-game high score tables.\n - You can also add an extra sharing button for users to share their best score to different chats.\n - For examples of what can be done using this new stuff, check the @gamebot and @gamee bots."
}
]
}
diff --git a/.butcher/types/AcceptedGiftTypes/entity.json b/.butcher/types/AcceptedGiftTypes/entity.json
new file mode 100644
index 00000000..5292a643
--- /dev/null
+++ b/.butcher/types/AcceptedGiftTypes/entity.json
@@ -0,0 +1,57 @@
+{
+ "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": "This object describes the types of gifts that can be gifted to a user or a chat.
",
+ "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": "True, if unlimited regular gifts are accepted | ",
+ "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": "True, if limited regular gifts are accepted | ",
+ "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": "True, if unique gifts or gifts that can be upgraded to unique for free are accepted | ",
+ "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": "True, if a Telegram Premium subscription is accepted | ",
+ "rst_description": ":code:`True`, if a Telegram Premium subscription is accepted\n",
+ "name": "premium_subscription",
+ "required": true
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if transfers of unique gifts from channels are accepted",
+ "html_description": "True, if transfers of unique gifts from channels are accepted | ",
+ "rst_description": ":code:`True`, if transfers of unique gifts from channels are accepted\n",
+ "name": "gifts_from_channels",
+ "required": true
+ }
+ ],
+ "category": "types"
+ }
+}
diff --git a/.butcher/types/AffiliateInfo/entity.json b/.butcher/types/AffiliateInfo/entity.json
new file mode 100644
index 00000000..f73a4f24
--- /dev/null
+++ b/.butcher/types/AffiliateInfo/entity.json
@@ -0,0 +1,57 @@
+{
+ "meta": {},
+ "group": {
+ "title": "Payments",
+ "anchor": "payments"
+ },
+ "object": {
+ "anchor": "affiliateinfo",
+ "name": "AffiliateInfo",
+ "description": "Contains information about the affiliate that received a commission via this transaction.",
+ "html_description": "Contains information about the affiliate that received a commission via this transaction.
",
+ "rst_description": "Contains information about the affiliate that received a commission via this transaction.",
+ "annotations": [
+ {
+ "type": "User",
+ "description": "The bot or the user that received an affiliate commission if it was received by a bot or a user",
+ "html_description": "Optional. The bot or the user that received an affiliate commission if it was received by a bot or a user | ",
+ "rst_description": "*Optional*. The bot or the user that received an affiliate commission if it was received by a bot or a user\n",
+ "name": "affiliate_user",
+ "required": false
+ },
+ {
+ "type": "Chat",
+ "description": "The chat that received an affiliate commission if it was received by a chat",
+ "html_description": "Optional. The chat that received an affiliate commission if it was received by a chat | ",
+ "rst_description": "*Optional*. The chat that received an affiliate commission if it was received by a chat\n",
+ "name": "affiliate_chat",
+ "required": false
+ },
+ {
+ "type": "Integer",
+ "description": "The number of Telegram Stars received by the affiliate for each 1000 Telegram Stars received by the bot from referred users",
+ "html_description": "The number of Telegram Stars received by the affiliate for each 1000 Telegram Stars received by the bot from referred users | ",
+ "rst_description": "The number of Telegram Stars received by the affiliate for each 1000 Telegram Stars received by the bot from referred users\n",
+ "name": "commission_per_mille",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "Integer amount of Telegram Stars received by the affiliate from the transaction, rounded to 0; can be negative for refunds",
+ "html_description": "Integer amount of Telegram Stars received by the affiliate from the transaction, rounded to 0; can be negative for refunds | ",
+ "rst_description": "Integer amount of Telegram Stars received by the affiliate from the transaction, rounded to 0; can be negative for refunds\n",
+ "name": "amount",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "The number of 1/1000000000 shares of Telegram Stars received by the affiliate; from -999999999 to 999999999; can be negative for refunds",
+ "html_description": "Optional. The number of 1/1000000000 shares of Telegram Stars received by the affiliate; from -999999999 to 999999999; can be negative for refunds | ",
+ "rst_description": "*Optional*. The number of 1/1000000000 shares of Telegram Stars received by the affiliate; from -999999999 to 999999999; can be negative for refunds\n",
+ "name": "nanostar_amount",
+ "required": false
+ }
+ ],
+ "category": "types"
+ }
+}
diff --git a/.butcher/types/BackgroundTypePattern/entity.json b/.butcher/types/BackgroundTypePattern/entity.json
index 1f286b9f..336bed87 100644
--- a/.butcher/types/BackgroundTypePattern/entity.json
+++ b/.butcher/types/BackgroundTypePattern/entity.json
@@ -7,9 +7,9 @@
"object": {
"anchor": "backgroundtypepattern",
"name": "BackgroundTypePattern",
- "description": "The background is a PNG or TGV (gzipped subset of SVG with MIME type 'application/x-tgwallpattern') pattern to be combined with the background fill chosen by the user.",
- "html_description": "The background is a PNG or TGV (gzipped subset of SVG with MIME type “application/x-tgwallpattern”) pattern to be combined with the background fill chosen by the user.
",
- "rst_description": "The background is a PNG or TGV (gzipped subset of SVG with MIME type 'application/x-tgwallpattern') pattern to be combined with the background fill chosen by the user.",
+ "description": "The background is a .PNG or .TGV (gzipped subset of SVG with MIME type 'application/x-tgwallpattern') pattern to be combined with the background fill chosen by the user.",
+ "html_description": "The background is a .PNG or .TGV (gzipped subset of SVG with MIME type “application/x-tgwallpattern”) pattern to be combined with the background fill chosen by the user.
",
+ "rst_description": "The background is a .PNG or .TGV (gzipped subset of SVG with MIME type 'application/x-tgwallpattern') pattern to be combined with the background fill chosen by the user.",
"annotations": [
{
"type": "String",
diff --git a/.butcher/types/BotCommandScopeChat/entity.json b/.butcher/types/BotCommandScopeChat/entity.json
index 09990c4a..bf5abb13 100644
--- a/.butcher/types/BotCommandScopeChat/entity.json
+++ b/.butcher/types/BotCommandScopeChat/entity.json
@@ -21,9 +21,9 @@
},
{
"type": "Integer or String",
- "description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
- "html_description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) | ",
- "rst_description": "Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
+ "description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername). Channel direct messages chats and channel chats aren't supported.",
+ "html_description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername). Channel direct messages chats and channel chats aren't supported. | ",
+ "rst_description": "Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`). Channel direct messages chats and channel chats aren't supported.\n",
"name": "chat_id",
"required": true
}
diff --git a/.butcher/types/BotCommandScopeChatAdministrators/entity.json b/.butcher/types/BotCommandScopeChatAdministrators/entity.json
index 06c96964..5e68cc7f 100644
--- a/.butcher/types/BotCommandScopeChatAdministrators/entity.json
+++ b/.butcher/types/BotCommandScopeChatAdministrators/entity.json
@@ -21,9 +21,9 @@
},
{
"type": "Integer or String",
- "description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
- "html_description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) | ",
- "rst_description": "Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
+ "description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername). Channel direct messages chats and channel chats aren't supported.",
+ "html_description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername). Channel direct messages chats and channel chats aren't supported. | ",
+ "rst_description": "Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`). Channel direct messages chats and channel chats aren't supported.\n",
"name": "chat_id",
"required": true
}
diff --git a/.butcher/types/BotCommandScopeChatMember/entity.json b/.butcher/types/BotCommandScopeChatMember/entity.json
index 6d75e7d6..12e4471e 100644
--- a/.butcher/types/BotCommandScopeChatMember/entity.json
+++ b/.butcher/types/BotCommandScopeChatMember/entity.json
@@ -21,9 +21,9 @@
},
{
"type": "Integer or String",
- "description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
- "html_description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) | ",
- "rst_description": "Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
+ "description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername). Channel direct messages chats and channel chats aren't supported.",
+ "html_description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername). Channel direct messages chats and channel chats aren't supported. | ",
+ "rst_description": "Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`). Channel direct messages chats and channel chats aren't supported.\n",
"name": "chat_id",
"required": true
},
diff --git a/.butcher/types/BusinessBotRights/entity.json b/.butcher/types/BusinessBotRights/entity.json
new file mode 100644
index 00000000..7dc99a03
--- /dev/null
+++ b/.butcher/types/BusinessBotRights/entity.json
@@ -0,0 +1,141 @@
+{
+ "meta": {},
+ "group": {
+ "title": "Available types",
+ "anchor": "available-types"
+ },
+ "object": {
+ "anchor": "businessbotrights",
+ "name": "BusinessBotRights",
+ "description": "Represents the rights of a business bot.",
+ "html_description": "Represents the rights of a business bot.
",
+ "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": "Optional. True, if the bot can send and edit messages in the private chats that had incoming messages in the last 24 hours | ",
+ "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": "Optional. True, if the bot can mark incoming private messages as read | ",
+ "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": "Optional. True, if the bot can delete messages sent by the bot | ",
+ "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": "Optional. True, if the bot can delete all private messages in managed chats | ",
+ "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": "Optional. True, if the bot can edit the first and last name of the business account | ",
+ "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": "Optional. True, if the bot can edit the bio of the business account | ",
+ "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": "Optional. True, if the bot can edit the profile photo of the business account | ",
+ "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": "Optional. True, if the bot can edit the username of the business account | ",
+ "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": "Optional. True, if the bot can change the privacy settings pertaining to gifts for the business account | ",
+ "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": "Optional. True, if the bot can view gifts and the amount of Telegram Stars owned by the business account | ",
+ "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": "Optional. True, if the bot can convert regular gifts owned by the business account to Telegram Stars | ",
+ "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": "Optional. True, if the bot can transfer and upgrade gifts owned by the business account | ",
+ "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": "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 | ",
+ "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": "Optional. True, if the bot can post, edit and delete stories on behalf of the business account | ",
+ "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": "Optional. True, if the bot can delete messages sent by the bot | ",
+ "rst_description": "*Optional*. True, if the bot can delete messages sent by the bot\n",
+ "name": "can_delete_outgoing_messages",
+ "required": false,
+ "deprecated": {
+ "version": "9.1",
+ "release_date": "2025-07-03"
+ }
+ }
+ ],
+ "category": "types"
+ }
+}
diff --git a/.butcher/types/BusinessConnection/entity.json b/.butcher/types/BusinessConnection/entity.json
index 09b9a0ef..1eeec3df 100644
--- a/.butcher/types/BusinessConnection/entity.json
+++ b/.butcher/types/BusinessConnection/entity.json
@@ -43,21 +43,33 @@
"name": "date",
"required": true
},
+ {
+ "type": "BusinessBotRights",
+ "description": "Rights of the business bot",
+ "html_description": "Optional. Rights of the business bot | ",
+ "rst_description": "*Optional*. Rights of the business bot\n",
+ "name": "rights",
+ "required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the connection is active",
+ "html_description": "True, if the connection is active | ",
+ "rst_description": ":code:`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": "True, if the bot can act on behalf of the business account in chats that were active in the last 24 hours | ",
"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": "Boolean",
- "description": "True, if the connection is active",
- "html_description": "True, if the connection is active | ",
- "rst_description": "True, if the connection is active\n",
- "name": "is_enabled",
- "required": true
+ "required": false,
+ "deprecated": {
+ "version": "9.0",
+ "release_date": "2025-04-11"
+ }
}
],
"category": "types"
diff --git a/.butcher/types/Chat/aliases.yml b/.butcher/types/Chat/aliases.yml
index 89b5843c..7a03c4a9 100644
--- a/.butcher/types/Chat/aliases.yml
+++ b/.butcher/types/Chat/aliases.yml
@@ -71,6 +71,10 @@ set_administrator_custom_title:
method: setChatAdministratorCustomTitle
fill: *self
+set_member_tag:
+ method: setChatMemberTag
+ fill: *self
+
set_permissions:
method: setChatPermissions
fill: *self
diff --git a/.butcher/types/Chat/entity.json b/.butcher/types/Chat/entity.json
index df2e25b1..e06b2291 100644
--- a/.butcher/types/Chat/entity.json
+++ b/.butcher/types/Chat/entity.json
@@ -67,6 +67,14 @@
"name": "is_forum",
"required": false
},
+ {
+ "type": "True",
+ "description": "True, if the chat is the direct messages chat of a channel",
+ "html_description": "Optional. True, if the chat is the direct messages chat of a channel | ",
+ "rst_description": "*Optional*. :code:`True`, if the chat is the direct messages chat of a channel\n",
+ "name": "is_direct_messages",
+ "required": false
+ },
{
"type": "Integer",
"description": "Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See accent colors for more details. Returned only in getChat. Always returned in getChat.",
diff --git a/.butcher/types/ChatAdministratorRights/entity.json b/.butcher/types/ChatAdministratorRights/entity.json
index 21f5e36c..f271d1fd 100644
--- a/.butcher/types/ChatAdministratorRights/entity.json
+++ b/.butcher/types/ChatAdministratorRights/entity.json
@@ -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": "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. | ",
- "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": "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. | ",
+ "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": "Optional. True, if the administrator can post messages in the channel, or access channel statistics; for channels only | ",
- "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": "Optional. True, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only | ",
+ "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
},
@@ -130,6 +130,22 @@
"rst_description": "*Optional*. :code:`True`, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only\n",
"name": "can_manage_topics",
"required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only",
+ "html_description": "Optional. True, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only | ",
+ "rst_description": "*Optional*. :code:`True`, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only\n",
+ "name": "can_manage_direct_messages",
+ "required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted defaults to the value of can_pin_messages.",
+ "html_description": "Optional. True, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted defaults to the value of can_pin_messages. | ",
+ "rst_description": "*Optional*. :code:`True`, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted defaults to the value of can_pin_messages.\n",
+ "name": "can_manage_tags",
+ "required": false
}
],
"category": "types"
diff --git a/.butcher/types/ChatBoostSourceGiveaway/entity.json b/.butcher/types/ChatBoostSourceGiveaway/entity.json
index f01133f3..f6850a07 100644
--- a/.butcher/types/ChatBoostSourceGiveaway/entity.json
+++ b/.butcher/types/ChatBoostSourceGiveaway/entity.json
@@ -7,9 +7,9 @@
"object": {
"anchor": "chatboostsourcegiveaway",
"name": "ChatBoostSourceGiveaway",
- "description": "The boost was obtained by the creation of a Telegram Premium giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription.",
- "html_description": "The boost was obtained by the creation of a Telegram Premium giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription.
",
- "rst_description": "The boost was obtained by the creation of a Telegram Premium giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription.",
+ "description": "The boost was obtained by the creation of a Telegram Premium or a Telegram Star giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription for Telegram Premium giveaways and prize_star_count / 500 times for one year for Telegram Star giveaways.",
+ "html_description": "The boost was obtained by the creation of a Telegram Premium or a Telegram Star giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription for Telegram Premium giveaways and prize_star_count / 500 times for one year for Telegram Star giveaways.
",
+ "rst_description": "The boost was obtained by the creation of a Telegram Premium or a Telegram Star giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription for Telegram Premium giveaways and *prize_star_count* / 500 times for one year for Telegram Star giveaways.",
"annotations": [
{
"type": "String",
@@ -29,17 +29,25 @@
},
{
"type": "User",
- "description": "User that won the prize in the giveaway if any",
- "html_description": "Optional. User that won the prize in the giveaway if any | ",
- "rst_description": "*Optional*. User that won the prize in the giveaway if any\n",
+ "description": "User that won the prize in the giveaway if any; for Telegram Premium giveaways only",
+ "html_description": "Optional. User that won the prize in the giveaway if any; for Telegram Premium giveaways only | ",
+ "rst_description": "*Optional*. User that won the prize in the giveaway if any; for Telegram Premium giveaways only\n",
"name": "user",
"required": false
},
+ {
+ "type": "Integer",
+ "description": "The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only",
+ "html_description": "Optional. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only | ",
+ "rst_description": "*Optional*. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only\n",
+ "name": "prize_star_count",
+ "required": false
+ },
{
"type": "True",
"description": "True, if the giveaway was completed, but there was no user to win the prize",
- "html_description": "Optional. True, if the giveaway was completed, but there was no user to win the prize | ",
- "rst_description": "*Optional*. True, if the giveaway was completed, but there was no user to win the prize\n",
+ "html_description": "Optional. True, if the giveaway was completed, but there was no user to win the prize | ",
+ "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
}
diff --git a/.butcher/types/ChatFullInfo/entity.json b/.butcher/types/ChatFullInfo/entity.json
index 0d7dac49..3627d65d 100644
--- a/.butcher/types/ChatFullInfo/entity.json
+++ b/.butcher/types/ChatFullInfo/entity.json
@@ -67,6 +67,14 @@
"name": "is_forum",
"required": false
},
+ {
+ "type": "True",
+ "description": "True, if the chat is the direct messages chat of a channel",
+ "html_description": "Optional. True, if the chat is the direct messages chat of a channel | ",
+ "rst_description": "*Optional*. :code:`True`, if the chat is the direct messages chat of a channel\n",
+ "name": "is_direct_messages",
+ "required": false
+ },
{
"type": "Integer",
"description": "Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See accent colors for more details.",
@@ -139,6 +147,14 @@
"name": "personal_chat",
"required": false
},
+ {
+ "type": "Chat",
+ "description": "Information about the corresponding channel chat; for direct messages chats only",
+ "html_description": "Optional. Information about the corresponding channel chat; for direct messages chats only | ",
+ "rst_description": "*Optional*. Information about the corresponding channel chat; for direct messages chats only\n",
+ "name": "parent_chat",
+ "required": false
+ },
{
"type": "Array of ReactionType",
"description": "List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed.",
@@ -259,6 +275,14 @@
"name": "permissions",
"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": "Information about types of gifts that are accepted by the chat or by the corresponding user for private chats | ",
+ "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",
"description": "True, if paid media messages can be sent or forwarded to the channel chat. The field is available only for channel chats.",
@@ -362,6 +386,50 @@
"rst_description": "*Optional*. For supergroups, the location to which the supergroup is connected\n",
"name": "location",
"required": false
+ },
+ {
+ "type": "UserRating",
+ "description": "For private chats, the rating of the user if any",
+ "html_description": "Optional. For private chats, the rating of the user if any | ",
+ "rst_description": "*Optional*. For private chats, the rating of the user if any\n",
+ "name": "rating",
+ "required": false
+ },
+ {
+ "type": "Audio",
+ "description": "For private chats, the first audio added to the profile of the user",
+ "html_description": "Optional. For private chats, the first audio added to the profile of the user | ",
+ "rst_description": "*Optional*. For private chats, the first audio added to the profile of the user\n",
+ "name": "first_profile_audio",
+ "required": false
+ },
+ {
+ "type": "UniqueGiftColors",
+ "description": "The color scheme based on a unique gift that must be used for the chat's name, message replies and link previews",
+ "html_description": "Optional. The color scheme based on a unique gift that must be used for the chat's name, message replies and link previews | ",
+ "rst_description": "*Optional*. The color scheme based on a unique gift that must be used for the chat's name, message replies and link previews\n",
+ "name": "unique_gift_colors",
+ "required": false
+ },
+ {
+ "type": "Integer",
+ "description": "The number of Telegram Stars a general user have to pay to send a message to the chat",
+ "html_description": "Optional. The number of Telegram Stars a general user have to pay to send a message to the chat | ",
+ "rst_description": "*Optional*. The number of Telegram Stars a general user have to pay to send a message to the chat\n",
+ "name": "paid_message_star_count",
+ "required": false
+ },
+ {
+ "type": "True",
+ "description": "True, if gifts can be sent to the chat",
+ "html_description": "Optional. True, if gifts can be sent to the chat | ",
+ "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"
diff --git a/.butcher/types/ChatInviteLink/entity.json b/.butcher/types/ChatInviteLink/entity.json
index d2441682..c656d1a7 100644
--- a/.butcher/types/ChatInviteLink/entity.json
+++ b/.butcher/types/ChatInviteLink/entity.json
@@ -82,6 +82,22 @@
"rst_description": "*Optional*. Number of pending join requests created using this link\n",
"name": "pending_join_request_count",
"required": false
+ },
+ {
+ "type": "Integer",
+ "description": "The number of seconds the subscription will be active for before the next payment",
+ "html_description": "Optional. The number of seconds the subscription will be active for before the next payment | ",
+ "rst_description": "*Optional*. The number of seconds the subscription will be active for before the next payment\n",
+ "name": "subscription_period",
+ "required": false
+ },
+ {
+ "type": "Integer",
+ "description": "The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat using the link",
+ "html_description": "Optional. The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat using the link | ",
+ "rst_description": "*Optional*. The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat using the link\n",
+ "name": "subscription_price",
+ "required": false
}
],
"category": "types"
diff --git a/.butcher/types/ChatMemberAdministrator/entity.json b/.butcher/types/ChatMemberAdministrator/entity.json
index f217b3fe..7b55cc7a 100644
--- a/.butcher/types/ChatMemberAdministrator/entity.json
+++ b/.butcher/types/ChatMemberAdministrator/entity.json
@@ -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": "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. | ",
- "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": "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. | ",
+ "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": "Optional. True, if the administrator can post messages in the channel, or access channel statistics; for channels only | ",
- "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": "Optional. True, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only | ",
+ "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
},
@@ -155,6 +155,22 @@
"name": "can_manage_topics",
"required": false
},
+ {
+ "type": "Boolean",
+ "description": "True, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only",
+ "html_description": "Optional. True, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only | ",
+ "rst_description": "*Optional*. :code:`True`, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only\n",
+ "name": "can_manage_direct_messages",
+ "required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted defaults to the value of can_pin_messages.",
+ "html_description": "Optional. True, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted defaults to the value of can_pin_messages. | ",
+ "rst_description": "*Optional*. :code:`True`, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted defaults to the value of can_pin_messages.\n",
+ "name": "can_manage_tags",
+ "required": false
+ },
{
"type": "String",
"description": "Custom title for this user",
diff --git a/.butcher/types/ChatMemberMember/entity.json b/.butcher/types/ChatMemberMember/entity.json
index 90d6016a..ed1a8304 100644
--- a/.butcher/types/ChatMemberMember/entity.json
+++ b/.butcher/types/ChatMemberMember/entity.json
@@ -19,6 +19,14 @@
"name": "status",
"required": true
},
+ {
+ "type": "String",
+ "description": "Tag of the member",
+ "html_description": "Optional. Tag of the member | ",
+ "rst_description": "*Optional*. Tag of the member\n",
+ "name": "tag",
+ "required": false
+ },
{
"type": "User",
"description": "Information about the user",
@@ -26,6 +34,14 @@
"rst_description": "Information about the user\n",
"name": "user",
"required": true
+ },
+ {
+ "type": "Integer",
+ "description": "Date when the user's subscription will expire; Unix time",
+ "html_description": "Optional. Date when the user's subscription will expire; Unix time | ",
+ "rst_description": "*Optional*. Date when the user's subscription will expire; Unix time\n",
+ "name": "until_date",
+ "required": false
}
],
"category": "types"
diff --git a/.butcher/types/ChatMemberMember/replace.yml b/.butcher/types/ChatMemberMember/replace.yml
new file mode 100644
index 00000000..e264e991
--- /dev/null
+++ b/.butcher/types/ChatMemberMember/replace.yml
@@ -0,0 +1,5 @@
+annotations:
+ until_date:
+ parsed_type:
+ type: std
+ name: DateTime
diff --git a/.butcher/types/ChatMemberRestricted/entity.json b/.butcher/types/ChatMemberRestricted/entity.json
index e822ae41..f0572284 100644
--- a/.butcher/types/ChatMemberRestricted/entity.json
+++ b/.butcher/types/ChatMemberRestricted/entity.json
@@ -19,6 +19,14 @@
"name": "status",
"required": true
},
+ {
+ "type": "String",
+ "description": "Tag of the member",
+ "html_description": "Optional. Tag of the member | ",
+ "rst_description": "*Optional*. Tag of the member\n",
+ "name": "tag",
+ "required": false
+ },
{
"type": "User",
"description": "Information about the user",
@@ -93,9 +101,9 @@
},
{
"type": "Boolean",
- "description": "True, if the user is allowed to send polls",
- "html_description": "True, if the user is allowed to send polls | ",
- "rst_description": ":code:`True`, if the user is allowed to send polls\n",
+ "description": "True, if the user is allowed to send polls and checklists",
+ "html_description": "True, if the user is allowed to send polls and checklists | ",
+ "rst_description": ":code:`True`, if the user is allowed to send polls and checklists\n",
"name": "can_send_polls",
"required": true
},
@@ -115,6 +123,14 @@
"name": "can_add_web_page_previews",
"required": true
},
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to edit their own tag",
+ "html_description": "True, if the user is allowed to edit their own tag | ",
+ "rst_description": ":code:`True`, if the user is allowed to edit their own tag\n",
+ "name": "can_edit_tag",
+ "required": true
+ },
{
"type": "Boolean",
"description": "True, if the user is allowed to change the chat title, photo and other settings",
diff --git a/.butcher/types/ChatMemberUpdated/entity.json b/.butcher/types/ChatMemberUpdated/entity.json
index e76773dc..e20b3ee6 100644
--- a/.butcher/types/ChatMemberUpdated/entity.json
+++ b/.butcher/types/ChatMemberUpdated/entity.json
@@ -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": "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 | ",
- "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": "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 | ",
+ "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": "Optional. True, if the user joined the chat via a chat folder invite link | ",
- "rst_description": "*Optional*. True, if the user joined the chat via a chat folder invite link\n",
+ "html_description": "Optional. True, if the user joined the chat via a chat folder invite link | ",
+ "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
}
diff --git a/.butcher/types/ChatOwnerChanged/entity.json b/.butcher/types/ChatOwnerChanged/entity.json
new file mode 100644
index 00000000..083be3fa
--- /dev/null
+++ b/.butcher/types/ChatOwnerChanged/entity.json
@@ -0,0 +1,25 @@
+{
+ "meta": {},
+ "group": {
+ "title": "Available types",
+ "anchor": "available-types"
+ },
+ "object": {
+ "anchor": "chatownerchanged",
+ "name": "ChatOwnerChanged",
+ "description": "Describes a service message about an ownership change in the chat.",
+ "html_description": "Describes a service message about an ownership change in the chat.
",
+ "rst_description": "Describes a service message about an ownership change in the chat.",
+ "annotations": [
+ {
+ "type": "User",
+ "description": "The new owner of the chat",
+ "html_description": "The new owner of the chat | ",
+ "rst_description": "The new owner of the chat\n",
+ "name": "new_owner",
+ "required": true
+ }
+ ],
+ "category": "types"
+ }
+}
diff --git a/.butcher/types/ChatOwnerLeft/entity.json b/.butcher/types/ChatOwnerLeft/entity.json
new file mode 100644
index 00000000..bbeac660
--- /dev/null
+++ b/.butcher/types/ChatOwnerLeft/entity.json
@@ -0,0 +1,25 @@
+{
+ "meta": {},
+ "group": {
+ "title": "Available types",
+ "anchor": "available-types"
+ },
+ "object": {
+ "anchor": "chatownerleft",
+ "name": "ChatOwnerLeft",
+ "description": "Describes a service message about the chat owner leaving the chat.",
+ "html_description": "Describes a service message about the chat owner leaving the chat.
",
+ "rst_description": "Describes a service message about the chat owner leaving the chat.",
+ "annotations": [
+ {
+ "type": "User",
+ "description": "The user which will be the new owner of the chat if the previous owner does not return to the chat",
+ "html_description": "Optional. The user which will be the new owner of the chat if the previous owner does not return to the chat | ",
+ "rst_description": "*Optional*. The user which will be the new owner of the chat if the previous owner does not return to the chat\n",
+ "name": "new_owner",
+ "required": false
+ }
+ ],
+ "category": "types"
+ }
+}
diff --git a/.butcher/types/ChatPermissions/entity.json b/.butcher/types/ChatPermissions/entity.json
index b3209460..d6ad3cc9 100644
--- a/.butcher/types/ChatPermissions/entity.json
+++ b/.butcher/types/ChatPermissions/entity.json
@@ -69,9 +69,9 @@
},
{
"type": "Boolean",
- "description": "True, if the user is allowed to send polls",
- "html_description": "Optional. True, if the user is allowed to send polls | ",
- "rst_description": "*Optional*. :code:`True`, if the user is allowed to send polls\n",
+ "description": "True, if the user is allowed to send polls and checklists",
+ "html_description": "Optional. True, if the user is allowed to send polls and checklists | ",
+ "rst_description": "*Optional*. :code:`True`, if the user is allowed to send polls and checklists\n",
"name": "can_send_polls",
"required": false
},
@@ -91,6 +91,14 @@
"name": "can_add_web_page_previews",
"required": false
},
+ {
+ "type": "Boolean",
+ "description": "True, if the user is allowed to edit their own tag",
+ "html_description": "Optional. True, if the user is allowed to edit their own tag | ",
+ "rst_description": "*Optional*. :code:`True`, if the user is allowed to edit their own tag\n",
+ "name": "can_edit_tag",
+ "required": false
+ },
{
"type": "Boolean",
"description": "True, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups",
diff --git a/.butcher/types/Checklist/entity.json b/.butcher/types/Checklist/entity.json
new file mode 100644
index 00000000..0d415f2a
--- /dev/null
+++ b/.butcher/types/Checklist/entity.json
@@ -0,0 +1,57 @@
+{
+ "meta": {},
+ "group": {
+ "title": "Available types",
+ "anchor": "available-types"
+ },
+ "object": {
+ "anchor": "checklist",
+ "name": "Checklist",
+ "description": "Describes a checklist.",
+ "html_description": "Describes a checklist.
",
+ "rst_description": "Describes a checklist.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Title of the checklist",
+ "html_description": "Title of the checklist | ",
+ "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": "Optional. Special entities that appear in the checklist title | ",
+ "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": "List of tasks in the checklist | ",
+ "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": "Optional. True, if users other than the creator of the list can add tasks to the list | ",
+ "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": "Optional. True, if users other than the creator of the list can mark tasks as done or not done | ",
+ "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"
+ }
+}
diff --git a/.butcher/types/ChecklistTask/entity.json b/.butcher/types/ChecklistTask/entity.json
new file mode 100644
index 00000000..7dd1af45
--- /dev/null
+++ b/.butcher/types/ChecklistTask/entity.json
@@ -0,0 +1,65 @@
+{
+ "meta": {},
+ "group": {
+ "title": "Available types",
+ "anchor": "available-types"
+ },
+ "object": {
+ "anchor": "checklisttask",
+ "name": "ChecklistTask",
+ "description": "Describes a task in a checklist.",
+ "html_description": "Describes a task in a checklist.
",
+ "rst_description": "Describes a task in a checklist.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "description": "Unique identifier of the task",
+ "html_description": "Unique identifier of the task | ",
+ "rst_description": "Unique identifier of the task\n",
+ "name": "id",
+ "required": true
+ },
+ {
+ "type": "String",
+ "description": "Text of the task",
+ "html_description": "Text of the task | ",
+ "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": "Optional. Special entities that appear in the task text | ",
+ "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 by a user",
+ "html_description": "Optional. User that completed the task; omitted if the task wasn't completed by a user | ",
+ "rst_description": "*Optional*. User that completed the task; omitted if the task wasn't completed by a user\n",
+ "name": "completed_by_user",
+ "required": false
+ },
+ {
+ "type": "Chat",
+ "description": "Chat that completed the task; omitted if the task wasn't completed by a chat",
+ "html_description": "Optional. Chat that completed the task; omitted if the task wasn't completed by a chat | ",
+ "rst_description": "*Optional*. Chat that completed the task; omitted if the task wasn't completed by a chat\n",
+ "name": "completed_by_chat",
+ "required": false
+ },
+ {
+ "type": "Integer",
+ "description": "Point in time (Unix timestamp) when the task was completed; 0 if the task wasn't completed",
+ "html_description": "Optional. Point in time (Unix timestamp) when the task was completed; 0 if the task wasn't completed | ",
+ "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"
+ }
+}
diff --git a/.butcher/types/ChecklistTasksAdded/entity.json b/.butcher/types/ChecklistTasksAdded/entity.json
new file mode 100644
index 00000000..08767562
--- /dev/null
+++ b/.butcher/types/ChecklistTasksAdded/entity.json
@@ -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": "Describes a service message about tasks added to a checklist.
",
+ "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": "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. | ",
+ "rst_description": "*Optional*. Message containing the checklist to which the tasks were added. Note that the :class:`aiogram.types.message.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": "List of tasks added to the checklist | ",
+ "rst_description": "List of tasks added to the checklist\n",
+ "name": "tasks",
+ "required": true
+ }
+ ],
+ "category": "types"
+ }
+}
diff --git a/.butcher/types/ChecklistTasksDone/entity.json b/.butcher/types/ChecklistTasksDone/entity.json
new file mode 100644
index 00000000..7949b8ff
--- /dev/null
+++ b/.butcher/types/ChecklistTasksDone/entity.json
@@ -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": "Describes a service message about checklist tasks marked as done or not done.
",
+ "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": "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. | ",
+ "rst_description": "*Optional*. Message containing the checklist whose tasks were marked as done or not done. Note that the :class:`aiogram.types.message.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": "Optional. Identifiers of the tasks that were marked as done | ",
+ "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": "Optional. Identifiers of the tasks that were marked as not done | ",
+ "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"
+ }
+}
diff --git a/.butcher/types/CopyTextButton/entity.json b/.butcher/types/CopyTextButton/entity.json
new file mode 100644
index 00000000..cafe2a36
--- /dev/null
+++ b/.butcher/types/CopyTextButton/entity.json
@@ -0,0 +1,25 @@
+{
+ "meta": {},
+ "group": {
+ "title": "Available types",
+ "anchor": "available-types"
+ },
+ "object": {
+ "anchor": "copytextbutton",
+ "name": "CopyTextButton",
+ "description": "This object represents an inline keyboard button that copies specified text to the clipboard.",
+ "html_description": "This object represents an inline keyboard button that copies specified text to the clipboard.
",
+ "rst_description": "This object represents an inline keyboard button that copies specified text to the clipboard.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "The text to be copied to the clipboard; 1-256 characters",
+ "html_description": "The text to be copied to the clipboard; 1-256 characters | ",
+ "rst_description": "The text to be copied to the clipboard; 1-256 characters\n",
+ "name": "text",
+ "required": true
+ }
+ ],
+ "category": "types"
+ }
+}
diff --git a/.butcher/types/DirectMessagePriceChanged/entity.json b/.butcher/types/DirectMessagePriceChanged/entity.json
new file mode 100644
index 00000000..7652323c
--- /dev/null
+++ b/.butcher/types/DirectMessagePriceChanged/entity.json
@@ -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": "Describes a service message about a change in the price of direct messages sent to a channel chat.
",
+ "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": "True, if direct messages are enabled for the channel chat; false otherwise | ",
+ "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": "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. | ",
+ "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"
+ }
+}
diff --git a/.butcher/types/DirectMessagesTopic/entity.json b/.butcher/types/DirectMessagesTopic/entity.json
new file mode 100644
index 00000000..7139d8de
--- /dev/null
+++ b/.butcher/types/DirectMessagesTopic/entity.json
@@ -0,0 +1,33 @@
+{
+ "meta": {},
+ "group": {
+ "title": "Available types",
+ "anchor": "available-types"
+ },
+ "object": {
+ "anchor": "directmessagestopic",
+ "name": "DirectMessagesTopic",
+ "description": "Describes a topic of a direct messages chat.",
+ "html_description": "Describes a topic of a direct messages chat.
",
+ "rst_description": "Describes a topic of a direct messages chat.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "description": "Unique identifier of the topic. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.",
+ "html_description": "Unique identifier of the topic. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. | ",
+ "rst_description": "Unique identifier of the topic. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.\n",
+ "name": "topic_id",
+ "required": true
+ },
+ {
+ "type": "User",
+ "description": "Information about the user that created the topic. Currently, it is always present",
+ "html_description": "Optional. Information about the user that created the topic. Currently, it is always present | ",
+ "rst_description": "*Optional*. Information about the user that created the topic. Currently, it is always present\n",
+ "name": "user",
+ "required": false
+ }
+ ],
+ "category": "types"
+ }
+}
diff --git a/.butcher/types/ExternalReplyInfo/default.yml b/.butcher/types/ExternalReplyInfo/default.yml
new file mode 100644
index 00000000..becd35ac
--- /dev/null
+++ b/.butcher/types/ExternalReplyInfo/default.yml
@@ -0,0 +1,2 @@
+disable_web_page_preview: link_preview_is_disabled
+parse_mode: parse_mode
diff --git a/.butcher/types/ExternalReplyInfo/entity.json b/.butcher/types/ExternalReplyInfo/entity.json
index 312693a3..2eb4ed5c 100644
--- a/.butcher/types/ExternalReplyInfo/entity.json
+++ b/.butcher/types/ExternalReplyInfo/entity.json
@@ -131,6 +131,14 @@
"name": "has_media_spoiler",
"required": false
},
+ {
+ "type": "Checklist",
+ "description": "Message is a checklist",
+ "html_description": "Optional. Message is a checklist | ",
+ "rst_description": "*Optional*. Message is a checklist\n",
+ "name": "checklist",
+ "required": false
+ },
{
"type": "Contact",
"description": "Message is a shared contact, information about the contact",
diff --git a/.butcher/types/ForumTopic/entity.json b/.butcher/types/ForumTopic/entity.json
index 4198661a..d774fb7e 100644
--- a/.butcher/types/ForumTopic/entity.json
+++ b/.butcher/types/ForumTopic/entity.json
@@ -42,6 +42,14 @@
"rst_description": "*Optional*. Unique identifier of the custom emoji shown as the topic icon\n",
"name": "icon_custom_emoji_id",
"required": false
+ },
+ {
+ "type": "True",
+ "description": "True, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed by the bot",
+ "html_description": "Optional. True, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed by the bot | ",
+ "rst_description": "*Optional*. :code:`True`, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed by the bot\n",
+ "name": "is_name_implicit",
+ "required": false
}
],
"category": "types"
diff --git a/.butcher/types/ForumTopicCreated/entity.json b/.butcher/types/ForumTopicCreated/entity.json
index f1832898..a2b39b66 100644
--- a/.butcher/types/ForumTopicCreated/entity.json
+++ b/.butcher/types/ForumTopicCreated/entity.json
@@ -34,6 +34,14 @@
"rst_description": "*Optional*. Unique identifier of the custom emoji shown as the topic icon\n",
"name": "icon_custom_emoji_id",
"required": false
+ },
+ {
+ "type": "True",
+ "description": "True, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed by the bot",
+ "html_description": "Optional. True, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed by the bot | ",
+ "rst_description": "*Optional*. :code:`True`, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed by the bot\n",
+ "name": "is_name_implicit",
+ "required": false
}
],
"category": "types"
diff --git a/.butcher/types/Gift/entity.json b/.butcher/types/Gift/entity.json
new file mode 100644
index 00000000..be2f518f
--- /dev/null
+++ b/.butcher/types/Gift/entity.json
@@ -0,0 +1,121 @@
+{
+ "meta": {},
+ "group": {
+ "title": "Available types",
+ "anchor": "available-types"
+ },
+ "object": {
+ "anchor": "gift",
+ "name": "Gift",
+ "description": "This object represents a gift that can be sent by the bot.",
+ "html_description": "This object represents a gift that can be sent by the bot.
",
+ "rst_description": "This object represents a gift that can be sent by the bot.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Unique identifier of the gift",
+ "html_description": "Unique identifier of the gift | ",
+ "rst_description": "Unique identifier of the gift\n",
+ "name": "id",
+ "required": true
+ },
+ {
+ "type": "Sticker",
+ "description": "The sticker that represents the gift",
+ "html_description": "The sticker that represents the gift | ",
+ "rst_description": "The sticker that represents the gift\n",
+ "name": "sticker",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "The number of Telegram Stars that must be paid to send the sticker",
+ "html_description": "The number of Telegram Stars that must be paid to send the sticker | ",
+ "rst_description": "The number of Telegram Stars that must be paid to send the sticker\n",
+ "name": "star_count",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "The number of Telegram Stars that must be paid to upgrade the gift to a unique one",
+ "html_description": "Optional. The number of Telegram Stars that must be paid to upgrade the gift to a unique one | ",
+ "rst_description": "*Optional*. The number of Telegram Stars that must be paid to upgrade the gift to a unique one\n",
+ "name": "upgrade_star_count",
+ "required": false
+ },
+ {
+ "type": "True",
+ "description": "True, if the gift can only be purchased by Telegram Premium subscribers",
+ "html_description": "Optional. True, if the gift can only be purchased by Telegram Premium subscribers | ",
+ "rst_description": "*Optional*. :code:`True`, if the gift can only be purchased by Telegram Premium subscribers\n",
+ "name": "is_premium",
+ "required": false
+ },
+ {
+ "type": "True",
+ "description": "True, if the gift can be used (after being upgraded) to customize a user's appearance",
+ "html_description": "Optional. True, if the gift can be used (after being upgraded) to customize a user's appearance | ",
+ "rst_description": "*Optional*. :code:`True`, if the gift can be used (after being upgraded) to customize a user's appearance\n",
+ "name": "has_colors",
+ "required": false
+ },
+ {
+ "type": "Integer",
+ "description": "The total number of gifts of this type that can be sent by all users; for limited gifts only",
+ "html_description": "Optional. The total number of gifts of this type that can be sent by all users; for limited gifts only | ",
+ "rst_description": "*Optional*. The total number of gifts of this type that can be sent by all users; for limited gifts only\n",
+ "name": "total_count",
+ "required": false
+ },
+ {
+ "type": "Integer",
+ "description": "The number of remaining gifts of this type that can be sent by all users; for limited gifts only",
+ "html_description": "Optional. The number of remaining gifts of this type that can be sent by all users; for limited gifts only | ",
+ "rst_description": "*Optional*. The number of remaining gifts of this type that can be sent by all users; for limited gifts only\n",
+ "name": "remaining_count",
+ "required": false
+ },
+ {
+ "type": "Integer",
+ "description": "The total number of gifts of this type that can be sent by the bot; for limited gifts only",
+ "html_description": "Optional. The total number of gifts of this type that can be sent by the bot; for limited gifts only | ",
+ "rst_description": "*Optional*. The total number of gifts of this type that can be sent by the bot; for limited gifts only\n",
+ "name": "personal_total_count",
+ "required": false
+ },
+ {
+ "type": "Integer",
+ "description": "The number of remaining gifts of this type that can be sent by the bot; for limited gifts only",
+ "html_description": "Optional. The number of remaining gifts of this type that can be sent by the bot; for limited gifts only | ",
+ "rst_description": "*Optional*. The number of remaining gifts of this type that can be sent by the bot; for limited gifts only\n",
+ "name": "personal_remaining_count",
+ "required": false
+ },
+ {
+ "type": "GiftBackground",
+ "description": "Background of the gift",
+ "html_description": "Optional. Background of the gift | ",
+ "rst_description": "*Optional*. Background of the gift\n",
+ "name": "background",
+ "required": false
+ },
+ {
+ "type": "Integer",
+ "description": "The total number of different unique gifts that can be obtained by upgrading the gift",
+ "html_description": "Optional. The total number of different unique gifts that can be obtained by upgrading the gift | ",
+ "rst_description": "*Optional*. The total number of different unique gifts that can be obtained by upgrading the gift\n",
+ "name": "unique_gift_variant_count",
+ "required": false
+ },
+ {
+ "type": "Chat",
+ "description": "Information about the chat that published the gift",
+ "html_description": "Optional. Information about the chat that published the gift | ",
+ "rst_description": "*Optional*. Information about the chat that published the gift\n",
+ "name": "publisher_chat",
+ "required": false
+ }
+ ],
+ "category": "types"
+ }
+}
diff --git a/.butcher/types/GiftBackground/entity.json b/.butcher/types/GiftBackground/entity.json
new file mode 100644
index 00000000..34e3e0a6
--- /dev/null
+++ b/.butcher/types/GiftBackground/entity.json
@@ -0,0 +1,41 @@
+{
+ "meta": {},
+ "group": {
+ "title": "Available types",
+ "anchor": "available-types"
+ },
+ "object": {
+ "anchor": "giftbackground",
+ "name": "GiftBackground",
+ "description": "This object describes the background of a gift.",
+ "html_description": "This object describes the background of a gift.
",
+ "rst_description": "This object describes the background of a gift.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "description": "Center color of the background in RGB format",
+ "html_description": "Center color of the background in RGB format | ",
+ "rst_description": "Center color of the background in RGB format\n",
+ "name": "center_color",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "Edge color of the background in RGB format",
+ "html_description": "Edge color of the background in RGB format | ",
+ "rst_description": "Edge color of the background in RGB format\n",
+ "name": "edge_color",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "Text color of the background in RGB format",
+ "html_description": "Text color of the background in RGB format | ",
+ "rst_description": "Text color of the background in RGB format\n",
+ "name": "text_color",
+ "required": true
+ }
+ ],
+ "category": "types"
+ }
+}
diff --git a/.butcher/types/GiftInfo/entity.json b/.butcher/types/GiftInfo/entity.json
new file mode 100644
index 00000000..daf00279
--- /dev/null
+++ b/.butcher/types/GiftInfo/entity.json
@@ -0,0 +1,97 @@
+{
+ "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": "Describes a service message about a regular gift that was sent or received.
",
+ "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": "Information about the gift | ",
+ "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": "Optional. Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts | ",
+ "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": "Optional. Number of Telegram Stars that can be claimed by the receiver by converting the gift; omitted if conversion to Telegram Stars is impossible | ",
+ "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 for the ability to upgrade the gift",
+ "html_description": "Optional. Number of Telegram Stars that were prepaid for the ability to upgrade the gift | ",
+ "rst_description": "*Optional*. Number of Telegram Stars that were prepaid for the ability to upgrade the gift\n",
+ "name": "prepaid_upgrade_star_count",
+ "required": false
+ },
+ {
+ "type": "True",
+ "description": "True, if the gift's upgrade was purchased after the gift was sent",
+ "html_description": "Optional. True, if the gift's upgrade was purchased after the gift was sent | ",
+ "rst_description": "*Optional*. :code:`True`, if the gift's upgrade was purchased after the gift was sent\n",
+ "name": "is_upgrade_separate",
+ "required": false
+ },
+ {
+ "type": "True",
+ "description": "True, if the gift can be upgraded to a unique gift",
+ "html_description": "Optional. True, if the gift can be upgraded to a unique gift | ",
+ "rst_description": "*Optional*. :code:`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": "Optional. Text of the message that was added to the gift | ",
+ "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": "Optional. Special entities that appear in the text | ",
+ "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": "Optional. True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them | ",
+ "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": "Integer",
+ "description": "Unique number reserved for this gift when upgraded. See the number field in UniqueGift",
+ "html_description": "Optional. Unique number reserved for this gift when upgraded. See the number field in UniqueGift | ",
+ "rst_description": "*Optional*. Unique number reserved for this gift when upgraded. See the *number* field in :class:`aiogram.types.unique_gift.UniqueGift`\n",
+ "name": "unique_gift_number",
+ "required": false
+ }
+ ],
+ "category": "types"
+ }
+}
diff --git a/.butcher/types/Gifts/entity.json b/.butcher/types/Gifts/entity.json
new file mode 100644
index 00000000..bca737bd
--- /dev/null
+++ b/.butcher/types/Gifts/entity.json
@@ -0,0 +1,25 @@
+{
+ "meta": {},
+ "group": {
+ "title": "Available types",
+ "anchor": "available-types"
+ },
+ "object": {
+ "anchor": "gifts",
+ "name": "Gifts",
+ "description": "This object represent a list of gifts.",
+ "html_description": "This object represent a list of gifts.
",
+ "rst_description": "This object represent a list of gifts.",
+ "annotations": [
+ {
+ "type": "Array of Gift",
+ "description": "The list of gifts",
+ "html_description": "The list of gifts | ",
+ "rst_description": "The list of gifts\n",
+ "name": "gifts",
+ "required": true
+ }
+ ],
+ "category": "types"
+ }
+}
diff --git a/.butcher/types/Giveaway/entity.json b/.butcher/types/Giveaway/entity.json
index 53178a8c..ad326982 100644
--- a/.butcher/types/Giveaway/entity.json
+++ b/.butcher/types/Giveaway/entity.json
@@ -69,9 +69,17 @@
},
{
"type": "Integer",
- "description": "The number of months the Telegram Premium subscription won from the giveaway will be active for",
- "html_description": "Optional. The number of months the Telegram Premium subscription won from the giveaway will be active for | ",
- "rst_description": "*Optional*. The number of months the Telegram Premium subscription won from the giveaway will be active for\n",
+ "description": "The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only",
+ "html_description": "Optional. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only | ",
+ "rst_description": "*Optional*. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only\n",
+ "name": "prize_star_count",
+ "required": false
+ },
+ {
+ "type": "Integer",
+ "description": "The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only",
+ "html_description": "Optional. The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only | ",
+ "rst_description": "*Optional*. The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only\n",
"name": "premium_subscription_month_count",
"required": false
}
diff --git a/.butcher/types/GiveawayCompleted/entity.json b/.butcher/types/GiveawayCompleted/entity.json
index 169d3446..e1ecec54 100644
--- a/.butcher/types/GiveawayCompleted/entity.json
+++ b/.butcher/types/GiveawayCompleted/entity.json
@@ -34,6 +34,14 @@
"rst_description": "*Optional*. Message with the giveaway that was completed, if it wasn't deleted\n",
"name": "giveaway_message",
"required": false
+ },
+ {
+ "type": "True",
+ "description": "True, if the giveaway is a Telegram Star giveaway. Otherwise, currently, the giveaway is a Telegram Premium giveaway.",
+ "html_description": "Optional. True, if the giveaway is a Telegram Star giveaway. Otherwise, currently, the giveaway is a Telegram Premium giveaway. | ",
+ "rst_description": "*Optional*. :code:`True`, if the giveaway is a Telegram Star giveaway. Otherwise, currently, the giveaway is a Telegram Premium giveaway.\n",
+ "name": "is_star_giveaway",
+ "required": false
}
],
"category": "types"
diff --git a/.butcher/types/GiveawayCreated/entity.json b/.butcher/types/GiveawayCreated/entity.json
index 38e68bf3..1cf7ca10 100644
--- a/.butcher/types/GiveawayCreated/entity.json
+++ b/.butcher/types/GiveawayCreated/entity.json
@@ -7,10 +7,19 @@
"object": {
"anchor": "giveawaycreated",
"name": "GiveawayCreated",
- "description": "This object represents a service message about the creation of a scheduled giveaway. Currently holds no information.",
- "html_description": "This object represents a service message about the creation of a scheduled giveaway. Currently holds no information.
",
- "rst_description": "This object represents a service message about the creation of a scheduled giveaway. Currently holds no information.",
- "annotations": [],
+ "description": "This object represents a service message about the creation of a scheduled giveaway.",
+ "html_description": "This object represents a service message about the creation of a scheduled giveaway.
",
+ "rst_description": "This object represents a service message about the creation of a scheduled giveaway.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "description": "The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only",
+ "html_description": "Optional. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only | ",
+ "rst_description": "*Optional*. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only\n",
+ "name": "prize_star_count",
+ "required": false
+ }
+ ],
"category": "types"
}
}
diff --git a/.butcher/types/GiveawayWinners/entity.json b/.butcher/types/GiveawayWinners/entity.json
index 76628b90..6843f7a7 100644
--- a/.butcher/types/GiveawayWinners/entity.json
+++ b/.butcher/types/GiveawayWinners/entity.json
@@ -61,9 +61,17 @@
},
{
"type": "Integer",
- "description": "The number of months the Telegram Premium subscription won from the giveaway will be active for",
- "html_description": "Optional. The number of months the Telegram Premium subscription won from the giveaway will be active for | ",
- "rst_description": "*Optional*. The number of months the Telegram Premium subscription won from the giveaway will be active for\n",
+ "description": "The number of Telegram Stars that were split between giveaway winners; for Telegram Star giveaways only",
+ "html_description": "Optional. The number of Telegram Stars that were split between giveaway winners; for Telegram Star giveaways only | ",
+ "rst_description": "*Optional*. The number of Telegram Stars that were split between giveaway winners; for Telegram Star giveaways only\n",
+ "name": "prize_star_count",
+ "required": false
+ },
+ {
+ "type": "Integer",
+ "description": "The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only",
+ "html_description": "Optional. The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only | ",
+ "rst_description": "*Optional*. The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only\n",
"name": "premium_subscription_month_count",
"required": false
},
diff --git a/.butcher/types/InaccessibleMessage/aliases.yml b/.butcher/types/InaccessibleMessage/aliases.yml
new file mode 100644
index 00000000..225e4f7c
--- /dev/null
+++ b/.butcher/types/InaccessibleMessage/aliases.yml
@@ -0,0 +1,202 @@
+answer:
+ method: sendMessage
+ code: &assert-chat |
+ assert self.chat is not None, "This method can be used only if chat is present in the message."
+ fill: &fill-answer
+ chat_id: self.chat.id
+
+reply:
+ method: sendMessage
+ code: *assert-chat
+ fill: &fill-reply
+ <<: *fill-answer
+ reply_parameters: self.as_reply_parameters()
+ ignore: &ignore-reply
+ - reply_to_message_id
+
+answer_animation:
+ method: sendAnimation
+ code: *assert-chat
+ fill: *fill-answer
+
+reply_animation:
+ method: sendAnimation
+ code: *assert-chat
+ fill: *fill-reply
+ ignore: *ignore-reply
+
+answer_audio:
+ method: sendAudio
+ code: *assert-chat
+ fill: *fill-answer
+
+reply_audio:
+ method: sendAudio
+ code: *assert-chat
+ fill: *fill-reply
+ ignore: *ignore-reply
+
+answer_contact:
+ method: sendContact
+ code: *assert-chat
+ fill: *fill-answer
+
+reply_contact:
+ method: sendContact
+ code: *assert-chat
+ fill: *fill-reply
+ ignore: *ignore-reply
+
+answer_document:
+ method: sendDocument
+ code: *assert-chat
+ fill: *fill-answer
+
+reply_document:
+ method: sendDocument
+ code: *assert-chat
+ fill: *fill-reply
+ ignore: *ignore-reply
+
+answer_game:
+ method: sendGame
+ code: *assert-chat
+ fill: *fill-answer
+
+reply_game:
+ method: sendGame
+ code: *assert-chat
+ fill: *fill-reply
+ ignore: *ignore-reply
+
+answer_invoice:
+ method: sendInvoice
+ code: *assert-chat
+ fill: *fill-answer
+
+reply_invoice:
+ method: sendInvoice
+ code: *assert-chat
+ fill: *fill-reply
+ ignore: *ignore-reply
+
+answer_location:
+ method: sendLocation
+ code: *assert-chat
+ fill: *fill-answer
+
+reply_location:
+ method: sendLocation
+ code: *assert-chat
+ fill: *fill-reply
+ ignore: *ignore-reply
+
+answer_media_group:
+ method: sendMediaGroup
+ code: *assert-chat
+ fill: *fill-answer
+
+reply_media_group:
+ method: sendMediaGroup
+ code: *assert-chat
+ fill: *fill-reply
+ ignore: *ignore-reply
+
+answer_photo:
+ method: sendPhoto
+ code: *assert-chat
+ fill: *fill-answer
+
+reply_photo:
+ method: sendPhoto
+ code: *assert-chat
+ fill: *fill-reply
+ ignore: *ignore-reply
+
+answer_poll:
+ method: sendPoll
+ code: *assert-chat
+ fill: *fill-answer
+
+reply_poll:
+ method: sendPoll
+ code: *assert-chat
+ fill: *fill-reply
+ ignore: *ignore-reply
+
+answer_dice:
+ method: sendDice
+ code: *assert-chat
+ fill: *fill-answer
+
+reply_dice:
+ method: sendDice
+ code: *assert-chat
+ fill: *fill-reply
+ ignore: *ignore-reply
+
+answer_sticker:
+ method: sendSticker
+ code: *assert-chat
+ fill: *fill-answer
+
+reply_sticker:
+ method: sendSticker
+ code: *assert-chat
+ fill: *fill-reply
+ ignore: *ignore-reply
+
+answer_venue:
+ method: sendVenue
+ code: *assert-chat
+ fill: *fill-answer
+
+reply_venue:
+ method: sendVenue
+ code: *assert-chat
+ fill: *fill-reply
+ ignore: *ignore-reply
+
+answer_video:
+ method: sendVideo
+ code: *assert-chat
+ fill: *fill-answer
+
+reply_video:
+ method: sendVideo
+ code: *assert-chat
+ fill: *fill-reply
+ ignore: *ignore-reply
+
+answer_video_note:
+ method: sendVideoNote
+ code: *assert-chat
+ fill: *fill-answer
+
+reply_video_note:
+ method: sendVideoNote
+ code: *assert-chat
+ fill: *fill-reply
+ ignore: *ignore-reply
+
+answer_voice:
+ method: sendVoice
+ code: *assert-chat
+ fill: *fill-answer
+
+reply_voice:
+ method: sendVoice
+ code: *assert-chat
+ fill: *fill-reply
+ ignore: *ignore-reply
+
+answer_paid_media:
+ method: sendPaidMedia
+ code: *assert-chat
+ fill: *fill-answer
+
+reply_paid_media:
+ method: sendPaidMedia
+ code: *assert-chat
+ fill: *fill-reply
+ ignore: *ignore-reply
diff --git a/.butcher/types/InlineKeyboardButton/entity.json b/.butcher/types/InlineKeyboardButton/entity.json
index 7476ee56..15e52808 100644
--- a/.butcher/types/InlineKeyboardButton/entity.json
+++ b/.butcher/types/InlineKeyboardButton/entity.json
@@ -7,9 +7,9 @@
"object": {
"anchor": "inlinekeyboardbutton",
"name": "InlineKeyboardButton",
- "description": "This object represents one button of an inline keyboard. Exactly one of the optional fields must be used to specify type of the button.",
- "html_description": "This object represents one button of an inline keyboard. Exactly one of the optional fields must be used to specify type of the button.
",
- "rst_description": "This object represents one button of an inline keyboard. Exactly one of the optional fields must be used to specify type of the button.",
+ "description": "This object represents one button of an inline keyboard. Exactly one of the fields other than text, icon_custom_emoji_id, and style must be used to specify the type of the button.",
+ "html_description": "This object represents one button of an inline keyboard. Exactly one of the fields other than text, icon_custom_emoji_id, and style must be used to specify the type of the button.
",
+ "rst_description": "This object represents one button of an inline keyboard. Exactly one of the fields other than *text*, *icon_custom_emoji_id*, and *style* must be used to specify the type of the button.",
"annotations": [
{
"type": "String",
@@ -19,6 +19,22 @@
"name": "text",
"required": true
},
+ {
+ "type": "String",
+ "description": "Unique identifier of the custom emoji shown before the text of the button. Can only be used by bots that purchased additional usernames on Fragment or in the messages directly sent by the bot to private, group and supergroup chats if the owner of the bot has a Telegram Premium subscription.",
+ "html_description": "Optional. Unique identifier of the custom emoji shown before the text of the button. Can only be used by bots that purchased additional usernames on Fragment or in the messages directly sent by the bot to private, group and supergroup chats if the owner of the bot has a Telegram Premium subscription. | ",
+ "rst_description": "*Optional*. Unique identifier of the custom emoji shown before the text of the button. Can only be used by bots that purchased additional usernames on `Fragment `_ or in the messages directly sent by the bot to private, group and supergroup chats if the owner of the bot has a Telegram Premium subscription.\n",
+ "name": "icon_custom_emoji_id",
+ "required": false
+ },
+ {
+ "type": "String",
+ "description": "Style of the button. Must be one of 'danger' (red), 'success' (green) or 'primary' (blue). If omitted, then an app-specific style is used.",
+ "html_description": "Optional. Style of the button. Must be one of “danger” (red), “success” (green) or “primary” (blue). If omitted, then an app-specific style is used. | ",
+ "rst_description": "*Optional*. Style of the button. Must be one of 'danger' (red), 'success' (green) or 'primary' (blue). If omitted, then an app-specific style is used.\n",
+ "name": "style",
+ "required": false
+ },
{
"type": "String",
"description": "HTTP or tg:// URL to be opened when the button is pressed. Links tg://user?id= can be used to mention a user by their identifier without using a username, if this is allowed by their privacy settings.",
@@ -53,28 +69,36 @@
},
{
"type": "String",
- "description": "If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. Not supported for messages sent on behalf of a Telegram Business account.",
- "html_description": "Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. Not supported for messages sent on behalf of a Telegram Business account. | ",
- "rst_description": "*Optional*. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. Not supported for messages sent on behalf of a Telegram Business account.\n",
+ "description": "If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. Not supported for messages sent in channel direct messages chats and on behalf of a Telegram Business account.",
+ "html_description": "Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. Not supported for messages sent in channel direct messages chats and on behalf of a Telegram Business account. | ",
+ "rst_description": "*Optional*. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. Not supported for messages sent in channel direct messages chats and on behalf of a Telegram Business account.\n",
"name": "switch_inline_query",
"required": false
},
{
"type": "String",
- "description": "If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.\n\nThis offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent on behalf of a Telegram Business account.",
- "html_description": "Optional. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.
\n
\nThis offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent on behalf of a Telegram Business account. | ",
- "rst_description": "*Optional*. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.\n\n\n\nThis offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent on behalf of a Telegram Business account.\n",
+ "description": "If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.\n\nThis offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent in channel direct messages chats and on behalf of a Telegram Business account.",
+ "html_description": "Optional. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.
\n
\nThis offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent in channel direct messages chats and on behalf of a Telegram Business account. | ",
+ "rst_description": "*Optional*. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.\n\n\n\nThis offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent in channel direct messages chats and on behalf of a Telegram Business account.\n",
"name": "switch_inline_query_current_chat",
"required": false
},
{
"type": "SwitchInlineQueryChosenChat",
- "description": "If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent on behalf of a Telegram Business account.",
- "html_description": "Optional. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent on behalf of a Telegram Business account. | ",
- "rst_description": "*Optional*. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent on behalf of a Telegram Business account.\n",
+ "description": "If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent in channel direct messages chats and on behalf of a Telegram Business account.",
+ "html_description": "Optional. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent in channel direct messages chats and on behalf of a Telegram Business account. | ",
+ "rst_description": "*Optional*. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent in channel direct messages chats and on behalf of a Telegram Business account.\n",
"name": "switch_inline_query_chosen_chat",
"required": false
},
+ {
+ "type": "CopyTextButton",
+ "description": "Description of the button that copies the specified text to the clipboard.",
+ "html_description": "Optional. Description of the button that copies the specified text to the clipboard. | ",
+ "rst_description": "*Optional*. Description of the button that copies the specified text to the clipboard.\n",
+ "name": "copy_text",
+ "required": false
+ },
{
"type": "CallbackGame",
"description": "Description of the game that will be launched when the user presses the button.\n\nNOTE: This type of button must always be the first button in the first row.",
diff --git a/.butcher/types/InlineQueryResultArticle/entity.json b/.butcher/types/InlineQueryResultArticle/entity.json
index eba5d318..c9622b2a 100644
--- a/.butcher/types/InlineQueryResultArticle/entity.json
+++ b/.butcher/types/InlineQueryResultArticle/entity.json
@@ -59,14 +59,6 @@
"name": "url",
"required": false
},
- {
- "type": "Boolean",
- "description": "Pass True if you don't want the URL to be shown in the message",
- "html_description": "Optional. Pass True if you don't want the URL to be shown in the message | ",
- "rst_description": "*Optional*. Pass :code:`True` if you don't want the URL to be shown in the message\n",
- "name": "hide_url",
- "required": false
- },
{
"type": "String",
"description": "Short description of the result",
@@ -98,6 +90,18 @@
"rst_description": "*Optional*. Thumbnail height\n",
"name": "thumbnail_height",
"required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "Pass True if you don't want the URL to be shown in the message",
+ "html_description": "Optional. Pass True if you don't want the URL to be shown in the message | ",
+ "rst_description": "*Optional*. Pass :code:`True` if you don't want the URL to be shown in the message\n",
+ "name": "hide_url",
+ "required": false,
+ "deprecated": {
+ "version": "8.2",
+ "release_date": "2025-01-01"
+ }
}
],
"category": "types"
diff --git a/.butcher/types/InlineQueryResultDocument/entity.json b/.butcher/types/InlineQueryResultDocument/entity.json
index ff703482..97bb05a6 100644
--- a/.butcher/types/InlineQueryResultDocument/entity.json
+++ b/.butcher/types/InlineQueryResultDocument/entity.json
@@ -86,8 +86,8 @@
{
"type": "InlineKeyboardMarkup",
"description": "Inline keyboard attached to the message",
- "html_description": "Optional. Inline keyboard attached to the message | ",
- "rst_description": "*Optional*. Inline keyboard attached to the message\n",
+ "html_description": "Optional. Inline keyboard attached to the message | ",
+ "rst_description": "*Optional*. `Inline keyboard `_ attached to the message\n",
"name": "reply_markup",
"required": false
},
diff --git a/.butcher/types/InlineQueryResultGif/entity.json b/.butcher/types/InlineQueryResultGif/entity.json
index 7c104615..ee825305 100644
--- a/.butcher/types/InlineQueryResultGif/entity.json
+++ b/.butcher/types/InlineQueryResultGif/entity.json
@@ -29,9 +29,9 @@
},
{
"type": "String",
- "description": "A valid URL for the GIF file. File size must not exceed 1MB",
- "html_description": "A valid URL for the GIF file. File size must not exceed 1MB | ",
- "rst_description": "A valid URL for the GIF file. File size must not exceed 1MB\n",
+ "description": "A valid URL for the GIF file",
+ "html_description": "A valid URL for the GIF file | ",
+ "rst_description": "A valid URL for the GIF file\n",
"name": "gif_url",
"required": true
},
diff --git a/.butcher/types/InlineQueryResultMpeg4Gif/entity.json b/.butcher/types/InlineQueryResultMpeg4Gif/entity.json
index fa4c3e81..fc309461 100644
--- a/.butcher/types/InlineQueryResultMpeg4Gif/entity.json
+++ b/.butcher/types/InlineQueryResultMpeg4Gif/entity.json
@@ -29,9 +29,9 @@
},
{
"type": "String",
- "description": "A valid URL for the MPEG4 file. File size must not exceed 1MB",
- "html_description": "A valid URL for the MPEG4 file. File size must not exceed 1MB | ",
- "rst_description": "A valid URL for the MPEG4 file. File size must not exceed 1MB\n",
+ "description": "A valid URL for the MPEG4 file",
+ "html_description": "A valid URL for the MPEG4 file | ",
+ "rst_description": "A valid URL for the MPEG4 file\n",
"name": "mpeg4_url",
"required": true
},
diff --git a/.butcher/types/InputChecklist/entity.json b/.butcher/types/InputChecklist/entity.json
new file mode 100644
index 00000000..f2c45f06
--- /dev/null
+++ b/.butcher/types/InputChecklist/entity.json
@@ -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": "Describes a checklist to create.
",
+ "rst_description": "Describes a checklist to create.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Title of the checklist; 1-255 characters after entities parsing",
+ "html_description": "Title of the checklist; 1-255 characters after entities parsing | ",
+ "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": "Optional. Mode for parsing entities in the title. See formatting options for more details. | ",
+ "rst_description": "*Optional*. Mode for parsing entities in the title. See `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, custom_emoji, and date_time entities are allowed.",
+ "html_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, custom_emoji, and date_time entities are allowed. | ",
+ "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*, *custom_emoji*, and *date_time* entities are allowed.\n",
+ "name": "title_entities",
+ "required": false
+ },
+ {
+ "type": "Array of InputChecklistTask",
+ "description": "List of 1-30 tasks in the checklist",
+ "html_description": "List of 1-30 tasks in the checklist | ",
+ "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": "Optional. Pass True if other users can add tasks to the checklist | ",
+ "rst_description": "*Optional*. Pass :code:`True` if other users can add tasks to the checklist\n",
+ "name": "others_can_add_tasks",
+ "required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "Pass True if other users can mark tasks as done or not done in the checklist",
+ "html_description": "Optional. Pass True if other users can mark tasks as done or not done in the checklist | ",
+ "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"
+ }
+}
diff --git a/.butcher/types/InputChecklistTask/entity.json b/.butcher/types/InputChecklistTask/entity.json
new file mode 100644
index 00000000..b12d4239
--- /dev/null
+++ b/.butcher/types/InputChecklistTask/entity.json
@@ -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": "Describes a task to add to a checklist.
",
+ "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": "Unique identifier of the task; must be positive and unique among all task identifiers currently present in the checklist | ",
+ "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": "Text of the task; 1-100 characters after entities parsing | ",
+ "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": "Optional. Mode for parsing entities in the text. See formatting options for more details. | ",
+ "rst_description": "*Optional*. Mode for parsing entities in the text. See `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, custom_emoji, and date_time entities are allowed.",
+ "html_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, custom_emoji, and date_time entities are allowed. | ",
+ "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*, *custom_emoji*, and *date_time* entities are allowed.\n",
+ "name": "text_entities",
+ "required": false
+ }
+ ],
+ "category": "types"
+ }
+}
diff --git a/.butcher/types/InputInvoiceMessageContent/entity.json b/.butcher/types/InputInvoiceMessageContent/entity.json
index bed9e656..76d2f39b 100644
--- a/.butcher/types/InputInvoiceMessageContent/entity.json
+++ b/.butcher/types/InputInvoiceMessageContent/entity.json
@@ -29,9 +29,9 @@
},
{
"type": "String",
- "description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.",
- "html_description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. | ",
- "rst_description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.\n",
+ "description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.",
+ "html_description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes. | ",
+ "rst_description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.\n",
"name": "payload",
"required": true
},
diff --git a/.butcher/types/InputMediaAnimation/entity.json b/.butcher/types/InputMediaAnimation/entity.json
index e311a1ee..f64c7e1e 100644
--- a/.butcher/types/InputMediaAnimation/entity.json
+++ b/.butcher/types/InputMediaAnimation/entity.json
@@ -28,7 +28,7 @@
"required": true
},
{
- "type": "InputFile or String",
+ "type": "String",
"description": "Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files",
"html_description": "Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | ",
"rst_description": "*Optional*. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . :ref:`More information on Sending Files » `\n",
diff --git a/.butcher/types/InputMediaAudio/entity.json b/.butcher/types/InputMediaAudio/entity.json
index 5f10ad67..95af3e81 100644
--- a/.butcher/types/InputMediaAudio/entity.json
+++ b/.butcher/types/InputMediaAudio/entity.json
@@ -28,7 +28,7 @@
"required": true
},
{
- "type": "InputFile or String",
+ "type": "String",
"description": "Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files",
"html_description": "Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | ",
"rst_description": "*Optional*. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . :ref:`More information on Sending Files » `\n",
diff --git a/.butcher/types/InputMediaDocument/entity.json b/.butcher/types/InputMediaDocument/entity.json
index 676d6947..71be2aaa 100644
--- a/.butcher/types/InputMediaDocument/entity.json
+++ b/.butcher/types/InputMediaDocument/entity.json
@@ -28,7 +28,7 @@
"required": true
},
{
- "type": "InputFile or String",
+ "type": "String",
"description": "Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files",
"html_description": "Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | ",
"rst_description": "*Optional*. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . :ref:`More information on Sending Files » `\n",
diff --git a/.butcher/types/InputMediaVideo/entity.json b/.butcher/types/InputMediaVideo/entity.json
index f1dc1989..0dbf3767 100644
--- a/.butcher/types/InputMediaVideo/entity.json
+++ b/.butcher/types/InputMediaVideo/entity.json
@@ -28,13 +28,29 @@
"required": true
},
{
- "type": "InputFile or String",
+ "type": "String",
"description": "Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files",
"html_description": "Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | ",
"rst_description": "*Optional*. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . :ref:`More information on Sending Files » `\n",
"name": "thumbnail",
"required": false
},
+ {
+ "type": "String",
+ "description": "Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://' to upload a new one using multipart/form-data under name. More information on Sending Files",
+ "html_description": "Optional. Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files » | ",
+ "rst_description": "*Optional*. Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://' to upload a new one using multipart/form-data under name. :ref:`More information on Sending Files » `\n",
+ "name": "cover",
+ "required": false
+ },
+ {
+ "type": "Integer",
+ "description": "Start timestamp for the video in the message",
+ "html_description": "Optional. Start timestamp for the video in the message | ",
+ "rst_description": "*Optional*. Start timestamp for the video in the message\n",
+ "name": "start_timestamp",
+ "required": false
+ },
{
"type": "String",
"description": "Caption of the video to be sent, 0-1024 characters after entities parsing",
diff --git a/.butcher/types/InputMediaVideo/replace.yml b/.butcher/types/InputMediaVideo/replace.yml
index efa1d506..c7ee44f0 100644
--- a/.butcher/types/InputMediaVideo/replace.yml
+++ b/.butcher/types/InputMediaVideo/replace.yml
@@ -9,9 +9,29 @@ annotations:
references:
category: types
name: InputFile
+ cover:
+ parsed_type:
+ type: union
+ items:
+ - type: std
+ name: str
+ - type: entity
+ references:
+ category: types
+ name: InputFile
thumbnail:
parsed_type:
type: entity
references:
category: types
name: InputFile
+ start_timestamp:
+ parsed_type:
+ type: union
+ items:
+ - type: std
+ name: datetime.datetime
+ - type: std
+ name: datetime.timedelta
+ - type: std
+ name: int
diff --git a/.butcher/types/InputPaidMediaVideo/entity.json b/.butcher/types/InputPaidMediaVideo/entity.json
index a04bf3df..9ba408e5 100644
--- a/.butcher/types/InputPaidMediaVideo/entity.json
+++ b/.butcher/types/InputPaidMediaVideo/entity.json
@@ -28,13 +28,29 @@
"required": true
},
{
- "type": "InputFile or String",
+ "type": "String",
"description": "Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files",
"html_description": "Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | ",
"rst_description": "*Optional*. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . :ref:`More information on Sending Files » `\n",
"name": "thumbnail",
"required": false
},
+ {
+ "type": "String",
+ "description": "Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://' to upload a new one using multipart/form-data under name. More information on Sending Files",
+ "html_description": "Optional. Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files » | ",
+ "rst_description": "*Optional*. Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://' to upload a new one using multipart/form-data under name. :ref:`More information on Sending Files » `\n",
+ "name": "cover",
+ "required": false
+ },
+ {
+ "type": "Integer",
+ "description": "Start timestamp for the video in the message",
+ "html_description": "Optional. Start timestamp for the video in the message | ",
+ "rst_description": "*Optional*. Start timestamp for the video in the message\n",
+ "name": "start_timestamp",
+ "required": false
+ },
{
"type": "Integer",
"description": "Video width",
diff --git a/.butcher/types/InputPaidMediaVideo/replace.yml b/.butcher/types/InputPaidMediaVideo/replace.yml
index 17ac606b..c7ee44f0 100644
--- a/.butcher/types/InputPaidMediaVideo/replace.yml
+++ b/.butcher/types/InputPaidMediaVideo/replace.yml
@@ -9,3 +9,29 @@ annotations:
references:
category: types
name: InputFile
+ cover:
+ parsed_type:
+ type: union
+ items:
+ - type: std
+ name: str
+ - type: entity
+ references:
+ category: types
+ name: InputFile
+ thumbnail:
+ parsed_type:
+ type: entity
+ references:
+ category: types
+ name: InputFile
+ start_timestamp:
+ parsed_type:
+ type: union
+ items:
+ - type: std
+ name: datetime.datetime
+ - type: std
+ name: datetime.timedelta
+ - type: std
+ name: int
diff --git a/.butcher/types/InputProfilePhoto/entity.json b/.butcher/types/InputProfilePhoto/entity.json
new file mode 100644
index 00000000..f3ae06fd
--- /dev/null
+++ b/.butcher/types/InputProfilePhoto/entity.json
@@ -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": "This object describes a profile photo to set. Currently, it can be one of
",
+ "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"
+ }
+}
diff --git a/.butcher/types/InputProfilePhoto/subtypes.yml b/.butcher/types/InputProfilePhoto/subtypes.yml
new file mode 100644
index 00000000..6756ad51
--- /dev/null
+++ b/.butcher/types/InputProfilePhoto/subtypes.yml
@@ -0,0 +1 @@
+discriminator: "type"
diff --git a/.butcher/types/InputProfilePhotoAnimated/entity.json b/.butcher/types/InputProfilePhotoAnimated/entity.json
new file mode 100644
index 00000000..01083ce1
--- /dev/null
+++ b/.butcher/types/InputProfilePhotoAnimated/entity.json
@@ -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": "An animated profile photo in the MPEG4 format.
",
+ "rst_description": "An animated profile photo in the MPEG4 format.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Type of the profile photo, must be animated",
+ "html_description": "Type of the profile photo, must be animated | ",
+ "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://' if the photo was uploaded using multipart/form-data under . More information on Sending Files",
+ "html_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 » | ",
+ "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://' if the photo was uploaded using multipart/form-data under . :ref:`More information on 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": " |