From f1d9b118faa7eb7dcf80dce190d6ccfb4c517604 Mon Sep 17 00:00:00 2001 From: sys-001 Date: Fri, 5 Nov 2021 12:35:33 +0000 Subject: [PATCH] deploy: 05c9d3f2ebe68805c318ea0fedd0d6821f2436e8 --- schemas/botapi.json | 211 +++++++++++++++++--- schemas/botapi.yaml | 169 +++++++++++++--- schemas/botapi_openapi.json | 371 ++++++++++++++++++++++++++++++++++-- schemas/botapi_openapi.yaml | 249 ++++++++++++++++++++++-- schemas/botapi_postman.json | 138 ++++++++++++-- 5 files changed, 1034 insertions(+), 104 deletions(-) diff --git a/schemas/botapi.json b/schemas/botapi.json index bcdefbd..a8320b1 100644 --- a/schemas/botapi.json +++ b/schemas/botapi.json @@ -1,5 +1,5 @@ { - "version": "5.3.0", + "version": "5.4.0", "types": [ { "name": "Update", @@ -116,6 +116,14 @@ ], "optional": true, "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." + }, + { + "name": "chat_join_request", + "types": [ + "ChatJoinRequest" + ], + "optional": true, + "description": "Optional. A request to join the chat has been sent. The bot must have the can_invite_users administrator right in the chat to receive these updates." } ], "extended_by": [] @@ -376,7 +384,7 @@ "int" ], "optional": true, - "description": "Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unpriviledged user. Returned only in getChat." + "description": "Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unpriviledged user; in seconds. Returned only in getChat." }, { "name": "message_auto_delete_time", @@ -1656,7 +1664,7 @@ "int" ], "optional": true, - "description": "Optional. Time relative to the message sending date, during which the location can be updated, in seconds. For active live locations only." + "description": "Optional. Time relative to the message sending date, during which the location can be updated; in seconds. For active live locations only." }, { "name": "heading", @@ -1781,7 +1789,7 @@ "int" ], "optional": false, - "description": "New auto-delete time for messages in the chat" + "description": "New auto-delete time for messages in the chat; in seconds" } ], "extended_by": [] @@ -2301,6 +2309,14 @@ "optional": false, "description": "Creator of the link" }, + { + "name": "creates_join_request", + "types": [ + "bool" + ], + "optional": false, + "description": "True, if users joining the chat via the link need to be approved by chat administrators" + }, { "name": "is_primary", "types": [ @@ -2317,6 +2333,14 @@ "optional": false, "description": "True, if the link is revoked" }, + { + "name": "name", + "types": [ + "string" + ], + "optional": true, + "description": "Optional. Invite link name" + }, { "name": "expire_date", "types": [ @@ -2332,6 +2356,14 @@ ], "optional": true, "description": "Optional. Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999" + }, + { + "name": "pending_join_request_count", + "types": [ + "int" + ], + "optional": true, + "description": "Optional. Number of pending join requests created using this link" } ], "extended_by": [] @@ -2750,6 +2782,53 @@ ], "extended_by": [] }, + { + "name": "ChatJoinRequest", + "description": "Represents a join request sent to a chat.", + "fields": [ + { + "name": "chat", + "types": [ + "Chat" + ], + "optional": false, + "description": "Chat to which the request was sent" + }, + { + "name": "from", + "types": [ + "User" + ], + "optional": false, + "description": "User that sent the join request" + }, + { + "name": "date", + "types": [ + "int" + ], + "optional": false, + "description": "Date the request was sent in Unix time" + }, + { + "name": "bio", + "types": [ + "string" + ], + "optional": true, + "description": "Optional. Bio of the user." + }, + { + "name": "invite_link", + "types": [ + "ChatInviteLink" + ], + "optional": true, + "description": "Optional. Chat invite link that was used by the user to send the join request" + } + ], + "extended_by": [] + }, { "name": "ChatPermissions", "description": "Describes actions that a non-administrator user is allowed to take in a chat.", @@ -3410,7 +3489,7 @@ "bool" ], "optional": true, - "description": "Optional. Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always true, if the document is sent as part of an album." + "description": "Optional. Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always True, if the document is sent as part of an album." } ], "extended_by": [] @@ -8803,7 +8882,7 @@ "string" ], "optional": false, - "description": "Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_voice or upload_voice for voice notes, upload_document for general files, find_location for location data, record_video_note or upload_video_note for video notes." + "description": "Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_voice or upload_voice for voice notes, upload_document for general files, choose_sticker for stickers, find_location for location data, record_video_note or upload_video_note for video notes." } ], "return_types": [ @@ -8862,7 +8941,7 @@ }, { "name": "banChatMember", - "description": "Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.", + "description": "Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.", "fields": [ { "name": "chat_id", @@ -8938,7 +9017,7 @@ }, { "name": "restrictChatMember", - "description": "Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate admin rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.", + "description": "Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.", "fields": [ { "name": "chat_id", @@ -8980,7 +9059,7 @@ }, { "name": "promoteChatMember", - "description": "Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Pass False for all boolean parameters to demote a user. Returns True on success.", + "description": "Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.", "fields": [ { "name": "chat_id", @@ -9128,7 +9207,7 @@ }, { "name": "setChatPermissions", - "description": "Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members admin rights. Returns True on success.", + "description": "Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members administrator rights. Returns True on success.", "fields": [ { "name": "chat_id", @@ -9154,7 +9233,7 @@ }, { "name": "exportChatInviteLink", - "description": "Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the new invite link as String on success.", + "description": "Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success.", "fields": [ { "name": "chat_id", @@ -9172,7 +9251,7 @@ }, { "name": "createChatInviteLink", - "description": "Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.", + "description": "Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.", "fields": [ { "name": "chat_id", @@ -9183,6 +9262,14 @@ "optional": false, "description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername)" }, + { + "name": "name", + "types": [ + "string" + ], + "optional": true, + "description": "Invite link name; 0-32 characters" + }, { "name": "expire_date", "types": [ @@ -9198,6 +9285,14 @@ ], "optional": true, "description": "Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999" + }, + { + "name": "creates_join_request", + "types": [ + "bool" + ], + "optional": true, + "description": "True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified" } ], "return_types": [ @@ -9206,7 +9301,7 @@ }, { "name": "editChatInviteLink", - "description": "Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the edited invite link as a ChatInviteLink object.", + "description": "Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object.", "fields": [ { "name": "chat_id", @@ -9225,6 +9320,14 @@ "optional": false, "description": "The invite link to edit" }, + { + "name": "name", + "types": [ + "string" + ], + "optional": true, + "description": "Invite link name; 0-32 characters" + }, { "name": "expire_date", "types": [ @@ -9240,6 +9343,14 @@ ], "optional": true, "description": "Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999" + }, + { + "name": "creates_join_request", + "types": [ + "bool" + ], + "optional": true, + "description": "True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified" } ], "return_types": [ @@ -9248,7 +9359,7 @@ }, { "name": "revokeChatInviteLink", - "description": "Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the revoked invite link as ChatInviteLink object.", + "description": "Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object.", "fields": [ { "name": "chat_id", @@ -9272,9 +9383,61 @@ "ChatInviteLink" ] }, + { + "name": "approveChatJoinRequest", + "description": "Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.", + "fields": [ + { + "name": "chat_id", + "types": [ + "int", + "string" + ], + "optional": false, + "description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername)" + }, + { + "name": "user_id", + "types": [ + "int" + ], + "optional": false, + "description": "Unique identifier of the target user" + } + ], + "return_types": [ + "bool" + ] + }, + { + "name": "declineChatJoinRequest", + "description": "Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.", + "fields": [ + { + "name": "chat_id", + "types": [ + "int", + "string" + ], + "optional": false, + "description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername)" + }, + { + "name": "user_id", + "types": [ + "int" + ], + "optional": false, + "description": "Unique identifier of the target user" + } + ], + "return_types": [ + "bool" + ] + }, { "name": "setChatPhoto", - "description": "Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.", + "description": "Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.", "fields": [ { "name": "chat_id", @@ -9300,7 +9463,7 @@ }, { "name": "deleteChatPhoto", - "description": "Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.", + "description": "Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.", "fields": [ { "name": "chat_id", @@ -9318,7 +9481,7 @@ }, { "name": "setChatTitle", - "description": "Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.", + "description": "Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.", "fields": [ { "name": "chat_id", @@ -9344,7 +9507,7 @@ }, { "name": "setChatDescription", - "description": "Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.", + "description": "Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.", "fields": [ { "name": "chat_id", @@ -9370,7 +9533,7 @@ }, { "name": "pinChatMessage", - "description": "Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns True on success.", + "description": "Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.", "fields": [ { "name": "chat_id", @@ -9404,7 +9567,7 @@ }, { "name": "unpinChatMessage", - "description": "Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns True on success.", + "description": "Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.", "fields": [ { "name": "chat_id", @@ -9430,7 +9593,7 @@ }, { "name": "unpinAllChatMessages", - "description": "Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns True on success.", + "description": "Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.", "fields": [ { "name": "chat_id", @@ -9546,7 +9709,7 @@ }, { "name": "setChatStickerSet", - "description": "Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.", + "description": "Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.", "fields": [ { "name": "chat_id", @@ -9572,7 +9735,7 @@ }, { "name": "deleteChatStickerSet", - "description": "Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.", + "description": "Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.", "fields": [ { "name": "chat_id", @@ -9614,7 +9777,7 @@ "bool" ], "optional": true, - "description": "If true, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false." + "description": "If True, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false." }, { "name": "url", diff --git a/schemas/botapi.yaml b/schemas/botapi.yaml index cd14315..ee510da 100644 --- a/schemas/botapi.yaml +++ b/schemas/botapi.yaml @@ -1,4 +1,4 @@ -version: 5.3.0 +version: 5.4.0 types: - name: Update @@ -88,6 +88,12 @@ types: - ChatMemberUpdated optional: true 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.' + - + name: chat_join_request + types: + - ChatJoinRequest + optional: true + description: 'Optional. A request to join the chat has been sent. The bot must have the can_invite_users administrator right in the chat to receive these updates.' extended_by: { } - name: WebhookInfo @@ -282,7 +288,7 @@ types: types: - int optional: true - description: 'Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unpriviledged user. Returned only in getChat.' + description: 'Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unpriviledged user; in seconds. Returned only in getChat.' - name: message_auto_delete_time types: @@ -1238,7 +1244,7 @@ types: types: - int optional: true - description: 'Optional. Time relative to the message sending date, during which the location can be updated, in seconds. For active live locations only.' + description: 'Optional. Time relative to the message sending date, during which the location can be updated; in seconds. For active live locations only.' - name: heading types: @@ -1331,7 +1337,7 @@ types: types: - int optional: false - description: 'New auto-delete time for messages in the chat' + description: 'New auto-delete time for messages in the chat; in seconds' extended_by: { } - name: VoiceChatScheduled @@ -1717,6 +1723,12 @@ types: - User optional: false description: 'Creator of the link' + - + name: creates_join_request + types: + - bool + optional: false + description: 'True, if users joining the chat via the link need to be approved by chat administrators' - name: is_primary types: @@ -1729,6 +1741,12 @@ types: - bool optional: false description: 'True, if the link is revoked' + - + name: name + types: + - string + optional: true + description: 'Optional. Invite link name' - name: expire_date types: @@ -1741,6 +1759,12 @@ types: - int optional: true description: 'Optional. Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999' + - + name: pending_join_request_count + types: + - int + optional: true + description: 'Optional. Number of pending join requests created using this link' extended_by: { } - name: ChatMember @@ -2052,6 +2076,41 @@ types: optional: true description: 'Optional. Chat invite link, which was used by the user to join the chat; for joining by invite link events only.' extended_by: { } + - + name: ChatJoinRequest + description: 'Represents a join request sent to a chat.' + fields: + - + name: chat + types: + - Chat + optional: false + description: 'Chat to which the request was sent' + - + name: from + types: + - User + optional: false + description: 'User that sent the join request' + - + name: date + types: + - int + optional: false + description: 'Date the request was sent in Unix time' + - + name: bio + types: + - string + optional: true + description: 'Optional. Bio of the user.' + - + name: invite_link + types: + - ChatInviteLink + optional: true + description: 'Optional. Chat invite link that was used by the user to send the join request' + extended_by: { } - name: ChatPermissions description: 'Describes actions that a non-administrator user is allowed to take in a chat.' @@ -2549,7 +2608,7 @@ types: types: - bool optional: true - description: 'Optional. Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always true, if the document is sent as part of an album.' + description: 'Optional. Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always True, if the document is sent as part of an album.' extended_by: { } - name: InputFile @@ -6592,7 +6651,7 @@ methods: types: - string optional: false - description: 'Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_voice or upload_voice for voice notes, upload_document for general files, find_location for location data, record_video_note or upload_video_note for video notes.' + description: 'Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_voice or upload_voice for voice notes, upload_document for general files, choose_sticker for stickers, find_location for location data, record_video_note or upload_video_note for video notes.' return_types: - bool - @@ -6633,7 +6692,7 @@ methods: - File - name: banChatMember - description: 'Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.' + description: 'Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.' fields: - name: chat_id @@ -6689,7 +6748,7 @@ methods: - bool - name: restrictChatMember - description: 'Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate admin rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.' + description: 'Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.' fields: - name: chat_id @@ -6720,7 +6779,7 @@ methods: - bool - name: promoteChatMember - description: 'Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Pass False for all boolean parameters to demote a user. Returns True on success.' + description: 'Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.' fields: - name: chat_id @@ -6830,7 +6889,7 @@ methods: - bool - name: setChatPermissions - description: 'Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members admin rights. Returns True on success.' + description: 'Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members administrator rights. Returns True on success.' fields: - name: chat_id @@ -6849,7 +6908,7 @@ methods: - bool - name: exportChatInviteLink - description: 'Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the new invite link as String on success.' + description: 'Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success.' fields: - name: chat_id @@ -6862,7 +6921,7 @@ methods: - string - name: createChatInviteLink - description: 'Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.' + description: 'Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.' fields: - name: chat_id @@ -6871,6 +6930,12 @@ methods: - string optional: false description: 'Unique identifier for the target chat or username of the target channel (in the format @channelusername)' + - + name: name + types: + - string + optional: true + description: 'Invite link name; 0-32 characters' - name: expire_date types: @@ -6883,11 +6948,17 @@ methods: - int optional: true description: 'Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999' + - + name: creates_join_request + types: + - bool + optional: true + description: 'True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can''t be specified' return_types: - ChatInviteLink - name: editChatInviteLink - description: 'Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the edited invite link as a ChatInviteLink object.' + description: 'Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object.' fields: - name: chat_id @@ -6902,6 +6973,12 @@ methods: - string optional: false description: 'The invite link to edit' + - + name: name + types: + - string + optional: true + description: 'Invite link name; 0-32 characters' - name: expire_date types: @@ -6914,11 +6991,17 @@ methods: - int optional: true description: 'Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999' + - + name: creates_join_request + types: + - bool + optional: true + description: 'True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can''t be specified' return_types: - ChatInviteLink - name: revokeChatInviteLink - description: 'Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the revoked invite link as ChatInviteLink object.' + description: 'Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object.' fields: - name: chat_id @@ -6935,9 +7018,47 @@ methods: description: 'The invite link to revoke' return_types: - ChatInviteLink + - + name: approveChatJoinRequest + description: 'Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.' + fields: + - + name: chat_id + types: + - int + - string + optional: false + description: 'Unique identifier for the target chat or username of the target channel (in the format @channelusername)' + - + name: user_id + types: + - int + optional: false + description: 'Unique identifier of the target user' + return_types: + - bool + - + name: declineChatJoinRequest + description: 'Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.' + fields: + - + name: chat_id + types: + - int + - string + optional: false + description: 'Unique identifier for the target chat or username of the target channel (in the format @channelusername)' + - + name: user_id + types: + - int + optional: false + description: 'Unique identifier of the target user' + return_types: + - bool - name: setChatPhoto - description: 'Use this method to set a new profile photo for the chat. Photos can''t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.' + description: 'Use this method to set a new profile photo for the chat. Photos can''t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.' fields: - name: chat_id @@ -6956,7 +7077,7 @@ methods: - bool - name: deleteChatPhoto - description: 'Use this method to delete a chat photo. Photos can''t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.' + description: 'Use this method to delete a chat photo. Photos can''t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.' fields: - name: chat_id @@ -6969,7 +7090,7 @@ methods: - bool - name: setChatTitle - description: 'Use this method to change the title of a chat. Titles can''t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.' + description: 'Use this method to change the title of a chat. Titles can''t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.' fields: - name: chat_id @@ -6988,7 +7109,7 @@ methods: - bool - name: setChatDescription - description: 'Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.' + description: 'Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.' fields: - name: chat_id @@ -7007,7 +7128,7 @@ methods: - bool - name: pinChatMessage - description: 'Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the ''can_pin_messages'' admin right in a supergroup or ''can_edit_messages'' admin right in a channel. Returns True on success.' + description: 'Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the ''can_pin_messages'' administrator right in a supergroup or ''can_edit_messages'' administrator right in a channel. Returns True on success.' fields: - name: chat_id @@ -7032,7 +7153,7 @@ methods: - bool - name: unpinChatMessage - description: 'Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the ''can_pin_messages'' admin right in a supergroup or ''can_edit_messages'' admin right in a channel. Returns True on success.' + description: 'Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the ''can_pin_messages'' administrator right in a supergroup or ''can_edit_messages'' administrator right in a channel. Returns True on success.' fields: - name: chat_id @@ -7051,7 +7172,7 @@ methods: - bool - name: unpinAllChatMessages - description: 'Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the ''can_pin_messages'' admin right in a supergroup or ''can_edit_messages'' admin right in a channel. Returns True on success.' + description: 'Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the ''can_pin_messages'' administrator right in a supergroup or ''can_edit_messages'' administrator right in a channel. Returns True on success.' fields: - name: chat_id @@ -7135,7 +7256,7 @@ methods: - ChatMember - name: setChatStickerSet - description: 'Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.' + description: 'Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.' fields: - name: chat_id @@ -7154,7 +7275,7 @@ methods: - bool - name: deleteChatStickerSet - description: 'Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.' + description: 'Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.' fields: - name: chat_id @@ -7186,7 +7307,7 @@ methods: types: - bool optional: true - description: 'If true, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false.' + description: 'If True, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false.' - name: url types: diff --git a/schemas/botapi_openapi.json b/schemas/botapi_openapi.json index 4a3990c..71451e4 100644 --- a/schemas/botapi_openapi.json +++ b/schemas/botapi_openapi.json @@ -3,7 +3,7 @@ "info": { "title": "Telegram Bot API", "description": "Auto-generated OpenAPI schema by TGScraper.", - "version": "5.3.0" + "version": "5.4.0" }, "servers": [ { @@ -208,6 +208,9 @@ }, "chat_member": { "$ref": "#/components/schemas/ChatMemberUpdated" + }, + "chat_join_request": { + "$ref": "#/components/schemas/ChatJoinRequest" } }, "type": "object" @@ -1359,6 +1362,7 @@ "required": [ "invite_link", "creator", + "creates_join_request", "is_primary", "is_revoked" ], @@ -1369,17 +1373,26 @@ "creator": { "$ref": "#/components/schemas/User" }, + "creates_join_request": { + "type": "boolean" + }, "is_primary": { "type": "boolean" }, "is_revoked": { "type": "boolean" }, + "name": { + "type": "string" + }, "expire_date": { "type": "integer" }, "member_limit": { "type": "integer" + }, + "pending_join_request_count": { + "type": "integer" } }, "type": "object" @@ -1633,6 +1646,32 @@ }, "type": "object" }, + "ChatJoinRequest": { + "description": "Represents a join request sent to a chat.", + "required": [ + "chat", + "from", + "date" + ], + "properties": { + "chat": { + "$ref": "#/components/schemas/Chat" + }, + "from": { + "$ref": "#/components/schemas/User" + }, + "date": { + "type": "integer" + }, + "bio": { + "type": "string" + }, + "invite_link": { + "$ref": "#/components/schemas/ChatInviteLink" + } + }, + "type": "object" + }, "ChatPermissions": { "description": "Describes actions that a non-administrator user is allowed to take in a chat.", "properties": { @@ -9689,7 +9728,7 @@ } }, "/banChatMember": { - "description": "Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.", + "description": "Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.", "post": { "requestBody": { "required": true, @@ -9976,7 +10015,7 @@ } }, "/restrictChatMember": { - "description": "Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate admin rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.", + "description": "Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.", "post": { "requestBody": { "required": true, @@ -10127,7 +10166,7 @@ } }, "/promoteChatMember": { - "description": "Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Pass False for all boolean parameters to demote a user. Returns True on success.", + "description": "Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.", "post": { "requestBody": { "required": true, @@ -10498,7 +10537,7 @@ } }, "/setChatPermissions": { - "description": "Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members admin rights. Returns True on success.", + "description": "Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members administrator rights. Returns True on success.", "post": { "requestBody": { "required": true, @@ -10628,7 +10667,7 @@ } }, "/exportChatInviteLink": { - "description": "Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the new invite link as String on success.", + "description": "Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success.", "post": { "requestBody": { "required": true, @@ -10746,7 +10785,7 @@ } }, "/createChatInviteLink": { - "description": "Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.", + "description": "Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.", "post": { "requestBody": { "required": true, @@ -10768,11 +10807,17 @@ } ] }, + "name": { + "type": "string" + }, "expire_date": { "type": "integer" }, "member_limit": { "type": "integer" + }, + "creates_join_request": { + "type": "boolean" } } } @@ -10794,11 +10839,17 @@ } ] }, + "name": { + "type": "string" + }, "expire_date": { "type": "integer" }, "member_limit": { "type": "integer" + }, + "creates_join_request": { + "type": "boolean" } } } @@ -10820,11 +10871,17 @@ } ] }, + "name": { + "type": "string" + }, "expire_date": { "type": "integer" }, "member_limit": { "type": "integer" + }, + "creates_join_request": { + "type": "boolean" } } } @@ -10882,7 +10939,7 @@ } }, "/editChatInviteLink": { - "description": "Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the edited invite link as a ChatInviteLink object.", + "description": "Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object.", "post": { "requestBody": { "required": true, @@ -10908,11 +10965,17 @@ "invite_link": { "type": "string" }, + "name": { + "type": "string" + }, "expire_date": { "type": "integer" }, "member_limit": { "type": "integer" + }, + "creates_join_request": { + "type": "boolean" } } } @@ -10938,11 +11001,17 @@ "invite_link": { "type": "string" }, + "name": { + "type": "string" + }, "expire_date": { "type": "integer" }, "member_limit": { "type": "integer" + }, + "creates_join_request": { + "type": "boolean" } } } @@ -10968,11 +11037,17 @@ "invite_link": { "type": "string" }, + "name": { + "type": "string" + }, "expire_date": { "type": "integer" }, "member_limit": { "type": "integer" + }, + "creates_join_request": { + "type": "boolean" } } } @@ -11030,7 +11105,7 @@ } }, "/revokeChatInviteLink": { - "description": "Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the revoked invite link as ChatInviteLink object.", + "description": "Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object.", "post": { "requestBody": { "required": true, @@ -11159,8 +11234,268 @@ } } }, + "/approveChatJoinRequest": { + "description": "Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.", + "post": { + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "chat_id", + "user_id" + ], + "properties": { + "chat_id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + }, + "user_id": { + "type": "integer" + } + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "required": [ + "chat_id", + "user_id" + ], + "properties": { + "chat_id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + }, + "user_id": { + "type": "integer" + } + } + } + }, + "multipart/form-data": { + "schema": { + "type": "object", + "required": [ + "chat_id", + "user_id" + ], + "properties": { + "chat_id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + }, + "user_id": { + "type": "integer" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Request was successful, the result is returned.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/Success" + }, + { + "type": "object", + "properties": { + "result": { + "type": "boolean" + } + } + } + ] + } + } + } + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "429": { + "$ref": "#/components/responses/TooManyRequests" + }, + "5XX": { + "$ref": "#/components/responses/ServerError" + }, + "default": { + "$ref": "#/components/responses/UnknownError" + } + } + } + }, + "/declineChatJoinRequest": { + "description": "Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.", + "post": { + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "chat_id", + "user_id" + ], + "properties": { + "chat_id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + }, + "user_id": { + "type": "integer" + } + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "required": [ + "chat_id", + "user_id" + ], + "properties": { + "chat_id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + }, + "user_id": { + "type": "integer" + } + } + } + }, + "multipart/form-data": { + "schema": { + "type": "object", + "required": [ + "chat_id", + "user_id" + ], + "properties": { + "chat_id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + }, + "user_id": { + "type": "integer" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Request was successful, the result is returned.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/Success" + }, + { + "type": "object", + "properties": { + "result": { + "type": "boolean" + } + } + } + ] + } + } + } + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "429": { + "$ref": "#/components/responses/TooManyRequests" + }, + "5XX": { + "$ref": "#/components/responses/ServerError" + }, + "default": { + "$ref": "#/components/responses/UnknownError" + } + } + } + }, "/setChatPhoto": { - "description": "Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.", + "description": "Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.", "post": { "requestBody": { "required": true, @@ -11290,7 +11625,7 @@ } }, "/deleteChatPhoto": { - "description": "Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.", + "description": "Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.", "post": { "requestBody": { "required": true, @@ -11408,7 +11743,7 @@ } }, "/setChatTitle": { - "description": "Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.", + "description": "Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.", "post": { "requestBody": { "required": true, @@ -11538,7 +11873,7 @@ } }, "/setChatDescription": { - "description": "Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.", + "description": "Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.", "post": { "requestBody": { "required": true, @@ -11665,7 +12000,7 @@ } }, "/pinChatMessage": { - "description": "Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns True on success.", + "description": "Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.", "post": { "requestBody": { "required": true, @@ -11804,7 +12139,7 @@ } }, "/unpinChatMessage": { - "description": "Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns True on success.", + "description": "Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.", "post": { "requestBody": { "required": true, @@ -11931,7 +12266,7 @@ } }, "/unpinAllChatMessages": { - "description": "Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns True on success.", + "description": "Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.", "post": { "requestBody": { "required": true, @@ -12654,7 +12989,7 @@ } }, "/setChatStickerSet": { - "description": "Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.", + "description": "Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.", "post": { "requestBody": { "required": true, @@ -12784,7 +13119,7 @@ } }, "/deleteChatStickerSet": { - "description": "Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.", + "description": "Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.", "post": { "requestBody": { "required": true, diff --git a/schemas/botapi_openapi.yaml b/schemas/botapi_openapi.yaml index 5b7e16a..d578218 100644 --- a/schemas/botapi_openapi.yaml +++ b/schemas/botapi_openapi.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: 'Telegram Bot API' description: 'Auto-generated OpenAPI schema by TGScraper.' - version: 5.3.0 + version: 5.4.0 servers: - url: 'https://api.telegram.org/bot{token}' @@ -134,6 +134,8 @@ components: $ref: '#/components/schemas/ChatMemberUpdated' chat_member: $ref: '#/components/schemas/ChatMemberUpdated' + chat_join_request: + $ref: '#/components/schemas/ChatJoinRequest' type: object WebhookInfo: description: 'Contains information about the current status of a webhook.' @@ -919,6 +921,7 @@ components: required: - invite_link - creator + - creates_join_request - is_primary - is_revoked properties: @@ -926,14 +929,20 @@ components: type: string creator: $ref: '#/components/schemas/User' + creates_join_request: + type: boolean is_primary: type: boolean is_revoked: type: boolean + name: + type: string expire_date: type: integer member_limit: type: integer + pending_join_request_count: + type: integer type: object ChatMember: description: 'This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported:' @@ -1111,6 +1120,24 @@ components: invite_link: $ref: '#/components/schemas/ChatInviteLink' type: object + ChatJoinRequest: + description: 'Represents a join request sent to a chat.' + required: + - chat + - from + - date + properties: + chat: + $ref: '#/components/schemas/Chat' + from: + $ref: '#/components/schemas/User' + date: + type: integer + bio: + type: string + invite_link: + $ref: '#/components/schemas/ChatInviteLink' + type: object ChatPermissions: description: 'Describes actions that a non-administrator user is allowed to take in a chat.' properties: @@ -6327,7 +6354,7 @@ paths: default: $ref: '#/components/responses/UnknownError' /banChatMember: - description: 'Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.' + description: 'Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.' post: requestBody: required: true @@ -6507,7 +6534,7 @@ paths: default: $ref: '#/components/responses/UnknownError' /restrictChatMember: - description: 'Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate admin rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.' + description: 'Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.' post: requestBody: required: true @@ -6603,7 +6630,7 @@ paths: default: $ref: '#/components/responses/UnknownError' /promoteChatMember: - description: 'Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Pass False for all boolean parameters to demote a user. Returns True on success.' + description: 'Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.' post: requestBody: required: true @@ -6840,7 +6867,7 @@ paths: default: $ref: '#/components/responses/UnknownError' /setChatPermissions: - description: 'Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members admin rights. Returns True on success.' + description: 'Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members administrator rights. Returns True on success.' post: requestBody: required: true @@ -6921,7 +6948,7 @@ paths: default: $ref: '#/components/responses/UnknownError' /exportChatInviteLink: - description: 'Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the new invite link as String on success.' + description: 'Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success.' post: requestBody: required: true @@ -6993,7 +7020,7 @@ paths: default: $ref: '#/components/responses/UnknownError' /createChatInviteLink: - description: 'Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.' + description: 'Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.' post: requestBody: required: true @@ -7010,10 +7037,14 @@ paths: type: integer - type: string + name: + type: string expire_date: type: integer member_limit: type: integer + creates_join_request: + type: boolean application/x-www-form-urlencoded: schema: type: object @@ -7026,10 +7057,14 @@ paths: type: integer - type: string + name: + type: string expire_date: type: integer member_limit: type: integer + creates_join_request: + type: boolean multipart/form-data: schema: type: object @@ -7042,10 +7077,14 @@ paths: type: integer - type: string + name: + type: string expire_date: type: integer member_limit: type: integer + creates_join_request: + type: boolean responses: 200: description: 'Request was successful, the result is returned.' @@ -7077,7 +7116,7 @@ paths: default: $ref: '#/components/responses/UnknownError' /editChatInviteLink: - description: 'Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the edited invite link as a ChatInviteLink object.' + description: 'Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object.' post: requestBody: required: true @@ -7097,10 +7136,14 @@ paths: type: string invite_link: type: string + name: + type: string expire_date: type: integer member_limit: type: integer + creates_join_request: + type: boolean application/x-www-form-urlencoded: schema: type: object @@ -7116,10 +7159,14 @@ paths: type: string invite_link: type: string + name: + type: string expire_date: type: integer member_limit: type: integer + creates_join_request: + type: boolean multipart/form-data: schema: type: object @@ -7135,10 +7182,14 @@ paths: type: string invite_link: type: string + name: + type: string expire_date: type: integer member_limit: type: integer + creates_join_request: + type: boolean responses: 200: description: 'Request was successful, the result is returned.' @@ -7170,7 +7221,7 @@ paths: default: $ref: '#/components/responses/UnknownError' /revokeChatInviteLink: - description: 'Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the revoked invite link as ChatInviteLink object.' + description: 'Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object.' post: requestBody: required: true @@ -7250,8 +7301,170 @@ paths: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' + /approveChatJoinRequest: + description: 'Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.' + post: + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - chat_id + - user_id + properties: + chat_id: + anyOf: + - + type: integer + - + type: string + user_id: + type: integer + application/x-www-form-urlencoded: + schema: + type: object + required: + - chat_id + - user_id + properties: + chat_id: + anyOf: + - + type: integer + - + type: string + user_id: + type: integer + multipart/form-data: + schema: + type: object + required: + - chat_id + - user_id + properties: + chat_id: + anyOf: + - + type: integer + - + type: string + user_id: + type: integer + responses: + 200: + description: 'Request was successful, the result is returned.' + content: + application/json: + schema: + allOf: + - + $ref: '#/components/schemas/Success' + - + type: object + properties: + result: + type: boolean + 400: + $ref: '#/components/responses/BadRequest' + 401: + $ref: '#/components/responses/Unauthorized' + 403: + $ref: '#/components/responses/Forbidden' + 404: + $ref: '#/components/responses/NotFound' + 409: + $ref: '#/components/responses/Conflict' + 429: + $ref: '#/components/responses/TooManyRequests' + 5XX: + $ref: '#/components/responses/ServerError' + default: + $ref: '#/components/responses/UnknownError' + /declineChatJoinRequest: + description: 'Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.' + post: + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - chat_id + - user_id + properties: + chat_id: + anyOf: + - + type: integer + - + type: string + user_id: + type: integer + application/x-www-form-urlencoded: + schema: + type: object + required: + - chat_id + - user_id + properties: + chat_id: + anyOf: + - + type: integer + - + type: string + user_id: + type: integer + multipart/form-data: + schema: + type: object + required: + - chat_id + - user_id + properties: + chat_id: + anyOf: + - + type: integer + - + type: string + user_id: + type: integer + responses: + 200: + description: 'Request was successful, the result is returned.' + content: + application/json: + schema: + allOf: + - + $ref: '#/components/schemas/Success' + - + type: object + properties: + result: + type: boolean + 400: + $ref: '#/components/responses/BadRequest' + 401: + $ref: '#/components/responses/Unauthorized' + 403: + $ref: '#/components/responses/Forbidden' + 404: + $ref: '#/components/responses/NotFound' + 409: + $ref: '#/components/responses/Conflict' + 429: + $ref: '#/components/responses/TooManyRequests' + 5XX: + $ref: '#/components/responses/ServerError' + default: + $ref: '#/components/responses/UnknownError' /setChatPhoto: - description: 'Use this method to set a new profile photo for the chat. Photos can''t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.' + description: 'Use this method to set a new profile photo for the chat. Photos can''t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.' post: requestBody: required: true @@ -7332,7 +7545,7 @@ paths: default: $ref: '#/components/responses/UnknownError' /deleteChatPhoto: - description: 'Use this method to delete a chat photo. Photos can''t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.' + description: 'Use this method to delete a chat photo. Photos can''t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.' post: requestBody: required: true @@ -7404,7 +7617,7 @@ paths: default: $ref: '#/components/responses/UnknownError' /setChatTitle: - description: 'Use this method to change the title of a chat. Titles can''t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.' + description: 'Use this method to change the title of a chat. Titles can''t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.' post: requestBody: required: true @@ -7485,7 +7698,7 @@ paths: default: $ref: '#/components/responses/UnknownError' /setChatDescription: - description: 'Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.' + description: 'Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.' post: requestBody: required: true @@ -7563,7 +7776,7 @@ paths: default: $ref: '#/components/responses/UnknownError' /pinChatMessage: - description: 'Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the ''can_pin_messages'' admin right in a supergroup or ''can_edit_messages'' admin right in a channel. Returns True on success.' + description: 'Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the ''can_pin_messages'' administrator right in a supergroup or ''can_edit_messages'' administrator right in a channel. Returns True on success.' post: requestBody: required: true @@ -7650,7 +7863,7 @@ paths: default: $ref: '#/components/responses/UnknownError' /unpinChatMessage: - description: 'Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the ''can_pin_messages'' admin right in a supergroup or ''can_edit_messages'' admin right in a channel. Returns True on success.' + description: 'Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the ''can_pin_messages'' administrator right in a supergroup or ''can_edit_messages'' administrator right in a channel. Returns True on success.' post: requestBody: required: true @@ -7728,7 +7941,7 @@ paths: default: $ref: '#/components/responses/UnknownError' /unpinAllChatMessages: - description: 'Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the ''can_pin_messages'' admin right in a supergroup or ''can_edit_messages'' admin right in a channel. Returns True on success.' + description: 'Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the ''can_pin_messages'' administrator right in a supergroup or ''can_edit_messages'' administrator right in a channel. Returns True on success.' post: requestBody: required: true @@ -8171,7 +8384,7 @@ paths: default: $ref: '#/components/responses/UnknownError' /setChatStickerSet: - description: 'Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.' + description: 'Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.' post: requestBody: required: true @@ -8252,7 +8465,7 @@ paths: default: $ref: '#/components/responses/UnknownError' /deleteChatStickerSet: - description: 'Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.' + description: 'Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.' post: requestBody: required: true diff --git a/schemas/botapi_postman.json b/schemas/botapi_postman.json index 006167e..8412c17 100644 --- a/schemas/botapi_postman.json +++ b/schemas/botapi_postman.json @@ -3,7 +3,7 @@ "name": "Telegram Bot API", "description": "Auto-generated Postman collection by TGScraper.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "version": "5.3.0" + "version": "5.4.0" }, "variable": { "key": "token", @@ -1771,7 +1771,7 @@ { "key": "action", "disabled": false, - "description": "Required. Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_voice or upload_voice for voice notes, upload_document for general files, find_location for location data, record_video_note or upload_video_note for video notes.", + "description": "Required. Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_voice or upload_voice for voice notes, upload_document for general files, choose_sticker for stickers, find_location for location data, record_video_note or upload_video_note for video notes.", "type": "text" } ] @@ -1912,7 +1912,7 @@ "banChatMember" ] }, - "description": "Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success." + "description": "Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success." } }, { @@ -2004,7 +2004,7 @@ "restrictChatMember" ] }, - "description": "Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate admin rights. Pass True for all permissions to lift restrictions from a user. Returns True on success." + "description": "Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success." } }, { @@ -2107,7 +2107,7 @@ "promoteChatMember" ] }, - "description": "Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Pass False for all boolean parameters to demote a user. Returns True on success." + "description": "Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success." } }, { @@ -2187,7 +2187,7 @@ "setChatPermissions" ] }, - "description": "Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members admin rights. Returns True on success." + "description": "Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members administrator rights. Returns True on success." } }, { @@ -2218,7 +2218,7 @@ "exportChatInviteLink" ] }, - "description": "Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the new invite link as String on success." + "description": "Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success." } }, { @@ -2234,6 +2234,12 @@ "description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)", "type": "text" }, + { + "key": "name", + "disabled": true, + "description": "Optional. Invite link name; 0-32 characters", + "type": "text" + }, { "key": "expire_date", "disabled": true, @@ -2245,6 +2251,12 @@ "disabled": true, "description": "Optional. Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999", "type": "text" + }, + { + "key": "creates_join_request", + "disabled": true, + "description": "Optional. True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified", + "type": "text" } ] }, @@ -2261,7 +2273,7 @@ "createChatInviteLink" ] }, - "description": "Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object." + "description": "Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object." } }, { @@ -2283,6 +2295,12 @@ "description": "Required. The invite link to edit", "type": "text" }, + { + "key": "name", + "disabled": true, + "description": "Optional. Invite link name; 0-32 characters", + "type": "text" + }, { "key": "expire_date", "disabled": true, @@ -2294,6 +2312,12 @@ "disabled": true, "description": "Optional. Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999", "type": "text" + }, + { + "key": "creates_join_request", + "disabled": true, + "description": "Optional. True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified", + "type": "text" } ] }, @@ -2310,7 +2334,7 @@ "editChatInviteLink" ] }, - "description": "Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the edited invite link as a ChatInviteLink object." + "description": "Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object." } }, { @@ -2347,7 +2371,81 @@ "revokeChatInviteLink" ] }, - "description": "Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the revoked invite link as ChatInviteLink object." + "description": "Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object." + } + }, + { + "name": "approveChatJoinRequest", + "request": { + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "chat_id", + "disabled": false, + "description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)", + "type": "text" + }, + { + "key": "user_id", + "disabled": false, + "description": "Required. Unique identifier of the target user", + "type": "text" + } + ] + }, + "url": { + "raw": "https://api.telegram.org/bot{{token}}/approveChatJoinRequest", + "protocol": "https", + "host": [ + "api", + "telegram", + "org" + ], + "path": [ + "bot{{token}}", + "approveChatJoinRequest" + ] + }, + "description": "Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success." + } + }, + { + "name": "declineChatJoinRequest", + "request": { + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "chat_id", + "disabled": false, + "description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)", + "type": "text" + }, + { + "key": "user_id", + "disabled": false, + "description": "Required. Unique identifier of the target user", + "type": "text" + } + ] + }, + "url": { + "raw": "https://api.telegram.org/bot{{token}}/declineChatJoinRequest", + "protocol": "https", + "host": [ + "api", + "telegram", + "org" + ], + "path": [ + "bot{{token}}", + "declineChatJoinRequest" + ] + }, + "description": "Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success." } }, { @@ -2384,7 +2482,7 @@ "setChatPhoto" ] }, - "description": "Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success." + "description": "Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success." } }, { @@ -2415,7 +2513,7 @@ "deleteChatPhoto" ] }, - "description": "Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success." + "description": "Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success." } }, { @@ -2452,7 +2550,7 @@ "setChatTitle" ] }, - "description": "Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success." + "description": "Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success." } }, { @@ -2489,7 +2587,7 @@ "setChatDescription" ] }, - "description": "Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success." + "description": "Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success." } }, { @@ -2532,7 +2630,7 @@ "pinChatMessage" ] }, - "description": "Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns True on success." + "description": "Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success." } }, { @@ -2569,7 +2667,7 @@ "unpinChatMessage" ] }, - "description": "Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns True on success." + "description": "Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success." } }, { @@ -2600,7 +2698,7 @@ "unpinAllChatMessages" ] }, - "description": "Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns True on success." + "description": "Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success." } }, { @@ -2798,7 +2896,7 @@ "setChatStickerSet" ] }, - "description": "Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success." + "description": "Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success." } }, { @@ -2829,7 +2927,7 @@ "deleteChatStickerSet" ] }, - "description": "Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success." + "description": "Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success." } }, { @@ -2854,7 +2952,7 @@ { "key": "show_alert", "disabled": true, - "description": "Optional. If true, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false.", + "description": "Optional. If True, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false.", "type": "text" }, {