Update from API docs

This commit is contained in:
Alex Root Junior 2023-01-07 22:41:36 +02:00
parent d8e943424a
commit c5f3569471
No known key found for this signature in database
GPG key ID: 074C1D455EBEA4AC
7 changed files with 17 additions and 17 deletions

View file

@ -32,9 +32,9 @@
{ {
"type": "String", "type": "String",
"required": false, "required": false,
"description": "New topic name, 0-128 characters. If not specififed or empty, the current name of the topic will be kept", "description": "New topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept",
"html_description": "<td>New topic name, 0-128 characters. If not specififed or empty, the current name of the topic will be kept</td>", "html_description": "<td>New topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept</td>",
"rst_description": "New topic name, 0-128 characters. If not specififed or empty, the current name of the topic will be kept\n", "rst_description": "New topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept\n",
"name": "name" "name": "name"
}, },
{ {

View file

@ -9,9 +9,9 @@
"object": { "object": {
"anchor": "getchatmember", "anchor": "getchatmember",
"name": "getChatMember", "name": "getChatMember",
"description": "Use this method to get information about a member of a chat. The method is guaranteed to work only if the bot is an administrator in the chat. Returns a ChatMember object on success.", "description": "Use this method to get information about a member of a chat. The method is guaranteed to work for other users, only if the bot is an administrator in the chat. Returns a ChatMember object on success.",
"html_description": "<p>Use this method to get information about a member of a chat. The method is guaranteed to work only if the bot is an administrator in the chat. Returns a <a href=\"#chatmember\">ChatMember</a> object on success.</p>", "html_description": "<p>Use this method to get information about a member of a chat. The method is guaranteed to work for other users, only if the bot is an administrator in the chat. Returns a <a href=\"#chatmember\">ChatMember</a> object on success.</p>",
"rst_description": "Use this method to get information about a member of a chat. The method is guaranteed to work only if the bot is an administrator in the chat. Returns a :class:`aiogram.types.chat_member.ChatMember` object on success.", "rst_description": "Use this method to get information about a member of a chat. The method is guaranteed to work for other users, only if the bot is an administrator in the chat. Returns a :class:`aiogram.types.chat_member.ChatMember` object on success.",
"annotations": [ "annotations": [
{ {
"type": "Integer or String", "type": "Integer or String",

View file

@ -7282,9 +7282,9 @@
{ {
"anchor": "getchatmember", "anchor": "getchatmember",
"name": "getChatMember", "name": "getChatMember",
"description": "Use this method to get information about a member of a chat. The method is guaranteed to work only if the bot is an administrator in the chat. Returns a ChatMember object on success.", "description": "Use this method to get information about a member of a chat. The method is guaranteed to work for other users, only if the bot is an administrator in the chat. Returns a ChatMember object on success.",
"html_description": "<p>Use this method to get information about a member of a chat. The method is guaranteed to work only if the bot is an administrator in the chat. Returns a <a href=\"#chatmember\">ChatMember</a> object on success.</p>", "html_description": "<p>Use this method to get information about a member of a chat. The method is guaranteed to work for other users, only if the bot is an administrator in the chat. Returns a <a href=\"#chatmember\">ChatMember</a> object on success.</p>",
"rst_description": "Use this method to get information about a member of a chat. The method is guaranteed to work only if the bot is an administrator in the chat. Returns a :class:`aiogram.types.chat_member.ChatMember` object on success.", "rst_description": "Use this method to get information about a member of a chat. The method is guaranteed to work for other users, only if the bot is an administrator in the chat. Returns a :class:`aiogram.types.chat_member.ChatMember` object on success.",
"annotations": [ "annotations": [
{ {
"type": "Integer or String", "type": "Integer or String",
@ -7426,9 +7426,9 @@
{ {
"type": "String", "type": "String",
"required": false, "required": false,
"description": "New topic name, 0-128 characters. If not specififed or empty, the current name of the topic will be kept", "description": "New topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept",
"html_description": "<td>New topic name, 0-128 characters. If not specififed or empty, the current name of the topic will be kept</td>", "html_description": "<td>New topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept</td>",
"rst_description": "New topic name, 0-128 characters. If not specififed or empty, the current name of the topic will be kept\n", "rst_description": "New topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept\n",
"name": "name" "name": "name"
}, },
{ {

View file

@ -1117,7 +1117,7 @@ class Bot(ContextInstanceMixin["Bot"]):
:param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`) :param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)
:param message_thread_id: Unique identifier for the target message thread of the forum topic :param message_thread_id: Unique identifier for the target message thread of the forum topic
:param name: New topic name, 0-128 characters. If not specififed or empty, the current name of the topic will be kept :param name: New topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept
:param icon_custom_emoji_id: New unique identifier of the custom emoji shown as the topic icon. Use :class:`aiogram.methods.get_forum_topic_icon_stickers.GetForumTopicIconStickers` to get all allowed custom emoji identifiers. Pass an empty string to remove the icon. If not specified, the current icon will be kept :param icon_custom_emoji_id: New unique identifier of the custom emoji shown as the topic icon. Use :class:`aiogram.methods.get_forum_topic_icon_stickers.GetForumTopicIconStickers` to get all allowed custom emoji identifiers. Pass an empty string to remove the icon. If not specified, the current icon will be kept
:param request_timeout: Request timeout :param request_timeout: Request timeout
:return: Returns :code:`True` on success. :return: Returns :code:`True` on success.
@ -1417,7 +1417,7 @@ class Bot(ContextInstanceMixin["Bot"]):
ChatMemberBanned, ChatMemberBanned,
]: ]:
""" """
Use this method to get information about a member of a chat. The method is guaranteed to work only if the bot is an administrator in the chat. Returns a :class:`aiogram.types.chat_member.ChatMember` object on success. Use this method to get information about a member of a chat. The method is guaranteed to work for other users, only if the bot is an administrator in the chat. Returns a :class:`aiogram.types.chat_member.ChatMember` object on success.
:param chat_id: Unique identifier for the target chat or username of the target supergroup or channel (in the format :code:`@channelusername`) :param chat_id: Unique identifier for the target chat or username of the target supergroup or channel (in the format :code:`@channelusername`)
:param user_id: Unique identifier of the target user :param user_id: Unique identifier of the target user

View file

@ -22,7 +22,7 @@ class EditForumTopic(TelegramMethod[bool]):
message_thread_id: int message_thread_id: int
"""Unique identifier for the target message thread of the forum topic""" """Unique identifier for the target message thread of the forum topic"""
name: Optional[str] = None name: Optional[str] = None
"""New topic name, 0-128 characters. If not specififed or empty, the current name of the topic will be kept""" """New topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept"""
icon_custom_emoji_id: Optional[str] = None icon_custom_emoji_id: Optional[str] = None
"""New unique identifier of the custom emoji shown as the topic icon. Use :class:`aiogram.methods.get_forum_topic_icon_stickers.GetForumTopicIconStickers` to get all allowed custom emoji identifiers. Pass an empty string to remove the icon. If not specified, the current icon will be kept""" """New unique identifier of the custom emoji shown as the topic icon. Use :class:`aiogram.methods.get_forum_topic_icon_stickers.GetForumTopicIconStickers` to get all allowed custom emoji identifiers. Pass an empty string to remove the icon. If not specified, the current icon will be kept"""

View file

@ -29,7 +29,7 @@ class GetChatMember(
] ]
): ):
""" """
Use this method to get information about a member of a chat. The method is guaranteed to work only if the bot is an administrator in the chat. Returns a :class:`aiogram.types.chat_member.ChatMember` object on success. Use this method to get information about a member of a chat. The method is guaranteed to work for other users, only if the bot is an administrator in the chat. Returns a :class:`aiogram.types.chat_member.ChatMember` object on success.
Source: https://core.telegram.org/bots/api#getchatmember Source: https://core.telegram.org/bots/api#getchatmember
""" """

View file

@ -506,7 +506,7 @@ class Chat(TelegramObject):
- :code:`chat_id` - :code:`chat_id`
Use this method to get information about a member of a chat. The method is guaranteed to work only if the bot is an administrator in the chat. Returns a :class:`aiogram.types.chat_member.ChatMember` object on success. Use this method to get information about a member of a chat. The method is guaranteed to work for other users, only if the bot is an administrator in the chat. Returns a :class:`aiogram.types.chat_member.ChatMember` object on success.
Source: https://core.telegram.org/bots/api#getchatmember Source: https://core.telegram.org/bots/api#getchatmember