diff --git a/.butcher/methods/getChatMember/entity.json b/.butcher/methods/getChatMember/entity.json index 57a4e1c2..767abf3e 100644 --- a/.butcher/methods/getChatMember/entity.json +++ b/.butcher/methods/getChatMember/entity.json @@ -9,9 +9,9 @@ "object": { "anchor": "getchatmember", "name": "getChatMember", - "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": "

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.

", - "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.", + "description": "Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a ChatMember object on success.", + "html_description": "

Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a ChatMember object on success.

", + "rst_description": "Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a :class:`aiogram.types.chat_member.ChatMember` object on success.", "annotations": [ { "type": "Integer or String", diff --git a/.butcher/schema/schema.json b/.butcher/schema/schema.json index b2bd4b90..32dbfdac 100644 --- a/.butcher/schema/schema.json +++ b/.butcher/schema/schema.json @@ -2709,9 +2709,9 @@ "annotations": [ { "type": "Integer", - "description": "Signed 32-bit identifier of the request", - "html_description": "Signed 32-bit identifier of the request", - "rst_description": "Signed 32-bit identifier of the request\n", + "description": "Signed 32-bit identifier of the request, which will be received back in the UserShared object. Must be unique within the message", + "html_description": "Signed 32-bit identifier of the request, which will be received back in the UserShared object. Must be unique within the message", + "rst_description": "Signed 32-bit identifier of the request, which will be received back in the :class:`aiogram.types.user_shared.UserShared` object. Must be unique within the message\n", "name": "request_id", "required": true }, @@ -2743,9 +2743,9 @@ "annotations": [ { "type": "Integer", - "description": "Signed 32-bit identifier of the request", - "html_description": "Signed 32-bit identifier of the request", - "rst_description": "Signed 32-bit identifier of the request\n", + "description": "Signed 32-bit identifier of the request, which will be received back in the ChatShared object. Must be unique within the message", + "html_description": "Signed 32-bit identifier of the request, which will be received back in the ChatShared object. Must be unique within the message", + "rst_description": "Signed 32-bit identifier of the request, which will be received back in the :class:`aiogram.types.chat_shared.ChatShared` object. Must be unique within the message\n", "name": "request_id", "required": true }, @@ -2783,9 +2783,9 @@ }, { "type": "ChatAdministratorRights", - "description": "A JSON-serialized object listing the required administrator rights of the user in the chat. If not specified, no additional restrictions are applied.", - "html_description": "Optional. A JSON-serialized object listing the required administrator rights of the user in the chat. If not specified, no additional restrictions are applied.", - "rst_description": "*Optional*. A JSON-serialized object listing the required administrator rights of the user in the chat. If not specified, no additional restrictions are applied.\n", + "description": "A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of bot_administrator_rights. If not specified, no additional restrictions are applied.", + "html_description": "Optional. A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of bot_administrator_rights. If not specified, no additional restrictions are applied.", + "rst_description": "*Optional*. A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of *bot_administrator_rights*. If not specified, no additional restrictions are applied.\n", "name": "user_administrator_rights", "required": false }, @@ -7578,9 +7578,9 @@ { "anchor": "getchatmember", "name": "getChatMember", - "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": "

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.

", - "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.", + "description": "Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a ChatMember object on success.", + "html_description": "

Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a ChatMember object on success.

", + "rst_description": "Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a :class:`aiogram.types.chat_member.ChatMember` object on success.", "annotations": [ { "type": "Integer or String", diff --git a/.butcher/types/KeyboardButtonRequestChat/entity.json b/.butcher/types/KeyboardButtonRequestChat/entity.json index a79e6fc0..570fa963 100644 --- a/.butcher/types/KeyboardButtonRequestChat/entity.json +++ b/.butcher/types/KeyboardButtonRequestChat/entity.json @@ -15,9 +15,9 @@ "annotations": [ { "type": "Integer", - "description": "Signed 32-bit identifier of the request", - "html_description": "Signed 32-bit identifier of the request", - "rst_description": "Signed 32-bit identifier of the request\n", + "description": "Signed 32-bit identifier of the request, which will be received back in the ChatShared object. Must be unique within the message", + "html_description": "Signed 32-bit identifier of the request, which will be received back in the ChatShared object. Must be unique within the message", + "rst_description": "Signed 32-bit identifier of the request, which will be received back in the :class:`aiogram.types.chat_shared.ChatShared` object. Must be unique within the message\n", "name": "request_id", "required": true }, @@ -55,9 +55,9 @@ }, { "type": "ChatAdministratorRights", - "description": "A JSON-serialized object listing the required administrator rights of the user in the chat. If not specified, no additional restrictions are applied.", - "html_description": "Optional. A JSON-serialized object listing the required administrator rights of the user in the chat. If not specified, no additional restrictions are applied.", - "rst_description": "*Optional*. A JSON-serialized object listing the required administrator rights of the user in the chat. If not specified, no additional restrictions are applied.\n", + "description": "A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of bot_administrator_rights. If not specified, no additional restrictions are applied.", + "html_description": "Optional. A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of bot_administrator_rights. If not specified, no additional restrictions are applied.", + "rst_description": "*Optional*. A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of *bot_administrator_rights*. If not specified, no additional restrictions are applied.\n", "name": "user_administrator_rights", "required": false }, diff --git a/.butcher/types/KeyboardButtonRequestUser/entity.json b/.butcher/types/KeyboardButtonRequestUser/entity.json index 95814d2f..ae6be60f 100644 --- a/.butcher/types/KeyboardButtonRequestUser/entity.json +++ b/.butcher/types/KeyboardButtonRequestUser/entity.json @@ -15,9 +15,9 @@ "annotations": [ { "type": "Integer", - "description": "Signed 32-bit identifier of the request", - "html_description": "Signed 32-bit identifier of the request", - "rst_description": "Signed 32-bit identifier of the request\n", + "description": "Signed 32-bit identifier of the request, which will be received back in the UserShared object. Must be unique within the message", + "html_description": "Signed 32-bit identifier of the request, which will be received back in the UserShared object. Must be unique within the message", + "rst_description": "Signed 32-bit identifier of the request, which will be received back in the :class:`aiogram.types.user_shared.UserShared` object. Must be unique within the message\n", "name": "request_id", "required": true }, diff --git a/aiogram/client/bot.py b/aiogram/client/bot.py index 92b7aa34..d125d394 100644 --- a/aiogram/client/bot.py +++ b/aiogram/client/bot.py @@ -1486,9 +1486,9 @@ class Bot(ContextInstanceMixin["Bot"]): ChatMemberBanned, ]: """ - 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. + Use this method to get information about a member of a chat. The method is only guaranteed to work for other users 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#{'anchor': 'getchatmember', 'name': 'getChatMember', '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': '

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.

', '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': [{'type': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)', 'html_description': 'Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)', 'rst_description': 'Unique identifier for the target chat or username of the target supergroup or channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'Integer', 'required': True, 'description': 'Unique identifier of the target user', 'html_description': 'Unique identifier of the target user', 'rst_description': 'Unique identifier of the target user\n', 'name': 'user_id', 'parsed_type': {'type': 'std', 'name': 'int'}}], 'category': 'methods', 'returning': {'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'}}]}}, 'bases': ['TelegramMethod']} + Source: https://core.telegram.org/bots/api#{'anchor': 'getchatmember', 'name': 'getChatMember', 'description': 'Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a ChatMember object on success.', 'html_description': '

Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a ChatMember object on success.

', 'rst_description': 'Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a :class:`aiogram.types.chat_member.ChatMember` object on success.', 'annotations': [{'type': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)', 'html_description': 'Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)', 'rst_description': 'Unique identifier for the target chat or username of the target supergroup or channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'Integer', 'required': True, 'description': 'Unique identifier of the target user', 'html_description': 'Unique identifier of the target user', 'rst_description': 'Unique identifier of the target user\n', 'name': 'user_id', 'parsed_type': {'type': 'std', 'name': 'int'}}], 'category': 'methods', 'returning': {'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'}}]}}, 'bases': ['TelegramMethod']} :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 diff --git a/aiogram/methods/get_chat_member.py b/aiogram/methods/get_chat_member.py index 2d4e9d0b..ee531e1c 100644 --- a/aiogram/methods/get_chat_member.py +++ b/aiogram/methods/get_chat_member.py @@ -29,7 +29,7 @@ class GetChatMember( ] ): """ - 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. + Use this method to get information about a member of a chat. The method is only guaranteed to work for other users 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 """ diff --git a/aiogram/types/chat.py b/aiogram/types/chat.py index 25e0e110..4bb6d688 100644 --- a/aiogram/types/chat.py +++ b/aiogram/types/chat.py @@ -506,7 +506,7 @@ class Chat(TelegramObject): - :code:`chat_id` - 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. + Use this method to get information about a member of a chat. The method is only guaranteed to work for other users 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 diff --git a/aiogram/types/keyboard_button_request_chat.py b/aiogram/types/keyboard_button_request_chat.py index 5e015673..f4ec059c 100644 --- a/aiogram/types/keyboard_button_request_chat.py +++ b/aiogram/types/keyboard_button_request_chat.py @@ -16,7 +16,7 @@ class KeyboardButtonRequestChat(TelegramObject): """ request_id: int - """Signed 32-bit identifier of the request""" + """Signed 32-bit identifier of the request, which will be received back in the :class:`aiogram.types.chat_shared.ChatShared` object. Must be unique within the message""" chat_is_channel: bool """Pass :code:`True` to request a channel chat, pass :code:`False` to request a group or a supergroup chat.""" chat_is_forum: Optional[bool] = None @@ -26,7 +26,7 @@ class KeyboardButtonRequestChat(TelegramObject): chat_is_created: Optional[bool] = None """*Optional*. Pass :code:`True` to request a chat owned by the user. Otherwise, no additional restrictions are applied.""" user_administrator_rights: Optional[ChatAdministratorRights] = None - """*Optional*. A JSON-serialized object listing the required administrator rights of the user in the chat. If not specified, no additional restrictions are applied.""" + """*Optional*. A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of *bot_administrator_rights*. If not specified, no additional restrictions are applied.""" bot_administrator_rights: Optional[ChatAdministratorRights] = None """*Optional*. A JSON-serialized object listing the required administrator rights of the bot in the chat. The rights must be a subset of *user_administrator_rights*. If not specified, no additional restrictions are applied.""" bot_is_member: Optional[bool] = None diff --git a/aiogram/types/keyboard_button_request_user.py b/aiogram/types/keyboard_button_request_user.py index 00c1898f..5fce962a 100644 --- a/aiogram/types/keyboard_button_request_user.py +++ b/aiogram/types/keyboard_button_request_user.py @@ -11,7 +11,7 @@ class KeyboardButtonRequestUser(TelegramObject): """ request_id: int - """Signed 32-bit identifier of the request""" + """Signed 32-bit identifier of the request, which will be received back in the :class:`aiogram.types.user_shared.UserShared` object. Must be unique within the message""" user_is_bot: Optional[bool] = None """*Optional*. Pass :code:`True` to request a bot, pass :code:`False` to request a regular user. If not specified, no additional restrictions are applied.""" user_is_premium: Optional[bool] = None