Adding new code-generator (Butcher) (#1069)

* Re-generate types

* Re-generate methods (only attributes)

* Added enums

* Base init generator

* Added butcher configs

* Fixed tests, bump butcher

* Added changelog

* Added enum docs

* Added templates for docs index

* Re-generate bot class, remove deprecated methods
This commit is contained in:
Alex Root Junior 2022-11-21 01:06:55 +02:00 committed by GitHub
parent c7779abc50
commit d034c1ba9f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
387 changed files with 32036 additions and 3144 deletions

View file

@ -0,0 +1,91 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "animation",
"name": "Animation",
"description": "This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).",
"html_description": "<p>This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).</p>",
"rst_description": "This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).",
"annotations": [
{
"type": "String",
"description": "Identifier for this file, which can be used to download or reuse the file",
"html_description": "<td>Identifier for this file, which can be used to download or reuse the file</td>",
"rst_description": "Identifier for this file, which can be used to download or reuse the file\n",
"name": "file_id",
"required": true
},
{
"type": "String",
"description": "Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.",
"html_description": "<td>Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.</td>",
"rst_description": "Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.\n",
"name": "file_unique_id",
"required": true
},
{
"type": "Integer",
"description": "Video width as defined by sender",
"html_description": "<td>Video width as defined by sender</td>",
"rst_description": "Video width as defined by sender\n",
"name": "width",
"required": true
},
{
"type": "Integer",
"description": "Video height as defined by sender",
"html_description": "<td>Video height as defined by sender</td>",
"rst_description": "Video height as defined by sender\n",
"name": "height",
"required": true
},
{
"type": "Integer",
"description": "Duration of the video in seconds as defined by sender",
"html_description": "<td>Duration of the video in seconds as defined by sender</td>",
"rst_description": "Duration of the video in seconds as defined by sender\n",
"name": "duration",
"required": true
},
{
"type": "PhotoSize",
"description": "Animation thumbnail as defined by sender",
"html_description": "<td><em>Optional</em>. Animation thumbnail as defined by sender</td>",
"rst_description": "*Optional*. Animation thumbnail as defined by sender\n",
"name": "thumb",
"required": false
},
{
"type": "String",
"description": "Original animation filename as defined by sender",
"html_description": "<td><em>Optional</em>. Original animation filename as defined by sender</td>",
"rst_description": "*Optional*. Original animation filename as defined by sender\n",
"name": "file_name",
"required": false
},
{
"type": "String",
"description": "MIME type of the file as defined by sender",
"html_description": "<td><em>Optional</em>. MIME type of the file as defined by sender</td>",
"rst_description": "*Optional*. MIME type of the file as defined by sender\n",
"name": "mime_type",
"required": false
},
{
"type": "Integer",
"description": "File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.",
"html_description": "<td><em>Optional</em>. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.</td>",
"rst_description": "*Optional*. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.\n",
"name": "file_size",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,91 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "audio",
"name": "Audio",
"description": "This object represents an audio file to be treated as music by the Telegram clients.",
"html_description": "<p>This object represents an audio file to be treated as music by the Telegram clients.</p>",
"rst_description": "This object represents an audio file to be treated as music by the Telegram clients.",
"annotations": [
{
"type": "String",
"description": "Identifier for this file, which can be used to download or reuse the file",
"html_description": "<td>Identifier for this file, which can be used to download or reuse the file</td>",
"rst_description": "Identifier for this file, which can be used to download or reuse the file\n",
"name": "file_id",
"required": true
},
{
"type": "String",
"description": "Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.",
"html_description": "<td>Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.</td>",
"rst_description": "Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.\n",
"name": "file_unique_id",
"required": true
},
{
"type": "Integer",
"description": "Duration of the audio in seconds as defined by sender",
"html_description": "<td>Duration of the audio in seconds as defined by sender</td>",
"rst_description": "Duration of the audio in seconds as defined by sender\n",
"name": "duration",
"required": true
},
{
"type": "String",
"description": "Performer of the audio as defined by sender or by audio tags",
"html_description": "<td><em>Optional</em>. Performer of the audio as defined by sender or by audio tags</td>",
"rst_description": "*Optional*. Performer of the audio as defined by sender or by audio tags\n",
"name": "performer",
"required": false
},
{
"type": "String",
"description": "Title of the audio as defined by sender or by audio tags",
"html_description": "<td><em>Optional</em>. Title of the audio as defined by sender or by audio tags</td>",
"rst_description": "*Optional*. Title of the audio as defined by sender or by audio tags\n",
"name": "title",
"required": false
},
{
"type": "String",
"description": "Original filename as defined by sender",
"html_description": "<td><em>Optional</em>. Original filename as defined by sender</td>",
"rst_description": "*Optional*. Original filename as defined by sender\n",
"name": "file_name",
"required": false
},
{
"type": "String",
"description": "MIME type of the file as defined by sender",
"html_description": "<td><em>Optional</em>. MIME type of the file as defined by sender</td>",
"rst_description": "*Optional*. MIME type of the file as defined by sender\n",
"name": "mime_type",
"required": false
},
{
"type": "Integer",
"description": "File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.",
"html_description": "<td><em>Optional</em>. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.</td>",
"rst_description": "*Optional*. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.\n",
"name": "file_size",
"required": false
},
{
"type": "PhotoSize",
"description": "Thumbnail of the album cover to which the music file belongs",
"html_description": "<td><em>Optional</em>. Thumbnail of the album cover to which the music file belongs</td>",
"rst_description": "*Optional*. Thumbnail of the album cover to which the music file belongs\n",
"name": "thumb",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,35 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "botcommand",
"name": "BotCommand",
"description": "This object represents a bot command.",
"html_description": "<p>This object represents a bot command.</p>",
"rst_description": "This object represents a bot command.",
"annotations": [
{
"type": "String",
"description": "Text of the command; 1-32 characters. Can contain only lowercase English letters, digits and underscores.",
"html_description": "<td>Text of the command; 1-32 characters. Can contain only lowercase English letters, digits and underscores.</td>",
"rst_description": "Text of the command; 1-32 characters. Can contain only lowercase English letters, digits and underscores.\n",
"name": "command",
"required": true
},
{
"type": "String",
"description": "Description of the command; 1-256 characters.",
"html_description": "<td>Description of the command; 1-256 characters.</td>",
"rst_description": "Description of the command; 1-256 characters.\n",
"name": "description",
"required": true
}
],
"category": "types"
}
}

View file

@ -0,0 +1,2 @@
bases:
- MutableTelegramObject

View file

@ -0,0 +1,18 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "botcommandscope",
"name": "BotCommandScope",
"description": "This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported:\n - BotCommandScopeDefault\n - BotCommandScopeAllPrivateChats\n - BotCommandScopeAllGroupChats\n - BotCommandScopeAllChatAdministrators\n - BotCommandScopeChat\n - BotCommandScopeChatAdministrators\n - BotCommandScopeChatMember",
"html_description": "<p>This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported:</p><ul>\n<li><a href=\"#botcommandscopedefault\">BotCommandScopeDefault</a></li>\n<li><a href=\"#botcommandscopeallprivatechats\">BotCommandScopeAllPrivateChats</a></li>\n<li><a href=\"#botcommandscopeallgroupchats\">BotCommandScopeAllGroupChats</a></li>\n<li><a href=\"#botcommandscopeallchatadministrators\">BotCommandScopeAllChatAdministrators</a></li>\n<li><a href=\"#botcommandscopechat\">BotCommandScopeChat</a></li>\n<li><a href=\"#botcommandscopechatadministrators\">BotCommandScopeChatAdministrators</a></li>\n<li><a href=\"#botcommandscopechatmember\">BotCommandScopeChatMember</a></li>\n</ul>",
"rst_description": "This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported:\n\n - :class:`aiogram.types.bot_command_scope_default.BotCommandScopeDefault`\n - :class:`aiogram.types.bot_command_scope_all_private_chats.BotCommandScopeAllPrivateChats`\n - :class:`aiogram.types.bot_command_scope_all_group_chats.BotCommandScopeAllGroupChats`\n - :class:`aiogram.types.bot_command_scope_all_chat_administrators.BotCommandScopeAllChatAdministrators`\n - :class:`aiogram.types.bot_command_scope_chat.BotCommandScopeChat`\n - :class:`aiogram.types.bot_command_scope_chat_administrators.BotCommandScopeChatAdministrators`\n - :class:`aiogram.types.bot_command_scope_chat_member.BotCommandScopeChatMember`",
"annotations": [],
"category": "types"
}
}

View file

@ -0,0 +1,27 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "botcommandscopeallchatadministrators",
"name": "BotCommandScopeAllChatAdministrators",
"description": "Represents the scope of bot commands, covering all group and supergroup chat administrators.",
"html_description": "<p>Represents the <a href=\"#botcommandscope\">scope</a> of bot commands, covering all group and supergroup chat administrators.</p>",
"rst_description": "Represents the `scope <https://core.telegram.org/bots/api#botcommandscope>`_ of bot commands, covering all group and supergroup chat administrators.",
"annotations": [
{
"type": "String",
"description": "Scope type, must be all_chat_administrators",
"html_description": "<td>Scope type, must be <em>all_chat_administrators</em></td>",
"rst_description": "Scope type, must be *all_chat_administrators*\n",
"name": "type",
"required": true
}
],
"category": "types"
}
}

View file

@ -0,0 +1,2 @@
bases:
- BotCommandScope

View file

@ -0,0 +1,27 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "botcommandscopeallgroupchats",
"name": "BotCommandScopeAllGroupChats",
"description": "Represents the scope of bot commands, covering all group and supergroup chats.",
"html_description": "<p>Represents the <a href=\"#botcommandscope\">scope</a> of bot commands, covering all group and supergroup chats.</p>",
"rst_description": "Represents the `scope <https://core.telegram.org/bots/api#botcommandscope>`_ of bot commands, covering all group and supergroup chats.",
"annotations": [
{
"type": "String",
"description": "Scope type, must be all_group_chats",
"html_description": "<td>Scope type, must be <em>all_group_chats</em></td>",
"rst_description": "Scope type, must be *all_group_chats*\n",
"name": "type",
"required": true
}
],
"category": "types"
}
}

View file

@ -0,0 +1,2 @@
bases:
- BotCommandScope

View file

@ -0,0 +1,27 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "botcommandscopeallprivatechats",
"name": "BotCommandScopeAllPrivateChats",
"description": "Represents the scope of bot commands, covering all private chats.",
"html_description": "<p>Represents the <a href=\"#botcommandscope\">scope</a> of bot commands, covering all private chats.</p>",
"rst_description": "Represents the `scope <https://core.telegram.org/bots/api#botcommandscope>`_ of bot commands, covering all private chats.",
"annotations": [
{
"type": "String",
"description": "Scope type, must be all_private_chats",
"html_description": "<td>Scope type, must be <em>all_private_chats</em></td>",
"rst_description": "Scope type, must be *all_private_chats*\n",
"name": "type",
"required": true
}
],
"category": "types"
}
}

View file

@ -0,0 +1,2 @@
bases:
- BotCommandScope

View file

@ -0,0 +1,35 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "botcommandscopechat",
"name": "BotCommandScopeChat",
"description": "Represents the scope of bot commands, covering a specific chat.",
"html_description": "<p>Represents the <a href=\"#botcommandscope\">scope</a> of bot commands, covering a specific chat.</p>",
"rst_description": "Represents the `scope <https://core.telegram.org/bots/api#botcommandscope>`_ of bot commands, covering a specific chat.",
"annotations": [
{
"type": "String",
"description": "Scope type, must be chat",
"html_description": "<td>Scope type, must be <em>chat</em></td>",
"rst_description": "Scope type, must be *chat*\n",
"name": "type",
"required": true
},
{
"type": "Integer or String",
"description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"html_description": "<td>Unique identifier for the target chat or username of the target supergroup (in the format <code>@supergroupusername</code>)</td>",
"rst_description": "Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
"name": "chat_id",
"required": true
}
],
"category": "types"
}
}

View file

@ -0,0 +1,2 @@
bases:
- BotCommandScope

View file

@ -0,0 +1,35 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "botcommandscopechatadministrators",
"name": "BotCommandScopeChatAdministrators",
"description": "Represents the scope of bot commands, covering all administrators of a specific group or supergroup chat.",
"html_description": "<p>Represents the <a href=\"#botcommandscope\">scope</a> of bot commands, covering all administrators of a specific group or supergroup chat.</p>",
"rst_description": "Represents the `scope <https://core.telegram.org/bots/api#botcommandscope>`_ of bot commands, covering all administrators of a specific group or supergroup chat.",
"annotations": [
{
"type": "String",
"description": "Scope type, must be chat_administrators",
"html_description": "<td>Scope type, must be <em>chat_administrators</em></td>",
"rst_description": "Scope type, must be *chat_administrators*\n",
"name": "type",
"required": true
},
{
"type": "Integer or String",
"description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"html_description": "<td>Unique identifier for the target chat or username of the target supergroup (in the format <code>@supergroupusername</code>)</td>",
"rst_description": "Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
"name": "chat_id",
"required": true
}
],
"category": "types"
}
}

View file

@ -0,0 +1,2 @@
bases:
- BotCommandScope

View file

@ -0,0 +1,43 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "botcommandscopechatmember",
"name": "BotCommandScopeChatMember",
"description": "Represents the scope of bot commands, covering a specific member of a group or supergroup chat.",
"html_description": "<p>Represents the <a href=\"#botcommandscope\">scope</a> of bot commands, covering a specific member of a group or supergroup chat.</p>",
"rst_description": "Represents the `scope <https://core.telegram.org/bots/api#botcommandscope>`_ of bot commands, covering a specific member of a group or supergroup chat.",
"annotations": [
{
"type": "String",
"description": "Scope type, must be chat_member",
"html_description": "<td>Scope type, must be <em>chat_member</em></td>",
"rst_description": "Scope type, must be *chat_member*\n",
"name": "type",
"required": true
},
{
"type": "Integer or String",
"description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"html_description": "<td>Unique identifier for the target chat or username of the target supergroup (in the format <code>@supergroupusername</code>)</td>",
"rst_description": "Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
"name": "chat_id",
"required": true
},
{
"type": "Integer",
"description": "Unique identifier of the target user",
"html_description": "<td>Unique identifier of the target user</td>",
"rst_description": "Unique identifier of the target user\n",
"name": "user_id",
"required": true
}
],
"category": "types"
}
}

View file

@ -0,0 +1,2 @@
bases:
- BotCommandScope

View file

@ -0,0 +1,27 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "botcommandscopedefault",
"name": "BotCommandScopeDefault",
"description": "Represents the default scope of bot commands. Default commands are used if no commands with a narrower scope are specified for the user.",
"html_description": "<p>Represents the default <a href=\"#botcommandscope\">scope</a> of bot commands. Default commands are used if no commands with a <a href=\"#determining-list-of-commands\">narrower scope</a> are specified for the user.</p>",
"rst_description": "Represents the default `scope <https://core.telegram.org/bots/api#botcommandscope>`_ of bot commands. Default commands are used if no commands with a `narrower scope <https://core.telegram.org/bots/api#determining-list-of-commands>`_ are specified for the user.",
"annotations": [
{
"type": "String",
"description": "Scope type, must be default",
"html_description": "<td>Scope type, must be <em>default</em></td>",
"rst_description": "Scope type, must be *default*\n",
"name": "type",
"required": true
}
],
"category": "types"
}
}

View file

@ -0,0 +1,2 @@
bases:
- BotCommandScope

View file

@ -0,0 +1,18 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Games",
"anchor": "games"
},
"object": {
"anchor": "callbackgame",
"name": "CallbackGame",
"description": "A placeholder, currently holds no information. Use BotFather to set up your game.",
"html_description": "<p>A placeholder, currently holds no information. Use <a href=\"https://t.me/botfather\">BotFather</a> to set up your game.</p>",
"rst_description": "A placeholder, currently holds no information. Use `BotFather <https://t.me/botfather>`_ to set up your game.",
"annotations": [],
"category": "types"
}
}

View file

@ -0,0 +1,75 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "callbackquery",
"name": "CallbackQuery",
"description": "This object represents an incoming callback query from a callback button in an inline keyboard. If the button that originated the query was attached to a message sent by the bot, the field message will be present. If the button was attached to a message sent via the bot (in inline mode), the field inline_message_id will be present. Exactly one of the fields data or game_short_name will be present.\nNOTE: After the user presses a callback button, Telegram clients will display a progress bar until you call answerCallbackQuery. It is, therefore, necessary to react by calling answerCallbackQuery even if no notification to the user is needed (e.g., without specifying any of the optional parameters).",
"html_description": "<p>This object represents an incoming callback query from a callback button in an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>. If the button that originated the query was attached to a message sent by the bot, the field <em>message</em> will be present. If the button was attached to a message sent via the bot (in <a href=\"#inline-mode\">inline mode</a>), the field <em>inline_message_id</em> will be present. Exactly one of the fields <em>data</em> or <em>game_short_name</em> will be present.</p><blockquote>\n<p><strong>NOTE:</strong> After the user presses a callback button, Telegram clients will display a progress bar until you call <a href=\"#answercallbackquery\">answerCallbackQuery</a>. It is, therefore, necessary to react by calling <a href=\"#answercallbackquery\">answerCallbackQuery</a> even if no notification to the user is needed (e.g., without specifying any of the optional parameters).</p>\n</blockquote>",
"rst_description": "This object represents an incoming callback query from a callback button in an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_. If the button that originated the query was attached to a message sent by the bot, the field *message* will be present. If the button was attached to a message sent via the bot (in `inline mode <https://core.telegram.org/bots/api#inline-mode>`_), the field *inline_message_id* will be present. Exactly one of the fields *data* or *game_short_name* will be present.\n\n **NOTE:** After the user presses a callback button, Telegram clients will display a progress bar until you call :class:`aiogram.methods.answer_callback_query.AnswerCallbackQuery`. It is, therefore, necessary to react by calling :class:`aiogram.methods.answer_callback_query.AnswerCallbackQuery` even if no notification to the user is needed (e.g., without specifying any of the optional parameters).",
"annotations": [
{
"type": "String",
"description": "Unique identifier for this query",
"html_description": "<td>Unique identifier for this query</td>",
"rst_description": "Unique identifier for this query\n",
"name": "id",
"required": true
},
{
"type": "User",
"description": "Sender",
"html_description": "<td>Sender</td>",
"rst_description": "Sender\n",
"name": "from",
"required": true
},
{
"type": "Message",
"description": "Message with the callback button that originated the query. Note that message content and message date will not be available if the message is too old",
"html_description": "<td><em>Optional</em>. Message with the callback button that originated the query. Note that message content and message date will not be available if the message is too old</td>",
"rst_description": "*Optional*. Message with the callback button that originated the query. Note that message content and message date will not be available if the message is too old\n",
"name": "message",
"required": false
},
{
"type": "String",
"description": "Identifier of the message sent via the bot in inline mode, that originated the query.",
"html_description": "<td><em>Optional</em>. Identifier of the message sent via the bot in inline mode, that originated the query.</td>",
"rst_description": "*Optional*. Identifier of the message sent via the bot in inline mode, that originated the query.\n",
"name": "inline_message_id",
"required": false
},
{
"type": "String",
"description": "Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games.",
"html_description": "<td>Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in <a href=\"#games\">games</a>.</td>",
"rst_description": "Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in :class:`aiogram.methods.games.Games`.\n",
"name": "chat_instance",
"required": true
},
{
"type": "String",
"description": "Data associated with the callback button. Be aware that the message originated the query can contain no callback buttons with this data.",
"html_description": "<td><em>Optional</em>. Data associated with the callback button. Be aware that the message originated the query can contain no callback buttons with this data.</td>",
"rst_description": "*Optional*. Data associated with the callback button. Be aware that the message originated the query can contain no callback buttons with this data.\n",
"name": "data",
"required": false
},
{
"type": "String",
"description": "Short name of a Game to be returned, serves as the unique identifier for the game",
"html_description": "<td><em>Optional</em>. Short name of a <a href=\"#games\">Game</a> to be returned, serves as the unique identifier for the game</td>",
"rst_description": "*Optional*. Short name of a `Game <https://core.telegram.org/bots/api#games>`_ to be returned, serves as the unique identifier for the game\n",
"name": "game_short_name",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,108 @@
#ban_sender_chat:
# method: banChatSenderChat
# fill: &self
# chat_id: self.id
#
#unban_sender_chat:
# method: unbanChatSenderChat
# fill: *self
#
#get_administrators:
# method: getChatAdministrators
# fill: *self
#
#delete_message:
# method: deleteMessage
# fill: *self
#
#revoke_invite_link:
# method: revokeChatInviteLink
# fill: *self
#
#edit_invite_link:
# method: editChatInviteLink
# fill: *self
#
#create_invite_link:
# method: createChatInviteLink
# fill: *self
#
#export_invite_link:
# method: exportChatInviteLink
# fill: *self
#
#do:
# method: sendChatAction
# fill: *self
#
#delete_sticker_set:
# method: deleteChatStickerSet
# fill: *self
#
#set_sticker_set:
# method: setChatStickerSet
# fill: *self
#
#get_member:
# method: getChatMember
# fill: *self
#
#get_member_count:
# method: getChatMemberCount
# fill: *self
#
#leave:
# method: leaveChat
# fill: *self
#
#unpin_all_messages:
# method: unpinAllChatMessages
# fill: *self
#
#unpin_message:
# method: unpinChatMessage
# fill: *self
#
#pin_message:
# method: pinChatMessage
# fill: *self
#
#set_administrator_custom_title:
# method: setChatAdministratorCustomTitle
# fill: *self
#
#set_permissions:
# method: setChatPermissions
# fill: *self
#
#promote:
# method: promoteChatMember
# fill: *self
#
#restrict:
# method: restrictChatMember
# fill: *self
#
#unban:
# method: unbanChatMember
# fill: *self
#
#ban:
# method: banChatMember
# fill: *self
#
#set_description:
# method: setChatDescription
# fill: *self
#
#set_title:
# method: setChatTitle
# fill: *self
#
#delete_photo:
# method: deleteChatPhoto
# fill: *self
#
#set_photo:
# method: setChatPhoto
# fill: *self

View file

@ -0,0 +1,227 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "chat",
"name": "Chat",
"description": "This object represents a chat.",
"html_description": "<p>This object represents a chat.</p>",
"rst_description": "This object represents a chat.",
"annotations": [
{
"type": "Integer",
"description": "Unique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.",
"html_description": "<td>Unique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.</td>",
"rst_description": "Unique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.\n",
"name": "id",
"required": true
},
{
"type": "String",
"description": "Type of chat, can be either 'private', 'group', 'supergroup' or 'channel'",
"html_description": "<td>Type of chat, can be either &#8220;private&#8221;, &#8220;group&#8221;, &#8220;supergroup&#8221; or &#8220;channel&#8221;</td>",
"rst_description": "Type of chat, can be either 'private', 'group', 'supergroup' or 'channel'\n",
"name": "type",
"required": true
},
{
"type": "String",
"description": "Title, for supergroups, channels and group chats",
"html_description": "<td><em>Optional</em>. Title, for supergroups, channels and group chats</td>",
"rst_description": "*Optional*. Title, for supergroups, channels and group chats\n",
"name": "title",
"required": false
},
{
"type": "String",
"description": "Username, for private chats, supergroups and channels if available",
"html_description": "<td><em>Optional</em>. Username, for private chats, supergroups and channels if available</td>",
"rst_description": "*Optional*. Username, for private chats, supergroups and channels if available\n",
"name": "username",
"required": false
},
{
"type": "String",
"description": "First name of the other party in a private chat",
"html_description": "<td><em>Optional</em>. First name of the other party in a private chat</td>",
"rst_description": "*Optional*. First name of the other party in a private chat\n",
"name": "first_name",
"required": false
},
{
"type": "String",
"description": "Last name of the other party in a private chat",
"html_description": "<td><em>Optional</em>. Last name of the other party in a private chat</td>",
"rst_description": "*Optional*. Last name of the other party in a private chat\n",
"name": "last_name",
"required": false
},
{
"type": "True",
"description": "True, if the supergroup chat is a forum (has topics enabled)",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the supergroup chat is a forum (has <a href=\"https://telegram.org/blog/topics-in-groups-collectible-usernames#topics-in-groups\">topics</a> enabled)</td>",
"rst_description": "*Optional*. :code:`True`, if the supergroup chat is a forum (has `topics <https://telegram.org/blog/topics-in-groups-collectible-usernames#topics-in-groups>`_ enabled)\n",
"name": "is_forum",
"required": false
},
{
"type": "ChatPhoto",
"description": "Chat photo. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. Chat photo. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. Chat photo. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "photo",
"required": false
},
{
"type": "Array of String",
"description": "If non-empty, the list of all active chat usernames; for private chats, supergroups and channels. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. If non-empty, the list of all <a href=\"https://telegram.org/blog/topics-in-groups-collectible-usernames#collectible-usernames\">active chat usernames</a>; for private chats, supergroups and channels. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. If non-empty, the list of all `active chat usernames <https://telegram.org/blog/topics-in-groups-collectible-usernames#collectible-usernames>`_; for private chats, supergroups and channels. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "active_usernames",
"required": false
},
{
"type": "String",
"description": "Custom emoji identifier of emoji status of the other party in a private chat. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. Custom emoji identifier of emoji status of the other party in a private chat. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. Custom emoji identifier of emoji status of the other party in a private chat. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "emoji_status_custom_emoji_id",
"required": false
},
{
"type": "String",
"description": "Bio of the other party in a private chat. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. Bio of the other party in a private chat. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. Bio of the other party in a private chat. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "bio",
"required": false
},
{
"type": "True",
"description": "True, if privacy settings of the other party in the private chat allows to use tg://user?id=<user_id> links only in chats with the user. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. <em>True</em>, if privacy settings of the other party in the private chat allows to use <code>tg://user?id=&lt;user_id&gt;</code> links only in chats with the user. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. :code:`True`, if privacy settings of the other party in the private chat allows to use :code:`tg://user?id=<user_id>` links only in chats with the user. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "has_private_forwards",
"required": false
},
{
"type": "True",
"description": "True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the privacy settings of the other party restrict sending voice and video note messages in the private chat. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. :code:`True`, if the privacy settings of the other party restrict sending voice and video note messages in the private chat. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "has_restricted_voice_and_video_messages",
"required": false
},
{
"type": "True",
"description": "True, if users need to join the supergroup before they can send messages. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. <em>True</em>, if users need to join the supergroup before they can send messages. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. :code:`True`, if users need to join the supergroup before they can send messages. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "join_to_send_messages",
"required": false
},
{
"type": "True",
"description": "True, if all users directly joining the supergroup need to be approved by supergroup administrators. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. <em>True</em>, if all users directly joining the supergroup need to be approved by supergroup administrators. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. :code:`True`, if all users directly joining the supergroup need to be approved by supergroup administrators. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "join_by_request",
"required": false
},
{
"type": "String",
"description": "Description, for groups, supergroups and channel chats. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. Description, for groups, supergroups and channel chats. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. Description, for groups, supergroups and channel chats. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "description",
"required": false
},
{
"type": "String",
"description": "Primary invite link, for groups, supergroups and channel chats. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. Primary invite link, for groups, supergroups and channel chats. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. Primary invite link, for groups, supergroups and channel chats. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "invite_link",
"required": false
},
{
"type": "Message",
"description": "The most recent pinned message (by sending date). Returned only in getChat.",
"html_description": "<td><em>Optional</em>. The most recent pinned message (by sending date). Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. The most recent pinned message (by sending date). Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "pinned_message",
"required": false
},
{
"type": "ChatPermissions",
"description": "Default chat member permissions, for groups and supergroups. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. Default chat member permissions, for groups and supergroups. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. Default chat member permissions, for groups and supergroups. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "permissions",
"required": false
},
{
"type": "Integer",
"description": "For supergroups, the minimum allowed delay between consecutive messages sent by each unpriviledged user; in seconds. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. For supergroups, the minimum allowed delay between consecutive messages sent by each unpriviledged user; in seconds. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. For supergroups, the minimum allowed delay between consecutive messages sent by each unpriviledged user; in seconds. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "slow_mode_delay",
"required": false
},
{
"type": "Integer",
"description": "The time after which all messages sent to the chat will be automatically deleted; in seconds. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. The time after which all messages sent to the chat will be automatically deleted; in seconds. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. The time after which all messages sent to the chat will be automatically deleted; in seconds. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "message_auto_delete_time",
"required": false
},
{
"type": "True",
"description": "True, if messages from the chat can't be forwarded to other chats. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. <em>True</em>, if messages from the chat can't be forwarded to other chats. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. :code:`True`, if messages from the chat can't be forwarded to other chats. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "has_protected_content",
"required": false
},
{
"type": "String",
"description": "For supergroups, name of group sticker set. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. For supergroups, name of group sticker set. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. For supergroups, name of group sticker set. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "sticker_set_name",
"required": false
},
{
"type": "True",
"description": "True, if the bot can change the group sticker set. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the bot can change the group sticker set. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. :code:`True`, if the bot can change the group sticker set. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "can_set_sticker_set",
"required": false
},
{
"type": "Integer",
"description": "Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "linked_chat_id",
"required": false
},
{
"type": "ChatLocation",
"description": "For supergroups, the location to which the supergroup is connected. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. For supergroups, the location to which the supergroup is connected. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. For supergroups, the location to which the supergroup is connected. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "location",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,115 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "chatadministratorrights",
"name": "ChatAdministratorRights",
"description": "Represents the rights of an administrator in a chat.",
"html_description": "<p>Represents the rights of an administrator in a chat.</p>",
"rst_description": "Represents the rights of an administrator in a chat.",
"annotations": [
{
"type": "Boolean",
"description": "True, if the user's presence in the chat is hidden",
"html_description": "<td><em>True</em>, if the user's presence in the chat is hidden</td>",
"rst_description": ":code:`True`, if the user's presence in the chat is hidden\n",
"name": "is_anonymous",
"required": true
},
{
"type": "Boolean",
"description": "True, if the administrator can access the chat event log, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege",
"html_description": "<td><em>True</em>, if the administrator can access the chat event log, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege</td>",
"rst_description": ":code:`True`, if the administrator can access the chat event log, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege\n",
"name": "can_manage_chat",
"required": true
},
{
"type": "Boolean",
"description": "True, if the administrator can delete messages of other users",
"html_description": "<td><em>True</em>, if the administrator can delete messages of other users</td>",
"rst_description": ":code:`True`, if the administrator can delete messages of other users\n",
"name": "can_delete_messages",
"required": true
},
{
"type": "Boolean",
"description": "True, if the administrator can manage video chats",
"html_description": "<td><em>True</em>, if the administrator can manage video chats</td>",
"rst_description": ":code:`True`, if the administrator can manage video chats\n",
"name": "can_manage_video_chats",
"required": true
},
{
"type": "Boolean",
"description": "True, if the administrator can restrict, ban or unban chat members",
"html_description": "<td><em>True</em>, if the administrator can restrict, ban or unban chat members</td>",
"rst_description": ":code:`True`, if the administrator can restrict, ban or unban chat members\n",
"name": "can_restrict_members",
"required": true
},
{
"type": "Boolean",
"description": "True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by the user)",
"html_description": "<td><em>True</em>, if the administrator can add new administrators with a subset of their own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by the user)</td>",
"rst_description": ":code:`True`, if the administrator can add new administrators with a subset of their own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by the user)\n",
"name": "can_promote_members",
"required": true
},
{
"type": "Boolean",
"description": "True, if the user is allowed to change the chat title, photo and other settings",
"html_description": "<td><em>True</em>, if the user is allowed to change the chat title, photo and other settings</td>",
"rst_description": ":code:`True`, if the user is allowed to change the chat title, photo and other settings\n",
"name": "can_change_info",
"required": true
},
{
"type": "Boolean",
"description": "True, if the user is allowed to invite new users to the chat",
"html_description": "<td><em>True</em>, if the user is allowed to invite new users to the chat</td>",
"rst_description": ":code:`True`, if the user is allowed to invite new users to the chat\n",
"name": "can_invite_users",
"required": true
},
{
"type": "Boolean",
"description": "True, if the administrator can post in the channel; channels only",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the administrator can post in the channel; channels only</td>",
"rst_description": "*Optional*. :code:`True`, if the administrator can post in the channel; channels only\n",
"name": "can_post_messages",
"required": false
},
{
"type": "Boolean",
"description": "True, if the administrator can edit messages of other users and can pin messages; channels only",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the administrator can edit messages of other users and can pin messages; channels only</td>",
"rst_description": "*Optional*. :code:`True`, if the administrator can edit messages of other users and can pin messages; channels only\n",
"name": "can_edit_messages",
"required": false
},
{
"type": "Boolean",
"description": "True, if the user is allowed to pin messages; groups and supergroups only",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the user is allowed to pin messages; groups and supergroups only</td>",
"rst_description": "*Optional*. :code:`True`, if the user is allowed to pin messages; groups and supergroups only\n",
"name": "can_pin_messages",
"required": false
},
{
"type": "Boolean",
"description": "True, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only</td>",
"rst_description": "*Optional*. :code:`True`, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only\n",
"name": "can_manage_topics",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,91 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "chatinvitelink",
"name": "ChatInviteLink",
"description": "Represents an invite link for a chat.",
"html_description": "<p>Represents an invite link for a chat.</p>",
"rst_description": "Represents an invite link for a chat.",
"annotations": [
{
"type": "String",
"description": "The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with '…'.",
"html_description": "<td>The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with &#8220;&#8230;&#8221;.</td>",
"rst_description": "The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with '…'.\n",
"name": "invite_link",
"required": true
},
{
"type": "User",
"description": "Creator of the link",
"html_description": "<td>Creator of the link</td>",
"rst_description": "Creator of the link\n",
"name": "creator",
"required": true
},
{
"type": "Boolean",
"description": "True, if users joining the chat via the link need to be approved by chat administrators",
"html_description": "<td><em>True</em>, if users joining the chat via the link need to be approved by chat administrators</td>",
"rst_description": ":code:`True`, if users joining the chat via the link need to be approved by chat administrators\n",
"name": "creates_join_request",
"required": true
},
{
"type": "Boolean",
"description": "True, if the link is primary",
"html_description": "<td><em>True</em>, if the link is primary</td>",
"rst_description": ":code:`True`, if the link is primary\n",
"name": "is_primary",
"required": true
},
{
"type": "Boolean",
"description": "True, if the link is revoked",
"html_description": "<td><em>True</em>, if the link is revoked</td>",
"rst_description": ":code:`True`, if the link is revoked\n",
"name": "is_revoked",
"required": true
},
{
"type": "String",
"description": "Invite link name",
"html_description": "<td><em>Optional</em>. Invite link name</td>",
"rst_description": "*Optional*. Invite link name\n",
"name": "name",
"required": false
},
{
"type": "Integer",
"description": "Point in time (Unix timestamp) when the link will expire or has been expired",
"html_description": "<td><em>Optional</em>. Point in time (Unix timestamp) when the link will expire or has been expired</td>",
"rst_description": "*Optional*. Point in time (Unix timestamp) when the link will expire or has been expired\n",
"name": "expire_date",
"required": false
},
{
"type": "Integer",
"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><em>Optional</em>. 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": "*Optional*. 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",
"required": false
},
{
"type": "Integer",
"description": "Number of pending join requests created using this link",
"html_description": "<td><em>Optional</em>. Number of pending join requests created using this link</td>",
"rst_description": "*Optional*. Number of pending join requests created using this link\n",
"name": "pending_join_request_count",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,5 @@
annotations:
expire_date:
parsed_type:
type: std
name: datetime.datetime

View file

@ -0,0 +1,59 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "chatjoinrequest",
"name": "ChatJoinRequest",
"description": "Represents a join request sent to a chat.",
"html_description": "<p>Represents a join request sent to a chat.</p>",
"rst_description": "Represents a join request sent to a chat.",
"annotations": [
{
"type": "Chat",
"description": "Chat to which the request was sent",
"html_description": "<td>Chat to which the request was sent</td>",
"rst_description": "Chat to which the request was sent\n",
"name": "chat",
"required": true
},
{
"type": "User",
"description": "User that sent the join request",
"html_description": "<td>User that sent the join request</td>",
"rst_description": "User that sent the join request\n",
"name": "from",
"required": true
},
{
"type": "Integer",
"description": "Date the request was sent in Unix time",
"html_description": "<td>Date the request was sent in Unix time</td>",
"rst_description": "Date the request was sent in Unix time\n",
"name": "date",
"required": true
},
{
"type": "String",
"description": "Bio of the user.",
"html_description": "<td><em>Optional</em>. Bio of the user.</td>",
"rst_description": "*Optional*. Bio of the user.\n",
"name": "bio",
"required": false
},
{
"type": "ChatInviteLink",
"description": "Chat invite link that was used by the user to send the join request",
"html_description": "<td><em>Optional</em>. Chat invite link that was used by the user to send the join request</td>",
"rst_description": "*Optional*. Chat invite link that was used by the user to send the join request\n",
"name": "invite_link",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,5 @@
annotations:
date:
parsed_type:
type: std
name: datetime.datetime

View file

@ -0,0 +1,35 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "chatlocation",
"name": "ChatLocation",
"description": "Represents a location to which a chat is connected.",
"html_description": "<p>Represents a location to which a chat is connected.</p>",
"rst_description": "Represents a location to which a chat is connected.",
"annotations": [
{
"type": "Location",
"description": "The location to which the supergroup is connected. Can't be a live location.",
"html_description": "<td>The location to which the supergroup is connected. Can't be a live location.</td>",
"rst_description": "The location to which the supergroup is connected. Can't be a live location.\n",
"name": "location",
"required": true
},
{
"type": "String",
"description": "Location address; 1-64 characters, as defined by the chat owner",
"html_description": "<td>Location address; 1-64 characters, as defined by the chat owner</td>",
"rst_description": "Location address; 1-64 characters, as defined by the chat owner\n",
"name": "address",
"required": true
}
],
"category": "types"
}
}

View file

@ -0,0 +1,18 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "chatmember",
"name": "ChatMember",
"description": "This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported:\n - ChatMemberOwner\n - ChatMemberAdministrator\n - ChatMemberMember\n - ChatMemberRestricted\n - ChatMemberLeft\n - ChatMemberBanned",
"html_description": "<p>This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported:</p><ul>\n<li><a href=\"#chatmemberowner\">ChatMemberOwner</a></li>\n<li><a href=\"#chatmemberadministrator\">ChatMemberAdministrator</a></li>\n<li><a href=\"#chatmembermember\">ChatMemberMember</a></li>\n<li><a href=\"#chatmemberrestricted\">ChatMemberRestricted</a></li>\n<li><a href=\"#chatmemberleft\">ChatMemberLeft</a></li>\n<li><a href=\"#chatmemberbanned\">ChatMemberBanned</a></li>\n</ul>",
"rst_description": "This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported:\n\n - :class:`aiogram.types.chat_member_owner.ChatMemberOwner`\n - :class:`aiogram.types.chat_member_administrator.ChatMemberAdministrator`\n - :class:`aiogram.types.chat_member_member.ChatMemberMember`\n - :class:`aiogram.types.chat_member_restricted.ChatMemberRestricted`\n - :class:`aiogram.types.chat_member_left.ChatMemberLeft`\n - :class:`aiogram.types.chat_member_banned.ChatMemberBanned`",
"annotations": [],
"category": "types"
}
}

View file

@ -0,0 +1,27 @@
define:
- type: "String"
description: "The member's status in the chat"
html_description: "<td>The member's status in the chat</td>"
rst_description: "The member's status in the chat"
name: "status"
required: true
clone:
- ChatMemberOwner:
exclude:
- status
- ChatMemberAdministrator:
exclude:
- status
- ChatMemberMember:
exclude:
- status
- ChatMemberRestricted:
exclude:
- status
- ChatMemberLeft:
exclude:
- status
- ChatMemberBanned:
exclude:
- status

View file

@ -0,0 +1,5 @@
annotations:
until_date:
parsed_type:
type: std
name: datetime.datetime

View file

@ -0,0 +1,147 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "chatmemberadministrator",
"name": "ChatMemberAdministrator",
"description": "Represents a chat member that has some additional privileges.",
"html_description": "<p>Represents a <a href=\"#chatmember\">chat member</a> that has some additional privileges.</p>",
"rst_description": "Represents a `chat member <https://core.telegram.org/bots/api#chatmember>`_ that has some additional privileges.",
"annotations": [
{
"type": "String",
"description": "The member's status in the chat, always 'administrator'",
"html_description": "<td>The member's status in the chat, always &#8220;administrator&#8221;</td>",
"rst_description": "The member's status in the chat, always 'administrator'\n",
"name": "status",
"required": true
},
{
"type": "User",
"description": "Information about the user",
"html_description": "<td>Information about the user</td>",
"rst_description": "Information about the user\n",
"name": "user",
"required": true
},
{
"type": "Boolean",
"description": "True, if the bot is allowed to edit administrator privileges of that user",
"html_description": "<td><em>True</em>, if the bot is allowed to edit administrator privileges of that user</td>",
"rst_description": ":code:`True`, if the bot is allowed to edit administrator privileges of that user\n",
"name": "can_be_edited",
"required": true
},
{
"type": "Boolean",
"description": "True, if the user's presence in the chat is hidden",
"html_description": "<td><em>True</em>, if the user's presence in the chat is hidden</td>",
"rst_description": ":code:`True`, if the user's presence in the chat is hidden\n",
"name": "is_anonymous",
"required": true
},
{
"type": "Boolean",
"description": "True, if the administrator can access the chat event log, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege",
"html_description": "<td><em>True</em>, if the administrator can access the chat event log, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege</td>",
"rst_description": ":code:`True`, if the administrator can access the chat event log, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege\n",
"name": "can_manage_chat",
"required": true
},
{
"type": "Boolean",
"description": "True, if the administrator can delete messages of other users",
"html_description": "<td><em>True</em>, if the administrator can delete messages of other users</td>",
"rst_description": ":code:`True`, if the administrator can delete messages of other users\n",
"name": "can_delete_messages",
"required": true
},
{
"type": "Boolean",
"description": "True, if the administrator can manage video chats",
"html_description": "<td><em>True</em>, if the administrator can manage video chats</td>",
"rst_description": ":code:`True`, if the administrator can manage video chats\n",
"name": "can_manage_video_chats",
"required": true
},
{
"type": "Boolean",
"description": "True, if the administrator can restrict, ban or unban chat members",
"html_description": "<td><em>True</em>, if the administrator can restrict, ban or unban chat members</td>",
"rst_description": ":code:`True`, if the administrator can restrict, ban or unban chat members\n",
"name": "can_restrict_members",
"required": true
},
{
"type": "Boolean",
"description": "True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by the user)",
"html_description": "<td><em>True</em>, if the administrator can add new administrators with a subset of their own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by the user)</td>",
"rst_description": ":code:`True`, if the administrator can add new administrators with a subset of their own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by the user)\n",
"name": "can_promote_members",
"required": true
},
{
"type": "Boolean",
"description": "True, if the user is allowed to change the chat title, photo and other settings",
"html_description": "<td><em>True</em>, if the user is allowed to change the chat title, photo and other settings</td>",
"rst_description": ":code:`True`, if the user is allowed to change the chat title, photo and other settings\n",
"name": "can_change_info",
"required": true
},
{
"type": "Boolean",
"description": "True, if the user is allowed to invite new users to the chat",
"html_description": "<td><em>True</em>, if the user is allowed to invite new users to the chat</td>",
"rst_description": ":code:`True`, if the user is allowed to invite new users to the chat\n",
"name": "can_invite_users",
"required": true
},
{
"type": "Boolean",
"description": "True, if the administrator can post in the channel; channels only",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the administrator can post in the channel; channels only</td>",
"rst_description": "*Optional*. :code:`True`, if the administrator can post in the channel; channels only\n",
"name": "can_post_messages",
"required": false
},
{
"type": "Boolean",
"description": "True, if the administrator can edit messages of other users and can pin messages; channels only",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the administrator can edit messages of other users and can pin messages; channels only</td>",
"rst_description": "*Optional*. :code:`True`, if the administrator can edit messages of other users and can pin messages; channels only\n",
"name": "can_edit_messages",
"required": false
},
{
"type": "Boolean",
"description": "True, if the user is allowed to pin messages; groups and supergroups only",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the user is allowed to pin messages; groups and supergroups only</td>",
"rst_description": "*Optional*. :code:`True`, if the user is allowed to pin messages; groups and supergroups only\n",
"name": "can_pin_messages",
"required": false
},
{
"type": "Boolean",
"description": "True, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only</td>",
"rst_description": "*Optional*. :code:`True`, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only\n",
"name": "can_manage_topics",
"required": false
},
{
"type": "String",
"description": "Custom title for this user",
"html_description": "<td><em>Optional</em>. Custom title for this user</td>",
"rst_description": "*Optional*. Custom title for this user\n",
"name": "custom_title",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,2 @@
bases:
- ChatMember

View file

@ -0,0 +1,43 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "chatmemberbanned",
"name": "ChatMemberBanned",
"description": "Represents a chat member that was banned in the chat and can't return to the chat or view chat messages.",
"html_description": "<p>Represents a <a href=\"#chatmember\">chat member</a> that was banned in the chat and can't return to the chat or view chat messages.</p>",
"rst_description": "Represents a `chat member <https://core.telegram.org/bots/api#chatmember>`_ that was banned in the chat and can't return to the chat or view chat messages.",
"annotations": [
{
"type": "String",
"description": "The member's status in the chat, always 'kicked'",
"html_description": "<td>The member's status in the chat, always &#8220;kicked&#8221;</td>",
"rst_description": "The member's status in the chat, always 'kicked'\n",
"name": "status",
"required": true
},
{
"type": "User",
"description": "Information about the user",
"html_description": "<td>Information about the user</td>",
"rst_description": "Information about the user\n",
"name": "user",
"required": true
},
{
"type": "Integer",
"description": "Date when restrictions will be lifted for this user; unix time. If 0, then the user is banned forever",
"html_description": "<td>Date when restrictions will be lifted for this user; unix time. If 0, then the user is banned forever</td>",
"rst_description": "Date when restrictions will be lifted for this user; unix time. If 0, then the user is banned forever\n",
"name": "until_date",
"required": true
}
],
"category": "types"
}
}

View file

@ -0,0 +1,7 @@
bases:
- ChatMember
annotations:
until_date:
parsed_type:
type: std
name: datetime.datetime

View file

@ -0,0 +1,35 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "chatmemberleft",
"name": "ChatMemberLeft",
"description": "Represents a chat member that isn't currently a member of the chat, but may join it themselves.",
"html_description": "<p>Represents a <a href=\"#chatmember\">chat member</a> that isn't currently a member of the chat, but may join it themselves.</p>",
"rst_description": "Represents a `chat member <https://core.telegram.org/bots/api#chatmember>`_ that isn't currently a member of the chat, but may join it themselves.",
"annotations": [
{
"type": "String",
"description": "The member's status in the chat, always 'left'",
"html_description": "<td>The member's status in the chat, always &#8220;left&#8221;</td>",
"rst_description": "The member's status in the chat, always 'left'\n",
"name": "status",
"required": true
},
{
"type": "User",
"description": "Information about the user",
"html_description": "<td>Information about the user</td>",
"rst_description": "Information about the user\n",
"name": "user",
"required": true
}
],
"category": "types"
}
}

View file

@ -0,0 +1,2 @@
bases:
- ChatMember

View file

@ -0,0 +1,35 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "chatmembermember",
"name": "ChatMemberMember",
"description": "Represents a chat member that has no additional privileges or restrictions.",
"html_description": "<p>Represents a <a href=\"#chatmember\">chat member</a> that has no additional privileges or restrictions.</p>",
"rst_description": "Represents a `chat member <https://core.telegram.org/bots/api#chatmember>`_ that has no additional privileges or restrictions.",
"annotations": [
{
"type": "String",
"description": "The member's status in the chat, always 'member'",
"html_description": "<td>The member's status in the chat, always &#8220;member&#8221;</td>",
"rst_description": "The member's status in the chat, always 'member'\n",
"name": "status",
"required": true
},
{
"type": "User",
"description": "Information about the user",
"html_description": "<td>Information about the user</td>",
"rst_description": "Information about the user\n",
"name": "user",
"required": true
}
],
"category": "types"
}
}

View file

@ -0,0 +1,2 @@
bases:
- ChatMember

View file

@ -0,0 +1,51 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "chatmemberowner",
"name": "ChatMemberOwner",
"description": "Represents a chat member that owns the chat and has all administrator privileges.",
"html_description": "<p>Represents a <a href=\"#chatmember\">chat member</a> that owns the chat and has all administrator privileges.</p>",
"rst_description": "Represents a `chat member <https://core.telegram.org/bots/api#chatmember>`_ that owns the chat and has all administrator privileges.",
"annotations": [
{
"type": "String",
"description": "The member's status in the chat, always 'creator'",
"html_description": "<td>The member's status in the chat, always &#8220;creator&#8221;</td>",
"rst_description": "The member's status in the chat, always 'creator'\n",
"name": "status",
"required": true
},
{
"type": "User",
"description": "Information about the user",
"html_description": "<td>Information about the user</td>",
"rst_description": "Information about the user\n",
"name": "user",
"required": true
},
{
"type": "Boolean",
"description": "True, if the user's presence in the chat is hidden",
"html_description": "<td><em>True</em>, if the user's presence in the chat is hidden</td>",
"rst_description": ":code:`True`, if the user's presence in the chat is hidden\n",
"name": "is_anonymous",
"required": true
},
{
"type": "String",
"description": "Custom title for this user",
"html_description": "<td><em>Optional</em>. Custom title for this user</td>",
"rst_description": "*Optional*. Custom title for this user\n",
"name": "custom_title",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,2 @@
bases:
- ChatMember

View file

@ -0,0 +1,123 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "chatmemberrestricted",
"name": "ChatMemberRestricted",
"description": "Represents a chat member that is under certain restrictions in the chat. Supergroups only.",
"html_description": "<p>Represents a <a href=\"#chatmember\">chat member</a> that is under certain restrictions in the chat. Supergroups only.</p>",
"rst_description": "Represents a `chat member <https://core.telegram.org/bots/api#chatmember>`_ that is under certain restrictions in the chat. Supergroups only.",
"annotations": [
{
"type": "String",
"description": "The member's status in the chat, always 'restricted'",
"html_description": "<td>The member's status in the chat, always &#8220;restricted&#8221;</td>",
"rst_description": "The member's status in the chat, always 'restricted'\n",
"name": "status",
"required": true
},
{
"type": "User",
"description": "Information about the user",
"html_description": "<td>Information about the user</td>",
"rst_description": "Information about the user\n",
"name": "user",
"required": true
},
{
"type": "Boolean",
"description": "True, if the user is a member of the chat at the moment of the request",
"html_description": "<td><em>True</em>, if the user is a member of the chat at the moment of the request</td>",
"rst_description": ":code:`True`, if the user is a member of the chat at the moment of the request\n",
"name": "is_member",
"required": true
},
{
"type": "Boolean",
"description": "True, if the user is allowed to change the chat title, photo and other settings",
"html_description": "<td><em>True</em>, if the user is allowed to change the chat title, photo and other settings</td>",
"rst_description": ":code:`True`, if the user is allowed to change the chat title, photo and other settings\n",
"name": "can_change_info",
"required": true
},
{
"type": "Boolean",
"description": "True, if the user is allowed to invite new users to the chat",
"html_description": "<td><em>True</em>, if the user is allowed to invite new users to the chat</td>",
"rst_description": ":code:`True`, if the user is allowed to invite new users to the chat\n",
"name": "can_invite_users",
"required": true
},
{
"type": "Boolean",
"description": "True, if the user is allowed to pin messages",
"html_description": "<td><em>True</em>, if the user is allowed to pin messages</td>",
"rst_description": ":code:`True`, if the user is allowed to pin messages\n",
"name": "can_pin_messages",
"required": true
},
{
"type": "Boolean",
"description": "True, if the user is allowed to create forum topics",
"html_description": "<td><em>True</em>, if the user is allowed to create forum topics</td>",
"rst_description": ":code:`True`, if the user is allowed to create forum topics\n",
"name": "can_manage_topics",
"required": true
},
{
"type": "Boolean",
"description": "True, if the user is allowed to send text messages, contacts, locations and venues",
"html_description": "<td><em>True</em>, if the user is allowed to send text messages, contacts, locations and venues</td>",
"rst_description": ":code:`True`, if the user is allowed to send text messages, contacts, locations and venues\n",
"name": "can_send_messages",
"required": true
},
{
"type": "Boolean",
"description": "True, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes",
"html_description": "<td><em>True</em>, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes</td>",
"rst_description": ":code:`True`, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes\n",
"name": "can_send_media_messages",
"required": true
},
{
"type": "Boolean",
"description": "True, if the user is allowed to send polls",
"html_description": "<td><em>True</em>, if the user is allowed to send polls</td>",
"rst_description": ":code:`True`, if the user is allowed to send polls\n",
"name": "can_send_polls",
"required": true
},
{
"type": "Boolean",
"description": "True, if the user is allowed to send animations, games, stickers and use inline bots",
"html_description": "<td><em>True</em>, if the user is allowed to send animations, games, stickers and use inline bots</td>",
"rst_description": ":code:`True`, if the user is allowed to send animations, games, stickers and use inline bots\n",
"name": "can_send_other_messages",
"required": true
},
{
"type": "Boolean",
"description": "True, if the user is allowed to add web page previews to their messages",
"html_description": "<td><em>True</em>, if the user is allowed to add web page previews to their messages</td>",
"rst_description": ":code:`True`, if the user is allowed to add web page previews to their messages\n",
"name": "can_add_web_page_previews",
"required": true
},
{
"type": "Integer",
"description": "Date when restrictions will be lifted for this user; unix time. If 0, then the user is restricted forever",
"html_description": "<td>Date when restrictions will be lifted for this user; unix time. If 0, then the user is restricted forever</td>",
"rst_description": "Date when restrictions will be lifted for this user; unix time. If 0, then the user is restricted forever\n",
"name": "until_date",
"required": true
}
],
"category": "types"
}
}

View file

@ -0,0 +1,7 @@
bases:
- ChatMember
annotations:
until_date:
parsed_type:
type: std
name: datetime.datetime

View file

@ -0,0 +1,67 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "chatmemberupdated",
"name": "ChatMemberUpdated",
"description": "This object represents changes in the status of a chat member.",
"html_description": "<p>This object represents changes in the status of a chat member.</p>",
"rst_description": "This object represents changes in the status of a chat member.",
"annotations": [
{
"type": "Chat",
"description": "Chat the user belongs to",
"html_description": "<td>Chat the user belongs to</td>",
"rst_description": "Chat the user belongs to\n",
"name": "chat",
"required": true
},
{
"type": "User",
"description": "Performer of the action, which resulted in the change",
"html_description": "<td>Performer of the action, which resulted in the change</td>",
"rst_description": "Performer of the action, which resulted in the change\n",
"name": "from",
"required": true
},
{
"type": "Integer",
"description": "Date the change was done in Unix time",
"html_description": "<td>Date the change was done in Unix time</td>",
"rst_description": "Date the change was done in Unix time\n",
"name": "date",
"required": true
},
{
"type": "ChatMember",
"description": "Previous information about the chat member",
"html_description": "<td>Previous information about the chat member</td>",
"rst_description": "Previous information about the chat member\n",
"name": "old_chat_member",
"required": true
},
{
"type": "ChatMember",
"description": "New information about the chat member",
"html_description": "<td>New information about the chat member</td>",
"rst_description": "New information about the chat member\n",
"name": "new_chat_member",
"required": true
},
{
"type": "ChatInviteLink",
"description": "Chat invite link, which was used by the user to join the chat; for joining by invite link events only.",
"html_description": "<td><em>Optional</em>. Chat invite link, which was used by the user to join the chat; for joining by invite link events only.</td>",
"rst_description": "*Optional*. Chat invite link, which was used by the user to join the chat; for joining by invite link events only.\n",
"name": "invite_link",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,34 @@
annotations:
date:
parsed_type:
type: std
name: datetime.datetime
old_chat_member: &chat-member-type
parsed_type:
type: union
items:
- type: entity
references:
category: types
name: ChatMemberOwner
- type: entity
references:
category: types
name: ChatMemberAdministrator
- type: entity
references:
category: types
name: ChatMemberMember
- type: entity
references:
category: types
name: ChatMemberRestricted
- type: entity
references:
category: types
name: ChatMemberLeft
- type: entity
references:
category: types
name: ChatMemberBanned
new_chat_member: *chat-member-type

View file

@ -0,0 +1,91 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "chatpermissions",
"name": "ChatPermissions",
"description": "Describes actions that a non-administrator user is allowed to take in a chat.",
"html_description": "<p>Describes actions that a non-administrator user is allowed to take in a chat.</p>",
"rst_description": "Describes actions that a non-administrator user is allowed to take in a chat.",
"annotations": [
{
"type": "Boolean",
"description": "True, if the user is allowed to send text messages, contacts, locations and venues",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the user is allowed to send text messages, contacts, locations and venues</td>",
"rst_description": "*Optional*. :code:`True`, if the user is allowed to send text messages, contacts, locations and venues\n",
"name": "can_send_messages",
"required": false
},
{
"type": "Boolean",
"description": "True, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages</td>",
"rst_description": "*Optional*. :code:`True`, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages\n",
"name": "can_send_media_messages",
"required": false
},
{
"type": "Boolean",
"description": "True, if the user is allowed to send polls, implies can_send_messages",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the user is allowed to send polls, implies can_send_messages</td>",
"rst_description": "*Optional*. :code:`True`, if the user is allowed to send polls, implies can_send_messages\n",
"name": "can_send_polls",
"required": false
},
{
"type": "Boolean",
"description": "True, if the user is allowed to send animations, games, stickers and use inline bots, implies can_send_media_messages",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the user is allowed to send animations, games, stickers and use inline bots, implies can_send_media_messages</td>",
"rst_description": "*Optional*. :code:`True`, if the user is allowed to send animations, games, stickers and use inline bots, implies can_send_media_messages\n",
"name": "can_send_other_messages",
"required": false
},
{
"type": "Boolean",
"description": "True, if the user is allowed to add web page previews to their messages, implies can_send_media_messages",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the user is allowed to add web page previews to their messages, implies can_send_media_messages</td>",
"rst_description": "*Optional*. :code:`True`, if the user is allowed to add web page previews to their messages, implies can_send_media_messages\n",
"name": "can_add_web_page_previews",
"required": false
},
{
"type": "Boolean",
"description": "True, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups</td>",
"rst_description": "*Optional*. :code:`True`, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups\n",
"name": "can_change_info",
"required": false
},
{
"type": "Boolean",
"description": "True, if the user is allowed to invite new users to the chat",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the user is allowed to invite new users to the chat</td>",
"rst_description": "*Optional*. :code:`True`, if the user is allowed to invite new users to the chat\n",
"name": "can_invite_users",
"required": false
},
{
"type": "Boolean",
"description": "True, if the user is allowed to pin messages. Ignored in public supergroups",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the user is allowed to pin messages. Ignored in public supergroups</td>",
"rst_description": "*Optional*. :code:`True`, if the user is allowed to pin messages. Ignored in public supergroups\n",
"name": "can_pin_messages",
"required": false
},
{
"type": "Boolean",
"description": "True, if the user is allowed to create forum topics. If omitted defaults to the value of can_pin_messages",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the user is allowed to create forum topics. If omitted defaults to the value of can_pin_messages</td>",
"rst_description": "*Optional*. :code:`True`, if the user is allowed to create forum topics. If omitted defaults to the value of can_pin_messages\n",
"name": "can_manage_topics",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,2 @@
bases:
- MutableTelegramObject

View file

@ -0,0 +1,51 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "chatphoto",
"name": "ChatPhoto",
"description": "This object represents a chat photo.",
"html_description": "<p>This object represents a chat photo.</p>",
"rst_description": "This object represents a chat photo.",
"annotations": [
{
"type": "String",
"description": "File identifier of small (160x160) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed.",
"html_description": "<td>File identifier of small (160x160) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed.</td>",
"rst_description": "File identifier of small (160x160) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed.\n",
"name": "small_file_id",
"required": true
},
{
"type": "String",
"description": "Unique file identifier of small (160x160) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.",
"html_description": "<td>Unique file identifier of small (160x160) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.</td>",
"rst_description": "Unique file identifier of small (160x160) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.\n",
"name": "small_file_unique_id",
"required": true
},
{
"type": "String",
"description": "File identifier of big (640x640) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed.",
"html_description": "<td>File identifier of big (640x640) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed.</td>",
"rst_description": "File identifier of big (640x640) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed.\n",
"name": "big_file_id",
"required": true
},
{
"type": "String",
"description": "Unique file identifier of big (640x640) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.",
"html_description": "<td>Unique file identifier of big (640x640) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.</td>",
"rst_description": "Unique file identifier of big (640x640) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.\n",
"name": "big_file_unique_id",
"required": true
}
],
"category": "types"
}
}

View file

@ -0,0 +1,59 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
},
"object": {
"anchor": "choseninlineresult",
"name": "ChosenInlineResult",
"description": "Represents a result of an inline query that was chosen by the user and sent to their chat partner.\nNote: It is necessary to enable inline feedback via @BotFather in order to receive these objects in updates.",
"html_description": "<p>Represents a <a href=\"#inlinequeryresult\">result</a> of an inline query that was chosen by the user and sent to their chat partner.</p><p><strong>Note:</strong> It is necessary to enable <a href=\"/bots/inline#collecting-feedback\">inline feedback</a> via <a href=\"https://t.me/botfather\">@BotFather</a> in order to receive these objects in updates.</p>",
"rst_description": "Represents a `result <https://core.telegram.org/bots/api#inlinequeryresult>`_ of an inline query that was chosen by the user and sent to their chat partner.\n**Note:** It is necessary to enable `inline feedback <https://core.telegram.org/bots/inline#collecting-feedback>`_ via `@BotFather <https://t.me/botfather>`_ in order to receive these objects in updates.",
"annotations": [
{
"type": "String",
"description": "The unique identifier for the result that was chosen",
"html_description": "<td>The unique identifier for the result that was chosen</td>",
"rst_description": "The unique identifier for the result that was chosen\n",
"name": "result_id",
"required": true
},
{
"type": "User",
"description": "The user that chose the result",
"html_description": "<td>The user that chose the result</td>",
"rst_description": "The user that chose the result\n",
"name": "from",
"required": true
},
{
"type": "Location",
"description": "Sender location, only for bots that require user location",
"html_description": "<td><em>Optional</em>. Sender location, only for bots that require user location</td>",
"rst_description": "*Optional*. Sender location, only for bots that require user location\n",
"name": "location",
"required": false
},
{
"type": "String",
"description": "Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message. Will be also received in callback queries and can be used to edit the message.",
"html_description": "<td><em>Optional</em>. Identifier of the sent inline message. Available only if there is an <a href=\"#inlinekeyboardmarkup\">inline keyboard</a> attached to the message. Will be also received in <a href=\"#callbackquery\">callback queries</a> and can be used to <a href=\"#updating-messages\">edit</a> the message.</td>",
"rst_description": "*Optional*. Identifier of the sent inline message. Available only if there is an `inline keyboard <https://core.telegram.org/bots/api#inlinekeyboardmarkup>`_ attached to the message. Will be also received in `callback queries <https://core.telegram.org/bots/api#callbackquery>`_ and can be used to `edit <https://core.telegram.org/bots/api#updating-messages>`_ the message.\n",
"name": "inline_message_id",
"required": false
},
{
"type": "String",
"description": "The query that was used to obtain the result",
"html_description": "<td>The query that was used to obtain the result</td>",
"rst_description": "The query that was used to obtain the result\n",
"name": "query",
"required": true
}
],
"category": "types"
}
}

View file

@ -0,0 +1,59 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "contact",
"name": "Contact",
"description": "This object represents a phone contact.",
"html_description": "<p>This object represents a phone contact.</p>",
"rst_description": "This object represents a phone contact.",
"annotations": [
{
"type": "String",
"description": "Contact's phone number",
"html_description": "<td>Contact's phone number</td>",
"rst_description": "Contact's phone number\n",
"name": "phone_number",
"required": true
},
{
"type": "String",
"description": "Contact's first name",
"html_description": "<td>Contact's first name</td>",
"rst_description": "Contact's first name\n",
"name": "first_name",
"required": true
},
{
"type": "String",
"description": "Contact's last name",
"html_description": "<td><em>Optional</em>. Contact's last name</td>",
"rst_description": "*Optional*. Contact's last name\n",
"name": "last_name",
"required": false
},
{
"type": "Integer",
"description": "Contact's user identifier in Telegram. 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": "<td><em>Optional</em>. Contact's user identifier in Telegram. 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.</td>",
"rst_description": "*Optional*. Contact's user identifier in Telegram. 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": "user_id",
"required": false
},
{
"type": "String",
"description": "Additional data about the contact in the form of a vCard",
"html_description": "<td><em>Optional</em>. Additional data about the contact in the form of a <a href=\"https://en.wikipedia.org/wiki/VCard\">vCard</a></td>",
"rst_description": "*Optional*. Additional data about the contact in the form of a `vCard <https://en.wikipedia.org/wiki/VCard>`_\n",
"name": "vcard",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,35 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "dice",
"name": "Dice",
"description": "This object represents an animated emoji that displays a random value.",
"html_description": "<p>This object represents an animated emoji that displays a random value.</p>",
"rst_description": "This object represents an animated emoji that displays a random value.",
"annotations": [
{
"type": "String",
"description": "Emoji on which the dice throw animation is based",
"html_description": "<td>Emoji on which the dice throw animation is based</td>",
"rst_description": "Emoji on which the dice throw animation is based\n",
"name": "emoji",
"required": true
},
{
"type": "Integer",
"description": "Value of the dice, 1-6 for '', '' and '' base emoji, 1-5 for '' and '' base emoji, 1-64 for '' base emoji",
"html_description": "<td>Value of the dice, 1-6 for &#8220;<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8EB2.png\" width=\"20\" height=\"20\" alt=\"&#127922;\"/>&#8221;, &#8220;<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8EAF.png\" width=\"20\" height=\"20\" alt=\"&#127919;\"/>&#8221; and &#8220;<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8EB3.png\" width=\"20\" height=\"20\" alt=\"&#127923;\"/>&#8221; base emoji, 1-5 for &#8220;<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8F80.png\" width=\"20\" height=\"20\" alt=\"&#127936;\"/>&#8221; and &#8220;<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/E29ABD.png\" width=\"20\" height=\"20\" alt=\"&#9917;\"/>&#8221; base emoji, 1-64 for &#8220;<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8EB0.png\" width=\"20\" height=\"20\" alt=\"&#127920;\"/>&#8221; base emoji</td>",
"rst_description": "Value of the dice, 1-6 for '🎲', '🎯' and '🎳' base emoji, 1-5 for '🏀' and '⚽' base emoji, 1-64 for '🎰' base emoji\n",
"name": "value",
"required": true
}
],
"category": "types"
}
}

View file

@ -0,0 +1,67 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "document",
"name": "Document",
"description": "This object represents a general file (as opposed to photos, voice messages and audio files).",
"html_description": "<p>This object represents a general file (as opposed to <a href=\"#photosize\">photos</a>, <a href=\"#voice\">voice messages</a> and <a href=\"#audio\">audio files</a>).</p>",
"rst_description": "This object represents a general file (as opposed to `photos <https://core.telegram.org/bots/api#photosize>`_, `voice messages <https://core.telegram.org/bots/api#voice>`_ and `audio files <https://core.telegram.org/bots/api#audio>`_).",
"annotations": [
{
"type": "String",
"description": "Identifier for this file, which can be used to download or reuse the file",
"html_description": "<td>Identifier for this file, which can be used to download or reuse the file</td>",
"rst_description": "Identifier for this file, which can be used to download or reuse the file\n",
"name": "file_id",
"required": true
},
{
"type": "String",
"description": "Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.",
"html_description": "<td>Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.</td>",
"rst_description": "Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.\n",
"name": "file_unique_id",
"required": true
},
{
"type": "PhotoSize",
"description": "Document thumbnail as defined by sender",
"html_description": "<td><em>Optional</em>. Document thumbnail as defined by sender</td>",
"rst_description": "*Optional*. Document thumbnail as defined by sender\n",
"name": "thumb",
"required": false
},
{
"type": "String",
"description": "Original filename as defined by sender",
"html_description": "<td><em>Optional</em>. Original filename as defined by sender</td>",
"rst_description": "*Optional*. Original filename as defined by sender\n",
"name": "file_name",
"required": false
},
{
"type": "String",
"description": "MIME type of the file as defined by sender",
"html_description": "<td><em>Optional</em>. MIME type of the file as defined by sender</td>",
"rst_description": "*Optional*. MIME type of the file as defined by sender\n",
"name": "mime_type",
"required": false
},
{
"type": "Integer",
"description": "File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.",
"html_description": "<td><em>Optional</em>. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.</td>",
"rst_description": "*Optional*. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.\n",
"name": "file_size",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,43 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Telegram Passport",
"anchor": "telegram-passport"
},
"object": {
"anchor": "encryptedcredentials",
"name": "EncryptedCredentials",
"description": "Describes data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.",
"html_description": "<p>Describes data required for decrypting and authenticating <a href=\"#encryptedpassportelement\">EncryptedPassportElement</a>. See the <a href=\"/passport#receiving-information\">Telegram Passport Documentation</a> for a complete description of the data decryption and authentication processes.</p>",
"rst_description": "Describes data required for decrypting and authenticating :class:`aiogram.types.encrypted_passport_element.EncryptedPassportElement`. See the `Telegram Passport Documentation <https://core.telegram.org/passport#receiving-information>`_ for a complete description of the data decryption and authentication processes.",
"annotations": [
{
"type": "String",
"description": "Base64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for EncryptedPassportElement decryption and authentication",
"html_description": "<td>Base64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for <a href=\"#encryptedpassportelement\">EncryptedPassportElement</a> decryption and authentication</td>",
"rst_description": "Base64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for :class:`aiogram.types.encrypted_passport_element.EncryptedPassportElement` decryption and authentication\n",
"name": "data",
"required": true
},
{
"type": "String",
"description": "Base64-encoded data hash for data authentication",
"html_description": "<td>Base64-encoded data hash for data authentication</td>",
"rst_description": "Base64-encoded data hash for data authentication\n",
"name": "hash",
"required": true
},
{
"type": "String",
"description": "Base64-encoded secret, encrypted with the bot's public RSA key, required for data decryption",
"html_description": "<td>Base64-encoded secret, encrypted with the bot's public RSA key, required for data decryption</td>",
"rst_description": "Base64-encoded secret, encrypted with the bot's public RSA key, required for data decryption\n",
"name": "secret",
"required": true
}
],
"category": "types"
}
}

View file

@ -0,0 +1,99 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Telegram Passport",
"anchor": "telegram-passport"
},
"object": {
"anchor": "encryptedpassportelement",
"name": "EncryptedPassportElement",
"description": "Describes documents or other Telegram Passport elements shared with the bot by the user.",
"html_description": "<p>Describes documents or other Telegram Passport elements shared with the bot by the user.</p>",
"rst_description": "Describes documents or other Telegram Passport elements shared with the bot by the user.",
"annotations": [
{
"type": "String",
"description": "Element type. One of 'personal_details', 'passport', 'driver_license', 'identity_card', 'internal_passport', 'address', 'utility_bill', 'bank_statement', 'rental_agreement', 'passport_registration', 'temporary_registration', 'phone_number', 'email'.",
"html_description": "<td>Element type. One of &#8220;personal_details&#8221;, &#8220;passport&#8221;, &#8220;driver_license&#8221;, &#8220;identity_card&#8221;, &#8220;internal_passport&#8221;, &#8220;address&#8221;, &#8220;utility_bill&#8221;, &#8220;bank_statement&#8221;, &#8220;rental_agreement&#8221;, &#8220;passport_registration&#8221;, &#8220;temporary_registration&#8221;, &#8220;phone_number&#8221;, &#8220;email&#8221;.</td>",
"rst_description": "Element type. One of 'personal_details', 'passport', 'driver_license', 'identity_card', 'internal_passport', 'address', 'utility_bill', 'bank_statement', 'rental_agreement', 'passport_registration', 'temporary_registration', 'phone_number', 'email'.\n",
"name": "type",
"required": true
},
{
"type": "String",
"description": "Base64-encoded encrypted Telegram Passport element data provided by the user, available for 'personal_details', 'passport', 'driver_license', 'identity_card', 'internal_passport' and 'address' types. Can be decrypted and verified using the accompanying EncryptedCredentials.",
"html_description": "<td><em>Optional</em>. Base64-encoded encrypted Telegram Passport element data provided by the user, available for &#8220;personal_details&#8221;, &#8220;passport&#8221;, &#8220;driver_license&#8221;, &#8220;identity_card&#8221;, &#8220;internal_passport&#8221; and &#8220;address&#8221; types. Can be decrypted and verified using the accompanying <a href=\"#encryptedcredentials\">EncryptedCredentials</a>.</td>",
"rst_description": "*Optional*. Base64-encoded encrypted Telegram Passport element data provided by the user, available for 'personal_details', 'passport', 'driver_license', 'identity_card', 'internal_passport' and 'address' types. Can be decrypted and verified using the accompanying :class:`aiogram.types.encrypted_credentials.EncryptedCredentials`.\n",
"name": "data",
"required": false
},
{
"type": "String",
"description": "User's verified phone number, available only for 'phone_number' type",
"html_description": "<td><em>Optional</em>. User's verified phone number, available only for &#8220;phone_number&#8221; type</td>",
"rst_description": "*Optional*. User's verified phone number, available only for 'phone_number' type\n",
"name": "phone_number",
"required": false
},
{
"type": "String",
"description": "User's verified email address, available only for 'email' type",
"html_description": "<td><em>Optional</em>. User's verified email address, available only for &#8220;email&#8221; type</td>",
"rst_description": "*Optional*. User's verified email address, available only for 'email' type\n",
"name": "email",
"required": false
},
{
"type": "Array of PassportFile",
"description": "Array of encrypted files with documents provided by the user, available for 'utility_bill', 'bank_statement', 'rental_agreement', 'passport_registration' and 'temporary_registration' types. Files can be decrypted and verified using the accompanying EncryptedCredentials.",
"html_description": "<td><em>Optional</em>. Array of encrypted files with documents provided by the user, available for &#8220;utility_bill&#8221;, &#8220;bank_statement&#8221;, &#8220;rental_agreement&#8221;, &#8220;passport_registration&#8221; and &#8220;temporary_registration&#8221; types. Files can be decrypted and verified using the accompanying <a href=\"#encryptedcredentials\">EncryptedCredentials</a>.</td>",
"rst_description": "*Optional*. Array of encrypted files with documents provided by the user, available for 'utility_bill', 'bank_statement', 'rental_agreement', 'passport_registration' and 'temporary_registration' types. Files can be decrypted and verified using the accompanying :class:`aiogram.types.encrypted_credentials.EncryptedCredentials`.\n",
"name": "files",
"required": false
},
{
"type": "PassportFile",
"description": "Encrypted file with the front side of the document, provided by the user. Available for 'passport', 'driver_license', 'identity_card' and 'internal_passport'. The file can be decrypted and verified using the accompanying EncryptedCredentials.",
"html_description": "<td><em>Optional</em>. Encrypted file with the front side of the document, provided by the user. Available for &#8220;passport&#8221;, &#8220;driver_license&#8221;, &#8220;identity_card&#8221; and &#8220;internal_passport&#8221;. The file can be decrypted and verified using the accompanying <a href=\"#encryptedcredentials\">EncryptedCredentials</a>.</td>",
"rst_description": "*Optional*. Encrypted file with the front side of the document, provided by the user. Available for 'passport', 'driver_license', 'identity_card' and 'internal_passport'. The file can be decrypted and verified using the accompanying :class:`aiogram.types.encrypted_credentials.EncryptedCredentials`.\n",
"name": "front_side",
"required": false
},
{
"type": "PassportFile",
"description": "Encrypted file with the reverse side of the document, provided by the user. Available for 'driver_license' and 'identity_card'. The file can be decrypted and verified using the accompanying EncryptedCredentials.",
"html_description": "<td><em>Optional</em>. Encrypted file with the reverse side of the document, provided by the user. Available for &#8220;driver_license&#8221; and &#8220;identity_card&#8221;. The file can be decrypted and verified using the accompanying <a href=\"#encryptedcredentials\">EncryptedCredentials</a>.</td>",
"rst_description": "*Optional*. Encrypted file with the reverse side of the document, provided by the user. Available for 'driver_license' and 'identity_card'. The file can be decrypted and verified using the accompanying :class:`aiogram.types.encrypted_credentials.EncryptedCredentials`.\n",
"name": "reverse_side",
"required": false
},
{
"type": "PassportFile",
"description": "Encrypted file with the selfie of the user holding a document, provided by the user; available for 'passport', 'driver_license', 'identity_card' and 'internal_passport'. The file can be decrypted and verified using the accompanying EncryptedCredentials.",
"html_description": "<td><em>Optional</em>. Encrypted file with the selfie of the user holding a document, provided by the user; available for &#8220;passport&#8221;, &#8220;driver_license&#8221;, &#8220;identity_card&#8221; and &#8220;internal_passport&#8221;. The file can be decrypted and verified using the accompanying <a href=\"#encryptedcredentials\">EncryptedCredentials</a>.</td>",
"rst_description": "*Optional*. Encrypted file with the selfie of the user holding a document, provided by the user; available for 'passport', 'driver_license', 'identity_card' and 'internal_passport'. The file can be decrypted and verified using the accompanying :class:`aiogram.types.encrypted_credentials.EncryptedCredentials`.\n",
"name": "selfie",
"required": false
},
{
"type": "Array of PassportFile",
"description": "Array of encrypted files with translated versions of documents provided by the user. Available if requested for 'passport', 'driver_license', 'identity_card', 'internal_passport', 'utility_bill', 'bank_statement', 'rental_agreement', 'passport_registration' and 'temporary_registration' types. Files can be decrypted and verified using the accompanying EncryptedCredentials.",
"html_description": "<td><em>Optional</em>. Array of encrypted files with translated versions of documents provided by the user. Available if requested for &#8220;passport&#8221;, &#8220;driver_license&#8221;, &#8220;identity_card&#8221;, &#8220;internal_passport&#8221;, &#8220;utility_bill&#8221;, &#8220;bank_statement&#8221;, &#8220;rental_agreement&#8221;, &#8220;passport_registration&#8221; and &#8220;temporary_registration&#8221; types. Files can be decrypted and verified using the accompanying <a href=\"#encryptedcredentials\">EncryptedCredentials</a>.</td>",
"rst_description": "*Optional*. Array of encrypted files with translated versions of documents provided by the user. Available if requested for 'passport', 'driver_license', 'identity_card', 'internal_passport', 'utility_bill', 'bank_statement', 'rental_agreement', 'passport_registration' and 'temporary_registration' types. Files can be decrypted and verified using the accompanying :class:`aiogram.types.encrypted_credentials.EncryptedCredentials`.\n",
"name": "translation",
"required": false
},
{
"type": "String",
"description": "Base64-encoded element hash for using in PassportElementErrorUnspecified",
"html_description": "<td>Base64-encoded element hash for using in <a href=\"#passportelementerrorunspecified\">PassportElementErrorUnspecified</a></td>",
"rst_description": "Base64-encoded element hash for using in :class:`aiogram.types.passport_element_error_unspecified.PassportElementErrorUnspecified`\n",
"name": "hash",
"required": true
}
],
"category": "types"
}
}

View file

@ -0,0 +1,51 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "file",
"name": "File",
"description": "This object represents a file ready to be downloaded. The file can be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile.\nThe maximum file size to download is 20 MB",
"html_description": "<p>This object represents a file ready to be downloaded. The file can be downloaded via the link <code>https://api.telegram.org/file/bot&lt;token&gt;/&lt;file_path&gt;</code>. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling <a href=\"#getfile\">getFile</a>.</p><blockquote>\n<p>The maximum file size to download is 20 MB</p>\n</blockquote>",
"rst_description": "This object represents a file ready to be downloaded. The file can be downloaded via the link :code:`https://api.telegram.org/file/bot<token>/<file_path>`. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling :class:`aiogram.methods.get_file.GetFile`.\n\n The maximum file size to download is 20 MB",
"annotations": [
{
"type": "String",
"description": "Identifier for this file, which can be used to download or reuse the file",
"html_description": "<td>Identifier for this file, which can be used to download or reuse the file</td>",
"rst_description": "Identifier for this file, which can be used to download or reuse the file\n",
"name": "file_id",
"required": true
},
{
"type": "String",
"description": "Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.",
"html_description": "<td>Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.</td>",
"rst_description": "Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.\n",
"name": "file_unique_id",
"required": true
},
{
"type": "Integer",
"description": "File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.",
"html_description": "<td><em>Optional</em>. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.</td>",
"rst_description": "*Optional*. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.\n",
"name": "file_size",
"required": false
},
{
"type": "String",
"description": "File path. Use https://api.telegram.org/file/bot<token>/<file_path> to get the file.",
"html_description": "<td><em>Optional</em>. File path. Use <code>https://api.telegram.org/file/bot&lt;token&gt;/&lt;file_path&gt;</code> to get the file.</td>",
"rst_description": "*Optional*. File path. Use :code:`https://api.telegram.org/file/bot<token>/<file_path>` to get the file.\n",
"name": "file_path",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,43 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "forcereply",
"name": "ForceReply",
"description": "Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode.\nExample: A poll bot for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll:\n\nExplain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2). May be appealing for hardcore users but lacks modern day polish.\nGuide the user through a step-by-step process. 'Please send me your question', 'Cool, now let's add the first answer option', 'Great. Keep adding answer options, then send /done when you're ready'.\nThe last option is definitely more attractive. And if you use ForceReply in your bot's questions, it will receive the user's answers even if it only receives replies, commands and mentions - without any extra work for the user.",
"html_description": "<p>Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice <a href=\"/bots/features#privacy-mode\">privacy mode</a>.</p><blockquote>\n<p><strong>Example:</strong> A <a href=\"https://t.me/PollBot\">poll bot</a> for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll:</p>\n<ul>\n<li>Explain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2). May be appealing for hardcore users but lacks modern day polish.</li>\n<li>Guide the user through a step-by-step process. 'Please send me your question', 'Cool, now let's add the first answer option', 'Great. Keep adding answer options, then send /done when you're ready'.</li>\n</ul>\n<p>The last option is definitely more attractive. And if you use <a href=\"#forcereply\">ForceReply</a> in your bot's questions, it will receive the user's answers even if it only receives replies, commands and mentions - without any extra work for the user.</p>\n</blockquote>",
"rst_description": "Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice `privacy mode <https://core.telegram.org/bots/features#privacy-mode>`_.\n\n **Example:** A `poll bot <https://t.me/PollBot>`_ for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll:\n \n - Explain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2). May be appealing for hardcore users but lacks modern day polish.\n - Guide the user through a step-by-step process. 'Please send me your question', 'Cool, now let's add the first answer option', 'Great. Keep adding answer options, then send /done when you're ready'.\n \n The last option is definitely more attractive. And if you use :class:`aiogram.types.force_reply.ForceReply` in your bot's questions, it will receive the user's answers even if it only receives replies, commands and mentions - without any extra work for the user.",
"annotations": [
{
"type": "True",
"description": "Shows reply interface to the user, as if they manually selected the bot's message and tapped 'Reply'",
"html_description": "<td>Shows reply interface to the user, as if they manually selected the bot's message and tapped 'Reply'</td>",
"rst_description": "Shows reply interface to the user, as if they manually selected the bot's message and tapped 'Reply'\n",
"name": "force_reply",
"required": true
},
{
"type": "String",
"description": "The placeholder to be shown in the input field when the reply is active; 1-64 characters",
"html_description": "<td><em>Optional</em>. The placeholder to be shown in the input field when the reply is active; 1-64 characters</td>",
"rst_description": "*Optional*. The placeholder to be shown in the input field when the reply is active; 1-64 characters\n",
"name": "input_field_placeholder",
"required": false
},
{
"type": "Boolean",
"description": "Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.",
"html_description": "<td><em>Optional</em>. Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the <em>text</em> of the <a href=\"#message\">Message</a> object; 2) if the bot's message is a reply (has <em>reply_to_message_id</em>), sender of the original message.</td>",
"rst_description": "*Optional*. Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the *text* of the :class:`aiogram.types.message.Message` object; 2) if the bot's message is a reply (has *reply_to_message_id*), sender of the original message.\n",
"name": "selective",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,5 @@
bases:
- MutableTelegramObject
annotations:
force_reply:
const: "True"

View file

@ -0,0 +1,51 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "forumtopic",
"name": "ForumTopic",
"description": "This object represents a forum topic.",
"html_description": "<p>This object represents a forum topic.</p>",
"rst_description": "This object represents a forum topic.",
"annotations": [
{
"type": "Integer",
"description": "Unique identifier of the forum topic",
"html_description": "<td>Unique identifier of the forum topic</td>",
"rst_description": "Unique identifier of the forum topic\n",
"name": "message_thread_id",
"required": true
},
{
"type": "String",
"description": "Name of the topic",
"html_description": "<td>Name of the topic</td>",
"rst_description": "Name of the topic\n",
"name": "name",
"required": true
},
{
"type": "Integer",
"description": "Color of the topic icon in RGB format",
"html_description": "<td>Color of the topic icon in RGB format</td>",
"rst_description": "Color of the topic icon in RGB format\n",
"name": "icon_color",
"required": true
},
{
"type": "String",
"description": "Unique identifier of the custom emoji shown as the topic icon",
"html_description": "<td><em>Optional</em>. Unique identifier of the custom emoji shown as the topic icon</td>",
"rst_description": "*Optional*. Unique identifier of the custom emoji shown as the topic icon\n",
"name": "icon_custom_emoji_id",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,18 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "forumtopicclosed",
"name": "ForumTopicClosed",
"description": "This object represents a service message about a forum topic closed in the chat. Currently holds no information.",
"html_description": "<p>This object represents a service message about a forum topic closed in the chat. Currently holds no information.</p>",
"rst_description": "This object represents a service message about a forum topic closed in the chat. Currently holds no information.",
"annotations": [],
"category": "types"
}
}

View file

@ -0,0 +1,43 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "forumtopiccreated",
"name": "ForumTopicCreated",
"description": "This object represents a service message about a new forum topic created in the chat.",
"html_description": "<p>This object represents a service message about a new forum topic created in the chat.</p>",
"rst_description": "This object represents a service message about a new forum topic created in the chat.",
"annotations": [
{
"type": "String",
"description": "Name of the topic",
"html_description": "<td>Name of the topic</td>",
"rst_description": "Name of the topic\n",
"name": "name",
"required": true
},
{
"type": "Integer",
"description": "Color of the topic icon in RGB format",
"html_description": "<td>Color of the topic icon in RGB format</td>",
"rst_description": "Color of the topic icon in RGB format\n",
"name": "icon_color",
"required": true
},
{
"type": "String",
"description": "Unique identifier of the custom emoji shown as the topic icon",
"html_description": "<td><em>Optional</em>. Unique identifier of the custom emoji shown as the topic icon</td>",
"rst_description": "*Optional*. Unique identifier of the custom emoji shown as the topic icon\n",
"name": "icon_custom_emoji_id",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,18 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "forumtopicreopened",
"name": "ForumTopicReopened",
"description": "This object represents a service message about a forum topic reopened in the chat. Currently holds no information.",
"html_description": "<p>This object represents a service message about a forum topic reopened in the chat. Currently holds no information.</p>",
"rst_description": "This object represents a service message about a forum topic reopened in the chat. Currently holds no information.",
"annotations": [],
"category": "types"
}
}

View file

@ -0,0 +1,67 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Games",
"anchor": "games"
},
"object": {
"anchor": "game",
"name": "Game",
"description": "This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.",
"html_description": "<p>This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.</p>",
"rst_description": "This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.",
"annotations": [
{
"type": "String",
"description": "Title of the game",
"html_description": "<td>Title of the game</td>",
"rst_description": "Title of the game\n",
"name": "title",
"required": true
},
{
"type": "String",
"description": "Description of the game",
"html_description": "<td>Description of the game</td>",
"rst_description": "Description of the game\n",
"name": "description",
"required": true
},
{
"type": "Array of PhotoSize",
"description": "Photo that will be displayed in the game message in chats.",
"html_description": "<td>Photo that will be displayed in the game message in chats.</td>",
"rst_description": "Photo that will be displayed in the game message in chats.\n",
"name": "photo",
"required": true
},
{
"type": "String",
"description": "Brief description of the game or high scores included in the game message. Can be automatically edited to include current high scores for the game when the bot calls setGameScore, or manually edited using editMessageText. 0-4096 characters.",
"html_description": "<td><em>Optional</em>. Brief description of the game or high scores included in the game message. Can be automatically edited to include current high scores for the game when the bot calls <a href=\"#setgamescore\">setGameScore</a>, or manually edited using <a href=\"#editmessagetext\">editMessageText</a>. 0-4096 characters.</td>",
"rst_description": "*Optional*. Brief description of the game or high scores included in the game message. Can be automatically edited to include current high scores for the game when the bot calls :class:`aiogram.methods.set_game_score.SetGameScore`, or manually edited using :class:`aiogram.methods.edit_message_text.EditMessageText`. 0-4096 characters.\n",
"name": "text",
"required": false
},
{
"type": "Array of MessageEntity",
"description": "Special entities that appear in text, such as usernames, URLs, bot commands, etc.",
"html_description": "<td><em>Optional</em>. Special entities that appear in <em>text</em>, such as usernames, URLs, bot commands, etc.</td>",
"rst_description": "*Optional*. Special entities that appear in *text*, such as usernames, URLs, bot commands, etc.\n",
"name": "text_entities",
"required": false
},
{
"type": "Animation",
"description": "Animation that will be displayed in the game message in chats. Upload via BotFather",
"html_description": "<td><em>Optional</em>. Animation that will be displayed in the game message in chats. Upload via <a href=\"https://t.me/botfather\">BotFather</a></td>",
"rst_description": "*Optional*. Animation that will be displayed in the game message in chats. Upload via `BotFather <https://t.me/botfather>`_\n",
"name": "animation",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,43 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Games",
"anchor": "games"
},
"object": {
"anchor": "gamehighscore",
"name": "GameHighScore",
"description": "This object represents one row of the high scores table for a game.\nAnd that's about all we've got for now.\nIf you've got any questions, please check out our Bot FAQ",
"html_description": "<p>This object represents one row of the high scores table for a game.</p><p>And that's about all we've got for now.<br/>\nIf you've got any questions, please check out our <a href=\"/bots/faq\"><strong>Bot FAQ &#187;</strong></a></p>",
"rst_description": "This object represents one row of the high scores table for a game.\nAnd that's about all we've got for now.\n\nIf you've got any questions, please check out our `https://core.telegram.org/bots/faq <https://core.telegram.org/bots/faq>`_ **Bot FAQ »**",
"annotations": [
{
"type": "Integer",
"description": "Position in high score table for the game",
"html_description": "<td>Position in high score table for the game</td>",
"rst_description": "Position in high score table for the game\n",
"name": "position",
"required": true
},
{
"type": "User",
"description": "User",
"html_description": "<td>User</td>",
"rst_description": "User\n",
"name": "user",
"required": true
},
{
"type": "Integer",
"description": "Score",
"html_description": "<td>Score</td>",
"rst_description": "Score\n",
"name": "score",
"required": true
}
],
"category": "types"
}
}

View file

@ -0,0 +1,91 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "inlinekeyboardbutton",
"name": "InlineKeyboardButton",
"description": "This object represents one button of an inline keyboard. You must use exactly one of the optional fields.",
"html_description": "<p>This object represents one button of an inline keyboard. You <strong>must</strong> use exactly one of the optional fields.</p>",
"rst_description": "This object represents one button of an inline keyboard. You **must** use exactly one of the optional fields.",
"annotations": [
{
"type": "String",
"description": "Label text on the button",
"html_description": "<td>Label text on the button</td>",
"rst_description": "Label text on the button\n",
"name": "text",
"required": true
},
{
"type": "String",
"description": "HTTP or tg:// URL to be opened when the button is pressed. Links tg://user?id=<user_id> can be used to mention a user by their ID without using a username, if this is allowed by their privacy settings.",
"html_description": "<td><em>Optional</em>. HTTP or tg:// URL to be opened when the button is pressed. Links <code>tg://user?id=&lt;user_id&gt;</code> can be used to mention a user by their ID without using a username, if this is allowed by their privacy settings.</td>",
"rst_description": "*Optional*. HTTP or tg:// URL to be opened when the button is pressed. Links :code:`tg://user?id=<user_id>` can be used to mention a user by their ID without using a username, if this is allowed by their privacy settings.\n",
"name": "url",
"required": false
},
{
"type": "String",
"description": "Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes",
"html_description": "<td><em>Optional</em>. Data to be sent in a <a href=\"#callbackquery\">callback query</a> to the bot when button is pressed, 1-64 bytes</td>",
"rst_description": "*Optional*. Data to be sent in a `callback query <https://core.telegram.org/bots/api#callbackquery>`_ to the bot when button is pressed, 1-64 bytes\n",
"name": "callback_data",
"required": false
},
{
"type": "WebAppInfo",
"description": "Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery. Available only in private chats between a user and the bot.",
"html_description": "<td><em>Optional</em>. Description of the <a href=\"/bots/webapps\">Web App</a> that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method <a href=\"#answerwebappquery\">answerWebAppQuery</a>. Available only in private chats between a user and the bot.</td>",
"rst_description": "*Optional*. Description of the `Web App <https://core.telegram.org/bots/webapps>`_ that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method :class:`aiogram.methods.answer_web_app_query.AnswerWebAppQuery`. Available only in private chats between a user and the bot.\n",
"name": "web_app",
"required": false
},
{
"type": "LoginUrl",
"description": "An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget.",
"html_description": "<td><em>Optional</em>. An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the <a href=\"/widgets/login\">Telegram Login Widget</a>.</td>",
"rst_description": "*Optional*. An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the `Telegram Login Widget <https://core.telegram.org/widgets/login>`_.\n",
"name": "login_url",
"required": false
},
{
"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.\n\nNote: This offers an easy way for users to start using your bot in inline mode when they are currently in a private chat with it. Especially useful when combined with switch_pm… actions - in this case the user will be automatically returned to the chat they switched from, skipping the chat selection screen.",
"html_description": "<td><em>Optional</em>. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted.<br/>\n<br/>\n<strong>Note:</strong> This offers an easy way for users to start using your bot in <a href=\"/bots/inline\">inline mode</a> when they are currently in a private chat with it. Especially useful when combined with <a href=\"#answerinlinequery\"><em>switch_pm&#8230;</em></a> actions - in this case the user will be automatically returned to the chat they switched from, skipping the chat selection screen.</td>",
"rst_description": "*Optional*. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted.\n\n\n\n**Note:** This offers an easy way for users to start using your bot in `inline mode <https://core.telegram.org/bots/inline>`_ when they are currently in a private chat with it. Especially useful when combined with `https://core.telegram.org/bots/api#answerinlinequery <https://core.telegram.org/bots/api#answerinlinequery>`_ *switch_pm…* actions - in this case the user will be automatically returned to the chat they switched from, skipping the chat selection screen.\n",
"name": "switch_inline_query",
"required": false
},
{
"type": "String",
"description": "If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.\n\nThis offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options.",
"html_description": "<td><em>Optional</em>. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.<br/>\n<br/>\nThis offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options.</td>",
"rst_description": "*Optional*. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.\n\n\n\nThis offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options.\n",
"name": "switch_inline_query_current_chat",
"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.",
"html_description": "<td><em>Optional</em>. Description of the game that will be launched when the user presses the button.<br/>\n<br/>\n<strong>NOTE:</strong> This type of button <strong>must</strong> always be the first button in the first row.</td>",
"rst_description": "*Optional*. Description of the game that will be launched when the user presses the button.\n\n\n\n**NOTE:** This type of button **must** always be the first button in the first row.\n",
"name": "callback_game",
"required": false
},
{
"type": "Boolean",
"description": "Specify True, to send a Pay button.\n\nNOTE: This type of button must always be the first button in the first row and can only be used in invoice messages.",
"html_description": "<td><em>Optional</em>. Specify <em>True</em>, to send a <a href=\"#payments\">Pay button</a>.<br/>\n<br/>\n<strong>NOTE:</strong> This type of button <strong>must</strong> always be the first button in the first row and can only be used in invoice messages.</td>",
"rst_description": "*Optional*. Specify :code:`True`, to send a `Pay button <https://core.telegram.org/bots/api#payments>`_.\n\n\n\n**NOTE:** This type of button **must** always be the first button in the first row and can only be used in invoice messages.\n",
"name": "pay",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,2 @@
bases:
- MutableTelegramObject

View file

@ -0,0 +1,27 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Available types",
"anchor": "available-types"
},
"object": {
"anchor": "inlinekeyboardmarkup",
"name": "InlineKeyboardMarkup",
"description": "This object represents an inline keyboard that appears right next to the message it belongs to.\nNote: This will only work in Telegram versions released after 9 April, 2016. Older clients will display unsupported message.",
"html_description": "<p>This object represents an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a> that appears right next to the message it belongs to.</p><p><strong>Note:</strong> This will only work in Telegram versions released after 9 April, 2016. Older clients will display <em>unsupported message</em>.</p>",
"rst_description": "This object represents an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ that appears right next to the message it belongs to.\n**Note:** This will only work in Telegram versions released after 9 April, 2016. Older clients will display *unsupported message*.",
"annotations": [
{
"type": "Array of Array of InlineKeyboardButton",
"description": "Array of button rows, each represented by an Array of InlineKeyboardButton objects",
"html_description": "<td>Array of button rows, each represented by an Array of <a href=\"#inlinekeyboardbutton\">InlineKeyboardButton</a> objects</td>",
"rst_description": "Array of button rows, each represented by an Array of :class:`aiogram.types.inline_keyboard_button.InlineKeyboardButton` objects\n",
"name": "inline_keyboard",
"required": true
}
],
"category": "types"
}
}

View file

@ -0,0 +1,2 @@
bases:
- MutableTelegramObject

View file

@ -0,0 +1,67 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
},
"object": {
"anchor": "inlinequery",
"name": "InlineQuery",
"description": "This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.",
"html_description": "<p>This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.</p>",
"rst_description": "This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.",
"annotations": [
{
"type": "String",
"description": "Unique identifier for this query",
"html_description": "<td>Unique identifier for this query</td>",
"rst_description": "Unique identifier for this query\n",
"name": "id",
"required": true
},
{
"type": "User",
"description": "Sender",
"html_description": "<td>Sender</td>",
"rst_description": "Sender\n",
"name": "from",
"required": true
},
{
"type": "String",
"description": "Text of the query (up to 256 characters)",
"html_description": "<td>Text of the query (up to 256 characters)</td>",
"rst_description": "Text of the query (up to 256 characters)\n",
"name": "query",
"required": true
},
{
"type": "String",
"description": "Offset of the results to be returned, can be controlled by the bot",
"html_description": "<td>Offset of the results to be returned, can be controlled by the bot</td>",
"rst_description": "Offset of the results to be returned, can be controlled by the bot\n",
"name": "offset",
"required": true
},
{
"type": "String",
"description": "Type of the chat from which the inline query was sent. Can be either 'sender' for a private chat with the inline query sender, 'private', 'group', 'supergroup', or 'channel'. The chat type should be always known for requests sent from official clients and most third-party clients, unless the request was sent from a secret chat",
"html_description": "<td><em>Optional</em>. Type of the chat from which the inline query was sent. Can be either &#8220;sender&#8221; for a private chat with the inline query sender, &#8220;private&#8221;, &#8220;group&#8221;, &#8220;supergroup&#8221;, or &#8220;channel&#8221;. The chat type should be always known for requests sent from official clients and most third-party clients, unless the request was sent from a secret chat</td>",
"rst_description": "*Optional*. Type of the chat from which the inline query was sent. Can be either 'sender' for a private chat with the inline query sender, 'private', 'group', 'supergroup', or 'channel'. The chat type should be always known for requests sent from official clients and most third-party clients, unless the request was sent from a secret chat\n",
"name": "chat_type",
"required": false
},
{
"type": "Location",
"description": "Sender location, only for bots that request user location",
"html_description": "<td><em>Optional</em>. Sender location, only for bots that request user location</td>",
"rst_description": "*Optional*. Sender location, only for bots that request user location\n",
"name": "location",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,18 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
},
"object": {
"anchor": "inlinequeryresult",
"name": "InlineQueryResult",
"description": "This object represents one result of an inline query. Telegram clients currently support results of the following 20 types:\n - InlineQueryResultCachedAudio\n - InlineQueryResultCachedDocument\n - InlineQueryResultCachedGif\n - InlineQueryResultCachedMpeg4Gif\n - InlineQueryResultCachedPhoto\n - InlineQueryResultCachedSticker\n - InlineQueryResultCachedVideo\n - InlineQueryResultCachedVoice\n - InlineQueryResultArticle\n - InlineQueryResultAudio\n - InlineQueryResultContact\n - InlineQueryResultGame\n - InlineQueryResultDocument\n - InlineQueryResultGif\n - InlineQueryResultLocation\n - InlineQueryResultMpeg4Gif\n - InlineQueryResultPhoto\n - InlineQueryResultVenue\n - InlineQueryResultVideo\n - InlineQueryResultVoice\nNote: All URLs passed in inline query results will be available to end users and therefore must be assumed to be public.",
"html_description": "<p>This object represents one result of an inline query. Telegram clients currently support results of the following 20 types:</p><ul>\n<li><a href=\"#inlinequeryresultcachedaudio\">InlineQueryResultCachedAudio</a></li>\n<li><a href=\"#inlinequeryresultcacheddocument\">InlineQueryResultCachedDocument</a></li>\n<li><a href=\"#inlinequeryresultcachedgif\">InlineQueryResultCachedGif</a></li>\n<li><a href=\"#inlinequeryresultcachedmpeg4gif\">InlineQueryResultCachedMpeg4Gif</a></li>\n<li><a href=\"#inlinequeryresultcachedphoto\">InlineQueryResultCachedPhoto</a></li>\n<li><a href=\"#inlinequeryresultcachedsticker\">InlineQueryResultCachedSticker</a></li>\n<li><a href=\"#inlinequeryresultcachedvideo\">InlineQueryResultCachedVideo</a></li>\n<li><a href=\"#inlinequeryresultcachedvoice\">InlineQueryResultCachedVoice</a></li>\n<li><a href=\"#inlinequeryresultarticle\">InlineQueryResultArticle</a></li>\n<li><a href=\"#inlinequeryresultaudio\">InlineQueryResultAudio</a></li>\n<li><a href=\"#inlinequeryresultcontact\">InlineQueryResultContact</a></li>\n<li><a href=\"#inlinequeryresultgame\">InlineQueryResultGame</a></li>\n<li><a href=\"#inlinequeryresultdocument\">InlineQueryResultDocument</a></li>\n<li><a href=\"#inlinequeryresultgif\">InlineQueryResultGif</a></li>\n<li><a href=\"#inlinequeryresultlocation\">InlineQueryResultLocation</a></li>\n<li><a href=\"#inlinequeryresultmpeg4gif\">InlineQueryResultMpeg4Gif</a></li>\n<li><a href=\"#inlinequeryresultphoto\">InlineQueryResultPhoto</a></li>\n<li><a href=\"#inlinequeryresultvenue\">InlineQueryResultVenue</a></li>\n<li><a href=\"#inlinequeryresultvideo\">InlineQueryResultVideo</a></li>\n<li><a href=\"#inlinequeryresultvoice\">InlineQueryResultVoice</a></li>\n</ul><p><strong>Note:</strong> All URLs passed in inline query results will be available to end users and therefore must be assumed to be <strong>public</strong>.</p>",
"rst_description": "This object represents one result of an inline query. Telegram clients currently support results of the following 20 types:\n\n - :class:`aiogram.types.inline_query_result_cached_audio.InlineQueryResultCachedAudio`\n - :class:`aiogram.types.inline_query_result_cached_document.InlineQueryResultCachedDocument`\n - :class:`aiogram.types.inline_query_result_cached_gif.InlineQueryResultCachedGif`\n - :class:`aiogram.types.inline_query_result_cached_mpeg4_gif.InlineQueryResultCachedMpeg4Gif`\n - :class:`aiogram.types.inline_query_result_cached_photo.InlineQueryResultCachedPhoto`\n - :class:`aiogram.types.inline_query_result_cached_sticker.InlineQueryResultCachedSticker`\n - :class:`aiogram.types.inline_query_result_cached_video.InlineQueryResultCachedVideo`\n - :class:`aiogram.types.inline_query_result_cached_voice.InlineQueryResultCachedVoice`\n - :class:`aiogram.types.inline_query_result_article.InlineQueryResultArticle`\n - :class:`aiogram.types.inline_query_result_audio.InlineQueryResultAudio`\n - :class:`aiogram.types.inline_query_result_contact.InlineQueryResultContact`\n - :class:`aiogram.types.inline_query_result_game.InlineQueryResultGame`\n - :class:`aiogram.types.inline_query_result_document.InlineQueryResultDocument`\n - :class:`aiogram.types.inline_query_result_gif.InlineQueryResultGif`\n - :class:`aiogram.types.inline_query_result_location.InlineQueryResultLocation`\n - :class:`aiogram.types.inline_query_result_mpeg4_gif.InlineQueryResultMpeg4Gif`\n - :class:`aiogram.types.inline_query_result_photo.InlineQueryResultPhoto`\n - :class:`aiogram.types.inline_query_result_venue.InlineQueryResultVenue`\n - :class:`aiogram.types.inline_query_result_video.InlineQueryResultVideo`\n - :class:`aiogram.types.inline_query_result_voice.InlineQueryResultVoice`\n\n**Note:** All URLs passed in inline query results will be available to end users and therefore must be assumed to be **public**.",
"annotations": [],
"category": "types"
}
}

View file

@ -0,0 +1,2 @@
bases:
- MutableTelegramObject

View file

@ -0,0 +1,107 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
},
"object": {
"anchor": "inlinequeryresultarticle",
"name": "InlineQueryResultArticle",
"description": "Represents a link to an article or web page.",
"html_description": "<p>Represents a link to an article or web page.</p>",
"rst_description": "Represents a link to an article or web page.",
"annotations": [
{
"type": "String",
"description": "Type of the result, must be article",
"html_description": "<td>Type of the result, must be <em>article</em></td>",
"rst_description": "Type of the result, must be *article*\n",
"name": "type",
"required": true
},
{
"type": "String",
"description": "Unique identifier for this result, 1-64 Bytes",
"html_description": "<td>Unique identifier for this result, 1-64 Bytes</td>",
"rst_description": "Unique identifier for this result, 1-64 Bytes\n",
"name": "id",
"required": true
},
{
"type": "String",
"description": "Title of the result",
"html_description": "<td>Title of the result</td>",
"rst_description": "Title of the result\n",
"name": "title",
"required": true
},
{
"type": "InputMessageContent",
"description": "Content of the message to be sent",
"html_description": "<td>Content of the message to be sent</td>",
"rst_description": "Content of the message to be sent\n",
"name": "input_message_content",
"required": true
},
{
"type": "InlineKeyboardMarkup",
"description": "Inline keyboard attached to the message",
"html_description": "<td><em>Optional</em>. <a href=\"/bots/features#inline-keyboards\">Inline keyboard</a> attached to the message</td>",
"rst_description": "*Optional*. `Inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ attached to the message\n",
"name": "reply_markup",
"required": false
},
{
"type": "String",
"description": "URL of the result",
"html_description": "<td><em>Optional</em>. URL of the result</td>",
"rst_description": "*Optional*. URL of the result\n",
"name": "url",
"required": false
},
{
"type": "Boolean",
"description": "Pass True if you don't want the URL to be shown in the message",
"html_description": "<td><em>Optional</em>. Pass <em>True</em> if you don't want the URL to be shown in the message</td>",
"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",
"html_description": "<td><em>Optional</em>. Short description of the result</td>",
"rst_description": "*Optional*. Short description of the result\n",
"name": "description",
"required": false
},
{
"type": "String",
"description": "Url of the thumbnail for the result",
"html_description": "<td><em>Optional</em>. Url of the thumbnail for the result</td>",
"rst_description": "*Optional*. Url of the thumbnail for the result\n",
"name": "thumb_url",
"required": false
},
{
"type": "Integer",
"description": "Thumbnail width",
"html_description": "<td><em>Optional</em>. Thumbnail width</td>",
"rst_description": "*Optional*. Thumbnail width\n",
"name": "thumb_width",
"required": false
},
{
"type": "Integer",
"description": "Thumbnail height",
"html_description": "<td><em>Optional</em>. Thumbnail height</td>",
"rst_description": "*Optional*. Thumbnail height\n",
"name": "thumb_height",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,2 @@
bases:
- InlineQueryResult

View file

@ -0,0 +1,107 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
},
"object": {
"anchor": "inlinequeryresultaudio",
"name": "InlineQueryResultAudio",
"description": "Represents a link to an MP3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.\nNote: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.",
"html_description": "<p>Represents a link to an MP3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use <em>input_message_content</em> to send a message with the specified content instead of the audio.</p><p><strong>Note:</strong> This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.</p>",
"rst_description": "Represents a link to an MP3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the audio.\n**Note:** This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.",
"annotations": [
{
"type": "String",
"description": "Type of the result, must be audio",
"html_description": "<td>Type of the result, must be <em>audio</em></td>",
"rst_description": "Type of the result, must be *audio*\n",
"name": "type",
"required": true
},
{
"type": "String",
"description": "Unique identifier for this result, 1-64 bytes",
"html_description": "<td>Unique identifier for this result, 1-64 bytes</td>",
"rst_description": "Unique identifier for this result, 1-64 bytes\n",
"name": "id",
"required": true
},
{
"type": "String",
"description": "A valid URL for the audio file",
"html_description": "<td>A valid URL for the audio file</td>",
"rst_description": "A valid URL for the audio file\n",
"name": "audio_url",
"required": true
},
{
"type": "String",
"description": "Title",
"html_description": "<td>Title</td>",
"rst_description": "Title\n",
"name": "title",
"required": true
},
{
"type": "String",
"description": "Caption, 0-1024 characters after entities parsing",
"html_description": "<td><em>Optional</em>. Caption, 0-1024 characters after entities parsing</td>",
"rst_description": "*Optional*. Caption, 0-1024 characters after entities parsing\n",
"name": "caption",
"required": false
},
{
"type": "String",
"description": "Mode for parsing entities in the audio caption. See formatting options for more details.",
"html_description": "<td><em>Optional</em>. Mode for parsing entities in the audio caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description": "*Optional*. Mode for parsing entities in the audio caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name": "parse_mode",
"required": false
},
{
"type": "Array of MessageEntity",
"description": "List of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description": "<td><em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description": "*Optional*. List of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"name": "caption_entities",
"required": false
},
{
"type": "String",
"description": "Performer",
"html_description": "<td><em>Optional</em>. Performer</td>",
"rst_description": "*Optional*. Performer\n",
"name": "performer",
"required": false
},
{
"type": "Integer",
"description": "Audio duration in seconds",
"html_description": "<td><em>Optional</em>. Audio duration in seconds</td>",
"rst_description": "*Optional*. Audio duration in seconds\n",
"name": "audio_duration",
"required": false
},
{
"type": "InlineKeyboardMarkup",
"description": "Inline keyboard attached to the message",
"html_description": "<td><em>Optional</em>. <a href=\"/bots/features#inline-keyboards\">Inline keyboard</a> attached to the message</td>",
"rst_description": "*Optional*. `Inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ attached to the message\n",
"name": "reply_markup",
"required": false
},
{
"type": "InputMessageContent",
"description": "Content of the message to be sent instead of the audio",
"html_description": "<td><em>Optional</em>. Content of the message to be sent instead of the audio</td>",
"rst_description": "*Optional*. Content of the message to be sent instead of the audio\n",
"name": "input_message_content",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,6 @@
bases:
- InlineQueryResult
annotations:
parse_mode:
value: UNSET

View file

@ -0,0 +1,83 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
},
"object": {
"anchor": "inlinequeryresultcachedaudio",
"name": "InlineQueryResultCachedAudio",
"description": "Represents a link to an MP3 audio file stored on the Telegram servers. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.\nNote: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.",
"html_description": "<p>Represents a link to an MP3 audio file stored on the Telegram servers. By default, this audio file will be sent by the user. Alternatively, you can use <em>input_message_content</em> to send a message with the specified content instead of the audio.</p><p><strong>Note:</strong> This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.</p>",
"rst_description": "Represents a link to an MP3 audio file stored on the Telegram servers. By default, this audio file will be sent by the user. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the audio.\n**Note:** This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.",
"annotations": [
{
"type": "String",
"description": "Type of the result, must be audio",
"html_description": "<td>Type of the result, must be <em>audio</em></td>",
"rst_description": "Type of the result, must be *audio*\n",
"name": "type",
"required": true
},
{
"type": "String",
"description": "Unique identifier for this result, 1-64 bytes",
"html_description": "<td>Unique identifier for this result, 1-64 bytes</td>",
"rst_description": "Unique identifier for this result, 1-64 bytes\n",
"name": "id",
"required": true
},
{
"type": "String",
"description": "A valid file identifier for the audio file",
"html_description": "<td>A valid file identifier for the audio file</td>",
"rst_description": "A valid file identifier for the audio file\n",
"name": "audio_file_id",
"required": true
},
{
"type": "String",
"description": "Caption, 0-1024 characters after entities parsing",
"html_description": "<td><em>Optional</em>. Caption, 0-1024 characters after entities parsing</td>",
"rst_description": "*Optional*. Caption, 0-1024 characters after entities parsing\n",
"name": "caption",
"required": false
},
{
"type": "String",
"description": "Mode for parsing entities in the audio caption. See formatting options for more details.",
"html_description": "<td><em>Optional</em>. Mode for parsing entities in the audio caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description": "*Optional*. Mode for parsing entities in the audio caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name": "parse_mode",
"required": false
},
{
"type": "Array of MessageEntity",
"description": "List of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description": "<td><em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description": "*Optional*. List of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"name": "caption_entities",
"required": false
},
{
"type": "InlineKeyboardMarkup",
"description": "Inline keyboard attached to the message",
"html_description": "<td><em>Optional</em>. <a href=\"/bots/features#inline-keyboards\">Inline keyboard</a> attached to the message</td>",
"rst_description": "*Optional*. `Inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ attached to the message\n",
"name": "reply_markup",
"required": false
},
{
"type": "InputMessageContent",
"description": "Content of the message to be sent instead of the audio",
"html_description": "<td><em>Optional</em>. Content of the message to be sent instead of the audio</td>",
"rst_description": "*Optional*. Content of the message to be sent instead of the audio\n",
"name": "input_message_content",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,6 @@
bases:
- InlineQueryResult
annotations:
parse_mode:
value: UNSET

View file

@ -0,0 +1,99 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
},
"object": {
"anchor": "inlinequeryresultcacheddocument",
"name": "InlineQueryResultCachedDocument",
"description": "Represents a link to a file stored on the Telegram servers. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file.\nNote: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.",
"html_description": "<p>Represents a link to a file stored on the Telegram servers. By default, this file will be sent by the user with an optional caption. Alternatively, you can use <em>input_message_content</em> to send a message with the specified content instead of the file.</p><p><strong>Note:</strong> This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.</p>",
"rst_description": "Represents a link to a file stored on the Telegram servers. By default, this file will be sent by the user with an optional caption. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the file.\n**Note:** This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.",
"annotations": [
{
"type": "String",
"description": "Type of the result, must be document",
"html_description": "<td>Type of the result, must be <em>document</em></td>",
"rst_description": "Type of the result, must be *document*\n",
"name": "type",
"required": true
},
{
"type": "String",
"description": "Unique identifier for this result, 1-64 bytes",
"html_description": "<td>Unique identifier for this result, 1-64 bytes</td>",
"rst_description": "Unique identifier for this result, 1-64 bytes\n",
"name": "id",
"required": true
},
{
"type": "String",
"description": "Title for the result",
"html_description": "<td>Title for the result</td>",
"rst_description": "Title for the result\n",
"name": "title",
"required": true
},
{
"type": "String",
"description": "A valid file identifier for the file",
"html_description": "<td>A valid file identifier for the file</td>",
"rst_description": "A valid file identifier for the file\n",
"name": "document_file_id",
"required": true
},
{
"type": "String",
"description": "Short description of the result",
"html_description": "<td><em>Optional</em>. Short description of the result</td>",
"rst_description": "*Optional*. Short description of the result\n",
"name": "description",
"required": false
},
{
"type": "String",
"description": "Caption of the document to be sent, 0-1024 characters after entities parsing",
"html_description": "<td><em>Optional</em>. Caption of the document to be sent, 0-1024 characters after entities parsing</td>",
"rst_description": "*Optional*. Caption of the document to be sent, 0-1024 characters after entities parsing\n",
"name": "caption",
"required": false
},
{
"type": "String",
"description": "Mode for parsing entities in the document caption. See formatting options for more details.",
"html_description": "<td><em>Optional</em>. Mode for parsing entities in the document caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description": "*Optional*. Mode for parsing entities in the document caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name": "parse_mode",
"required": false
},
{
"type": "Array of MessageEntity",
"description": "List of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description": "<td><em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description": "*Optional*. List of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"name": "caption_entities",
"required": false
},
{
"type": "InlineKeyboardMarkup",
"description": "Inline keyboard attached to the message",
"html_description": "<td><em>Optional</em>. <a href=\"/bots/features#inline-keyboards\">Inline keyboard</a> attached to the message</td>",
"rst_description": "*Optional*. `Inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ attached to the message\n",
"name": "reply_markup",
"required": false
},
{
"type": "InputMessageContent",
"description": "Content of the message to be sent instead of the file",
"html_description": "<td><em>Optional</em>. Content of the message to be sent instead of the file</td>",
"rst_description": "*Optional*. Content of the message to be sent instead of the file\n",
"name": "input_message_content",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,6 @@
bases:
- InlineQueryResult
annotations:
parse_mode:
value: UNSET

View file

@ -0,0 +1,91 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
},
"object": {
"anchor": "inlinequeryresultcachedgif",
"name": "InlineQueryResultCachedGif",
"description": "Represents a link to an animated GIF file stored on the Telegram servers. By default, this animated GIF file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with specified content instead of the animation.",
"html_description": "<p>Represents a link to an animated GIF file stored on the Telegram servers. By default, this animated GIF file will be sent by the user with an optional caption. Alternatively, you can use <em>input_message_content</em> to send a message with specified content instead of the animation.</p>",
"rst_description": "Represents a link to an animated GIF file stored on the Telegram servers. By default, this animated GIF file will be sent by the user with an optional caption. Alternatively, you can use *input_message_content* to send a message with specified content instead of the animation.",
"annotations": [
{
"type": "String",
"description": "Type of the result, must be gif",
"html_description": "<td>Type of the result, must be <em>gif</em></td>",
"rst_description": "Type of the result, must be *gif*\n",
"name": "type",
"required": true
},
{
"type": "String",
"description": "Unique identifier for this result, 1-64 bytes",
"html_description": "<td>Unique identifier for this result, 1-64 bytes</td>",
"rst_description": "Unique identifier for this result, 1-64 bytes\n",
"name": "id",
"required": true
},
{
"type": "String",
"description": "A valid file identifier for the GIF file",
"html_description": "<td>A valid file identifier for the GIF file</td>",
"rst_description": "A valid file identifier for the GIF file\n",
"name": "gif_file_id",
"required": true
},
{
"type": "String",
"description": "Title for the result",
"html_description": "<td><em>Optional</em>. Title for the result</td>",
"rst_description": "*Optional*. Title for the result\n",
"name": "title",
"required": false
},
{
"type": "String",
"description": "Caption of the GIF file to be sent, 0-1024 characters after entities parsing",
"html_description": "<td><em>Optional</em>. Caption of the GIF file to be sent, 0-1024 characters after entities parsing</td>",
"rst_description": "*Optional*. Caption of the GIF file to be sent, 0-1024 characters after entities parsing\n",
"name": "caption",
"required": false
},
{
"type": "String",
"description": "Mode for parsing entities in the caption. See formatting options for more details.",
"html_description": "<td><em>Optional</em>. Mode for parsing entities in the caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description": "*Optional*. Mode for parsing entities in the caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name": "parse_mode",
"required": false
},
{
"type": "Array of MessageEntity",
"description": "List of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description": "<td><em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description": "*Optional*. List of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"name": "caption_entities",
"required": false
},
{
"type": "InlineKeyboardMarkup",
"description": "Inline keyboard attached to the message",
"html_description": "<td><em>Optional</em>. <a href=\"/bots/features#inline-keyboards\">Inline keyboard</a> attached to the message</td>",
"rst_description": "*Optional*. `Inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ attached to the message\n",
"name": "reply_markup",
"required": false
},
{
"type": "InputMessageContent",
"description": "Content of the message to be sent instead of the GIF animation",
"html_description": "<td><em>Optional</em>. Content of the message to be sent instead of the GIF animation</td>",
"rst_description": "*Optional*. Content of the message to be sent instead of the GIF animation\n",
"name": "input_message_content",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,6 @@
bases:
- InlineQueryResult
annotations:
parse_mode:
value: UNSET

View file

@ -0,0 +1,91 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
},
"object": {
"anchor": "inlinequeryresultcachedmpeg4gif",
"name": "InlineQueryResultCachedMpeg4Gif",
"description": "Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers. By default, this animated MPEG-4 file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.",
"html_description": "<p>Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers. By default, this animated MPEG-4 file will be sent by the user with an optional caption. Alternatively, you can use <em>input_message_content</em> to send a message with the specified content instead of the animation.</p>",
"rst_description": "Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers. By default, this animated MPEG-4 file will be sent by the user with an optional caption. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the animation.",
"annotations": [
{
"type": "String",
"description": "Type of the result, must be mpeg4_gif",
"html_description": "<td>Type of the result, must be <em>mpeg4_gif</em></td>",
"rst_description": "Type of the result, must be *mpeg4_gif*\n",
"name": "type",
"required": true
},
{
"type": "String",
"description": "Unique identifier for this result, 1-64 bytes",
"html_description": "<td>Unique identifier for this result, 1-64 bytes</td>",
"rst_description": "Unique identifier for this result, 1-64 bytes\n",
"name": "id",
"required": true
},
{
"type": "String",
"description": "A valid file identifier for the MPEG4 file",
"html_description": "<td>A valid file identifier for the MPEG4 file</td>",
"rst_description": "A valid file identifier for the MPEG4 file\n",
"name": "mpeg4_file_id",
"required": true
},
{
"type": "String",
"description": "Title for the result",
"html_description": "<td><em>Optional</em>. Title for the result</td>",
"rst_description": "*Optional*. Title for the result\n",
"name": "title",
"required": false
},
{
"type": "String",
"description": "Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing",
"html_description": "<td><em>Optional</em>. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing</td>",
"rst_description": "*Optional*. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing\n",
"name": "caption",
"required": false
},
{
"type": "String",
"description": "Mode for parsing entities in the caption. See formatting options for more details.",
"html_description": "<td><em>Optional</em>. Mode for parsing entities in the caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description": "*Optional*. Mode for parsing entities in the caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name": "parse_mode",
"required": false
},
{
"type": "Array of MessageEntity",
"description": "List of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description": "<td><em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description": "*Optional*. List of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"name": "caption_entities",
"required": false
},
{
"type": "InlineKeyboardMarkup",
"description": "Inline keyboard attached to the message",
"html_description": "<td><em>Optional</em>. <a href=\"/bots/features#inline-keyboards\">Inline keyboard</a> attached to the message</td>",
"rst_description": "*Optional*. `Inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ attached to the message\n",
"name": "reply_markup",
"required": false
},
{
"type": "InputMessageContent",
"description": "Content of the message to be sent instead of the video animation",
"html_description": "<td><em>Optional</em>. Content of the message to be sent instead of the video animation</td>",
"rst_description": "*Optional*. Content of the message to be sent instead of the video animation\n",
"name": "input_message_content",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,6 @@
bases:
- InlineQueryResult
annotations:
parse_mode:
value: UNSET

View file

@ -0,0 +1,99 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
},
"object": {
"anchor": "inlinequeryresultcachedphoto",
"name": "InlineQueryResultCachedPhoto",
"description": "Represents a link to a photo stored on the Telegram servers. By default, this photo will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.",
"html_description": "<p>Represents a link to a photo stored on the Telegram servers. By default, this photo will be sent by the user with an optional caption. Alternatively, you can use <em>input_message_content</em> to send a message with the specified content instead of the photo.</p>",
"rst_description": "Represents a link to a photo stored on the Telegram servers. By default, this photo will be sent by the user with an optional caption. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the photo.",
"annotations": [
{
"type": "String",
"description": "Type of the result, must be photo",
"html_description": "<td>Type of the result, must be <em>photo</em></td>",
"rst_description": "Type of the result, must be *photo*\n",
"name": "type",
"required": true
},
{
"type": "String",
"description": "Unique identifier for this result, 1-64 bytes",
"html_description": "<td>Unique identifier for this result, 1-64 bytes</td>",
"rst_description": "Unique identifier for this result, 1-64 bytes\n",
"name": "id",
"required": true
},
{
"type": "String",
"description": "A valid file identifier of the photo",
"html_description": "<td>A valid file identifier of the photo</td>",
"rst_description": "A valid file identifier of the photo\n",
"name": "photo_file_id",
"required": true
},
{
"type": "String",
"description": "Title for the result",
"html_description": "<td><em>Optional</em>. Title for the result</td>",
"rst_description": "*Optional*. Title for the result\n",
"name": "title",
"required": false
},
{
"type": "String",
"description": "Short description of the result",
"html_description": "<td><em>Optional</em>. Short description of the result</td>",
"rst_description": "*Optional*. Short description of the result\n",
"name": "description",
"required": false
},
{
"type": "String",
"description": "Caption of the photo to be sent, 0-1024 characters after entities parsing",
"html_description": "<td><em>Optional</em>. Caption of the photo to be sent, 0-1024 characters after entities parsing</td>",
"rst_description": "*Optional*. Caption of the photo to be sent, 0-1024 characters after entities parsing\n",
"name": "caption",
"required": false
},
{
"type": "String",
"description": "Mode for parsing entities in the photo caption. See formatting options for more details.",
"html_description": "<td><em>Optional</em>. Mode for parsing entities in the photo caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description": "*Optional*. Mode for parsing entities in the photo caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name": "parse_mode",
"required": false
},
{
"type": "Array of MessageEntity",
"description": "List of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description": "<td><em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description": "*Optional*. List of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"name": "caption_entities",
"required": false
},
{
"type": "InlineKeyboardMarkup",
"description": "Inline keyboard attached to the message",
"html_description": "<td><em>Optional</em>. <a href=\"/bots/features#inline-keyboards\">Inline keyboard</a> attached to the message</td>",
"rst_description": "*Optional*. `Inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ attached to the message\n",
"name": "reply_markup",
"required": false
},
{
"type": "InputMessageContent",
"description": "Content of the message to be sent instead of the photo",
"html_description": "<td><em>Optional</em>. Content of the message to be sent instead of the photo</td>",
"rst_description": "*Optional*. Content of the message to be sent instead of the photo\n",
"name": "input_message_content",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,6 @@
bases:
- InlineQueryResult
annotations:
parse_mode:
value: UNSET

View file

@ -0,0 +1,59 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
},
"object": {
"anchor": "inlinequeryresultcachedsticker",
"name": "InlineQueryResultCachedSticker",
"description": "Represents a link to a sticker stored on the Telegram servers. By default, this sticker will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the sticker.\nNote: This will only work in Telegram versions released after 9 April, 2016 for static stickers and after 06 July, 2019 for animated stickers. Older clients will ignore them.",
"html_description": "<p>Represents a link to a sticker stored on the Telegram servers. By default, this sticker will be sent by the user. Alternatively, you can use <em>input_message_content</em> to send a message with the specified content instead of the sticker.</p><p><strong>Note:</strong> This will only work in Telegram versions released after 9 April, 2016 for static stickers and after 06 July, 2019 for <a href=\"https://telegram.org/blog/animated-stickers\">animated stickers</a>. Older clients will ignore them.</p>",
"rst_description": "Represents a link to a sticker stored on the Telegram servers. By default, this sticker will be sent by the user. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the sticker.\n**Note:** This will only work in Telegram versions released after 9 April, 2016 for static stickers and after 06 July, 2019 for `animated stickers <https://telegram.org/blog/animated-stickers>`_. Older clients will ignore them.",
"annotations": [
{
"type": "String",
"description": "Type of the result, must be sticker",
"html_description": "<td>Type of the result, must be <em>sticker</em></td>",
"rst_description": "Type of the result, must be *sticker*\n",
"name": "type",
"required": true
},
{
"type": "String",
"description": "Unique identifier for this result, 1-64 bytes",
"html_description": "<td>Unique identifier for this result, 1-64 bytes</td>",
"rst_description": "Unique identifier for this result, 1-64 bytes\n",
"name": "id",
"required": true
},
{
"type": "String",
"description": "A valid file identifier of the sticker",
"html_description": "<td>A valid file identifier of the sticker</td>",
"rst_description": "A valid file identifier of the sticker\n",
"name": "sticker_file_id",
"required": true
},
{
"type": "InlineKeyboardMarkup",
"description": "Inline keyboard attached to the message",
"html_description": "<td><em>Optional</em>. <a href=\"/bots/features#inline-keyboards\">Inline keyboard</a> attached to the message</td>",
"rst_description": "*Optional*. `Inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ attached to the message\n",
"name": "reply_markup",
"required": false
},
{
"type": "InputMessageContent",
"description": "Content of the message to be sent instead of the sticker",
"html_description": "<td><em>Optional</em>. Content of the message to be sent instead of the sticker</td>",
"rst_description": "*Optional*. Content of the message to be sent instead of the sticker\n",
"name": "input_message_content",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,2 @@
bases:
- InlineQueryResult

View file

@ -0,0 +1,99 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
},
"object": {
"anchor": "inlinequeryresultcachedvideo",
"name": "InlineQueryResultCachedVideo",
"description": "Represents a link to a video file stored on the Telegram servers. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.",
"html_description": "<p>Represents a link to a video file stored on the Telegram servers. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use <em>input_message_content</em> to send a message with the specified content instead of the video.</p>",
"rst_description": "Represents a link to a video file stored on the Telegram servers. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the video.",
"annotations": [
{
"type": "String",
"description": "Type of the result, must be video",
"html_description": "<td>Type of the result, must be <em>video</em></td>",
"rst_description": "Type of the result, must be *video*\n",
"name": "type",
"required": true
},
{
"type": "String",
"description": "Unique identifier for this result, 1-64 bytes",
"html_description": "<td>Unique identifier for this result, 1-64 bytes</td>",
"rst_description": "Unique identifier for this result, 1-64 bytes\n",
"name": "id",
"required": true
},
{
"type": "String",
"description": "A valid file identifier for the video file",
"html_description": "<td>A valid file identifier for the video file</td>",
"rst_description": "A valid file identifier for the video file\n",
"name": "video_file_id",
"required": true
},
{
"type": "String",
"description": "Title for the result",
"html_description": "<td>Title for the result</td>",
"rst_description": "Title for the result\n",
"name": "title",
"required": true
},
{
"type": "String",
"description": "Short description of the result",
"html_description": "<td><em>Optional</em>. Short description of the result</td>",
"rst_description": "*Optional*. Short description of the result\n",
"name": "description",
"required": false
},
{
"type": "String",
"description": "Caption of the video to be sent, 0-1024 characters after entities parsing",
"html_description": "<td><em>Optional</em>. Caption of the video to be sent, 0-1024 characters after entities parsing</td>",
"rst_description": "*Optional*. Caption of the video to be sent, 0-1024 characters after entities parsing\n",
"name": "caption",
"required": false
},
{
"type": "String",
"description": "Mode for parsing entities in the video caption. See formatting options for more details.",
"html_description": "<td><em>Optional</em>. Mode for parsing entities in the video caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description": "*Optional*. Mode for parsing entities in the video caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name": "parse_mode",
"required": false
},
{
"type": "Array of MessageEntity",
"description": "List of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description": "<td><em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description": "*Optional*. List of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"name": "caption_entities",
"required": false
},
{
"type": "InlineKeyboardMarkup",
"description": "Inline keyboard attached to the message",
"html_description": "<td><em>Optional</em>. <a href=\"/bots/features#inline-keyboards\">Inline keyboard</a> attached to the message</td>",
"rst_description": "*Optional*. `Inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ attached to the message\n",
"name": "reply_markup",
"required": false
},
{
"type": "InputMessageContent",
"description": "Content of the message to be sent instead of the video",
"html_description": "<td><em>Optional</em>. Content of the message to be sent instead of the video</td>",
"rst_description": "*Optional*. Content of the message to be sent instead of the video\n",
"name": "input_message_content",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,6 @@
bases:
- InlineQueryResult
annotations:
parse_mode:
value: UNSET

View file

@ -0,0 +1,91 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
},
"object": {
"anchor": "inlinequeryresultcachedvoice",
"name": "InlineQueryResultCachedVoice",
"description": "Represents a link to a voice message stored on the Telegram servers. By default, this voice message will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the voice message.\nNote: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.",
"html_description": "<p>Represents a link to a voice message stored on the Telegram servers. By default, this voice message will be sent by the user. Alternatively, you can use <em>input_message_content</em> to send a message with the specified content instead of the voice message.</p><p><strong>Note:</strong> This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.</p>",
"rst_description": "Represents a link to a voice message stored on the Telegram servers. By default, this voice message will be sent by the user. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the voice message.\n**Note:** This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.",
"annotations": [
{
"type": "String",
"description": "Type of the result, must be voice",
"html_description": "<td>Type of the result, must be <em>voice</em></td>",
"rst_description": "Type of the result, must be *voice*\n",
"name": "type",
"required": true
},
{
"type": "String",
"description": "Unique identifier for this result, 1-64 bytes",
"html_description": "<td>Unique identifier for this result, 1-64 bytes</td>",
"rst_description": "Unique identifier for this result, 1-64 bytes\n",
"name": "id",
"required": true
},
{
"type": "String",
"description": "A valid file identifier for the voice message",
"html_description": "<td>A valid file identifier for the voice message</td>",
"rst_description": "A valid file identifier for the voice message\n",
"name": "voice_file_id",
"required": true
},
{
"type": "String",
"description": "Voice message title",
"html_description": "<td>Voice message title</td>",
"rst_description": "Voice message title\n",
"name": "title",
"required": true
},
{
"type": "String",
"description": "Caption, 0-1024 characters after entities parsing",
"html_description": "<td><em>Optional</em>. Caption, 0-1024 characters after entities parsing</td>",
"rst_description": "*Optional*. Caption, 0-1024 characters after entities parsing\n",
"name": "caption",
"required": false
},
{
"type": "String",
"description": "Mode for parsing entities in the voice message caption. See formatting options for more details.",
"html_description": "<td><em>Optional</em>. Mode for parsing entities in the voice message caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description": "*Optional*. Mode for parsing entities in the voice message caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name": "parse_mode",
"required": false
},
{
"type": "Array of MessageEntity",
"description": "List of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description": "<td><em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description": "*Optional*. List of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"name": "caption_entities",
"required": false
},
{
"type": "InlineKeyboardMarkup",
"description": "Inline keyboard attached to the message",
"html_description": "<td><em>Optional</em>. <a href=\"/bots/features#inline-keyboards\">Inline keyboard</a> attached to the message</td>",
"rst_description": "*Optional*. `Inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ attached to the message\n",
"name": "reply_markup",
"required": false
},
{
"type": "InputMessageContent",
"description": "Content of the message to be sent instead of the voice message",
"html_description": "<td><em>Optional</em>. Content of the message to be sent instead of the voice message</td>",
"rst_description": "*Optional*. Content of the message to be sent instead of the voice message\n",
"name": "input_message_content",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,6 @@
bases:
- InlineQueryResult
annotations:
parse_mode:
value: UNSET

View file

@ -0,0 +1,107 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
},
"object": {
"anchor": "inlinequeryresultcontact",
"name": "InlineQueryResultContact",
"description": "Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the contact.\nNote: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.",
"html_description": "<p>Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can use <em>input_message_content</em> to send a message with the specified content instead of the contact.</p><p><strong>Note:</strong> This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.</p>",
"rst_description": "Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the contact.\n**Note:** This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.",
"annotations": [
{
"type": "String",
"description": "Type of the result, must be contact",
"html_description": "<td>Type of the result, must be <em>contact</em></td>",
"rst_description": "Type of the result, must be *contact*\n",
"name": "type",
"required": true
},
{
"type": "String",
"description": "Unique identifier for this result, 1-64 Bytes",
"html_description": "<td>Unique identifier for this result, 1-64 Bytes</td>",
"rst_description": "Unique identifier for this result, 1-64 Bytes\n",
"name": "id",
"required": true
},
{
"type": "String",
"description": "Contact's phone number",
"html_description": "<td>Contact's phone number</td>",
"rst_description": "Contact's phone number\n",
"name": "phone_number",
"required": true
},
{
"type": "String",
"description": "Contact's first name",
"html_description": "<td>Contact's first name</td>",
"rst_description": "Contact's first name\n",
"name": "first_name",
"required": true
},
{
"type": "String",
"description": "Contact's last name",
"html_description": "<td><em>Optional</em>. Contact's last name</td>",
"rst_description": "*Optional*. Contact's last name\n",
"name": "last_name",
"required": false
},
{
"type": "String",
"description": "Additional data about the contact in the form of a vCard, 0-2048 bytes",
"html_description": "<td><em>Optional</em>. Additional data about the contact in the form of a <a href=\"https://en.wikipedia.org/wiki/VCard\">vCard</a>, 0-2048 bytes</td>",
"rst_description": "*Optional*. Additional data about the contact in the form of a `vCard <https://en.wikipedia.org/wiki/VCard>`_, 0-2048 bytes\n",
"name": "vcard",
"required": false
},
{
"type": "InlineKeyboardMarkup",
"description": "Inline keyboard attached to the message",
"html_description": "<td><em>Optional</em>. <a href=\"/bots/features#inline-keyboards\">Inline keyboard</a> attached to the message</td>",
"rst_description": "*Optional*. `Inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ attached to the message\n",
"name": "reply_markup",
"required": false
},
{
"type": "InputMessageContent",
"description": "Content of the message to be sent instead of the contact",
"html_description": "<td><em>Optional</em>. Content of the message to be sent instead of the contact</td>",
"rst_description": "*Optional*. Content of the message to be sent instead of the contact\n",
"name": "input_message_content",
"required": false
},
{
"type": "String",
"description": "Url of the thumbnail for the result",
"html_description": "<td><em>Optional</em>. Url of the thumbnail for the result</td>",
"rst_description": "*Optional*. Url of the thumbnail for the result\n",
"name": "thumb_url",
"required": false
},
{
"type": "Integer",
"description": "Thumbnail width",
"html_description": "<td><em>Optional</em>. Thumbnail width</td>",
"rst_description": "*Optional*. Thumbnail width\n",
"name": "thumb_width",
"required": false
},
{
"type": "Integer",
"description": "Thumbnail height",
"html_description": "<td><em>Optional</em>. Thumbnail height</td>",
"rst_description": "*Optional*. Thumbnail height\n",
"name": "thumb_height",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,2 @@
bases:
- InlineQueryResult

View file

@ -0,0 +1,131 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
},
"object": {
"anchor": "inlinequeryresultdocument",
"name": "InlineQueryResultDocument",
"description": "Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file. Currently, only .PDF and .ZIP files can be sent using this method.\nNote: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.",
"html_description": "<p>Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use <em>input_message_content</em> to send a message with the specified content instead of the file. Currently, only <strong>.PDF</strong> and <strong>.ZIP</strong> files can be sent using this method.</p><p><strong>Note:</strong> This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.</p>",
"rst_description": "Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the file. Currently, only **.PDF** and **.ZIP** files can be sent using this method.\n**Note:** This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.",
"annotations": [
{
"type": "String",
"description": "Type of the result, must be document",
"html_description": "<td>Type of the result, must be <em>document</em></td>",
"rst_description": "Type of the result, must be *document*\n",
"name": "type",
"required": true
},
{
"type": "String",
"description": "Unique identifier for this result, 1-64 bytes",
"html_description": "<td>Unique identifier for this result, 1-64 bytes</td>",
"rst_description": "Unique identifier for this result, 1-64 bytes\n",
"name": "id",
"required": true
},
{
"type": "String",
"description": "Title for the result",
"html_description": "<td>Title for the result</td>",
"rst_description": "Title for the result\n",
"name": "title",
"required": true
},
{
"type": "String",
"description": "Caption of the document to be sent, 0-1024 characters after entities parsing",
"html_description": "<td><em>Optional</em>. Caption of the document to be sent, 0-1024 characters after entities parsing</td>",
"rst_description": "*Optional*. Caption of the document to be sent, 0-1024 characters after entities parsing\n",
"name": "caption",
"required": false
},
{
"type": "String",
"description": "Mode for parsing entities in the document caption. See formatting options for more details.",
"html_description": "<td><em>Optional</em>. Mode for parsing entities in the document caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description": "*Optional*. Mode for parsing entities in the document caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name": "parse_mode",
"required": false
},
{
"type": "Array of MessageEntity",
"description": "List of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description": "<td><em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description": "*Optional*. List of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"name": "caption_entities",
"required": false
},
{
"type": "String",
"description": "A valid URL for the file",
"html_description": "<td>A valid URL for the file</td>",
"rst_description": "A valid URL for the file\n",
"name": "document_url",
"required": true
},
{
"type": "String",
"description": "MIME type of the content of the file, either 'application/pdf' or 'application/zip'",
"html_description": "<td>MIME type of the content of the file, either &#8220;application/pdf&#8221; or &#8220;application/zip&#8221;</td>",
"rst_description": "MIME type of the content of the file, either 'application/pdf' or 'application/zip'\n",
"name": "mime_type",
"required": true
},
{
"type": "String",
"description": "Short description of the result",
"html_description": "<td><em>Optional</em>. Short description of the result</td>",
"rst_description": "*Optional*. Short description of the result\n",
"name": "description",
"required": false
},
{
"type": "InlineKeyboardMarkup",
"description": "Inline keyboard attached to the message",
"html_description": "<td><em>Optional</em>. Inline keyboard attached to the message</td>",
"rst_description": "*Optional*. Inline keyboard attached to the message\n",
"name": "reply_markup",
"required": false
},
{
"type": "InputMessageContent",
"description": "Content of the message to be sent instead of the file",
"html_description": "<td><em>Optional</em>. Content of the message to be sent instead of the file</td>",
"rst_description": "*Optional*. Content of the message to be sent instead of the file\n",
"name": "input_message_content",
"required": false
},
{
"type": "String",
"description": "URL of the thumbnail (JPEG only) for the file",
"html_description": "<td><em>Optional</em>. URL of the thumbnail (JPEG only) for the file</td>",
"rst_description": "*Optional*. URL of the thumbnail (JPEG only) for the file\n",
"name": "thumb_url",
"required": false
},
{
"type": "Integer",
"description": "Thumbnail width",
"html_description": "<td><em>Optional</em>. Thumbnail width</td>",
"rst_description": "*Optional*. Thumbnail width\n",
"name": "thumb_width",
"required": false
},
{
"type": "Integer",
"description": "Thumbnail height",
"html_description": "<td><em>Optional</em>. Thumbnail height</td>",
"rst_description": "*Optional*. Thumbnail height\n",
"name": "thumb_height",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,6 @@
bases:
- InlineQueryResult
annotations:
parse_mode:
value: UNSET

View file

@ -0,0 +1,51 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
},
"object": {
"anchor": "inlinequeryresultgame",
"name": "InlineQueryResultGame",
"description": "Represents a Game.\nNote: This will only work in Telegram versions released after October 1, 2016. Older clients will not display any inline results if a game result is among them.",
"html_description": "<p>Represents a <a href=\"#games\">Game</a>.</p><p><strong>Note:</strong> This will only work in Telegram versions released after October 1, 2016. Older clients will not display any inline results if a game result is among them.</p>",
"rst_description": "Represents a `Game <https://core.telegram.org/bots/api#games>`_.\n**Note:** This will only work in Telegram versions released after October 1, 2016. Older clients will not display any inline results if a game result is among them.",
"annotations": [
{
"type": "String",
"description": "Type of the result, must be game",
"html_description": "<td>Type of the result, must be <em>game</em></td>",
"rst_description": "Type of the result, must be *game*\n",
"name": "type",
"required": true
},
{
"type": "String",
"description": "Unique identifier for this result, 1-64 bytes",
"html_description": "<td>Unique identifier for this result, 1-64 bytes</td>",
"rst_description": "Unique identifier for this result, 1-64 bytes\n",
"name": "id",
"required": true
},
{
"type": "String",
"description": "Short name of the game",
"html_description": "<td>Short name of the game</td>",
"rst_description": "Short name of the game\n",
"name": "game_short_name",
"required": true
},
{
"type": "InlineKeyboardMarkup",
"description": "Inline keyboard attached to the message",
"html_description": "<td><em>Optional</em>. <a href=\"/bots/features#inline-keyboards\">Inline keyboard</a> attached to the message</td>",
"rst_description": "*Optional*. `Inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ attached to the message\n",
"name": "reply_markup",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,2 @@
bases:
- InlineQueryResult

View file

@ -0,0 +1,131 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
},
"object": {
"anchor": "inlinequeryresultgif",
"name": "InlineQueryResultGif",
"description": "Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.",
"html_description": "<p>Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use <em>input_message_content</em> to send a message with the specified content instead of the animation.</p>",
"rst_description": "Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the animation.",
"annotations": [
{
"type": "String",
"description": "Type of the result, must be gif",
"html_description": "<td>Type of the result, must be <em>gif</em></td>",
"rst_description": "Type of the result, must be *gif*\n",
"name": "type",
"required": true
},
{
"type": "String",
"description": "Unique identifier for this result, 1-64 bytes",
"html_description": "<td>Unique identifier for this result, 1-64 bytes</td>",
"rst_description": "Unique identifier for this result, 1-64 bytes\n",
"name": "id",
"required": true
},
{
"type": "String",
"description": "A valid URL for the GIF file. File size must not exceed 1MB",
"html_description": "<td>A valid URL for the GIF file. File size must not exceed 1MB</td>",
"rst_description": "A valid URL for the GIF file. File size must not exceed 1MB\n",
"name": "gif_url",
"required": true
},
{
"type": "Integer",
"description": "Width of the GIF",
"html_description": "<td><em>Optional</em>. Width of the GIF</td>",
"rst_description": "*Optional*. Width of the GIF\n",
"name": "gif_width",
"required": false
},
{
"type": "Integer",
"description": "Height of the GIF",
"html_description": "<td><em>Optional</em>. Height of the GIF</td>",
"rst_description": "*Optional*. Height of the GIF\n",
"name": "gif_height",
"required": false
},
{
"type": "Integer",
"description": "Duration of the GIF in seconds",
"html_description": "<td><em>Optional</em>. Duration of the GIF in seconds</td>",
"rst_description": "*Optional*. Duration of the GIF in seconds\n",
"name": "gif_duration",
"required": false
},
{
"type": "String",
"description": "URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result",
"html_description": "<td>URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result</td>",
"rst_description": "URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result\n",
"name": "thumb_url",
"required": true
},
{
"type": "String",
"description": "MIME type of the thumbnail, must be one of 'image/jpeg', 'image/gif', or 'video/mp4'. Defaults to 'image/jpeg'",
"html_description": "<td><em>Optional</em>. MIME type of the thumbnail, must be one of &#8220;image/jpeg&#8221;, &#8220;image/gif&#8221;, or &#8220;video/mp4&#8221;. Defaults to &#8220;image/jpeg&#8221;</td>",
"rst_description": "*Optional*. MIME type of the thumbnail, must be one of 'image/jpeg', 'image/gif', or 'video/mp4'. Defaults to 'image/jpeg'\n",
"name": "thumb_mime_type",
"required": false
},
{
"type": "String",
"description": "Title for the result",
"html_description": "<td><em>Optional</em>. Title for the result</td>",
"rst_description": "*Optional*. Title for the result\n",
"name": "title",
"required": false
},
{
"type": "String",
"description": "Caption of the GIF file to be sent, 0-1024 characters after entities parsing",
"html_description": "<td><em>Optional</em>. Caption of the GIF file to be sent, 0-1024 characters after entities parsing</td>",
"rst_description": "*Optional*. Caption of the GIF file to be sent, 0-1024 characters after entities parsing\n",
"name": "caption",
"required": false
},
{
"type": "String",
"description": "Mode for parsing entities in the caption. See formatting options for more details.",
"html_description": "<td><em>Optional</em>. Mode for parsing entities in the caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description": "*Optional*. Mode for parsing entities in the caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name": "parse_mode",
"required": false
},
{
"type": "Array of MessageEntity",
"description": "List of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description": "<td><em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description": "*Optional*. List of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"name": "caption_entities",
"required": false
},
{
"type": "InlineKeyboardMarkup",
"description": "Inline keyboard attached to the message",
"html_description": "<td><em>Optional</em>. <a href=\"/bots/features#inline-keyboards\">Inline keyboard</a> attached to the message</td>",
"rst_description": "*Optional*. `Inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ attached to the message\n",
"name": "reply_markup",
"required": false
},
{
"type": "InputMessageContent",
"description": "Content of the message to be sent instead of the GIF animation",
"html_description": "<td><em>Optional</em>. Content of the message to be sent instead of the GIF animation</td>",
"rst_description": "*Optional*. Content of the message to be sent instead of the GIF animation\n",
"name": "input_message_content",
"required": false
}
],
"category": "types"
}
}

View file

@ -0,0 +1,6 @@
bases:
- InlineQueryResult
annotations:
parse_mode:
value: UNSET

View file

@ -0,0 +1,131 @@
{
"meta": {
"deprecated": false
},
"group": {
"title": "Inline mode",
"anchor": "inline-mode"
},
"object": {
"anchor": "inlinequeryresultlocation",
"name": "InlineQueryResultLocation",
"description": "Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the location.\nNote: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.",
"html_description": "<p>Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use <em>input_message_content</em> to send a message with the specified content instead of the location.</p><p><strong>Note:</strong> This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.</p>",
"rst_description": "Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the location.\n**Note:** This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.",
"annotations": [
{
"type": "String",
"description": "Type of the result, must be location",
"html_description": "<td>Type of the result, must be <em>location</em></td>",
"rst_description": "Type of the result, must be *location*\n",
"name": "type",
"required": true
},
{
"type": "String",
"description": "Unique identifier for this result, 1-64 Bytes",
"html_description": "<td>Unique identifier for this result, 1-64 Bytes</td>",
"rst_description": "Unique identifier for this result, 1-64 Bytes\n",
"name": "id",
"required": true
},
{
"type": "Float number",
"description": "Location latitude in degrees",
"html_description": "<td>Location latitude in degrees</td>",
"rst_description": "Location latitude in degrees\n",
"name": "latitude",
"required": true
},
{
"type": "Float number",
"description": "Location longitude in degrees",
"html_description": "<td>Location longitude in degrees</td>",
"rst_description": "Location longitude in degrees\n",
"name": "longitude",
"required": true
},
{
"type": "String",
"description": "Location title",
"html_description": "<td>Location title</td>",
"rst_description": "Location title\n",
"name": "title",
"required": true
},
{
"type": "Float number",
"description": "The radius of uncertainty for the location, measured in meters; 0-1500",
"html_description": "<td><em>Optional</em>. The radius of uncertainty for the location, measured in meters; 0-1500</td>",
"rst_description": "*Optional*. The radius of uncertainty for the location, measured in meters; 0-1500\n",
"name": "horizontal_accuracy",
"required": false
},
{
"type": "Integer",
"description": "Period in seconds for which the location can be updated, should be between 60 and 86400.",
"html_description": "<td><em>Optional</em>. Period in seconds for which the location can be updated, should be between 60 and 86400.</td>",
"rst_description": "*Optional*. Period in seconds for which the location can be updated, should be between 60 and 86400.\n",
"name": "live_period",
"required": false
},
{
"type": "Integer",
"description": "For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.",
"html_description": "<td><em>Optional</em>. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.</td>",
"rst_description": "*Optional*. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.\n",
"name": "heading",
"required": false
},
{
"type": "Integer",
"description": "For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.",
"html_description": "<td><em>Optional</em>. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.</td>",
"rst_description": "*Optional*. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.\n",
"name": "proximity_alert_radius",
"required": false
},
{
"type": "InlineKeyboardMarkup",
"description": "Inline keyboard attached to the message",
"html_description": "<td><em>Optional</em>. <a href=\"/bots/features#inline-keyboards\">Inline keyboard</a> attached to the message</td>",
"rst_description": "*Optional*. `Inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ attached to the message\n",
"name": "reply_markup",
"required": false
},
{
"type": "InputMessageContent",
"description": "Content of the message to be sent instead of the location",
"html_description": "<td><em>Optional</em>. Content of the message to be sent instead of the location</td>",
"rst_description": "*Optional*. Content of the message to be sent instead of the location\n",
"name": "input_message_content",
"required": false
},
{
"type": "String",
"description": "Url of the thumbnail for the result",
"html_description": "<td><em>Optional</em>. Url of the thumbnail for the result</td>",
"rst_description": "*Optional*. Url of the thumbnail for the result\n",
"name": "thumb_url",
"required": false
},
{
"type": "Integer",
"description": "Thumbnail width",
"html_description": "<td><em>Optional</em>. Thumbnail width</td>",
"rst_description": "*Optional*. Thumbnail width\n",
"name": "thumb_width",
"required": false
},
{
"type": "Integer",
"description": "Thumbnail height",
"html_description": "<td><em>Optional</em>. Thumbnail height</td>",
"rst_description": "*Optional*. Thumbnail height\n",
"name": "thumb_height",
"required": false
}
],
"category": "types"
}
}

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