From adcefaf43bb5a751df639989720d717df0e03c05 Mon Sep 17 00:00:00 2001 From: GitHub Date: Sat, 23 Dec 2023 07:54:44 +0000 Subject: [PATCH] feat(schema): update documentation to the latest layer --- _schema/167.json | 369 ++++++++++++++++++++++++++++++++++---------- _schema/latest.json | 369 ++++++++++++++++++++++++++++++++++---------- 2 files changed, 568 insertions(+), 170 deletions(-) diff --git a/_schema/167.json b/_schema/167.json index 97ac7a2..311d3f9 100644 --- a/_schema/167.json +++ b/_schema/167.json @@ -4424,7 +4424,7 @@ }, "reply_markup": { "name": "reply_markup", - "description": " " + "description": "Reply markup for sending bot buttons" }, "safe": { "name": "safe", @@ -4820,7 +4820,7 @@ }, "stories_unavailable": { "name": "stories_unavailable", - "description": " " + "description": "No stories from the channel are visible." }, "title": { "name": "title", @@ -6036,7 +6036,11 @@ }, "view_forum_as_messages": { "name": "view_forum_as_messages", - "description": " " + "description": "Users may also choose to display messages from all topics of a forum¹ as if they were sent to a normal group, using a \"View as messages\" setting in the local client. This setting only affects the current account, and is synced to other logged in sessions using the channels.toggleViewForumAsMessages² method; invoking this method will update the value of this flag.", + "links": [ + "https://core.telegram.org/api/forum", + "https://core.telegram.org/method/channels.toggleViewForumAsMessages" + ] } } }, @@ -8233,7 +8237,11 @@ }, "view_forum_as_messages": { "name": "view_forum_as_messages", - "description": " " + "description": "Users may also choose to display messages from all topics of a forum¹ as if they were sent to a normal group, using a \"View as messages\" setting in the local client. This setting only affects the current account, and is synced to other logged in sessions using the channels.toggleViewForumAsMessages² method; invoking this method will update the value of this flag.", + "links": [ + "https://core.telegram.org/api/forum", + "https://core.telegram.org/method/channels.toggleViewForumAsMessages" + ] } } }, @@ -11924,14 +11932,32 @@ }, "inputInvoicePremiumGiftCode": { "name": "inputInvoicePremiumGiftCode", + "description": [ + "Used if the user wishes to start a channel giveaway¹ or send some giftcodes² to members of a channel, in exchange for boosts³." + ], + "links": [ + "https://core.telegram.org/api/giveaways", + "https://core.telegram.org/api/giveaways", + "https://core.telegram.org/api/boost" + ], "fields": { "option": { "name": "option", - "description": " " + "description": "Should be populated with one of the giveaway options returned by payments.getPremiumGiftCodeOptions¹, see the giveaways »² documentation for more info.", + "links": [ + "https://core.telegram.org/method/payments.getPremiumGiftCodeOptions", + "https://core.telegram.org/api/giveaways" + ] }, "purpose": { "name": "purpose", - "description": " " + "description": "Should be populated with inputStorePaymentPremiumGiveaway¹ for giveaways² and inputStorePaymentPremiumGiftCode³ for gifts⁴.", + "links": [ + "https://core.telegram.org/constructor/inputStorePaymentPremiumGiveaway", + "https://core.telegram.org/api/giveaways", + "https://core.telegram.org/constructor/inputStorePaymentPremiumGiftCode", + "https://core.telegram.org/api/giveaways" + ] } } }, @@ -13824,18 +13850,36 @@ }, "inputStorePaymentPremiumGiftCode": { "name": "inputStorePaymentPremiumGiftCode", + "description": [ + "Used to gift Telegram Premium¹ subscriptions only to some specific subscribers of a channel or to some of our contacts, see here »² for more info on giveaways and gifts." + ], + "links": [ + "https://core.telegram.org/api/premium", + "https://core.telegram.org/api/giveaways" + ], "fields": { "amount": { "name": "amount", - "description": " " + "description": "Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json¹, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).", + "links": [ + "https://core.telegram.org/bots/payments/currencies.json" + ] }, "boost_peer": { "name": "boost_peer", - "description": " " + "description": "If set, the gifts will be sent on behalf of a channel we are an admin of, which will also assign some boosts¹ to it. Otherwise, the gift will be sent directly from the currently logged in users, and we will gain some extra boost slots². See here »³ for more info on giveaways and gifts.", + "links": [ + "https://core.telegram.org/api/boost", + "https://core.telegram.org/api/boost", + "https://core.telegram.org/api/giveaways" + ] }, "currency": { "name": "currency", - "description": " " + "description": "Three-letter ISO 4217 currency¹ code", + "links": [ + "https://core.telegram.org/bots/payments#supported-currencies" + ] }, "flags": { "name": "flags", @@ -13846,32 +13890,54 @@ }, "users": { "name": "users", - "description": " " + "description": "The users that will receive the Telegram Premium¹ subscriptions.", + "links": [ + "https://core.telegram.org/api/premium" + ] } } }, "inputStorePaymentPremiumGiveaway": { "name": "inputStorePaymentPremiumGiveaway", + "description": [ + "Used to pay for a giveaway, see here »¹ for more info." + ], + "links": [ + "https://core.telegram.org/api/giveaways" + ], "fields": { "additional_peers": { "name": "additional_peers", - "description": " " + "description": "Additional channels that the user must join to participate to the giveaway can be specified here." }, "amount": { "name": "amount", - "description": " " + "description": "Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json¹, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).", + "links": [ + "https://core.telegram.org/bots/payments/currencies.json" + ] }, "boost_peer": { "name": "boost_peer", - "description": " " + "description": "The channel starting the giveaway, that the user must join to participate, that will receive the giveaway boosts¹; see here »² for more info on giveaways.", + "links": [ + "https://core.telegram.org/api/boost", + "https://core.telegram.org/api/giveaways" + ] }, "countries_iso2": { "name": "countries_iso2", - "description": " " + "description": "The set of users that can participate to the giveaway can be restricted by passing here an explicit whitelist of up to giveaway_countries_max¹ countries, specified as two-letter ISO 3166-1 alpha-2 country codes.", + "links": [ + "https://core.telegram.org/api/config#giveaway-countries-max" + ] }, "currency": { "name": "currency", - "description": " " + "description": "Three-letter ISO 4217 currency¹ code", + "links": [ + "https://core.telegram.org/bots/payments#supported-currencies" + ] }, "flags": { "name": "flags", @@ -13882,15 +13948,19 @@ }, "only_new_subscribers": { "name": "only_new_subscribers", - "description": " " + "description": "If set, only new subscribers starting from the giveaway creation date will be able to participate to the giveaway." }, "random_id": { "name": "random_id", - "description": " " + "description": "Random ID to avoid resending the giveaway" }, "until_date": { "name": "until_date", - "description": " " + "description": "The end date of the giveaway, must be at most giveaway_period_max¹ seconds in the future; see here »² for more info on giveaways.", + "links": [ + "https://core.telegram.org/api/config#giveaway-period-max", + "https://core.telegram.org/api/giveaways" + ] } } }, @@ -15442,10 +15512,20 @@ }, "messageActionGiftCode": { "name": "messageActionGiftCode", + "description": [ + "Contains a Telegram Premium giftcode link¹." + ], + "links": [ + "https://core.telegram.org/api/links#premium-giftcode-links" + ], "fields": { "boost_peer": { "name": "boost_peer", - "description": " " + "description": "Identifier of the channel that created the gift code either directly or through a giveaway¹: if we import this giftcode link, we will also automatically boost² this channel.", + "links": [ + "https://core.telegram.org/api/giveaways", + "https://core.telegram.org/api/boost" + ] }, "flags": { "name": "flags", @@ -15456,19 +15536,31 @@ }, "months": { "name": "months", - "description": " " + "description": "Duration in months of the gifted Telegram Premium subscription¹.", + "links": [ + "https://core.telegram.org/api/premium" + ] }, "slug": { "name": "slug", - "description": " " + "description": "Slug of the Telegram Premium giftcode link¹", + "links": [ + "https://core.telegram.org/api/links#premium-giftcode-links" + ] }, "unclaimed": { "name": "unclaimed", - "description": " " + "description": "If set, the link was not redeemed¹ yet.", + "links": [ + "https://core.telegram.org/api/links#premium-giftcode-links" + ] }, "via_giveaway": { "name": "via_giveaway", - "description": " " + "description": "If set, this gift code was received from a giveaway »¹ started by a channel we're subscribed to.", + "links": [ + "https://core.telegram.org/api/giveaways" + ] } } }, @@ -15514,18 +15606,30 @@ } }, "messageActionGiveawayLaunch": { - "name": "messageActionGiveawayLaunch" + "name": "messageActionGiveawayLaunch", + "description": [ + "A giveaway¹ was started." + ], + "links": [ + "https://core.telegram.org/api/giveaways" + ] }, "messageActionGiveawayResults": { "name": "messageActionGiveawayResults", + "description": [ + "A giveaway¹ has ended." + ], + "links": [ + "https://core.telegram.org/api/giveaways" + ], "fields": { "unclaimed_count": { "name": "unclaimed_count", - "description": " " + "description": "Number of undistributed prizes" }, "winners_count": { "name": "winners_count", - "description": " " + "description": "Number of winners in the giveaway" } } }, @@ -16755,14 +16859,20 @@ }, "messageMediaGiveaway": { "name": "messageMediaGiveaway", + "description": [ + "Contains info about a giveaway, see here »¹ for more info." + ], + "links": [ + "https://core.telegram.org/api/giveaways" + ], "fields": { "channels": { "name": "channels", - "description": " " + "description": "The channels that the user must join to participate in the giveaway." }, "countries_iso2": { "name": "countries_iso2", - "description": " " + "description": "If set, only users residing in these countries can participate in the giveaway, (specified as a list of two-letter ISO 3166-1 alpha-2 country codes); otherwise there are no country-based limitations." }, "flags": { "name": "flags", @@ -16773,19 +16883,25 @@ }, "months": { "name": "months", - "description": " " + "description": "Duration in months of each Telegram Premium¹ subscription in the giveaway.", + "links": [ + "https://core.telegram.org/api/premium" + ] }, "only_new_subscribers": { "name": "only_new_subscribers", - "description": " " + "description": "If set, only new subscribers starting from the giveaway creation date will be able to participate to the giveaway." }, "quantity": { "name": "quantity", - "description": " " + "description": "Number of Telegram Premium¹ subscriptions given away.", + "links": [ + "https://core.telegram.org/api/premium" + ] }, "until_date": { "name": "until_date", - "description": " " + "description": "The end date of the giveaway." } } }, @@ -20091,14 +20207,20 @@ }, "payments.checkedGiftCode": { "name": "payments.checkedGiftCode", + "description": [ + "Contains info about a Telegram Premium giftcode link¹." + ], + "links": [ + "https://core.telegram.org/api/links#premium-giftcode-links" + ], "fields": { "chats": { "name": "chats", - "description": " " + "description": "Mentioned chats" }, "date": { "name": "date", - "description": " " + "description": "Creation date of the gift code." }, "flags": { "name": "flags", @@ -20109,31 +20231,37 @@ }, "from_id": { "name": "from_id", - "description": " " + "description": "The peer that created the gift code." }, "giveaway_msg_id": { "name": "giveaway_msg_id", - "description": " " + "description": "Message ID of the giveaway in the channel specified in from_id." }, "months": { "name": "months", - "description": " " + "description": "Duration in months of the gifted Telegram Premium¹ subscription.", + "links": [ + "https://core.telegram.org/api/premium" + ] }, "to_id": { "name": "to_id", - "description": " " + "description": "The destination user of the gift." }, "used_date": { "name": "used_date", - "description": " " + "description": "When was the giftcode imported, if it was imported." }, "users": { "name": "users", - "description": " " + "description": "Mentioned users" }, "via_giveaway": { "name": "via_giveaway", - "description": " " + "description": "Whether this giftcode was created by a giveaway¹.", + "links": [ + "https://core.telegram.org/api/giveaways" + ] } } }, @@ -20157,14 +20285,22 @@ }, "payments.giveawayInfo": { "name": "payments.giveawayInfo", + "description": [ + "Contains info about an ongoing giveaway¹.", + "If neither the participating, joined_too_early_date, admin_disallowed_chat_id or disallowed_country flags are set, the user is not currently participating in the giveaway but could participate by joining all the channels specified in the messageMediaGiveaway¹.channels field." + ], + "links": [ + "https://core.telegram.org/api/giveaways", + "https://core.telegram.org/constructor/messageMediaGiveaway" + ], "fields": { "admin_disallowed_chat_id": { "name": "admin_disallowed_chat_id", - "description": " " + "description": "If set, the current user can't participate in the giveaway, because they are an administrator in one of the channels (ID specified in this flag) that created the giveaway." }, "disallowed_country": { "name": "disallowed_country", - "description": " " + "description": "If set, the current user can't participate in this giveaway, because their phone number is from the specified disallowed country (specified as a two-letter ISO 3166-1 alpha-2 country code)." }, "flags": { "name": "flags", @@ -20175,32 +20311,41 @@ }, "joined_too_early_date": { "name": "joined_too_early_date", - "description": " " + "description": "The current user can't participate in the giveaway, because they were already a member of the channel when the giveaway started, and the only_new_subscribers was set when starting the giveaway." }, "participating": { "name": "participating", - "description": " " + "description": "The current user is participating in the giveaway." }, "preparing_results": { "name": "preparing_results", - "description": " " + "description": "If set, the giveaway has ended and the results are being prepared." }, "start_date": { "name": "start_date", - "description": " " + "description": "When was the giveaway started" } } }, "payments.giveawayInfoResults": { "name": "payments.giveawayInfoResults", + "description": [ + "A giveaway¹ has ended." + ], + "links": [ + "https://core.telegram.org/api/giveaways" + ], "fields": { "activated_count": { "name": "activated_count", - "description": " " + "description": "Number of winners, which activated their gift codes¹.", + "links": [ + "https://core.telegram.org/api/links#premium-giftcode-links" + ] }, "finish_date": { "name": "finish_date", - "description": " " + "description": "End date of the giveaway. May be bigger than the end date specified in parameters of the giveaway." }, "flags": { "name": "flags", @@ -20211,23 +20356,27 @@ }, "gift_code_slug": { "name": "gift_code_slug", - "description": " " + "description": "If we're one of the winners of this giveaway, contains the Premium gift code¹, see here »² for more info on the full giveaway flow.", + "links": [ + "https://core.telegram.org/api/links#premium-giftcode-links", + "https://core.telegram.org/api/giveaways" + ] }, "refunded": { "name": "refunded", - "description": " " + "description": "Whether the giveaway was canceled and was fully refunded." }, "start_date": { "name": "start_date", - "description": " " + "description": "Start date of the giveaway" }, "winner": { "name": "winner", - "description": " " + "description": "Whether we're one of the winners of this giveaway." }, "winners_count": { "name": "winners_count", - "description": " " + "description": "Number of winners in the giveaway" } } }, @@ -21920,14 +22069,26 @@ }, "premiumGiftCodeOption": { "name": "premiumGiftCodeOption", + "description": [ + "Contains info about a giveaway/gift¹ option." + ], + "links": [ + "https://core.telegram.org/api/giveaways" + ], "fields": { "amount": { "name": "amount", - "description": " " + "description": "Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json¹, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).", + "links": [ + "https://core.telegram.org/bots/payments/currencies.json" + ] }, "currency": { "name": "currency", - "description": " " + "description": "Three-letter ISO 4217 currency¹ code", + "links": [ + "https://core.telegram.org/bots/payments#supported-currencies" + ] }, "flags": { "name": "flags", @@ -21938,19 +22099,22 @@ }, "months": { "name": "months", - "description": " " + "description": "Duration in months of each gifted Telegram Premium¹ subscription.", + "links": [ + "https://core.telegram.org/api/premium" + ] }, "store_product": { "name": "store_product", - "description": " " + "description": "Identifier of the store product associated with the option, official apps only." }, "store_quantity": { "name": "store_quantity", - "description": " " + "description": "Number of times the store product must be paid" }, "users": { "name": "users", - "description": " " + "description": "Number of users which will be able to activate the gift codes." } } }, @@ -22056,22 +22220,34 @@ }, "prepaidGiveaway": { "name": "prepaidGiveaway", + "description": [ + "Contains info about a prepaid giveaway »¹." + ], + "links": [ + "https://core.telegram.org/api/giveaways" + ], "fields": { "date": { "name": "date", - "description": " " + "description": "Payment date." }, "id": { "name": "id", - "description": " " + "description": "Prepaid giveaway ID." }, "months": { "name": "months", - "description": " " + "description": "Duration in months of each gifted Telegram Premium¹ subscription.", + "links": [ + "https://core.telegram.org/api/premium" + ] }, "quantity": { "name": "quantity", - "description": " " + "description": "Number of given away Telegram Premium¹ subscriptions.", + "links": [ + "https://core.telegram.org/api/premium" + ] } } }, @@ -23756,35 +23932,35 @@ }, "reactions_by_emotion_graph": { "name": "reactions_by_emotion_graph", - "description": " " + "description": "A graph containing the number of reactions on posts categorized by emotion" }, "reactions_per_post": { "name": "reactions_per_post", - "description": " " + "description": "total_reactions/postcount, for posts posted during the period in consideration. Note that in this case, current refers to the period in consideration (min_date till max_date), and prev refers to the previous period ((min_date - (max_date - min_date)) till min_date)" }, "reactions_per_story": { "name": "reactions_per_story", - "description": " " + "description": "total_reactions/storycount, for posts posted during the period in consideration. Note that in this case, current refers to the period in consideration (min_date till max_date), and prev refers to the previous period ((min_date - (max_date - min_date)) till min_date)" }, "recent_posts_interactions": { "name": "recent_posts_interactions", - "description": " " + "description": "Detailed statistics about number of views and shares of recently sent messages and stories" }, "shares_per_post": { "name": "shares_per_post", - "description": "total_viewcount/postcount, for posts posted during the period in consideration (views_per_post). Note that in this case, current refers to the period in consideration (min_date till max_date), and prev refers to the previous period ((min_date - (max_date - min_date)) till min_date)" + "description": "total_sharecount/postcount, for posts posted during the period in consideration. Note that in this case, current refers to the period in consideration (min_date till max_date), and prev refers to the previous period ((min_date - (max_date - min_date)) till min_date)" }, "shares_per_story": { "name": "shares_per_story", - "description": " " + "description": "total_shares/storycount, for posts posted during the period in consideration. Note that in this case, current refers to the period in consideration (min_date till max_date), and prev refers to the previous period ((min_date - (max_date - min_date)) till min_date)" }, "story_interactions_graph": { "name": "story_interactions_graph", - "description": " " + "description": "A graph containing the number of story views and shares" }, "story_reactions_by_emotion_graph": { "name": "story_reactions_by_emotion_graph", - "description": " " + "description": "A graph containing the number of reactions on stories categorized by emotion" }, "top_hours_graph": { "name": "top_hours_graph", @@ -23796,11 +23972,11 @@ }, "views_per_post": { "name": "views_per_post", - "description": "total_viewcount/postcount, for posts posted during the period in consideration (views_per_post). Note that in this case, current refers to the period in consideration (min_date till max_date), and prev refers to the previous period ((min_date - (max_date - min_date)) till min_date)." + "description": "total_viewcount/postcount, for posts posted during the period in consideration. Note that in this case, current refers to the period in consideration (min_date till max_date), and prev refers to the previous period ((min_date - (max_date - min_date)) till min_date)." }, "views_per_story": { "name": "views_per_story", - "description": " " + "description": "total_views/storycount, for posts posted during the period in consideration. Note that in this case, current refers to the period in consideration (min_date till max_date), and prev refers to the previous period ((min_date - (max_date - min_date)) till min_date)" } } }, @@ -23891,7 +24067,7 @@ "fields": { "reactions_by_emotion_graph": { "name": "reactions_by_emotion_graph", - "description": " " + "description": "A graph containing the number of reactions on stories categorized by emotion" }, "views_graph": { "name": "views_graph", @@ -23910,7 +24086,7 @@ "fields": { "chats": { "name": "chats", - "description": " " + "description": "Mentioned chats" }, "count": { "name": "count", @@ -23936,7 +24112,7 @@ }, "users": { "name": "users", - "description": " " + "description": "Mentioned users" } } }, @@ -26032,14 +26208,24 @@ }, "updateChannelViewForumAsMessages": { "name": "updateChannelViewForumAsMessages", + "description": [ + "Users may also choose to display messages from all topics as if they were sent to a normal group, using a \"View as messages\" setting in the local client.", + "This setting only affects the current account, and is synced to other logged in sessions using the channels.toggleViewForumAsMessages¹ method; invoking this method will update the value of the view_forum_as_messages flag of channelFull² or dialog³ and emit an updateChannelViewForumAsMessages⁴." + ], + "links": [ + "https://core.telegram.org/method/channels.toggleViewForumAsMessages", + "https://core.telegram.org/constructor/channelFull", + "https://core.telegram.org/constructor/dialog", + "https://core.telegram.org/constructor/updateChannelViewForumAsMessages" + ], "fields": { "channel_id": { "name": "channel_id", - "description": " " + "description": "The forum ID" }, "enabled": { "name": "enabled", - "description": " " + "description": "The new value of the toggle." } } }, @@ -27709,7 +27895,7 @@ "fields": { "date": { "name": "date", - "description": " " + "description": "When was the last message in messages marked as read." }, "flags": { "name": "flags", @@ -29117,7 +29303,7 @@ }, "stories_unavailable": { "name": "stories_unavailable", - "description": " " + "description": "No stories from this user are visible." }, "support": { "name": "support", @@ -39560,14 +39746,24 @@ }, "channels.toggleViewForumAsMessages": { "name": "channels.toggleViewForumAsMessages", + "description": [ + "Users may also choose to display messages from all topics of a forum¹ as if they were sent to a normal group, using a \"View as messages\" setting in the local client: this setting only affects the current account, and is synced to other logged in sessions using this method.", + "Invoking this method will update the value of the view_forum_as_messages flag of channelFull¹ or dialog² and emit an updateChannelViewForumAsMessages³." + ], + "links": [ + "https://core.telegram.org/api/forum", + "https://core.telegram.org/constructor/channelFull", + "https://core.telegram.org/constructor/dialog", + "https://core.telegram.org/constructor/updateChannelViewForumAsMessages" + ], "parameters": { "channel": { "name": "channel", - "description": " " + "description": "The forum" }, "enabled": { "name": "enabled", - "description": " " + "description": "The new value of the view_forum_as_messages flag." } }, "errors": [ @@ -52617,7 +52813,7 @@ "premium.getBoostsStatus": { "name": "premium.getBoostsStatus", "description": [ - "Gets the current boost status¹ of a peer." + "Gets the current number of boosts¹ of a channel." ], "links": [ "https://core.telegram.org/api/boost" @@ -53733,10 +53929,13 @@ }, "stories.getPeerMaxIDs": { "name": "stories.getPeerMaxIDs", + "description": [ + "Get the IDs of the maximum read stories for a set of peers." + ], "parameters": { "id": { "name": "id", - "description": " " + "description": "Peers" } } }, diff --git a/_schema/latest.json b/_schema/latest.json index 97ac7a2..311d3f9 100644 --- a/_schema/latest.json +++ b/_schema/latest.json @@ -4424,7 +4424,7 @@ }, "reply_markup": { "name": "reply_markup", - "description": " " + "description": "Reply markup for sending bot buttons" }, "safe": { "name": "safe", @@ -4820,7 +4820,7 @@ }, "stories_unavailable": { "name": "stories_unavailable", - "description": " " + "description": "No stories from the channel are visible." }, "title": { "name": "title", @@ -6036,7 +6036,11 @@ }, "view_forum_as_messages": { "name": "view_forum_as_messages", - "description": " " + "description": "Users may also choose to display messages from all topics of a forum¹ as if they were sent to a normal group, using a \"View as messages\" setting in the local client. This setting only affects the current account, and is synced to other logged in sessions using the channels.toggleViewForumAsMessages² method; invoking this method will update the value of this flag.", + "links": [ + "https://core.telegram.org/api/forum", + "https://core.telegram.org/method/channels.toggleViewForumAsMessages" + ] } } }, @@ -8233,7 +8237,11 @@ }, "view_forum_as_messages": { "name": "view_forum_as_messages", - "description": " " + "description": "Users may also choose to display messages from all topics of a forum¹ as if they were sent to a normal group, using a \"View as messages\" setting in the local client. This setting only affects the current account, and is synced to other logged in sessions using the channels.toggleViewForumAsMessages² method; invoking this method will update the value of this flag.", + "links": [ + "https://core.telegram.org/api/forum", + "https://core.telegram.org/method/channels.toggleViewForumAsMessages" + ] } } }, @@ -11924,14 +11932,32 @@ }, "inputInvoicePremiumGiftCode": { "name": "inputInvoicePremiumGiftCode", + "description": [ + "Used if the user wishes to start a channel giveaway¹ or send some giftcodes² to members of a channel, in exchange for boosts³." + ], + "links": [ + "https://core.telegram.org/api/giveaways", + "https://core.telegram.org/api/giveaways", + "https://core.telegram.org/api/boost" + ], "fields": { "option": { "name": "option", - "description": " " + "description": "Should be populated with one of the giveaway options returned by payments.getPremiumGiftCodeOptions¹, see the giveaways »² documentation for more info.", + "links": [ + "https://core.telegram.org/method/payments.getPremiumGiftCodeOptions", + "https://core.telegram.org/api/giveaways" + ] }, "purpose": { "name": "purpose", - "description": " " + "description": "Should be populated with inputStorePaymentPremiumGiveaway¹ for giveaways² and inputStorePaymentPremiumGiftCode³ for gifts⁴.", + "links": [ + "https://core.telegram.org/constructor/inputStorePaymentPremiumGiveaway", + "https://core.telegram.org/api/giveaways", + "https://core.telegram.org/constructor/inputStorePaymentPremiumGiftCode", + "https://core.telegram.org/api/giveaways" + ] } } }, @@ -13824,18 +13850,36 @@ }, "inputStorePaymentPremiumGiftCode": { "name": "inputStorePaymentPremiumGiftCode", + "description": [ + "Used to gift Telegram Premium¹ subscriptions only to some specific subscribers of a channel or to some of our contacts, see here »² for more info on giveaways and gifts." + ], + "links": [ + "https://core.telegram.org/api/premium", + "https://core.telegram.org/api/giveaways" + ], "fields": { "amount": { "name": "amount", - "description": " " + "description": "Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json¹, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).", + "links": [ + "https://core.telegram.org/bots/payments/currencies.json" + ] }, "boost_peer": { "name": "boost_peer", - "description": " " + "description": "If set, the gifts will be sent on behalf of a channel we are an admin of, which will also assign some boosts¹ to it. Otherwise, the gift will be sent directly from the currently logged in users, and we will gain some extra boost slots². See here »³ for more info on giveaways and gifts.", + "links": [ + "https://core.telegram.org/api/boost", + "https://core.telegram.org/api/boost", + "https://core.telegram.org/api/giveaways" + ] }, "currency": { "name": "currency", - "description": " " + "description": "Three-letter ISO 4217 currency¹ code", + "links": [ + "https://core.telegram.org/bots/payments#supported-currencies" + ] }, "flags": { "name": "flags", @@ -13846,32 +13890,54 @@ }, "users": { "name": "users", - "description": " " + "description": "The users that will receive the Telegram Premium¹ subscriptions.", + "links": [ + "https://core.telegram.org/api/premium" + ] } } }, "inputStorePaymentPremiumGiveaway": { "name": "inputStorePaymentPremiumGiveaway", + "description": [ + "Used to pay for a giveaway, see here »¹ for more info." + ], + "links": [ + "https://core.telegram.org/api/giveaways" + ], "fields": { "additional_peers": { "name": "additional_peers", - "description": " " + "description": "Additional channels that the user must join to participate to the giveaway can be specified here." }, "amount": { "name": "amount", - "description": " " + "description": "Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json¹, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).", + "links": [ + "https://core.telegram.org/bots/payments/currencies.json" + ] }, "boost_peer": { "name": "boost_peer", - "description": " " + "description": "The channel starting the giveaway, that the user must join to participate, that will receive the giveaway boosts¹; see here »² for more info on giveaways.", + "links": [ + "https://core.telegram.org/api/boost", + "https://core.telegram.org/api/giveaways" + ] }, "countries_iso2": { "name": "countries_iso2", - "description": " " + "description": "The set of users that can participate to the giveaway can be restricted by passing here an explicit whitelist of up to giveaway_countries_max¹ countries, specified as two-letter ISO 3166-1 alpha-2 country codes.", + "links": [ + "https://core.telegram.org/api/config#giveaway-countries-max" + ] }, "currency": { "name": "currency", - "description": " " + "description": "Three-letter ISO 4217 currency¹ code", + "links": [ + "https://core.telegram.org/bots/payments#supported-currencies" + ] }, "flags": { "name": "flags", @@ -13882,15 +13948,19 @@ }, "only_new_subscribers": { "name": "only_new_subscribers", - "description": " " + "description": "If set, only new subscribers starting from the giveaway creation date will be able to participate to the giveaway." }, "random_id": { "name": "random_id", - "description": " " + "description": "Random ID to avoid resending the giveaway" }, "until_date": { "name": "until_date", - "description": " " + "description": "The end date of the giveaway, must be at most giveaway_period_max¹ seconds in the future; see here »² for more info on giveaways.", + "links": [ + "https://core.telegram.org/api/config#giveaway-period-max", + "https://core.telegram.org/api/giveaways" + ] } } }, @@ -15442,10 +15512,20 @@ }, "messageActionGiftCode": { "name": "messageActionGiftCode", + "description": [ + "Contains a Telegram Premium giftcode link¹." + ], + "links": [ + "https://core.telegram.org/api/links#premium-giftcode-links" + ], "fields": { "boost_peer": { "name": "boost_peer", - "description": " " + "description": "Identifier of the channel that created the gift code either directly or through a giveaway¹: if we import this giftcode link, we will also automatically boost² this channel.", + "links": [ + "https://core.telegram.org/api/giveaways", + "https://core.telegram.org/api/boost" + ] }, "flags": { "name": "flags", @@ -15456,19 +15536,31 @@ }, "months": { "name": "months", - "description": " " + "description": "Duration in months of the gifted Telegram Premium subscription¹.", + "links": [ + "https://core.telegram.org/api/premium" + ] }, "slug": { "name": "slug", - "description": " " + "description": "Slug of the Telegram Premium giftcode link¹", + "links": [ + "https://core.telegram.org/api/links#premium-giftcode-links" + ] }, "unclaimed": { "name": "unclaimed", - "description": " " + "description": "If set, the link was not redeemed¹ yet.", + "links": [ + "https://core.telegram.org/api/links#premium-giftcode-links" + ] }, "via_giveaway": { "name": "via_giveaway", - "description": " " + "description": "If set, this gift code was received from a giveaway »¹ started by a channel we're subscribed to.", + "links": [ + "https://core.telegram.org/api/giveaways" + ] } } }, @@ -15514,18 +15606,30 @@ } }, "messageActionGiveawayLaunch": { - "name": "messageActionGiveawayLaunch" + "name": "messageActionGiveawayLaunch", + "description": [ + "A giveaway¹ was started." + ], + "links": [ + "https://core.telegram.org/api/giveaways" + ] }, "messageActionGiveawayResults": { "name": "messageActionGiveawayResults", + "description": [ + "A giveaway¹ has ended." + ], + "links": [ + "https://core.telegram.org/api/giveaways" + ], "fields": { "unclaimed_count": { "name": "unclaimed_count", - "description": " " + "description": "Number of undistributed prizes" }, "winners_count": { "name": "winners_count", - "description": " " + "description": "Number of winners in the giveaway" } } }, @@ -16755,14 +16859,20 @@ }, "messageMediaGiveaway": { "name": "messageMediaGiveaway", + "description": [ + "Contains info about a giveaway, see here »¹ for more info." + ], + "links": [ + "https://core.telegram.org/api/giveaways" + ], "fields": { "channels": { "name": "channels", - "description": " " + "description": "The channels that the user must join to participate in the giveaway." }, "countries_iso2": { "name": "countries_iso2", - "description": " " + "description": "If set, only users residing in these countries can participate in the giveaway, (specified as a list of two-letter ISO 3166-1 alpha-2 country codes); otherwise there are no country-based limitations." }, "flags": { "name": "flags", @@ -16773,19 +16883,25 @@ }, "months": { "name": "months", - "description": " " + "description": "Duration in months of each Telegram Premium¹ subscription in the giveaway.", + "links": [ + "https://core.telegram.org/api/premium" + ] }, "only_new_subscribers": { "name": "only_new_subscribers", - "description": " " + "description": "If set, only new subscribers starting from the giveaway creation date will be able to participate to the giveaway." }, "quantity": { "name": "quantity", - "description": " " + "description": "Number of Telegram Premium¹ subscriptions given away.", + "links": [ + "https://core.telegram.org/api/premium" + ] }, "until_date": { "name": "until_date", - "description": " " + "description": "The end date of the giveaway." } } }, @@ -20091,14 +20207,20 @@ }, "payments.checkedGiftCode": { "name": "payments.checkedGiftCode", + "description": [ + "Contains info about a Telegram Premium giftcode link¹." + ], + "links": [ + "https://core.telegram.org/api/links#premium-giftcode-links" + ], "fields": { "chats": { "name": "chats", - "description": " " + "description": "Mentioned chats" }, "date": { "name": "date", - "description": " " + "description": "Creation date of the gift code." }, "flags": { "name": "flags", @@ -20109,31 +20231,37 @@ }, "from_id": { "name": "from_id", - "description": " " + "description": "The peer that created the gift code." }, "giveaway_msg_id": { "name": "giveaway_msg_id", - "description": " " + "description": "Message ID of the giveaway in the channel specified in from_id." }, "months": { "name": "months", - "description": " " + "description": "Duration in months of the gifted Telegram Premium¹ subscription.", + "links": [ + "https://core.telegram.org/api/premium" + ] }, "to_id": { "name": "to_id", - "description": " " + "description": "The destination user of the gift." }, "used_date": { "name": "used_date", - "description": " " + "description": "When was the giftcode imported, if it was imported." }, "users": { "name": "users", - "description": " " + "description": "Mentioned users" }, "via_giveaway": { "name": "via_giveaway", - "description": " " + "description": "Whether this giftcode was created by a giveaway¹.", + "links": [ + "https://core.telegram.org/api/giveaways" + ] } } }, @@ -20157,14 +20285,22 @@ }, "payments.giveawayInfo": { "name": "payments.giveawayInfo", + "description": [ + "Contains info about an ongoing giveaway¹.", + "If neither the participating, joined_too_early_date, admin_disallowed_chat_id or disallowed_country flags are set, the user is not currently participating in the giveaway but could participate by joining all the channels specified in the messageMediaGiveaway¹.channels field." + ], + "links": [ + "https://core.telegram.org/api/giveaways", + "https://core.telegram.org/constructor/messageMediaGiveaway" + ], "fields": { "admin_disallowed_chat_id": { "name": "admin_disallowed_chat_id", - "description": " " + "description": "If set, the current user can't participate in the giveaway, because they are an administrator in one of the channels (ID specified in this flag) that created the giveaway." }, "disallowed_country": { "name": "disallowed_country", - "description": " " + "description": "If set, the current user can't participate in this giveaway, because their phone number is from the specified disallowed country (specified as a two-letter ISO 3166-1 alpha-2 country code)." }, "flags": { "name": "flags", @@ -20175,32 +20311,41 @@ }, "joined_too_early_date": { "name": "joined_too_early_date", - "description": " " + "description": "The current user can't participate in the giveaway, because they were already a member of the channel when the giveaway started, and the only_new_subscribers was set when starting the giveaway." }, "participating": { "name": "participating", - "description": " " + "description": "The current user is participating in the giveaway." }, "preparing_results": { "name": "preparing_results", - "description": " " + "description": "If set, the giveaway has ended and the results are being prepared." }, "start_date": { "name": "start_date", - "description": " " + "description": "When was the giveaway started" } } }, "payments.giveawayInfoResults": { "name": "payments.giveawayInfoResults", + "description": [ + "A giveaway¹ has ended." + ], + "links": [ + "https://core.telegram.org/api/giveaways" + ], "fields": { "activated_count": { "name": "activated_count", - "description": " " + "description": "Number of winners, which activated their gift codes¹.", + "links": [ + "https://core.telegram.org/api/links#premium-giftcode-links" + ] }, "finish_date": { "name": "finish_date", - "description": " " + "description": "End date of the giveaway. May be bigger than the end date specified in parameters of the giveaway." }, "flags": { "name": "flags", @@ -20211,23 +20356,27 @@ }, "gift_code_slug": { "name": "gift_code_slug", - "description": " " + "description": "If we're one of the winners of this giveaway, contains the Premium gift code¹, see here »² for more info on the full giveaway flow.", + "links": [ + "https://core.telegram.org/api/links#premium-giftcode-links", + "https://core.telegram.org/api/giveaways" + ] }, "refunded": { "name": "refunded", - "description": " " + "description": "Whether the giveaway was canceled and was fully refunded." }, "start_date": { "name": "start_date", - "description": " " + "description": "Start date of the giveaway" }, "winner": { "name": "winner", - "description": " " + "description": "Whether we're one of the winners of this giveaway." }, "winners_count": { "name": "winners_count", - "description": " " + "description": "Number of winners in the giveaway" } } }, @@ -21920,14 +22069,26 @@ }, "premiumGiftCodeOption": { "name": "premiumGiftCodeOption", + "description": [ + "Contains info about a giveaway/gift¹ option." + ], + "links": [ + "https://core.telegram.org/api/giveaways" + ], "fields": { "amount": { "name": "amount", - "description": " " + "description": "Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json¹, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).", + "links": [ + "https://core.telegram.org/bots/payments/currencies.json" + ] }, "currency": { "name": "currency", - "description": " " + "description": "Three-letter ISO 4217 currency¹ code", + "links": [ + "https://core.telegram.org/bots/payments#supported-currencies" + ] }, "flags": { "name": "flags", @@ -21938,19 +22099,22 @@ }, "months": { "name": "months", - "description": " " + "description": "Duration in months of each gifted Telegram Premium¹ subscription.", + "links": [ + "https://core.telegram.org/api/premium" + ] }, "store_product": { "name": "store_product", - "description": " " + "description": "Identifier of the store product associated with the option, official apps only." }, "store_quantity": { "name": "store_quantity", - "description": " " + "description": "Number of times the store product must be paid" }, "users": { "name": "users", - "description": " " + "description": "Number of users which will be able to activate the gift codes." } } }, @@ -22056,22 +22220,34 @@ }, "prepaidGiveaway": { "name": "prepaidGiveaway", + "description": [ + "Contains info about a prepaid giveaway »¹." + ], + "links": [ + "https://core.telegram.org/api/giveaways" + ], "fields": { "date": { "name": "date", - "description": " " + "description": "Payment date." }, "id": { "name": "id", - "description": " " + "description": "Prepaid giveaway ID." }, "months": { "name": "months", - "description": " " + "description": "Duration in months of each gifted Telegram Premium¹ subscription.", + "links": [ + "https://core.telegram.org/api/premium" + ] }, "quantity": { "name": "quantity", - "description": " " + "description": "Number of given away Telegram Premium¹ subscriptions.", + "links": [ + "https://core.telegram.org/api/premium" + ] } } }, @@ -23756,35 +23932,35 @@ }, "reactions_by_emotion_graph": { "name": "reactions_by_emotion_graph", - "description": " " + "description": "A graph containing the number of reactions on posts categorized by emotion" }, "reactions_per_post": { "name": "reactions_per_post", - "description": " " + "description": "total_reactions/postcount, for posts posted during the period in consideration. Note that in this case, current refers to the period in consideration (min_date till max_date), and prev refers to the previous period ((min_date - (max_date - min_date)) till min_date)" }, "reactions_per_story": { "name": "reactions_per_story", - "description": " " + "description": "total_reactions/storycount, for posts posted during the period in consideration. Note that in this case, current refers to the period in consideration (min_date till max_date), and prev refers to the previous period ((min_date - (max_date - min_date)) till min_date)" }, "recent_posts_interactions": { "name": "recent_posts_interactions", - "description": " " + "description": "Detailed statistics about number of views and shares of recently sent messages and stories" }, "shares_per_post": { "name": "shares_per_post", - "description": "total_viewcount/postcount, for posts posted during the period in consideration (views_per_post). Note that in this case, current refers to the period in consideration (min_date till max_date), and prev refers to the previous period ((min_date - (max_date - min_date)) till min_date)" + "description": "total_sharecount/postcount, for posts posted during the period in consideration. Note that in this case, current refers to the period in consideration (min_date till max_date), and prev refers to the previous period ((min_date - (max_date - min_date)) till min_date)" }, "shares_per_story": { "name": "shares_per_story", - "description": " " + "description": "total_shares/storycount, for posts posted during the period in consideration. Note that in this case, current refers to the period in consideration (min_date till max_date), and prev refers to the previous period ((min_date - (max_date - min_date)) till min_date)" }, "story_interactions_graph": { "name": "story_interactions_graph", - "description": " " + "description": "A graph containing the number of story views and shares" }, "story_reactions_by_emotion_graph": { "name": "story_reactions_by_emotion_graph", - "description": " " + "description": "A graph containing the number of reactions on stories categorized by emotion" }, "top_hours_graph": { "name": "top_hours_graph", @@ -23796,11 +23972,11 @@ }, "views_per_post": { "name": "views_per_post", - "description": "total_viewcount/postcount, for posts posted during the period in consideration (views_per_post). Note that in this case, current refers to the period in consideration (min_date till max_date), and prev refers to the previous period ((min_date - (max_date - min_date)) till min_date)." + "description": "total_viewcount/postcount, for posts posted during the period in consideration. Note that in this case, current refers to the period in consideration (min_date till max_date), and prev refers to the previous period ((min_date - (max_date - min_date)) till min_date)." }, "views_per_story": { "name": "views_per_story", - "description": " " + "description": "total_views/storycount, for posts posted during the period in consideration. Note that in this case, current refers to the period in consideration (min_date till max_date), and prev refers to the previous period ((min_date - (max_date - min_date)) till min_date)" } } }, @@ -23891,7 +24067,7 @@ "fields": { "reactions_by_emotion_graph": { "name": "reactions_by_emotion_graph", - "description": " " + "description": "A graph containing the number of reactions on stories categorized by emotion" }, "views_graph": { "name": "views_graph", @@ -23910,7 +24086,7 @@ "fields": { "chats": { "name": "chats", - "description": " " + "description": "Mentioned chats" }, "count": { "name": "count", @@ -23936,7 +24112,7 @@ }, "users": { "name": "users", - "description": " " + "description": "Mentioned users" } } }, @@ -26032,14 +26208,24 @@ }, "updateChannelViewForumAsMessages": { "name": "updateChannelViewForumAsMessages", + "description": [ + "Users may also choose to display messages from all topics as if they were sent to a normal group, using a \"View as messages\" setting in the local client.", + "This setting only affects the current account, and is synced to other logged in sessions using the channels.toggleViewForumAsMessages¹ method; invoking this method will update the value of the view_forum_as_messages flag of channelFull² or dialog³ and emit an updateChannelViewForumAsMessages⁴." + ], + "links": [ + "https://core.telegram.org/method/channels.toggleViewForumAsMessages", + "https://core.telegram.org/constructor/channelFull", + "https://core.telegram.org/constructor/dialog", + "https://core.telegram.org/constructor/updateChannelViewForumAsMessages" + ], "fields": { "channel_id": { "name": "channel_id", - "description": " " + "description": "The forum ID" }, "enabled": { "name": "enabled", - "description": " " + "description": "The new value of the toggle." } } }, @@ -27709,7 +27895,7 @@ "fields": { "date": { "name": "date", - "description": " " + "description": "When was the last message in messages marked as read." }, "flags": { "name": "flags", @@ -29117,7 +29303,7 @@ }, "stories_unavailable": { "name": "stories_unavailable", - "description": " " + "description": "No stories from this user are visible." }, "support": { "name": "support", @@ -39560,14 +39746,24 @@ }, "channels.toggleViewForumAsMessages": { "name": "channels.toggleViewForumAsMessages", + "description": [ + "Users may also choose to display messages from all topics of a forum¹ as if they were sent to a normal group, using a \"View as messages\" setting in the local client: this setting only affects the current account, and is synced to other logged in sessions using this method.", + "Invoking this method will update the value of the view_forum_as_messages flag of channelFull¹ or dialog² and emit an updateChannelViewForumAsMessages³." + ], + "links": [ + "https://core.telegram.org/api/forum", + "https://core.telegram.org/constructor/channelFull", + "https://core.telegram.org/constructor/dialog", + "https://core.telegram.org/constructor/updateChannelViewForumAsMessages" + ], "parameters": { "channel": { "name": "channel", - "description": " " + "description": "The forum" }, "enabled": { "name": "enabled", - "description": " " + "description": "The new value of the view_forum_as_messages flag." } }, "errors": [ @@ -52617,7 +52813,7 @@ "premium.getBoostsStatus": { "name": "premium.getBoostsStatus", "description": [ - "Gets the current boost status¹ of a peer." + "Gets the current number of boosts¹ of a channel." ], "links": [ "https://core.telegram.org/api/boost" @@ -53733,10 +53929,13 @@ }, "stories.getPeerMaxIDs": { "name": "stories.getPeerMaxIDs", + "description": [ + "Get the IDs of the maximum read stories for a set of peers." + ], "parameters": { "id": { "name": "id", - "description": " " + "description": "Peers" } } },