From e84c703bbfe748e227a59a0dbfff2b9829038690 Mon Sep 17 00:00:00 2001 From: GitHub Date: Thu, 31 Jul 2025 07:46:26 +0000 Subject: [PATCH] feat(schema): update documentation to the latest layer --- _schema/208.json | 80 +++++++++++++++++++++++++++++++--------- _schema/latest.json | 90 +++++++++++++++++++++++++++++++++------------ 2 files changed, 129 insertions(+), 41 deletions(-) diff --git a/_schema/208.json b/_schema/208.json index 0db3835..d8b5744 100644 --- a/_schema/208.json +++ b/_schema/208.json @@ -18833,7 +18833,11 @@ }, "report_delivery_until_date": { "name": "report_delivery_until_date", - "description": " " + "description": "Used for Telegram Gateway verification messages¹: if set and the current unixtime is bigger than the specified unixtime, invoke messages.reportMessagesDelivery² passing the ID and the peer of this message as soon as it is received by the client (optionally batching requests for the same peer).", + "links": [ + "https://telegram.org/blog/star-messages-gateway-2-0-and-more#save-even-more-on-user-verification", + "https://core.telegram.org/method/messages.reportMessagesDelivery" + ] }, "restriction_reason": { "name": "restriction_reason", @@ -21969,11 +21973,17 @@ }, "reactions": { "name": "reactions", - "description": " " + "description": "Reactions »¹.", + "links": [ + "https://core.telegram.org/api/reactions" + ] }, "reactions_are_possible": { "name": "reactions_are_possible", - "description": " " + "description": "Whether you can react to this messages »¹.", + "links": [ + "https://core.telegram.org/api/reactions" + ] }, "reply_to": { "name": "reply_to", @@ -42084,7 +42094,14 @@ ] }, "int256": { - "name": "int256" + "name": "int256", + "description": [ + "A basic bare type, the values of which correspond to a 256-bit integer.", + "More on basic types »¹" + ], + "links": [ + "https://core.telegram.org/mtproto/serialize" + ] }, "long": { "name": "long", @@ -44836,7 +44853,7 @@ }, "require_payment": { "name": "require_payment", - "description": "If set, requires the user to pay in order to send us messages (can only be used by monoforums, not users, i.e. parent_peer must be set if this flag is set; users must instead use the inputPrivacyKeyNoPaidMessages¹ privacy setting² to remove a previously added exemption). If not set, allows the user to send us messages without paying (can be used by both monoforums and users).", + "description": "If set, requires the user to pay in order to send us messages (can only be used by monoforums, not users, i.e. parent_peer must be set if this flag is set; users must instead use the inputPrivacyKeyNoPaidMessages¹ privacy setting² to remove a previously added exemption). If not set, allows the user to send us messages without paying (can be used by both monoforums and users).", "links": [ "https://core.telegram.org/constructor/inputPrivacyKeyNoPaidMessages", "https://core.telegram.org/api/privacy" @@ -47010,10 +47027,16 @@ }, "bots.getBotRecommendations": { "name": "bots.getBotRecommendations", + "description": [ + "Obtain a list of similarly themed bots, selected based on similarities in their subscriber bases, see here »¹ for more info." + ], + "links": [ + "https://core.telegram.org/api/recommend" + ], "parameters": { "bot": { "name": "bot", - "description": " " + "description": "The method will return bots related to the passed bot." } }, "errors": [ @@ -47474,18 +47497,27 @@ }, "bots.setCustomVerification": { "name": "bots.setCustomVerification", + "description": [ + "Verify a user or chat on behalf of an organization »¹." + ], + "links": [ + "https://core.telegram.org/api/bots/verification" + ], "parameters": { "bot": { "name": "bot", - "description": " " + "description": "Must not be set if invoked by a bot, must be set to the ID of an owned bot if invoked by a user." }, "custom_description": { "name": "custom_description", - "description": " " + "description": "Custom description for the verification, the UTF-8 length limit for this field is contained in bot_verification_description_length_limit »¹. If not set, Was verified by organization \"organization_name\" will be used as description.", + "links": [ + "https://core.telegram.org/api/config#bot-verification-description-length-limit" + ] }, "enabled": { "name": "enabled", - "description": " " + "description": "If set, adds the verification; otherwise removes verification." }, "flags": { "name": "flags", @@ -47496,7 +47528,7 @@ }, "peer": { "name": "peer", - "description": " " + "description": "The peer to verify" } }, "errors": [ @@ -59234,6 +59266,15 @@ }, "messages.reportMessagesDelivery": { "name": "messages.reportMessagesDelivery", + "description": [ + "Used for Telegram Gateway verification messages »¹: indicate to the server that one or more message²s were received by the client, if requested by the message³.report_delivery_until_date flag or the equivalent flag in push notifications⁴." + ], + "links": [ + "https://telegram.org/blog/star-messages-gateway-2-0-and-more#save-even-more-on-user-verification", + "https://core.telegram.org/constructor/message", + "https://core.telegram.org/constructor/message", + "https://core.telegram.org/api/push-updates" + ], "parameters": { "flags": { "name": "flags", @@ -59252,7 +59293,7 @@ }, "push": { "name": "push", - "description": " " + "description": "If set," } }, "errors": [ @@ -66338,10 +66379,13 @@ }, "phone.createConferenceCall": { "name": "phone.createConferenceCall", + "description": [ + "Create and optionally join a new conference call." + ], "parameters": { "block": { "name": "block", - "description": " " + "description": "Initial blockchain block (can only be used if join is set)." }, "flags": { "name": "flags", @@ -66352,27 +66396,27 @@ }, "join": { "name": "join", - "description": " " + "description": "If set, also join the call, otherwise just create the call link." }, "muted": { "name": "muted", - "description": " " + "description": "If set, mute our microphone when joining the call (can only be used if join is set)." }, "params": { "name": "params", - "description": " " + "description": "Parameters from tgcalls (can only be used if join is set)." }, "public_key": { "name": "public_key", - "description": " " + "description": "Public key (can only be used if join is set)." }, "random_id": { "name": "random_id", - "description": " " + "description": "Unique client message ID required to prevent creation of duplicate group calls." }, "video_stopped": { "name": "video_stopped", - "description": " " + "description": "If set, our video stream is disabled (can only be used if join is set)." } }, "bot_can_use": true diff --git a/_schema/latest.json b/_schema/latest.json index 59028eb..cfa7cbc 100644 --- a/_schema/latest.json +++ b/_schema/latest.json @@ -18833,7 +18833,11 @@ }, "report_delivery_until_date": { "name": "report_delivery_until_date", - "description": " " + "description": "Used for Telegram Gateway verification messages¹: if set and the current unixtime is bigger than the specified unixtime, invoke messages.reportMessagesDelivery² passing the ID and the peer of this message as soon as it is received by the client (optionally batching requests for the same peer).", + "links": [ + "https://telegram.org/blog/star-messages-gateway-2-0-and-more#save-even-more-on-user-verification", + "https://core.telegram.org/method/messages.reportMessagesDelivery" + ] }, "restriction_reason": { "name": "restriction_reason", @@ -21969,11 +21973,17 @@ }, "reactions": { "name": "reactions", - "description": " " + "description": "Reactions »¹.", + "links": [ + "https://core.telegram.org/api/reactions" + ] }, "reactions_are_possible": { "name": "reactions_are_possible", - "description": " " + "description": "Whether you can react to this messages »¹.", + "links": [ + "https://core.telegram.org/api/reactions" + ] }, "reply_to": { "name": "reply_to", @@ -42084,7 +42094,14 @@ ] }, "int256": { - "name": "int256" + "name": "int256", + "description": [ + "A basic bare type, the values of which correspond to a 256-bit integer.", + "More on basic types »¹" + ], + "links": [ + "https://core.telegram.org/mtproto/serialize" + ] }, "long": { "name": "long", @@ -44836,7 +44853,7 @@ }, "require_payment": { "name": "require_payment", - "description": "If set, requires the user to pay in order to send us messages (can only be used by monoforums, not users, i.e. parent_peer must be set if this flag is set; users must instead use the inputPrivacyKeyNoPaidMessages¹ privacy setting² to remove a previously added exemption). If not set, allows the user to send us messages without paying (can be used by both monoforums and users).", + "description": "If set, requires the user to pay in order to send us messages (can only be used by monoforums, not users, i.e. parent_peer must be set if this flag is set; users must instead use the inputPrivacyKeyNoPaidMessages¹ privacy setting² to remove a previously added exemption). If not set, allows the user to send us messages without paying (can be used by both monoforums and users).", "links": [ "https://core.telegram.org/constructor/inputPrivacyKeyNoPaidMessages", "https://core.telegram.org/api/privacy" @@ -47010,10 +47027,16 @@ }, "bots.getBotRecommendations": { "name": "bots.getBotRecommendations", + "description": [ + "Obtain a list of similarly themed bots, selected based on similarities in their subscriber bases, see here »¹ for more info." + ], + "links": [ + "https://core.telegram.org/api/recommend" + ], "parameters": { "bot": { "name": "bot", - "description": " " + "description": "The method will return bots related to the passed bot." } }, "errors": [ @@ -47474,18 +47497,27 @@ }, "bots.setCustomVerification": { "name": "bots.setCustomVerification", + "description": [ + "Verify a user or chat on behalf of an organization »¹." + ], + "links": [ + "https://core.telegram.org/api/bots/verification" + ], "parameters": { "bot": { "name": "bot", - "description": " " + "description": "Must not be set if invoked by a bot, must be set to the ID of an owned bot if invoked by a user." }, "custom_description": { "name": "custom_description", - "description": " " + "description": "Custom description for the verification, the UTF-8 length limit for this field is contained in bot_verification_description_length_limit »¹. If not set, Was verified by organization \"organization_name\" will be used as description.", + "links": [ + "https://core.telegram.org/api/config#bot-verification-description-length-limit" + ] }, "enabled": { "name": "enabled", - "description": " " + "description": "If set, adds the verification; otherwise removes verification." }, "flags": { "name": "flags", @@ -47496,7 +47528,7 @@ }, "peer": { "name": "peer", - "description": " " + "description": "The peer to verify" } }, "errors": [ @@ -59234,6 +59266,15 @@ }, "messages.reportMessagesDelivery": { "name": "messages.reportMessagesDelivery", + "description": [ + "Used for Telegram Gateway verification messages »¹: indicate to the server that one or more message²s were received by the client, if requested by the message³.report_delivery_until_date flag or the equivalent flag in push notifications⁴." + ], + "links": [ + "https://telegram.org/blog/star-messages-gateway-2-0-and-more#save-even-more-on-user-verification", + "https://core.telegram.org/constructor/message", + "https://core.telegram.org/constructor/message", + "https://core.telegram.org/api/push-updates" + ], "parameters": { "flags": { "name": "flags", @@ -59252,7 +59293,7 @@ }, "push": { "name": "push", - "description": " " + "description": "If set," } }, "errors": [ @@ -66338,10 +66379,13 @@ }, "phone.createConferenceCall": { "name": "phone.createConferenceCall", + "description": [ + "Create and optionally join a new conference call." + ], "parameters": { "block": { "name": "block", - "description": " " + "description": "Initial blockchain block (can only be used if join is set)." }, "flags": { "name": "flags", @@ -66352,27 +66396,27 @@ }, "join": { "name": "join", - "description": " " + "description": "If set, also join the call, otherwise just create the call link." }, "muted": { "name": "muted", - "description": " " + "description": "If set, mute our microphone when joining the call (can only be used if join is set)." }, "params": { "name": "params", - "description": " " + "description": "Parameters from tgcalls (can only be used if join is set)." }, "public_key": { "name": "public_key", - "description": " " + "description": "Public key (can only be used if join is set)." }, "random_id": { "name": "random_id", - "description": " " + "description": "Unique client message ID required to prevent creation of duplicate group calls." }, "video_stopped": { "name": "video_stopped", - "description": " " + "description": "If set, our video stream is disabled (can only be used if join is set)." } }, "bot_can_use": true @@ -72070,7 +72114,7 @@ "description": "The invite hash is empty." }, "INVITE_HASH_EXPIRED": { - "code": 406, + "code": 400, "type": "INVITE_HASH_EXPIRED", "description": "The invite link has expired." }, @@ -72410,7 +72454,7 @@ "description": "The specified participant ID is invalid." }, "PARTICIPANT_JOIN_MISSING": { - "code": 403, + "code": 400, "type": "PARTICIPANT_JOIN_MISSING", "description": "Trying to enable a presentation, when the user hasn't joined the Video Chat with phone.joinGroupCall." }, @@ -72550,7 +72594,7 @@ "description": "You asked for the code too many times." }, "PHONE_NUMBER_INVALID": { - "code": 400, + "code": 406, "type": "PHONE_NUMBER_INVALID", "description": "The phone number is invalid." }, @@ -73415,7 +73459,7 @@ "description": "You specified no topic IDs." }, "TOPIC_CLOSED": { - "code": 400, + "code": 406, "type": "TOPIC_CLOSED", "description": "This topic was closed, you can't send messages to it anymore." }, @@ -73425,7 +73469,7 @@ "description": "The close flag cannot be provided together with any of the other flags." }, "TOPIC_DELETED": { - "code": 400, + "code": 406, "type": "TOPIC_DELETED", "description": "The specified topic was deleted." },