aiogram 3.28.2__tar.gz → 3.29.0__tar.gz

aiogram-3.29.0/.apiversion

@@ -0,0 +1 @@
+10.1

aiogram-3.29.0/.butcher/enums/RichBlockType.yml

@@ -0,0 +1,30 @@
+name: RichBlockType
+description: |
+  This object represents a block in a rich formatted message.
+
+  Source: https://core.telegram.org/bots/api#richtext
+multi_parse:
+  attribute: type
+  regexp: "always '([a-z_]+)'"
+  entities:
+    - RichBlockParagraph
+    - RichBlockSectionHeading
+    - RichBlockPreformatted
+    - RichBlockFooter
+    - RichBlockDivider
+    - RichBlockMathematicalExpression
+    - RichBlockAnchor
+    - RichBlockList
+    - RichBlockBlockQuotation
+    - RichBlockPullQuotation
+    - RichBlockCollage
+    - RichBlockSlideshow
+    - RichBlockTable
+    - RichBlockDetails
+    - RichBlockMap
+    - RichBlockAnimation
+    - RichBlockAudio
+    - RichBlockPhoto
+    - RichBlockVideo
+    - RichBlockVoiceNote
+    - RichBlockThinking

aiogram-3.29.0/.butcher/enums/RichTextType.yml

@@ -0,0 +1,34 @@
+name: RichTextType
+description: |
+  This object represents the rich text type.
+
+  Source: https://core.telegram.org/bots/api#richtext
+multi_parse:
+  attribute: type
+  regexp: "always '([a-z_]+)'"
+  entities:
+    - RichTextBold
+    - RichTextItalic
+    - RichTextUnderline
+    - RichTextStrikethrough
+    - RichTextSpoiler
+    - RichTextDateTime
+    - RichTextTextMention
+    - RichTextSubscript
+    - RichTextSuperscript
+    - RichTextMarked
+    - RichTextCode
+    - RichTextCustomEmoji
+    - RichTextMathematicalExpression
+    - RichTextUrl
+    - RichTextEmailAddress
+    - RichTextPhoneNumber
+    - RichTextBankCardNumber
+    - RichTextMention
+    - RichTextHashtag
+    - RichTextCashtag
+    - RichTextBotCommand
+    - RichTextAnchor
+    - RichTextAnchorLink
+    - RichTextReference
+    - RichTextReferenceLink

aiogram-3.29.0/.butcher/methods/answerCallbackQuery/entity.json

@@ -0,0 +1,57 @@
+{
+  "meta": {},
+  "group": {
+    "title": "Available methods",
+    "anchor": "available-methods"
+  },
+  "object": {
+    "anchor": "answercallbackquery",
+    "name": "answerCallbackQuery",
+    "description": "Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.\nAlternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via @BotFather and accept the terms. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.",
+    "html_description": "<p>Use this method to send answers to callback queries sent from <a href=\"/bots/features#inline-keyboards\">inline keyboards</a>. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, <em>True</em> is returned.</p><blockquote>\n<p>Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via <a href=\"https://t.me/botfather\">@BotFather</a> and accept the terms. Otherwise, you may use links like <code>t.me/your_bot?start=XXXX</code> that open your bot with a parameter.</p>\n</blockquote>",
+    "rst_description": "Use this method to send answers to callback queries sent from `inline keyboards <https://core.telegram.org/bots/features#inline-keyboards>`_. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, :code:`True` is returned.\n\n Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via `@BotFather <https://t.me/botfather>`_ and accept the terms. Otherwise, you may use links like :code:`t.me/your_bot?start=XXXX` that open your bot with a parameter.",
+    "annotations": [
+      {
+        "type": "String",
+        "required": true,
+        "description": "Unique identifier for the query to be answered",
+        "html_description": "<td>Unique identifier for the query to be answered</td>",
+        "rst_description": "Unique identifier for the query to be answered\n",
+        "name": "callback_query_id"
+      },
+      {
+        "type": "String",
+        "required": false,
+        "description": "Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters.",
+        "html_description": "<td>Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters.</td>",
+        "rst_description": "Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters.\n",
+        "name": "text"
+      },
+      {
+        "type": "Boolean",
+        "required": false,
+        "description": "If True, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false.",
+        "html_description": "<td>If <em>True</em>, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to <em>false</em>.</td>",
+        "rst_description": "If :code:`True`, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to *false*.\n",
+        "name": "show_alert"
+      },
+      {
+        "type": "String",
+        "required": false,
+        "description": "URL that will be opened by the user's client. If you have created a Game and accepted the conditions via @BotFather, specify the URL that opens your game - note that this will only work if the query comes from a callback_game button.\n\nOtherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.",
+        "html_description": "<td>URL that will be opened by the user's client. If you have created a <a href=\"#game\">Game</a> and accepted the conditions via <a href=\"https://t.me/botfather\">@BotFather</a>, specify the URL that opens your game - note that this will only work if the query comes from a <a href=\"#inlinekeyboardbutton\"><em>callback_game</em></a> button.<br/>\n<br/>\nOtherwise, you may use links like <code>t.me/your_bot?start=XXXX</code> that open your bot with a parameter.</td>",
+        "rst_description": "URL that will be opened by the user's client. If you have created a :class:`aiogram.types.game.Game` and accepted the conditions via `@BotFather <https://t.me/botfather>`_, specify the URL that opens your game - note that this will only work if the query comes from a `https://core.telegram.org/bots/api#inlinekeyboardbutton <https://core.telegram.org/bots/api#inlinekeyboardbutton>`_ *callback_game* button.\n\n\n\nOtherwise, you may use links like :code:`t.me/your_bot?start=XXXX` that open your bot with a parameter.\n",
+        "name": "url"
+      },
+      {
+        "type": "Integer",
+        "required": false,
+        "description": "The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0.",
+        "html_description": "<td>The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0.</td>",
+        "rst_description": "The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0.\n",
+        "name": "cache_time"
+      }
+    ],
+    "category": "methods"
+  }
+}

aiogram-3.29.0/.butcher/methods/answerChatJoinRequestQuery/entity.json

@@ -0,0 +1,33 @@
+{
+  "meta": {},
+  "group": {
+    "title": "Available methods",
+    "anchor": "available-methods"
+  },
+  "object": {
+    "anchor": "answerchatjoinrequestquery",
+    "name": "answerChatJoinRequestQuery",
+    "description": "Use this method to process a received chat join request query. Returns True on success.",
+    "html_description": "<p>Use this method to process a received chat join request query. Returns <em>True</em> on success.</p>",
+    "rst_description": "Use this method to process a received chat join request query. Returns :code:`True` on success.",
+    "annotations": [
+      {
+        "type": "String",
+        "required": true,
+        "description": "Unique identifier of the join request query",
+        "html_description": "<td>Unique identifier of the join request query</td>",
+        "rst_description": "Unique identifier of the join request query\n",
+        "name": "chat_join_request_query_id"
+      },
+      {
+        "type": "String",
+        "required": true,
+        "description": "Result of the query. Must be either 'approve' to allow the user to join the chat, 'decline' to disallow the user to join the chat, or 'queue' to leave the decision to other administrators.",
+        "html_description": "<td>Result of the query. Must be either &#8220;approve&#8221; to allow the user to join the chat, &#8220;decline&#8221; to disallow the user to join the chat, or &#8220;queue&#8221; to leave the decision to other administrators.</td>",
+        "rst_description": "Result of the query. Must be either 'approve' to allow the user to join the chat, 'decline' to disallow the user to join the chat, or 'queue' to leave the decision to other administrators.\n",
+        "name": "result"
+      }
+    ],
+    "category": "methods"
+  }
+}

aiogram-3.29.0/.butcher/methods/approveSuggestedPost/entity.json

@@ -0,0 +1,41 @@
+{
+  "meta": {},
+  "group": {
+    "title": "Updating messages",
+    "anchor": "updating-messages"
+  },
+  "object": {
+    "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": "<p>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 <em>True</em> on success.</p>",
+    "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": "<td>Unique identifier for the target direct messages chat</td>",
+        "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": "<td>Identifier of a suggested post message to approve</td>",
+        "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": "<td>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.</td>",
+        "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"
+  }
+}

aiogram-3.29.0/.butcher/methods/copyMessage/entity.json

@@ -0,0 +1,177 @@
+{
+  "meta": {},
+  "group": {
+    "title": "Available methods",
+    "anchor": "available-methods"
+  },
+  "object": {
+    "anchor": "copymessage",
+    "name": "copyMessage",
+    "description": "Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.",
+    "html_description": "<p>Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz <a href=\"#poll\">poll</a> can be copied only if the value of the field <em>correct_option_id</em> is known to the bot. The method is analogous to the method <a href=\"#forwardmessage\">forwardMessage</a>, but the copied message doesn't have a link to the original message. Returns the <a href=\"#messageid\">MessageId</a> of the sent message on success.</p>",
+    "rst_description": "Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz :class:`aiogram.methods.poll.Poll` can be copied only if the value of the field *correct_option_id* is known to the bot. The method is analogous to the method :class:`aiogram.methods.forward_message.ForwardMessage`, but the copied message doesn't have a link to the original message. Returns the :class:`aiogram.types.message_id.MessageId` of the sent message on success.",
+    "annotations": [
+      {
+        "type": "Integer or String",
+        "required": true,
+        "description": "Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username",
+        "html_description": "<td>Unique identifier for the target chat or username of the target bot, supergroup or channel in the format <code>@username</code></td>",
+        "rst_description": "Unique identifier for the target chat or username of the target bot, supergroup or channel in the format :code:`@username`\n",
+        "name": "chat_id"
+      },
+      {
+        "type": "Integer or String",
+        "required": true,
+        "description": "Unique identifier for the chat where the original message was sent (or username of the target bot, supergroup or channel in the format @username)",
+        "html_description": "<td>Unique identifier for the chat where the original message was sent (or username of the target bot, supergroup or channel in the format <code>@username</code>)</td>",
+        "rst_description": "Unique identifier for the chat where the original message was sent (or username of the target bot, supergroup or channel in the format :code:`@username`)\n",
+        "name": "from_chat_id"
+      },
+      {
+        "type": "Integer",
+        "required": true,
+        "description": "Message identifier in the chat specified in from_chat_id",
+        "html_description": "<td>Message identifier in the chat specified in <em>from_chat_id</em></td>",
+        "rst_description": "Message identifier in the chat specified in *from_chat_id*\n",
+        "name": "message_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": "<td>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</td>",
+        "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": "<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
+        "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": false,
+        "description": "New start timestamp for the copied video in the message",
+        "html_description": "<td>New start timestamp for the copied video in the message</td>",
+        "rst_description": "New start timestamp for the copied video in the message\n",
+        "name": "video_start_timestamp"
+      },
+      {
+        "type": "String",
+        "required": false,
+        "description": "New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept.",
+        "html_description": "<td>New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept.</td>",
+        "rst_description": "New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept.\n",
+        "name": "caption"
+      },
+      {
+        "type": "String",
+        "required": false,
+        "description": "Mode for parsing entities in the new caption. See formatting options for more details.",
+        "html_description": "<td>Mode for parsing entities in the new caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
+        "rst_description": "Mode for parsing entities in the new caption. See `formatting options <https://core.telegram.org/bots/api#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 new caption, which can be specified instead of parse_mode",
+        "html_description": "<td>A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of <em>parse_mode</em></td>",
+        "rst_description": "A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of *parse_mode*\n",
+        "name": "caption_entities"
+      },
+      {
+        "type": "Boolean",
+        "required": false,
+        "description": "Pass True, if the caption must be shown above the message media. Ignored if a new caption isn't specified.",
+        "html_description": "<td>Pass <em>True</em>, if the caption must be shown above the message media. Ignored if a new caption isn't specified.</td>",
+        "rst_description": "Pass :code:`True`, if the caption must be shown above the message media. Ignored if a new caption isn't specified.\n",
+        "name": "show_caption_above_media"
+      },
+      {
+        "type": "Boolean",
+        "required": false,
+        "description": "Sends the message silently. Users will receive a notification with no sound.",
+        "html_description": "<td>Sends the message <a href=\"https://telegram.org/blog/channels-2-0#silent-messages\">silently</a>. Users will receive a notification with no sound.</td>",
+        "rst_description": "Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.\n",
+        "name": "disable_notification"
+      },
+      {
+        "type": "Boolean",
+        "required": false,
+        "description": "Protects the contents of the sent message from forwarding and saving",
+        "html_description": "<td>Protects the contents of the sent message from forwarding and saving</td>",
+        "rst_description": "Protects the contents of the sent message from forwarding and saving\n",
+        "name": "protect_content"
+      },
+      {
+        "type": "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": "<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.</td>",
+        "rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ 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": "<td>Unique identifier of the message effect to be added to the message; only available when copying to private chats</td>",
+        "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": "<td>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.</td>",
+        "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,
+        "description": "Description of the message to reply to",
+        "html_description": "<td>Description of the message to reply to</td>",
+        "rst_description": "Description of the message to reply to\n",
+        "name": "reply_parameters"
+      },
+      {
+        "type": "InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
+        "required": false,
+        "description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.",
+        "html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user.</td>",
+        "rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user.\n",
+        "name": "reply_markup"
+      },
+      {
+        "type": "Boolean",
+        "required": false,
+        "description": "Pass True if the message should be sent even if the specified replied-to message is not found",
+        "html_description": "<td>Pass <em>True</em> if the message should be sent even if the specified replied-to message is not found</td>",
+        "rst_description": "Pass :code:`True` if the message should be sent even if the specified replied-to message is not found\n",
+        "name": "allow_sending_without_reply",
+        "deprecated": {
+          "version": "7.0",
+          "release_date": "2023-12-29"
+        }
+      },
+      {
+        "type": "Integer",
+        "required": false,
+        "description": "If the message is a reply, ID of the original message",
+        "html_description": "<td>If the message is a reply, ID of the original message</td>",
+        "rst_description": "If the message is a reply, ID of the original message\n",
+        "name": "reply_to_message_id",
+        "deprecated": {
+          "version": "7.0",
+          "release_date": "2023-12-29"
+        }
+      }
+    ],
+    "category": "methods"
+  }
+}

aiogram-3.29.0/.butcher/methods/copyMessages/entity.json

@@ -0,0 +1,81 @@
+{
+  "meta": {},
+  "group": {
+    "title": "Available methods",
+    "anchor": "available-methods"
+  },
+  "object": {
+    "anchor": "copymessages",
+    "name": "copyMessages",
+    "description": "Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageId of the sent messages is returned.",
+    "html_description": "<p>Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz <a href=\"#poll\">poll</a> can be copied only if the value of the field <em>correct_option_id</em> is known to the bot. The method is analogous to the method <a href=\"#forwardmessages\">forwardMessages</a>, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of <a href=\"#messageid\">MessageId</a> of the sent messages is returned.</p>",
+    "rst_description": "Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz :class:`aiogram.methods.poll.Poll` can be copied only if the value of the field *correct_option_id* is known to the bot. The method is analogous to the method :class:`aiogram.methods.forward_messages.ForwardMessages`, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of :class:`aiogram.types.message_id.MessageId` of the sent messages is returned.",
+    "annotations": [
+      {
+        "type": "Integer or String",
+        "required": true,
+        "description": "Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username",
+        "html_description": "<td>Unique identifier for the target chat or username of the target bot, supergroup or channel in the format <code>@username</code></td>",
+        "rst_description": "Unique identifier for the target chat or username of the target bot, supergroup or channel in the format :code:`@username`\n",
+        "name": "chat_id"
+      },
+      {
+        "type": "Integer or String",
+        "required": true,
+        "description": "Unique identifier for the chat where the original messages were sent (or username of the target bot, supergroup or channel in the format @username)",
+        "html_description": "<td>Unique identifier for the chat where the original messages were sent (or username of the target bot, supergroup or channel in the format <code>@username</code>)</td>",
+        "rst_description": "Unique identifier for the chat where the original messages were sent (or username of the target bot, supergroup or channel in the format :code:`@username`)\n",
+        "name": "from_chat_id"
+      },
+      {
+        "type": "Array of Integer",
+        "required": true,
+        "description": "A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to copy. The identifiers must be specified in a strictly increasing order.",
+        "html_description": "<td>A JSON-serialized list of 1-100 identifiers of messages in the chat <em>from_chat_id</em> to copy. The identifiers must be specified in a strictly increasing order.</td>",
+        "rst_description": "A JSON-serialized list of 1-100 identifiers of messages in the chat *from_chat_id* to copy. The identifiers must be specified in a strictly increasing order.\n",
+        "name": "message_ids"
+      },
+      {
+        "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": "<td>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</td>",
+        "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": "<td>Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat</td>",
+        "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": "Boolean",
+        "required": false,
+        "description": "Sends the messages silently. Users will receive a notification with no sound.",
+        "html_description": "<td>Sends the messages <a href=\"https://telegram.org/blog/channels-2-0#silent-messages\">silently</a>. Users will receive a notification with no sound.</td>",
+        "rst_description": "Sends the messages `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.\n",
+        "name": "disable_notification"
+      },
+      {
+        "type": "Boolean",
+        "required": false,
+        "description": "Protects the contents of the sent messages from forwarding and saving",
+        "html_description": "<td>Protects the contents of the sent messages from forwarding and saving</td>",
+        "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 copy the messages without their captions",
+        "html_description": "<td>Pass <em>True</em> to copy the messages without their captions</td>",
+        "rst_description": "Pass :code:`True` to copy the messages without their captions\n",
+        "name": "remove_caption"
+      }
+    ],
+    "category": "methods"
+  }
+}

aiogram-3.29.0/.butcher/methods/createChatInviteLink/entity.json

@@ -0,0 +1,57 @@
+{
+  "meta": {},
+  "group": {
+    "title": "Available methods",
+    "anchor": "available-methods"
+  },
+  "object": {
+    "anchor": "createchatinvitelink",
+    "name": "createChatInviteLink",
+    "description": "Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.",
+    "html_description": "<p>Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method <a href=\"#revokechatinvitelink\">revokeChatInviteLink</a>. Returns the new invite link as <a href=\"#chatinvitelink\">ChatInviteLink</a> object.</p>",
+    "rst_description": "Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method :class:`aiogram.methods.revoke_chat_invite_link.RevokeChatInviteLink`. Returns the new invite link as :class:`aiogram.types.chat_invite_link.ChatInviteLink` object.",
+    "annotations": [
+      {
+        "type": "Integer or String",
+        "required": true,
+        "description": "Unique identifier for the target chat or username of the target channel in the format @username",
+        "html_description": "<td>Unique identifier for the target chat or username of the target channel in the format <code>@username</code></td>",
+        "rst_description": "Unique identifier for the target chat or username of the target channel in the format :code:`@username`\n",
+        "name": "chat_id"
+      },
+      {
+        "type": "String",
+        "required": false,
+        "description": "Invite link name; 0-32 characters",
+        "html_description": "<td>Invite link name; 0-32 characters</td>",
+        "rst_description": "Invite link name; 0-32 characters\n",
+        "name": "name"
+      },
+      {
+        "type": "Integer",
+        "required": false,
+        "description": "Point in time (Unix timestamp) when the link will expire",
+        "html_description": "<td>Point in time (Unix timestamp) when the link will expire</td>",
+        "rst_description": "Point in time (Unix timestamp) when the link will expire\n",
+        "name": "expire_date"
+      },
+      {
+        "type": "Integer",
+        "required": false,
+        "description": "The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999",
+        "html_description": "<td>The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999</td>",
+        "rst_description": "The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999\n",
+        "name": "member_limit"
+      },
+      {
+        "type": "Boolean",
+        "required": false,
+        "description": "True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified.",
+        "html_description": "<td><em>True</em>, if users joining the chat via the link need to be approved by chat administrators. If <em>True</em>, <em>member_limit</em> can't be specified.</td>",
+        "rst_description": ":code:`True`, if users joining the chat via the link need to be approved by chat administrators. If :code:`True`, *member_limit* can't be specified.\n",
+        "name": "creates_join_request"
+      }
+    ],
+    "category": "methods"
+  }
+}

aiogram-3.29.0/.butcher/methods/createChatSubscriptionInviteLink/entity.json

@@ -0,0 +1,49 @@
+{
+  "meta": {},
+  "group": {
+    "title": "Available methods",
+    "anchor": "available-methods"
+  },
+  "object": {
+    "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": "<p>Use this method to create a <a href=\"https://telegram.org/blog/superchannels-star-reactions-subscriptions#star-subscriptions\">subscription invite link</a> for a channel chat. The bot must have the <em>can_invite_users</em> administrator rights. The link can be edited using the method <a href=\"#editchatsubscriptioninvitelink\">editChatSubscriptionInviteLink</a> or revoked using the method <a href=\"#revokechatinvitelink\">revokeChatInviteLink</a>. Returns the new invite link as a <a href=\"#chatinvitelink\">ChatInviteLink</a> object.</p>",
+    "rst_description": "Use this method to create a `subscription invite link <https://telegram.org/blog/superchannels-star-reactions-subscriptions#star-subscriptions>`_ 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 @username",
+        "html_description": "<td>Unique identifier for the target channel chat or username of the target channel in the format <code>@username</code></td>",
+        "rst_description": "Unique identifier for the target channel chat or username of the target channel in the format :code:`@username`\n",
+        "name": "chat_id"
+      },
+      {
+        "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": "<td>The number of seconds the subscription will be active for before the next payment. Currently, it must always be 2592000 (30 days).</td>",
+        "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": "<td>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</td>",
+        "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"
+      },
+      {
+        "type": "String",
+        "required": false,
+        "description": "Invite link name; 0-32 characters",
+        "html_description": "<td>Invite link name; 0-32 characters</td>",
+        "rst_description": "Invite link name; 0-32 characters\n",
+        "name": "name"
+      }
+    ],
+    "category": "methods"
+  }
+}