Merge branch 'dev-3.x' into docs-update

This commit is contained in:
Alex Root Junior 2023-11-16 02:33:20 +02:00 committed by GitHub
commit fd5ca38c36
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1216 changed files with 25995 additions and 39588 deletions

View file

@ -1 +1 @@
6.6
6.9

View file

@ -0,0 +1,93 @@
name: Currency
description: |
Currencies supported by Telegram Bot API
Source: https://core.telegram.org/bots/payments#supported-currencies
static:
AED: "AED" # United Arab Emirates Dirham
AFN: "AFN" # Afghan Afghani
ALL: "ALL" # Albanian Lek
AMD: "AMD" # Armenian Dram
ARS: "ARS" # Argentine Peso
AUD: "AUD" # Australian Dollar
AZN: "AZN" # Azerbaijani Manat
BAM: "BAM" # Bosnia & Herzegovina Convertible Mark
BDT: "BDT" # Bangladeshi Taka
BGN: "BGN" # Bulgarian Lev
BND: "BND" # Brunei Dollar
BOB: "BOB" # Bolivian Boliviano
BRL: "BRL" # Brazilian Real
BYN: "BYN" # Belarusian ruble
CAD: "CAD" # Canadian Dollar
CHF: "CHF" # Swiss Franc
CLP: "CLP" # Chilean Peso
CNY: "CNY" # Chinese Renminbi Yuan
COP: "COP" # Colombian Peso
CRC: "CRC" # Costa Rican Colón
CZK: "CZK" # Czech Koruna
DKK: "DKK" # Danish Krone
DOP: "DOP" # Dominican Peso
DZD: "DZD" # Algerian Dinar
EGP: "EGP" # Egyptian Pound
ETB: "ETB" # Ethiopian Birr
EUR: "EUR" # Euro
GBP: "GBP" # British Pound
GEL: "GEL" # Georgian Lari
GTQ: "GTQ" # Guatemalan Quetzal
HKD: "HKD" # Hong Kong Dollar
HNL: "HNL" # Honduran Lempira
HRK: "HRK" # Croatian Kuna
HUF: "HUF" # Hungarian Forint
IDR: "IDR" # Indonesian Rupiah
ILS: "ILS" # Israeli New Sheqel
INR: "INR" # Indian Rupee
ISK: "ISK" # Icelandic Króna
JMD: "JMD" # Jamaican Dollar
JPY: "JPY" # Japanese Yen
KES: "KES" # Kenyan Shilling
KGS: "KGS" # Kyrgyzstani Som
KRW: "KRW" # South Korean Won
KZT: "KZT" # Kazakhstani Tenge
LBP: "LBP" # Lebanese Pound
LKR: "LKR" # Sri Lankan Rupee
MAD: "MAD" # Moroccan Dirham
MDL: "MDL" # Moldovan Leu
MNT: "MNT" # Mongolian Tögrög
MUR: "MUR" # Mauritian Rupee
MVR: "MVR" # Maldivian Rufiyaa
MXN: "MXN" # Mexican Peso
MYR: "MYR" # Malaysian Ringgit
MZN: "MZN" # Mozambican Metical
NGN: "NGN" # Nigerian Naira
NIO: "NIO" # Nicaraguan Córdoba
NOK: "NOK" # Norwegian Krone
NPR: "NPR" # Nepalese Rupee
NZD: "NZD" # New Zealand Dollar
PAB: "PAB" # Panamanian Balboa
PEN: "PEN" # Peruvian Nuevo Sol
PHP: "PHP" # Philippine Peso
PKR: "PKR" # Pakistani Rupee
PLN: "PLN" # Polish Złoty
PYG: "PYG" # Paraguayan Guaraní
QAR: "QAR" # Qatari Riyal
RON: "RON" # Romanian Leu
RSD: "RSD" # Serbian Dinar
RUB: "RUB" # Russian Ruble
SAR: "SAR" # Saudi Riyal
SEK: "SEK" # Swedish Krona
SGD: "SGD" # Singapore Dollar
THB: "THB" # Thai Baht
TJS: "TJS" # Tajikistani Somoni
TRY: "TRY" # Turkish Lira
TTD: "TTD" # Trinidad and Tobago Dollar
TWD: "TWD" # New Taiwan Dollar
TZS: "TZS" # Tanzanian Shilling
UAH: "UAH" # Ukrainian Hryvnia
UGX: "UGX" # Ugandan Shilling
USD: "USD" # United States Dollar
UYU: "UYU" # Uruguayan Peso
UZS: "UZS" # Uzbekistani Som
VND: "VND" # Vietnamese Đồng
YER: "YER" # Yemeni Rial
ZAR: "ZAR" # South African Rand

View file

@ -0,0 +1,10 @@
name: EncryptedPassportElement
description: |
This object represents type of encrypted passport element.
Source: https://core.telegram.org/bots/api#encryptedpassportelement
parse:
entity: EncryptedPassportElement
category: types
attribute: type
regexp: "'([a-z_]+)'"

View file

@ -0,0 +1,18 @@
name: PassportElementErrorType
description: |
This object represents a passport element error type.
Source: https://core.telegram.org/bots/api#passportelementerror
multi_parse:
attribute: source
regexp: 'must be ([a-z_]+)'
entities:
- PassportElementErrorDataField
- PassportElementErrorFrontSide
- PassportElementErrorReverseSide
- PassportElementErrorSelfie
- PassportElementErrorFile
- PassportElementErrorFiles
- PassportElementErrorTranslationFile
- PassportElementErrorTranslationFiles
- PassportElementErrorUnspecified

View file

@ -30,9 +30,9 @@
{
"type": "Integer",
"required": false,
"description": "Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.",
"html_description": "<td>Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.</td>",
"rst_description": "Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.\n",
"description": "Date when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.",
"html_description": "<td>Date when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.</td>",
"rst_description": "Date when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.\n",
"name": "until_date"
},
{

View file

@ -38,9 +38,9 @@
{
"type": "Array of String",
"required": false,
"description": "A JSON-serialized list of the update types you want your bot to receive. For example, specify ['message', 'edited_channel_post', 'callback_query'] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member (default). If not specified, the previous setting will be used.\n\nPlease note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time.",
"html_description": "<td>A JSON-serialized list of the update types you want your bot to receive. For example, specify [&#8220;message&#8221;, &#8220;edited_channel_post&#8221;, &#8220;callback_query&#8221;] to only receive updates of these types. See <a href=\"#update\">Update</a> for a complete list of available update types. Specify an empty list to receive all update types except <em>chat_member</em> (default). If not specified, the previous setting will be used.<br/>\n<br/>\nPlease note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time.</td>",
"rst_description": "A JSON-serialized list of the update types you want your bot to receive. For example, specify ['message', 'edited_channel_post', 'callback_query'] to only receive updates of these types. See :class:`aiogram.types.update.Update` for a complete list of available update types. Specify an empty list to receive all update types except *chat_member* (default). If not specified, the previous setting will be used.\n\n\n\nPlease note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time.\n",
"description": "A JSON-serialized list of the update types you want your bot to receive. For example, specify [\"message\", \"edited_channel_post\", \"callback_query\"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member (default). If not specified, the previous setting will be used.\n\nPlease note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time.",
"html_description": "<td>A JSON-serialized list of the update types you want your bot to receive. For example, specify <code>[\"message\", \"edited_channel_post\", \"callback_query\"]</code> to only receive updates of these types. See <a href=\"#update\">Update</a> for a complete list of available update types. Specify an empty list to receive all update types except <em>chat_member</em> (default). If not specified, the previous setting will be used.<br/>\n<br/>\nPlease note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time.</td>",
"rst_description": "A JSON-serialized list of the update types you want your bot to receive. For example, specify :code:`[\"message\", \"edited_channel_post\", \"callback_query\"]` to only receive updates of these types. See :class:`aiogram.types.update.Update` for a complete list of available update types. Specify an empty list to receive all update types except *chat_member* (default). If not specified, the previous setting will be used.\n\n\n\nPlease note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time.\n",
"name": "allowed_updates"
}
],

View file

@ -38,27 +38,11 @@
{
"type": "Boolean",
"required": false,
"description": "Pass 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>Pass <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": "Pass :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",
"description": "Pass True if the administrator can access the chat event log, boost list in channels, see channel members, report spam messages, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege",
"html_description": "<td>Pass <em>True</em> if the administrator can access the chat event log, boost list in channels, see channel members, report spam messages, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege</td>",
"rst_description": "Pass :code:`True` if the administrator can access the chat event log, boost list in channels, see channel members, report spam messages, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege\n",
"name": "can_manage_chat"
},
{
"type": "Boolean",
"required": false,
"description": "Pass True if the administrator can create channel posts, channels only",
"html_description": "<td>Pass <em>True</em> if the administrator can create channel posts, channels only</td>",
"rst_description": "Pass :code:`True` if the administrator can create channel posts, channels only\n",
"name": "can_post_messages"
},
{
"type": "Boolean",
"required": false,
"description": "Pass True if the administrator can edit messages of other users and can pin messages, channels only",
"html_description": "<td>Pass <em>True</em> if the administrator can edit messages of other users and can pin messages, channels only</td>",
"rst_description": "Pass :code:`True` if the administrator can edit messages of other users and can pin messages, channels only\n",
"name": "can_edit_messages"
},
{
"type": "Boolean",
"required": false,
@ -78,9 +62,9 @@
{
"type": "Boolean",
"required": false,
"description": "Pass True if the administrator can restrict, ban or unban chat members",
"html_description": "<td>Pass <em>True</em> if the administrator can restrict, ban or unban chat members</td>",
"rst_description": "Pass :code:`True` if the administrator can restrict, ban or unban chat members\n",
"description": "Pass True if the administrator can restrict, ban or unban chat members, or access supergroup statistics",
"html_description": "<td>Pass <em>True</em> if the administrator can restrict, ban or unban chat members, or access supergroup statistics</td>",
"rst_description": "Pass :code:`True` if the administrator can restrict, ban or unban chat members, or access supergroup statistics\n",
"name": "can_restrict_members"
},
{
@ -107,6 +91,22 @@
"rst_description": "Pass :code:`True` if the administrator can invite new users to the chat\n",
"name": "can_invite_users"
},
{
"type": "Boolean",
"required": false,
"description": "Pass True if the administrator can post messages in the channel, or access channel statistics; channels only",
"html_description": "<td>Pass <em>True</em> if the administrator can post messages in the channel, or access channel statistics; channels only</td>",
"rst_description": "Pass :code:`True` if the administrator can post messages in the channel, or access channel statistics; channels only\n",
"name": "can_post_messages"
},
{
"type": "Boolean",
"required": false,
"description": "Pass True if the administrator can edit messages of other users and can pin messages; channels only",
"html_description": "<td>Pass <em>True</em> if the administrator can edit messages of other users and can pin messages; channels only</td>",
"rst_description": "Pass :code:`True` if the administrator can edit messages of other users and can pin messages; channels only\n",
"name": "can_edit_messages"
},
{
"type": "Boolean",
"required": false,
@ -115,6 +115,30 @@
"rst_description": "Pass :code:`True` if the administrator can pin messages, supergroups only\n",
"name": "can_pin_messages"
},
{
"type": "Boolean",
"required": false,
"description": "Pass True if the administrator can post stories in the channel; channels only",
"html_description": "<td>Pass <em>True</em> if the administrator can post stories in the channel; channels only</td>",
"rst_description": "Pass :code:`True` if the administrator can post stories in the channel; channels only\n",
"name": "can_post_stories"
},
{
"type": "Boolean",
"required": false,
"description": "Pass True if the administrator can edit stories posted by other users; channels only",
"html_description": "<td>Pass <em>True</em> if the administrator can edit stories posted by other users; channels only</td>",
"rst_description": "Pass :code:`True` if the administrator can edit stories posted by other users; channels only\n",
"name": "can_edit_stories"
},
{
"type": "Boolean",
"required": false,
"description": "Pass True if the administrator can delete stories posted by other users; channels only",
"html_description": "<td>Pass <em>True</em> if the administrator can delete stories posted by other users; channels only</td>",
"rst_description": "Pass :code:`True` if the administrator can delete stories posted by other users; channels only\n",
"name": "can_delete_stories"
},
{
"type": "Boolean",
"required": false,

View file

@ -46,9 +46,9 @@
{
"type": "Integer",
"required": false,
"description": "Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever",
"html_description": "<td>Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever</td>",
"rst_description": "Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever\n",
"description": "Date when restrictions will be lifted for the user; Unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever",
"html_description": "<td>Date when restrictions will be lifted for the user; Unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever</td>",
"rst_description": "Date when restrictions will be lifted for the user; Unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever\n",
"name": "until_date"
}
],

View file

@ -46,9 +46,9 @@
{
"type": "Array of String",
"required": false,
"description": "A JSON-serialized list of the update types you want your bot to receive. For example, specify ['message', 'edited_channel_post', 'callback_query'] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member (default). If not specified, the previous setting will be used.\nPlease note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time.",
"html_description": "<td>A JSON-serialized list of the update types you want your bot to receive. For example, specify [&#8220;message&#8221;, &#8220;edited_channel_post&#8221;, &#8220;callback_query&#8221;] to only receive updates of these types. See <a href=\"#update\">Update</a> for a complete list of available update types. Specify an empty list to receive all update types except <em>chat_member</em> (default). If not specified, the previous setting will be used.<br/>\nPlease note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time.</td>",
"rst_description": "A JSON-serialized list of the update types you want your bot to receive. For example, specify ['message', 'edited_channel_post', 'callback_query'] to only receive updates of these types. See :class:`aiogram.types.update.Update` for a complete list of available update types. Specify an empty list to receive all update types except *chat_member* (default). If not specified, the previous setting will be used.\n\nPlease note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time.\n",
"description": "A JSON-serialized list of the update types you want your bot to receive. For example, specify [\"message\", \"edited_channel_post\", \"callback_query\"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member (default). If not specified, the previous setting will be used.\nPlease note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time.",
"html_description": "<td>A JSON-serialized list of the update types you want your bot to receive. For example, specify <code>[\"message\", \"edited_channel_post\", \"callback_query\"]</code> to only receive updates of these types. See <a href=\"#update\">Update</a> for a complete list of available update types. Specify an empty list to receive all update types except <em>chat_member</em> (default). If not specified, the previous setting will be used.<br/>\nPlease note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time.</td>",
"rst_description": "A JSON-serialized list of the update types you want your bot to receive. For example, specify :code:`[\"message\", \"edited_channel_post\", \"callback_query\"]` to only receive updates of these types. See :class:`aiogram.types.update.Update` for a complete list of available update types. Specify an empty list to receive all update types except *chat_member* (default). If not specified, the previous setting will be used.\n\nPlease note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time.\n",
"name": "allowed_updates"
},
{

View file

@ -0,0 +1,25 @@
{
"meta": {},
"group": {
"title": "Available methods",
"anchor": "available-methods"
},
"object": {
"anchor": "unpinallgeneralforumtopicmessages",
"name": "unpinAllGeneralForumTopicMessages",
"description": "Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.",
"html_description": "<p>Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the <em>can_pin_messages</em> administrator right in the supergroup. Returns <em>True</em> on success.</p>",
"rst_description": "Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the *can_pin_messages* administrator right in the supergroup. Returns :code:`True` on success.",
"annotations": [
{
"type": "Integer or String",
"required": true,
"description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"html_description": "<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"
}
],
"category": "methods"
}
}

View file

@ -1,7 +1,7 @@
{
"api": {
"version": "6.7",
"release_date": "2023-04-21"
"version": "6.9",
"release_date": "2023-09-22"
},
"items": [
{
@ -121,9 +121,9 @@
},
{
"type": "ChatMemberUpdated",
"description": "A chat member's status was updated in a chat. The bot must be an administrator in the chat and must explicitly specify 'chat_member' in the list of allowed_updates to receive these updates.",
"html_description": "<td><em>Optional</em>. A chat member's status was updated in a chat. The bot must be an administrator in the chat and must explicitly specify &#8220;chat_member&#8221; in the list of <em>allowed_updates</em> to receive these updates.</td>",
"rst_description": "*Optional*. A chat member's status was updated in a chat. The bot must be an administrator in the chat and must explicitly specify 'chat_member' in the list of *allowed_updates* to receive these updates.\n",
"description": "A chat member's status was updated in a chat. The bot must be an administrator in the chat and must explicitly specify \"chat_member\" in the list of allowed_updates to receive these updates.",
"html_description": "<td><em>Optional</em>. A chat member's status was updated in a chat. The bot must be an administrator in the chat and must explicitly specify <code>\"chat_member\"</code> in the list of <em>allowed_updates</em> to receive these updates.</td>",
"rst_description": "*Optional*. A chat member's status was updated in a chat. The bot must be an administrator in the chat and must explicitly specify :code:`\"chat_member\"` in the list of *allowed_updates* to receive these updates.\n",
"name": "chat_member",
"required": false
},
@ -172,9 +172,9 @@
{
"type": "Array of String",
"required": false,
"description": "A JSON-serialized list of the update types you want your bot to receive. For example, specify ['message', 'edited_channel_post', 'callback_query'] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member (default). If not specified, the previous setting will be used.\n\nPlease note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time.",
"html_description": "<td>A JSON-serialized list of the update types you want your bot to receive. For example, specify [&#8220;message&#8221;, &#8220;edited_channel_post&#8221;, &#8220;callback_query&#8221;] to only receive updates of these types. See <a href=\"#update\">Update</a> for a complete list of available update types. Specify an empty list to receive all update types except <em>chat_member</em> (default). If not specified, the previous setting will be used.<br/>\n<br/>\nPlease note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time.</td>",
"rst_description": "A JSON-serialized list of the update types you want your bot to receive. For example, specify ['message', 'edited_channel_post', 'callback_query'] to only receive updates of these types. See :class:`aiogram.types.update.Update` for a complete list of available update types. Specify an empty list to receive all update types except *chat_member* (default). If not specified, the previous setting will be used.\n\n\n\nPlease note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time.\n",
"description": "A JSON-serialized list of the update types you want your bot to receive. For example, specify [\"message\", \"edited_channel_post\", \"callback_query\"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member (default). If not specified, the previous setting will be used.\n\nPlease note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time.",
"html_description": "<td>A JSON-serialized list of the update types you want your bot to receive. For example, specify <code>[\"message\", \"edited_channel_post\", \"callback_query\"]</code> to only receive updates of these types. See <a href=\"#update\">Update</a> for a complete list of available update types. Specify an empty list to receive all update types except <em>chat_member</em> (default). If not specified, the previous setting will be used.<br/>\n<br/>\nPlease note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time.</td>",
"rst_description": "A JSON-serialized list of the update types you want your bot to receive. For example, specify :code:`[\"message\", \"edited_channel_post\", \"callback_query\"]` to only receive updates of these types. See :class:`aiogram.types.update.Update` for a complete list of available update types. Specify an empty list to receive all update types except *chat_member* (default). If not specified, the previous setting will be used.\n\n\n\nPlease note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time.\n",
"name": "allowed_updates"
}
],
@ -222,9 +222,9 @@
{
"type": "Array of String",
"required": false,
"description": "A JSON-serialized list of the update types you want your bot to receive. For example, specify ['message', 'edited_channel_post', 'callback_query'] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member (default). If not specified, the previous setting will be used.\nPlease note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time.",
"html_description": "<td>A JSON-serialized list of the update types you want your bot to receive. For example, specify [&#8220;message&#8221;, &#8220;edited_channel_post&#8221;, &#8220;callback_query&#8221;] to only receive updates of these types. See <a href=\"#update\">Update</a> for a complete list of available update types. Specify an empty list to receive all update types except <em>chat_member</em> (default). If not specified, the previous setting will be used.<br/>\nPlease note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time.</td>",
"rst_description": "A JSON-serialized list of the update types you want your bot to receive. For example, specify ['message', 'edited_channel_post', 'callback_query'] to only receive updates of these types. See :class:`aiogram.types.update.Update` for a complete list of available update types. Specify an empty list to receive all update types except *chat_member* (default). If not specified, the previous setting will be used.\n\nPlease note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time.\n",
"description": "A JSON-serialized list of the update types you want your bot to receive. For example, specify [\"message\", \"edited_channel_post\", \"callback_query\"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member (default). If not specified, the previous setting will be used.\nPlease note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time.",
"html_description": "<td>A JSON-serialized list of the update types you want your bot to receive. For example, specify <code>[\"message\", \"edited_channel_post\", \"callback_query\"]</code> to only receive updates of these types. See <a href=\"#update\">Update</a> for a complete list of available update types. Specify an empty list to receive all update types except <em>chat_member</em> (default). If not specified, the previous setting will be used.<br/>\nPlease note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time.</td>",
"rst_description": "A JSON-serialized list of the update types you want your bot to receive. For example, specify :code:`[\"message\", \"edited_channel_post\", \"callback_query\"]` to only receive updates of these types. See :class:`aiogram.types.update.Update` for a complete list of available update types. Specify an empty list to receive all update types except *chat_member* (default). If not specified, the previous setting will be used.\n\nPlease note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time.\n",
"name": "allowed_updates"
},
{
@ -547,6 +547,14 @@
"name": "emoji_status_custom_emoji_id",
"required": false
},
{
"type": "Integer",
"description": "Expiration date of the emoji status of the other party in a private chat in Unix time, if any. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. Expiration date of the emoji status of the other party in a private chat in Unix time, if any. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. Expiration date of the emoji status of the other party in a private chat in Unix time, if any. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "emoji_status_expiration_date",
"required": false
},
{
"type": "String",
"description": "Bio of the other party in a private chat. Returned only in getChat.",
@ -917,6 +925,14 @@
"name": "sticker",
"required": false
},
{
"type": "Story",
"description": "Message is a forwarded story",
"html_description": "<td><em>Optional</em>. Message is a forwarded story</td>",
"rst_description": "*Optional*. Message is a forwarded story\n",
"name": "story",
"required": false
},
{
"type": "Video",
"description": "Message is a video, information about the video",
@ -1151,9 +1167,9 @@
},
{
"type": "WriteAccessAllowed",
"description": "Service message: the user allowed the bot added to the attachment menu to write messages",
"html_description": "<td><em>Optional</em>. Service message: the user allowed the bot added to the attachment menu to write messages</td>",
"rst_description": "*Optional*. Service message: the user allowed the bot added to the attachment menu to write messages\n",
"description": "Service message: the user allowed the bot to write messages after adding it to the attachment or side menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method requestWriteAccess",
"html_description": "<td><em>Optional</em>. Service message: the user allowed the bot to write messages after adding it to the attachment or side menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method <a href=\"/bots/webapps#initializing-mini-apps\">requestWriteAccess</a></td>",
"rst_description": "*Optional*. Service message: the user allowed the bot to write messages after adding it to the attachment or side menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method `requestWriteAccess <https://core.telegram.org/bots/webapps#initializing-mini-apps>`_\n",
"name": "write_access_allowed",
"required": false
},
@ -1628,6 +1644,15 @@
],
"category": "types"
},
{
"anchor": "story",
"name": "Story",
"description": "This object represents a message about a forwarded story in the chat. Currently holds no information.",
"html_description": "<p>This object represents a message about a forwarded story in the chat. Currently holds no information.</p>",
"rst_description": "This object represents a message about a forwarded story in the chat. Currently holds no information.",
"annotations": [],
"category": "types"
},
{
"anchor": "video",
"name": "Video",
@ -1935,19 +1960,27 @@
"name": "poll_id",
"required": true
},
{
"type": "Chat",
"description": "The chat that changed the answer to the poll, if the voter is anonymous",
"html_description": "<td><em>Optional</em>. The chat that changed the answer to the poll, if the voter is anonymous</td>",
"rst_description": "*Optional*. The chat that changed the answer to the poll, if the voter is anonymous\n",
"name": "voter_chat",
"required": false
},
{
"type": "User",
"description": "The user, who changed the answer to the poll",
"html_description": "<td>The user, who changed the answer to the poll</td>",
"rst_description": "The user, who changed the answer to the poll\n",
"description": "The user that changed the answer to the poll, if the voter isn't anonymous",
"html_description": "<td><em>Optional</em>. The user that changed the answer to the poll, if the voter isn't anonymous</td>",
"rst_description": "*Optional*. The user that changed the answer to the poll, if the voter isn't anonymous\n",
"name": "user",
"required": true
"required": false
},
{
"type": "Array of Integer",
"description": "0-based identifiers of answer options, chosen by the user. May be empty if the user retracted their vote.",
"html_description": "<td>0-based identifiers of answer options, chosen by the user. May be empty if the user retracted their vote.</td>",
"rst_description": "0-based identifiers of answer options, chosen by the user. May be empty if the user retracted their vote.\n",
"description": "0-based identifiers of chosen answer options. May be empty if the vote was retracted.",
"html_description": "<td>0-based identifiers of chosen answer options. May be empty if the vote was retracted.</td>",
"rst_description": "0-based identifiers of chosen answer options. May be empty if the vote was retracted.\n",
"name": "option_ids",
"required": true
}
@ -2421,17 +2454,33 @@
{
"anchor": "writeaccessallowed",
"name": "WriteAccessAllowed",
"description": "This object represents a service message about a user allowing a bot to write messages after adding the bot to the attachment menu or launching a Web App from a link.",
"html_description": "<p>This object represents a service message about a user allowing a bot to write messages after adding the bot to the attachment menu or launching a Web App from a link.</p>",
"rst_description": "This object represents a service message about a user allowing a bot to write messages after adding the bot to the attachment menu or launching a Web App from a link.",
"description": "This object represents a service message about a user allowing a bot to write messages after adding it to the attachment menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method requestWriteAccess.",
"html_description": "<p>This object represents a service message about a user allowing a bot to write messages after adding it to the attachment menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method <a href=\"/bots/webapps#initializing-mini-apps\">requestWriteAccess</a>.</p>",
"rst_description": "This object represents a service message about a user allowing a bot to write messages after adding it to the attachment menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method `requestWriteAccess <https://core.telegram.org/bots/webapps#initializing-mini-apps>`_.",
"annotations": [
{
"type": "Boolean",
"description": "True, if the access was granted after the user accepted an explicit request from a Web App sent by the method requestWriteAccess",
"html_description": "<td><em>Optional</em>. True, if the access was granted after the user accepted an explicit request from a Web App sent by the method <a href=\"/bots/webapps#initializing-mini-apps\">requestWriteAccess</a></td>",
"rst_description": "*Optional*. True, if the access was granted after the user accepted an explicit request from a Web App sent by the method `requestWriteAccess <https://core.telegram.org/bots/webapps#initializing-mini-apps>`_\n",
"name": "from_request",
"required": false
},
{
"type": "String",
"description": "Name of the Web App which was launched from a link",
"html_description": "<td><em>Optional</em>. Name of the Web App which was launched from a link</td>",
"rst_description": "*Optional*. Name of the Web App which was launched from a link\n",
"description": "Name of the Web App, if the access was granted when the Web App was launched from a link",
"html_description": "<td><em>Optional</em>. Name of the Web App, if the access was granted when the Web App was launched from a link</td>",
"rst_description": "*Optional*. Name of the Web App, if the access was granted when the Web App was launched from a link\n",
"name": "web_app_name",
"required": false
},
{
"type": "Boolean",
"description": "True, if the access was granted when the bot was added to the attachment or side menu",
"html_description": "<td><em>Optional</em>. True, if the access was granted when the bot was added to the attachment or side menu</td>",
"rst_description": "*Optional*. True, if the access was granted when the bot was added to the attachment or side menu\n",
"name": "from_attachment_menu",
"required": false
}
],
"category": "types"
@ -2577,8 +2626,8 @@
{
"type": "String",
"description": "An HTTPS URL of a Web App to be opened with additional data as specified in Initializing Web Apps",
"html_description": "<td>An HTTPS URL of a Web App to be opened with additional data as specified in <a href=\"/bots/webapps#initializing-web-apps\">Initializing Web Apps</a></td>",
"rst_description": "An HTTPS URL of a Web App to be opened with additional data as specified in `Initializing Web Apps <https://core.telegram.org/bots/webapps#initializing-web-apps>`_\n",
"html_description": "<td>An HTTPS URL of a Web App to be opened with additional data as specified in <a href=\"/bots/webapps#initializing-mini-apps\">Initializing Web Apps</a></td>",
"rst_description": "An HTTPS URL of a Web App to be opened with additional data as specified in `Initializing Web Apps <https://core.telegram.org/bots/webapps#initializing-mini-apps>`_\n",
"name": "url",
"required": true
}
@ -2928,9 +2977,9 @@
},
{
"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",
"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.",
"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.</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",
"name": "switch_inline_query",
"required": false
},
@ -3302,9 +3351,9 @@
},
{
"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",
"description": "True, if the administrator can access the chat event log, boost list in channels, see channel members, report spam messages, 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, boost list in channels, see channel members, report spam messages, 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, boost list in channels, see channel members, report spam messages, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege\n",
"name": "can_manage_chat",
"required": true
},
@ -3326,9 +3375,9 @@
},
{
"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",
"description": "True, if the administrator can restrict, ban or unban chat members, or access supergroup statistics",
"html_description": "<td><em>True</em>, if the administrator can restrict, ban or unban chat members, or access supergroup statistics</td>",
"rst_description": ":code:`True`, if the administrator can restrict, ban or unban chat members, or access supergroup statistics\n",
"name": "can_restrict_members",
"required": true
},
@ -3358,9 +3407,9 @@
},
{
"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",
"description": "True, if the administrator can post messages in the channel, or access channel statistics; channels only",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the administrator can post messages in the channel, or access channel statistics; channels only</td>",
"rst_description": "*Optional*. :code:`True`, if the administrator can post messages in the channel, or access channel statistics; channels only\n",
"name": "can_post_messages",
"required": false
},
@ -3380,6 +3429,30 @@
"name": "can_pin_messages",
"required": false
},
{
"type": "Boolean",
"description": "True, if the administrator can post stories in the channel; channels only",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the administrator can post stories in the channel; channels only</td>",
"rst_description": "*Optional*. :code:`True`, if the administrator can post stories in the channel; channels only\n",
"name": "can_post_stories",
"required": false
},
{
"type": "Boolean",
"description": "True, if the administrator can edit stories posted by other users; channels only",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the administrator can edit stories posted by other users; channels only</td>",
"rst_description": "*Optional*. :code:`True`, if the administrator can edit stories posted by other users; channels only\n",
"name": "can_edit_stories",
"required": false
},
{
"type": "Boolean",
"description": "True, if the administrator can delete stories posted by other users; channels only",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the administrator can delete stories posted by other users; channels only</td>",
"rst_description": "*Optional*. :code:`True`, if the administrator can delete stories posted by other users; channels only\n",
"name": "can_delete_stories",
"required": false
},
{
"type": "Boolean",
"description": "True, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only",
@ -3483,9 +3556,9 @@
},
{
"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",
"description": "True, if the administrator can access the chat event log, boost list in channels, see channel members, report spam messages, 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, boost list in channels, see channel members, report spam messages, 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, boost list in channels, see channel members, report spam messages, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege\n",
"name": "can_manage_chat",
"required": true
},
@ -3507,9 +3580,9 @@
},
{
"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",
"description": "True, if the administrator can restrict, ban or unban chat members, or access supergroup statistics",
"html_description": "<td><em>True</em>, if the administrator can restrict, ban or unban chat members, or access supergroup statistics</td>",
"rst_description": ":code:`True`, if the administrator can restrict, ban or unban chat members, or access supergroup statistics\n",
"name": "can_restrict_members",
"required": true
},
@ -3539,9 +3612,9 @@
},
{
"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",
"description": "True, if the administrator can post messages in the channel, or access channel statistics; channels only",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the administrator can post messages in the channel, or access channel statistics; channels only</td>",
"rst_description": "*Optional*. :code:`True`, if the administrator can post messages in the channel, or access channel statistics; channels only\n",
"name": "can_post_messages",
"required": false
},
@ -3561,6 +3634,30 @@
"name": "can_pin_messages",
"required": false
},
{
"type": "Boolean",
"description": "True, if the administrator can post stories in the channel; channels only",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the administrator can post stories in the channel; channels only</td>",
"rst_description": "*Optional*. :code:`True`, if the administrator can post stories in the channel; channels only\n",
"name": "can_post_stories",
"required": false
},
{
"type": "Boolean",
"description": "True, if the administrator can edit stories posted by other users; channels only",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the administrator can edit stories posted by other users; channels only</td>",
"rst_description": "*Optional*. :code:`True`, if the administrator can edit stories posted by other users; channels only\n",
"name": "can_edit_stories",
"required": false
},
{
"type": "Boolean",
"description": "True, if the administrator can delete stories posted by other users; channels only",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the administrator can delete stories posted by other users; channels only</td>",
"rst_description": "*Optional*. :code:`True`, if the administrator can delete stories posted by other users; channels only\n",
"name": "can_delete_stories",
"required": false
},
{
"type": "Boolean",
"description": "True, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only",
@ -3751,9 +3848,9 @@
},
{
"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",
"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
}
@ -3811,9 +3908,9 @@
},
{
"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",
"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
}
@ -3911,9 +4008,9 @@
},
{
"type": "Integer",
"description": "Identifier of a private chat with the user who sent the join request. 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. The bot can use this identifier for 24 hours to send messages until the join request is processed, assuming no other administrator contacted the user.",
"html_description": "<td>Identifier of a private chat with the user who sent the join request. 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. The bot can use this identifier for 24 hours to send messages until the join request is processed, assuming no other administrator contacted the user.</td>",
"rst_description": "Identifier of a private chat with the user who sent the join request. 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. The bot can use this identifier for 24 hours to send messages until the join request is processed, assuming no other administrator contacted the user.\n",
"description": "Identifier of a private chat with the user who sent the join request. 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. The bot can use this identifier for 5 minutes to send messages until the join request is processed, assuming no other administrator contacted the user.",
"html_description": "<td>Identifier of a private chat with the user who sent the join request. 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. The bot can use this identifier for 5 minutes to send messages until the join request is processed, assuming no other administrator contacted the user.</td>",
"rst_description": "Identifier of a private chat with the user who sent the join request. 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. The bot can use this identifier for 5 minutes to send messages until the join request is processed, assuming no other administrator contacted the user.\n",
"name": "user_chat_id",
"required": true
},
@ -6788,9 +6885,9 @@
{
"type": "Integer",
"required": false,
"description": "Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.",
"html_description": "<td>Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.</td>",
"rst_description": "Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.\n",
"description": "Date when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.",
"html_description": "<td>Date when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.</td>",
"rst_description": "Date when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.\n",
"name": "until_date"
},
{
@ -6880,9 +6977,9 @@
{
"type": "Integer",
"required": false,
"description": "Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever",
"html_description": "<td>Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever</td>",
"rst_description": "Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever\n",
"description": "Date when restrictions will be lifted for the user; Unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever",
"html_description": "<td>Date when restrictions will be lifted for the user; Unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever</td>",
"rst_description": "Date when restrictions will be lifted for the user; Unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever\n",
"name": "until_date"
}
],
@ -6922,27 +7019,11 @@
{
"type": "Boolean",
"required": false,
"description": "Pass 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>Pass <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": "Pass :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",
"description": "Pass True if the administrator can access the chat event log, boost list in channels, see channel members, report spam messages, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege",
"html_description": "<td>Pass <em>True</em> if the administrator can access the chat event log, boost list in channels, see channel members, report spam messages, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege</td>",
"rst_description": "Pass :code:`True` if the administrator can access the chat event log, boost list in channels, see channel members, report spam messages, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege\n",
"name": "can_manage_chat"
},
{
"type": "Boolean",
"required": false,
"description": "Pass True if the administrator can create channel posts, channels only",
"html_description": "<td>Pass <em>True</em> if the administrator can create channel posts, channels only</td>",
"rst_description": "Pass :code:`True` if the administrator can create channel posts, channels only\n",
"name": "can_post_messages"
},
{
"type": "Boolean",
"required": false,
"description": "Pass True if the administrator can edit messages of other users and can pin messages, channels only",
"html_description": "<td>Pass <em>True</em> if the administrator can edit messages of other users and can pin messages, channels only</td>",
"rst_description": "Pass :code:`True` if the administrator can edit messages of other users and can pin messages, channels only\n",
"name": "can_edit_messages"
},
{
"type": "Boolean",
"required": false,
@ -6962,9 +7043,9 @@
{
"type": "Boolean",
"required": false,
"description": "Pass True if the administrator can restrict, ban or unban chat members",
"html_description": "<td>Pass <em>True</em> if the administrator can restrict, ban or unban chat members</td>",
"rst_description": "Pass :code:`True` if the administrator can restrict, ban or unban chat members\n",
"description": "Pass True if the administrator can restrict, ban or unban chat members, or access supergroup statistics",
"html_description": "<td>Pass <em>True</em> if the administrator can restrict, ban or unban chat members, or access supergroup statistics</td>",
"rst_description": "Pass :code:`True` if the administrator can restrict, ban or unban chat members, or access supergroup statistics\n",
"name": "can_restrict_members"
},
{
@ -6991,6 +7072,22 @@
"rst_description": "Pass :code:`True` if the administrator can invite new users to the chat\n",
"name": "can_invite_users"
},
{
"type": "Boolean",
"required": false,
"description": "Pass True if the administrator can post messages in the channel, or access channel statistics; channels only",
"html_description": "<td>Pass <em>True</em> if the administrator can post messages in the channel, or access channel statistics; channels only</td>",
"rst_description": "Pass :code:`True` if the administrator can post messages in the channel, or access channel statistics; channels only\n",
"name": "can_post_messages"
},
{
"type": "Boolean",
"required": false,
"description": "Pass True if the administrator can edit messages of other users and can pin messages; channels only",
"html_description": "<td>Pass <em>True</em> if the administrator can edit messages of other users and can pin messages; channels only</td>",
"rst_description": "Pass :code:`True` if the administrator can edit messages of other users and can pin messages; channels only\n",
"name": "can_edit_messages"
},
{
"type": "Boolean",
"required": false,
@ -6999,6 +7096,30 @@
"rst_description": "Pass :code:`True` if the administrator can pin messages, supergroups only\n",
"name": "can_pin_messages"
},
{
"type": "Boolean",
"required": false,
"description": "Pass True if the administrator can post stories in the channel; channels only",
"html_description": "<td>Pass <em>True</em> if the administrator can post stories in the channel; channels only</td>",
"rst_description": "Pass :code:`True` if the administrator can post stories in the channel; channels only\n",
"name": "can_post_stories"
},
{
"type": "Boolean",
"required": false,
"description": "Pass True if the administrator can edit stories posted by other users; channels only",
"html_description": "<td>Pass <em>True</em> if the administrator can edit stories posted by other users; channels only</td>",
"rst_description": "Pass :code:`True` if the administrator can edit stories posted by other users; channels only\n",
"name": "can_edit_stories"
},
{
"type": "Boolean",
"required": false,
"description": "Pass True if the administrator can delete stories posted by other users; channels only",
"html_description": "<td>Pass <em>True</em> if the administrator can delete stories posted by other users; channels only</td>",
"rst_description": "Pass :code:`True` if the administrator can delete stories posted by other users; channels only\n",
"name": "can_delete_stories"
},
{
"type": "Boolean",
"required": false,
@ -7945,6 +8066,24 @@
],
"category": "methods"
},
{
"anchor": "unpinallgeneralforumtopicmessages",
"name": "unpinAllGeneralForumTopicMessages",
"description": "Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.",
"html_description": "<p>Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the <em>can_pin_messages</em> administrator right in the supergroup. Returns <em>True</em> on success.</p>",
"rst_description": "Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the *can_pin_messages* administrator right in the supergroup. Returns :code:`True` on success.",
"annotations": [
{
"type": "Integer or String",
"required": true,
"description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"html_description": "<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"
}
],
"category": "methods"
},
{
"anchor": "answercallbackquery",
"name": "answerCallbackQuery",
@ -9629,9 +9768,9 @@
},
{
"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 switch back to the inline mode using the method web_app_switch_inline_query inside the Web App.",
"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 switch back to the inline mode using the method <em>web_app_switch_inline_query</em> inside the Web App.</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 switch back to the inline mode using the method *web_app_switch_inline_query* inside the Web App.\n",
"description": "Description of the Web App that will be launched when the user presses the button. The Web App will be able to switch back to the inline mode using the method switchInlineQuery inside the Web App.",
"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 switch back to the inline mode using the method <a href=\"/bots/webapps#initializing-mini-apps\">switchInlineQuery</a> inside the Web App.</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 switch back to the inline mode using the method `switchInlineQuery <https://core.telegram.org/bots/webapps#initializing-mini-apps>`_ inside the Web App.\n",
"name": "web_app",
"required": false
},

View file

@ -1,3 +1,5 @@
.. _enums:
#####
Enums
#####

View file

@ -8,6 +8,7 @@ Returns: :obj:`{{ object.returning.parsed_type|type }}`
:members:
:member-order: bysource
:undoc-members: True
:exclude-members: model_config,model_fields
Usage

View file

@ -7,3 +7,4 @@
:members:
:member-order: bysource
:undoc-members: True
:exclude-members: model_config,model_fields

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -106,3 +106,7 @@ delete_photo:
set_photo:
method: setChatPhoto
fill: *self
unpin_all_general_forum_topic_messages:
method: unpinAllGeneralForumTopicMessages
fill: *self

View file

@ -91,6 +91,14 @@
"name": "emoji_status_custom_emoji_id",
"required": false
},
{
"type": "Integer",
"description": "Expiration date of the emoji status of the other party in a private chat in Unix time, if any. Returned only in getChat.",
"html_description": "<td><em>Optional</em>. Expiration date of the emoji status of the other party in a private chat in Unix time, if any. Returned only in <a href=\"#getchat\">getChat</a>.</td>",
"rst_description": "*Optional*. Expiration date of the emoji status of the other party in a private chat in Unix time, if any. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
"name": "emoji_status_expiration_date",
"required": false
},
{
"type": "String",
"description": "Bio of the other party in a private chat. Returned only in getChat.",

View file

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

View file

@ -21,9 +21,9 @@
},
{
"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",
"description": "True, if the administrator can access the chat event log, boost list in channels, see channel members, report spam messages, 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, boost list in channels, see channel members, report spam messages, 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, boost list in channels, see channel members, report spam messages, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege\n",
"name": "can_manage_chat",
"required": true
},
@ -45,9 +45,9 @@
},
{
"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",
"description": "True, if the administrator can restrict, ban or unban chat members, or access supergroup statistics",
"html_description": "<td><em>True</em>, if the administrator can restrict, ban or unban chat members, or access supergroup statistics</td>",
"rst_description": ":code:`True`, if the administrator can restrict, ban or unban chat members, or access supergroup statistics\n",
"name": "can_restrict_members",
"required": true
},
@ -77,9 +77,9 @@
},
{
"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",
"description": "True, if the administrator can post messages in the channel, or access channel statistics; channels only",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the administrator can post messages in the channel, or access channel statistics; channels only</td>",
"rst_description": "*Optional*. :code:`True`, if the administrator can post messages in the channel, or access channel statistics; channels only\n",
"name": "can_post_messages",
"required": false
},
@ -99,6 +99,30 @@
"name": "can_pin_messages",
"required": false
},
{
"type": "Boolean",
"description": "True, if the administrator can post stories in the channel; channels only",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the administrator can post stories in the channel; channels only</td>",
"rst_description": "*Optional*. :code:`True`, if the administrator can post stories in the channel; channels only\n",
"name": "can_post_stories",
"required": false
},
{
"type": "Boolean",
"description": "True, if the administrator can edit stories posted by other users; channels only",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the administrator can edit stories posted by other users; channels only</td>",
"rst_description": "*Optional*. :code:`True`, if the administrator can edit stories posted by other users; channels only\n",
"name": "can_edit_stories",
"required": false
},
{
"type": "Boolean",
"description": "True, if the administrator can delete stories posted by other users; channels only",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the administrator can delete stories posted by other users; channels only</td>",
"rst_description": "*Optional*. :code:`True`, if the administrator can delete stories posted by other users; channels only\n",
"name": "can_delete_stories",
"required": false
},
{
"type": "Boolean",
"description": "True, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only",

View file

@ -2,4 +2,4 @@ annotations:
expire_date:
parsed_type:
type: std
name: datetime.datetime
name: DateTime

View file

@ -3,6 +3,145 @@ approve:
fill: &request-target
chat_id: self.chat.id
user_id: self.from_user.id
decline:
method: declineChatJoinRequest
fill: *request-target
answer:
method: sendMessage
fill: &fill-answer-chat
chat_id: self.chat.id
answer_pm:
method: sendMessage
fill: &fill-answer-user
chat_id: self.user_chat_id
answer_animation:
method: sendAnimation
fill: *fill-answer-chat
answer_animation_pm:
method: sendAnimation
fill: *fill-answer-user
answer_audio:
method: sendAudio
fill: *fill-answer-chat
answer_audio_pm:
method: sendAudio
fill: *fill-answer-user
answer_contact:
method: sendContact
fill: *fill-answer-chat
answer_contact_pm:
method: sendContact
fill: *fill-answer-user
answer_document:
method: sendDocument
fill: *fill-answer-chat
answer_document_pm:
method: sendDocument
fill: *fill-answer-user
answer_game:
method: sendGame
fill: *fill-answer-chat
answer_game_pm:
method: sendGame
fill: *fill-answer-user
answer_invoice:
method: sendInvoice
fill: *fill-answer-chat
answer_invoice_pm:
method: sendInvoice
fill: *fill-answer-user
answer_location:
method: sendLocation
fill: *fill-answer-chat
answer_location_pm:
method: sendLocation
fill: *fill-answer-user
answer_media_group:
method: sendMediaGroup
fill: *fill-answer-chat
answer_media_group_pm:
method: sendMediaGroup
fill: *fill-answer-user
answer_photo:
method: sendPhoto
fill: *fill-answer-chat
answer_photo_pm:
method: sendPhoto
fill: *fill-answer-user
answer_poll:
method: sendPoll
fill: *fill-answer-chat
answer_poll_pm:
method: sendPoll
fill: *fill-answer-user
answer_dice:
method: sendDice
fill: *fill-answer-chat
answer_dice_pm:
method: sendDice
fill: *fill-answer-user
answer_sticker:
method: sendSticker
fill: *fill-answer-chat
answer_sticker_pm:
method: sendSticker
fill: *fill-answer-user
answer_venue:
method: sendVenue
fill: *fill-answer-chat
answer_venue_pm:
method: sendVenue
fill: *fill-answer-user
answer_video:
method: sendVideo
fill: *fill-answer-chat
answer_video_pm:
method: sendVideo
fill: *fill-answer-user
answer_video_note:
method: sendVideoNote
fill: *fill-answer-chat
answer_video_note_pm:
method: sendVideoNote
fill: *fill-answer-user
answer_voice:
method: sendVoice
fill: *fill-answer-chat
answer_voice_pm:
method: sendVoice
fill: *fill-answer-user

View file

@ -29,9 +29,9 @@
},
{
"type": "Integer",
"description": "Identifier of a private chat with the user who sent the join request. 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. The bot can use this identifier for 24 hours to send messages until the join request is processed, assuming no other administrator contacted the user.",
"html_description": "<td>Identifier of a private chat with the user who sent the join request. 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. The bot can use this identifier for 24 hours to send messages until the join request is processed, assuming no other administrator contacted the user.</td>",
"rst_description": "Identifier of a private chat with the user who sent the join request. 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. The bot can use this identifier for 24 hours to send messages until the join request is processed, assuming no other administrator contacted the user.\n",
"description": "Identifier of a private chat with the user who sent the join request. 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. The bot can use this identifier for 5 minutes to send messages until the join request is processed, assuming no other administrator contacted the user.",
"html_description": "<td>Identifier of a private chat with the user who sent the join request. 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. The bot can use this identifier for 5 minutes to send messages until the join request is processed, assuming no other administrator contacted the user.</td>",
"rst_description": "Identifier of a private chat with the user who sent the join request. 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. The bot can use this identifier for 5 minutes to send messages until the join request is processed, assuming no other administrator contacted the user.\n",
"name": "user_chat_id",
"required": true
},

View file

@ -2,4 +2,4 @@ annotations:
date:
parsed_type:
type: std
name: datetime.datetime
name: DateTime

View file

@ -1,27 +0,0 @@
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

@ -2,4 +2,4 @@ annotations:
until_date:
parsed_type:
type: std
name: datetime.datetime
name: DateTime

View file

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

View file

@ -45,9 +45,9 @@
},
{
"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",
"description": "True, if the administrator can access the chat event log, boost list in channels, see channel members, report spam messages, 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, boost list in channels, see channel members, report spam messages, 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, boost list in channels, see channel members, report spam messages, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege\n",
"name": "can_manage_chat",
"required": true
},
@ -69,9 +69,9 @@
},
{
"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",
"description": "True, if the administrator can restrict, ban or unban chat members, or access supergroup statistics",
"html_description": "<td><em>True</em>, if the administrator can restrict, ban or unban chat members, or access supergroup statistics</td>",
"rst_description": ":code:`True`, if the administrator can restrict, ban or unban chat members, or access supergroup statistics\n",
"name": "can_restrict_members",
"required": true
},
@ -101,9 +101,9 @@
},
{
"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",
"description": "True, if the administrator can post messages in the channel, or access channel statistics; channels only",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the administrator can post messages in the channel, or access channel statistics; channels only</td>",
"rst_description": "*Optional*. :code:`True`, if the administrator can post messages in the channel, or access channel statistics; channels only\n",
"name": "can_post_messages",
"required": false
},
@ -123,6 +123,30 @@
"name": "can_pin_messages",
"required": false
},
{
"type": "Boolean",
"description": "True, if the administrator can post stories in the channel; channels only",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the administrator can post stories in the channel; channels only</td>",
"rst_description": "*Optional*. :code:`True`, if the administrator can post stories in the channel; channels only\n",
"name": "can_post_stories",
"required": false
},
{
"type": "Boolean",
"description": "True, if the administrator can edit stories posted by other users; channels only",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the administrator can edit stories posted by other users; channels only</td>",
"rst_description": "*Optional*. :code:`True`, if the administrator can edit stories posted by other users; channels only\n",
"name": "can_edit_stories",
"required": false
},
{
"type": "Boolean",
"description": "True, if the administrator can delete stories posted by other users; channels only",
"html_description": "<td><em>Optional</em>. <em>True</em>, if the administrator can delete stories posted by other users; channels only</td>",
"rst_description": "*Optional*. :code:`True`, if the administrator can delete stories posted by other users; channels only\n",
"name": "can_delete_stories",
"required": false
},
{
"type": "Boolean",
"description": "True, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only",

View file

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

View file

@ -29,9 +29,9 @@
},
{
"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",
"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
}

View file

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

View file

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

View file

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

View file

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

View file

@ -149,9 +149,9 @@
},
{
"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",
"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
}

View file

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

View file

@ -0,0 +1,68 @@
answer:
method: sendMessage
fill: &fill-answer
chat_id: self.chat.id
answer_animation:
method: sendAnimation
fill: *fill-answer
answer_audio:
method: sendAudio
fill: *fill-answer
answer_contact:
method: sendContact
fill: *fill-answer
answer_document:
method: sendDocument
fill: *fill-answer
answer_game:
method: sendGame
fill: *fill-answer
answer_invoice:
method: sendInvoice
fill: *fill-answer
answer_location:
method: sendLocation
fill: *fill-answer
answer_media_group:
method: sendMediaGroup
fill: *fill-answer
answer_photo:
method: sendPhoto
fill: *fill-answer
answer_poll:
method: sendPoll
fill: *fill-answer
answer_dice:
method: sendDice
fill: *fill-answer
answer_sticker:
method: sendSticker
fill: *fill-answer
answer_venue:
method: sendVenue
fill: *fill-answer
answer_video:
method: sendVideo
fill: *fill-answer
answer_video_note:
method: sendVideoNote
fill: *fill-answer
answer_voice:
method: sendVoice
fill: *fill-answer

View file

@ -2,33 +2,4 @@ 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
name: DateTime

View file

@ -53,9 +53,9 @@
},
{
"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",
"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.",
"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.</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",
"name": "switch_inline_query",
"required": false
},

View file

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

View file

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

View file

@ -1,6 +1,3 @@
bases:
- InlineQueryResult
annotations:
parse_mode:
value: UNSET_PARSE_MODE

View file

@ -1,6 +1,3 @@
bases:
- InlineQueryResult
annotations:
parse_mode:
value: UNSET_PARSE_MODE

View file

@ -1,6 +1,3 @@
bases:
- InlineQueryResult
annotations:
parse_mode:
value: UNSET_PARSE_MODE

View file

@ -1,6 +1,3 @@
bases:
- InlineQueryResult
annotations:
parse_mode:
value: UNSET_PARSE_MODE

View file

@ -1,6 +1,3 @@
bases:
- InlineQueryResult
annotations:
parse_mode:
value: UNSET_PARSE_MODE

View file

@ -1,6 +1,3 @@
bases:
- InlineQueryResult
annotations:
parse_mode:
value: UNSET_PARSE_MODE

View file

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

View file

@ -1,6 +1,3 @@
bases:
- InlineQueryResult
annotations:
parse_mode:
value: UNSET_PARSE_MODE

View file

@ -1,6 +1,3 @@
bases:
- InlineQueryResult
annotations:
parse_mode:
value: UNSET_PARSE_MODE

View file

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

View file

@ -1,6 +1,3 @@
bases:
- InlineQueryResult
annotations:
parse_mode:
value: UNSET_PARSE_MODE

View file

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

View file

@ -1,6 +1,3 @@
bases:
- InlineQueryResult
annotations:
parse_mode:
value: UNSET_PARSE_MODE

View file

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

View file

@ -1,6 +1,3 @@
bases:
- InlineQueryResult
annotations:
parse_mode:
value: UNSET_PARSE_MODE

View file

@ -1,6 +1,3 @@
bases:
- InlineQueryResult
annotations:
parse_mode:
value: UNSET_PARSE_MODE

View file

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

View file

@ -1,6 +1,3 @@
bases:
- InlineQueryResult
annotations:
parse_mode:
value: UNSET_PARSE_MODE

View file

@ -1,5 +1,3 @@
bases:
- InlineQueryResult
annotations:
parse_mode:
value: UNSET_PARSE_MODE

View file

@ -21,9 +21,9 @@
},
{
"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 switch back to the inline mode using the method web_app_switch_inline_query inside the Web App.",
"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 switch back to the inline mode using the method <em>web_app_switch_inline_query</em> inside the Web App.</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 switch back to the inline mode using the method *web_app_switch_inline_query* inside the Web App.\n",
"description": "Description of the Web App that will be launched when the user presses the button. The Web App will be able to switch back to the inline mode using the method switchInlineQuery inside the Web App.",
"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 switch back to the inline mode using the method <a href=\"/bots/webapps#initializing-mini-apps\">switchInlineQuery</a> inside the Web App.</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 switch back to the inline mode using the method `switchInlineQuery <https://core.telegram.org/bots/webapps#initializing-mini-apps>`_ inside the Web App.\n",
"name": "web_app",
"required": false
},

View file

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

View file

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

View file

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

View file

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

View file

@ -1,5 +1,3 @@
bases:
- InputMedia
annotations:
media:
parsed_type:

View file

@ -1,5 +1,3 @@
bases:
- InputMedia
annotations:
media:
parsed_type:

View file

@ -1,5 +1,3 @@
bases:
- InputMedia
annotations:
media:
parsed_type:

View file

@ -1,5 +1,3 @@
bases:
- InputMedia
annotations:
media:
parsed_type:

View file

@ -1,5 +1,3 @@
bases:
- InputMedia
annotations:
media:
parsed_type:

View file

@ -0,0 +1 @@
{ }

View file

@ -1,6 +1,3 @@
bases:
- InputMessageContent
annotations:
parse_mode:
value: UNSET_PARSE_MODE

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -1,189 +1,242 @@
answer:
method: sendMessage
code: &assert-chat |
assert self.chat is not None, "This method can be used only if chat is present in the message."
fill: &fill-answer
chat_id: self.chat.id
message_thread_id: self.message_thread_id if self.is_topic_message else None
reply:
method: sendMessage
code: *assert-chat
fill: &fill-reply
<<: *fill-answer
reply_to_message_id: self.message_id
answer_animation:
method: sendAnimation
code: *assert-chat
fill: *fill-answer
reply_animation:
method: sendAnimation
code: *assert-chat
fill: *fill-reply
answer_audio:
method: sendAudio
code: *assert-chat
fill: *fill-answer
reply_audio:
method: sendAudio
code: *assert-chat
fill: *fill-reply
answer_contact:
method: sendContact
code: *assert-chat
fill: *fill-answer
reply_contact:
method: sendContact
code: *assert-chat
fill: *fill-reply
answer_document:
method: sendDocument
code: *assert-chat
fill: *fill-answer
reply_document:
method: sendDocument
code: *assert-chat
fill: *fill-reply
answer_game:
method: sendGame
code: *assert-chat
fill: *fill-answer
reply_game:
method: sendGame
code: *assert-chat
fill: *fill-reply
answer_invoice:
method: sendInvoice
code: *assert-chat
fill: *fill-answer
reply_invoice:
method: sendInvoice
code: *assert-chat
fill: *fill-reply
answer_location:
method: sendLocation
code: *assert-chat
fill: *fill-answer
reply_location:
method: sendLocation
code: *assert-chat
fill: *fill-reply
answer_media_group:
method: sendMediaGroup
code: *assert-chat
fill: *fill-answer
reply_media_group:
method: sendMediaGroup
code: *assert-chat
fill: *fill-reply
answer_photo:
method: sendPhoto
code: *assert-chat
fill: *fill-answer
reply_photo:
method: sendPhoto
code: *assert-chat
fill: *fill-reply
answer_poll:
method: sendPoll
code: *assert-chat
fill: *fill-answer
reply_poll:
method: sendPoll
code: *assert-chat
fill: *fill-reply
answer_dice:
method: sendDice
code: *assert-chat
fill: *fill-answer
reply_dice:
method: sendDice
code: *assert-chat
fill: *fill-reply
answer_sticker:
method: sendSticker
code: *assert-chat
fill: *fill-answer
reply_sticker:
method: sendSticker
code: *assert-chat
fill: *fill-reply
answer_venue:
method: sendVenue
code: *assert-chat
fill: *fill-answer
reply_venue:
method: sendVenue
code: *assert-chat
fill: *fill-reply
answer_video:
method: sendVideo
code: *assert-chat
fill: *fill-answer
reply_video:
method: sendVideo
code: *assert-chat
fill: *fill-reply
answer_video_note:
method: sendVideoNote
code: *assert-chat
fill: *fill-answer
reply_video_note:
method: sendVideoNote
code: *assert-chat
fill: *fill-reply
answer_voice:
method: sendVoice
code: *assert-chat
fill: *fill-answer
reply_voice:
method: sendVoice
code: *assert-chat
fill: *fill-reply
copy_to:
method: copyMessage
code: *assert-chat
fill:
from_chat_id: self.chat.id
message_id: self.message_id
forward:
method: forwardMessage
code: *assert-chat
fill:
from_chat_id: self.chat.id
message_id: self.message_id
edit_text:
method: editMessageText
code: *assert-chat
fill: &message-target
chat_id: self.chat.id
message_id: self.message_id
forward:
method: forwardMessage
fill:
from_chat_id: self.chat.id
message_id: self.message_id
edit_media:
method: editMessageMedia
fill: *message-target
code: *assert-chat
edit_reply_markup:
method: editMessageReplyMarkup
code: *assert-chat
fill: *message-target
delete_reply_markup:
method: editMessageReplyMarkup
code: *assert-chat
fill:
<<: *message-target
reply_markup: None
edit_live_location:
method: editMessageLiveLocation
code: *assert-chat
fill: *message-target
stop_live_location:
method: stopMessageLiveLocation
code: *assert-chat
fill: *message-target
edit_caption:
method: editMessageCaption
code: *assert-chat
fill: *message-target
delete:
method: deleteMessage
code: *assert-chat
fill: *message-target
pin:
method: pinChatMessage
code: *assert-chat
fill: *message-target
unpin:
method: unpinChatMessage
code: *assert-chat
fill: *message-target

View file

@ -227,6 +227,14 @@
"name": "sticker",
"required": false
},
{
"type": "Story",
"description": "Message is a forwarded story",
"html_description": "<td><em>Optional</em>. Message is a forwarded story</td>",
"rst_description": "*Optional*. Message is a forwarded story\n",
"name": "story",
"required": false
},
{
"type": "Video",
"description": "Message is a video, information about the video",
@ -461,9 +469,9 @@
},
{
"type": "WriteAccessAllowed",
"description": "Service message: the user allowed the bot added to the attachment menu to write messages",
"html_description": "<td><em>Optional</em>. Service message: the user allowed the bot added to the attachment menu to write messages</td>",
"rst_description": "*Optional*. Service message: the user allowed the bot added to the attachment menu to write messages\n",
"description": "Service message: the user allowed the bot to write messages after adding it to the attachment or side menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method requestWriteAccess",
"html_description": "<td><em>Optional</em>. Service message: the user allowed the bot to write messages after adding it to the attachment or side menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method <a href=\"/bots/webapps#initializing-mini-apps\">requestWriteAccess</a></td>",
"rst_description": "*Optional*. Service message: the user allowed the bot to write messages after adding it to the attachment or side menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method `requestWriteAccess <https://core.telegram.org/bots/webapps#initializing-mini-apps>`_\n",
"name": "write_access_allowed",
"required": false
},

View file

@ -2,4 +2,8 @@ annotations:
date:
parsed_type:
type: std
name: datetime.datetime
name: DateTime
forward_date:
parsed_type:
type: std
name: DateTime

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -2,4 +2,4 @@ annotations:
close_date:
parsed_type:
type: std
name: datetime.datetime
name: DateTime

View file

@ -19,19 +19,27 @@
"name": "poll_id",
"required": true
},
{
"type": "Chat",
"description": "The chat that changed the answer to the poll, if the voter is anonymous",
"html_description": "<td><em>Optional</em>. The chat that changed the answer to the poll, if the voter is anonymous</td>",
"rst_description": "*Optional*. The chat that changed the answer to the poll, if the voter is anonymous\n",
"name": "voter_chat",
"required": false
},
{
"type": "User",
"description": "The user, who changed the answer to the poll",
"html_description": "<td>The user, who changed the answer to the poll</td>",
"rst_description": "The user, who changed the answer to the poll\n",
"description": "The user that changed the answer to the poll, if the voter isn't anonymous",
"html_description": "<td><em>Optional</em>. The user that changed the answer to the poll, if the voter isn't anonymous</td>",
"rst_description": "*Optional*. The user that changed the answer to the poll, if the voter isn't anonymous\n",
"name": "user",
"required": true
"required": false
},
{
"type": "Array of Integer",
"description": "0-based identifiers of answer options, chosen by the user. May be empty if the user retracted their vote.",
"html_description": "<td>0-based identifiers of answer options, chosen by the user. May be empty if the user retracted their vote.</td>",
"rst_description": "0-based identifiers of answer options, chosen by the user. May be empty if the user retracted their vote.\n",
"description": "0-based identifiers of chosen answer options. May be empty if the vote was retracted.",
"html_description": "<td>0-based identifiers of chosen answer options. May be empty if the vote was retracted.</td>",
"rst_description": "0-based identifiers of chosen answer options. May be empty if the vote was retracted.\n",
"name": "option_ids",
"required": true
}

View file

@ -0,0 +1,4 @@
answer:
method: answerPreCheckoutQuery
fill:
pre_checkout_query_id: self.id

View file

@ -0,0 +1,4 @@
answer:
method: answerShippingQuery
fill:
shipping_query_id: self.id

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