@grammyjs/types 3.6.2 → 3.8.0

package/methods.d.ts

@@ -1,7 +1,8 @@
 import type { InlineQueryResult, InlineQueryResultsButton } from "./inline.js";
-import type { BotCommand, BusinessConnection, ChatAdministratorRights, ChatFromGetChat, ChatInviteLink, ChatMember, ChatMemberAdministrator, ChatMemberOwner, ChatPermissions, ForumTopic, UserChatBoosts, UserFromGetMe, UserProfilePhotos, WebhookInfo } from "./manage.js";
+import type { BotCommand, BusinessConnection, ChatAdministratorRights, ChatInviteLink, ChatMember, ChatMemberAdministrator, ChatMemberOwner, ChatPermissions, ForumTopic, UserChatBoosts, UserFromGetMe, UserProfilePhotos, WebhookInfo } from "./manage.js";
+import type { ChatFullInfo } from "./manage.js";
 import type { ForceReply, InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove } from "./markup.js";
-import type { File, GameHighScore, LinkPreviewOptions, MaskPosition, Message, MessageEntity, MessageId, ParseMode, Poll, ReactionType, ReplyParameters, SentWebAppMessage, Sticker, StickerSet } from "./message.js";
+import type { File, GameHighScore, InputPollOption, LinkPreviewOptions, MaskPosition, Message, MessageEntity, MessageId, ParseMode, Poll, ReactionType, ReplyParameters, SentWebAppMessage, Sticker, StickerSet } from "./message.js";
 import type { PassportElementError } from "./passport.js";
 import type { LabeledPrice, ShippingOption } from "./payment.js";
 import type { BotCommandScope, BotDescription, BotName, BotShortDescription, MenuButton } from "./settings.js";
@@ -92,9 +93,11 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Unique identifier of the message effect to be added to the message */
+        message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
-        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account. */
+        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. */
         reply_markup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
         /** @deprecated Use `reply_parameters` instead. */
         reply_to_message_id?: number;
@@ -145,6 +148,8 @@ export type ApiMethods<F> = {
         parse_mode?: string;
         /** A list of special entities that appear in the new caption, which can be specified instead of parse_mode */
         caption_entities?: MessageEntity[];
+        /** Pass True, if the caption must be shown above the message media. Ignored if a new caption isn't specified. */
+        show_caption_above_media?: boolean;
         /** Sends the message silently. Users will receive a notification with no sound. */
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
@@ -189,15 +194,19 @@ export type ApiMethods<F> = {
         parse_mode?: ParseMode;
         /** A list of special entities that appear in the caption, which can be specified instead of parse_mode */
         caption_entities?: MessageEntity[];
+        /** Pass True, if the caption must be shown above the message media */
+        show_caption_above_media?: boolean;
         /** Pass True if the photo needs to be covered with a spoiler animation */
         has_spoiler?: boolean;
         /** Sends the message silently. Users will receive a notification with no sound. */
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Unique identifier of the message effect to be added to the message */
+        message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
-        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account. */
+        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. */
         reply_markup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
         /** @deprecated Use `reply_parameters` instead. */
         reply_to_message_id?: number;
@@ -232,9 +241,11 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Unique identifier of the message effect to be added to the message */
+        message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
-        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account. */
+        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. */
         reply_markup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
         /** @deprecated Use `reply_parameters` instead. */
         reply_to_message_id?: number;
@@ -263,9 +274,11 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Unique identifier of the message effect to be added to the message */
+        message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
-        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account. */
+        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. */
         reply_markup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
         /** @deprecated Use `reply_parameters` instead. */
         reply_to_message_id?: number;
@@ -294,6 +307,8 @@ export type ApiMethods<F> = {
         parse_mode?: ParseMode;
         /** A list of special entities that appear in the caption, which can be specified instead of parse_mode */
         caption_entities?: MessageEntity[];
+        /** Pass True, if the caption must be shown above the message media */
+        show_caption_above_media?: boolean;
         /** Pass True if the video needs to be covered with a spoiler animation */
         has_spoiler?: boolean;
         /** Pass True if the uploaded video is suitable for streaming */
@@ -302,9 +317,11 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Unique identifier of the message effect to be added to the message */
+        message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
-        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account. */
+        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. */
         reply_markup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
         /** @deprecated Use `reply_parameters` instead. */
         reply_to_message_id?: number;
@@ -333,20 +350,24 @@ export type ApiMethods<F> = {
         parse_mode?: ParseMode;
         /** A list of special entities that appear in the caption, which can be specified instead of parse_mode */
         caption_entities?: MessageEntity[];
+        /** Pass True, if the caption must be shown above the message media */
+        show_caption_above_media?: boolean;
         /** Pass True if the animation needs to be covered with a spoiler animation */
         has_spoiler?: boolean;
         /** Sends the message silently. Users will receive a notification with no sound. */
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Unique identifier of the message effect to be added to the message */
+        message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
-        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account. */
+        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. */
         reply_markup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
         /** @deprecated Use `reply_parameters` instead. */
         reply_to_message_id?: number;
     }): Message.AnimationMessage;
-    /** Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future. */
+    /** Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future. */
     sendVoice(args: {
         /** Unique identifier of the business connection on behalf of which the message will be sent */
         business_connection_id?: string;
@@ -368,9 +389,11 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Unique identifier of the message effect to be added to the message */
+        message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
-        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account. */
+        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. */
         reply_markup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
         /** @deprecated Use `reply_parameters` instead. */
         reply_to_message_id?: number;
@@ -396,9 +419,11 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Unique identifier of the message effect to be added to the message */
+        message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
-        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account. */
+        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. */
         reply_markup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
         /** @deprecated Use `reply_parameters` instead. */
         reply_to_message_id?: number;
@@ -417,6 +442,8 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent messages from forwarding and saving */
         protect_content?: boolean;
+        /** Unique identifier of the message effect to be added to the message */
+        message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
         /** @deprecated Use `reply_parameters` instead. */
@@ -436,7 +463,7 @@ export type ApiMethods<F> = {
         longitude: number;
         /** The radius of uncertainty for the location, measured in meters; 0-1500 */
         horizontal_accuracy?: number;
-        /** Period in seconds for which the location will be updated (see Live Locations, should be between 60 and 86400. */
+        /** Period in seconds during which the location will be updated (see Live Locations, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely. */
         live_period?: number;
         /** The direction in which user is moving, in degrees; 1-360. For active live locations only. */
         heading?: number;
@@ -446,9 +473,11 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Unique identifier of the message effect to be added to the message */
+        message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
-        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account. */
+        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. */
         reply_markup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
         /** @deprecated Use `reply_parameters` instead. */
         reply_to_message_id?: number;
@@ -465,6 +494,8 @@ export type ApiMethods<F> = {
         latitude: number;
         /** Longitude of new location */
         longitude: number;
+        /** New period in seconds during which the location can be updated, starting from the message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the new value must not exceed the current live_period by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, then live_period remains unchanged */
+        live_period?: number;
         /** The radius of uncertainty for the location, measured in meters; 0-1500 */
         horizontal_accuracy?: number;
         /** The direction in which user is moving, in degrees; 1-360. For active live locations only. */
@@ -513,9 +544,11 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Unique identifier of the message effect to be added to the message */
+        message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
-        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account. */
+        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. */
         reply_markup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
         /** @deprecated Use `reply_parameters` instead. */
         reply_to_message_id?: number;
@@ -540,9 +573,11 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Unique identifier of the message effect to be added to the message */
+        message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
-        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account. */
+        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. */
         reply_markup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
         /** @deprecated Use `reply_parameters` instead. */
         reply_to_message_id?: number;
@@ -557,8 +592,12 @@ export type ApiMethods<F> = {
         message_thread_id?: number;
         /** Poll question, 1-300 characters */
         question: string;
-        /** A list of answer options, 2-10 strings 1-100 characters each */
-        options: readonly string[];
+        /** Mode for parsing entities in the question. See formatting options for more details. Currently, only custom emoji entities are allowed */
+        question_parse_mode?: string;
+        /** A list of special entities that appear in the poll question. It can be specified instead of question_parse_mode */
+        question_entities?: MessageEntity[];
+        /** A list of 2-10 answer options */
+        options: InputPollOption[];
         /** True, if the poll needs to be anonymous, defaults to True */
         is_anonymous?: boolean;
         /** Poll type, “quiz” or “regular”, defaults to “regular” */
@@ -571,7 +610,7 @@ export type ApiMethods<F> = {
         explanation?: string;
         /** Mode for parsing entities in the explanation. See formatting options for more details. */
         explanation_parse_mode?: ParseMode;
-        /** A list of special entities that appear in the poll explanation, which can be specified instead of parse_mode */
+        /** A list of special entities that appear in the poll explanation. It can be specified instead of explanation_parse_mode */
         explanation_entities?: MessageEntity[];
         /** Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close_date. */
         open_period?: number;
@@ -583,9 +622,11 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Unique identifier of the message effect to be added to the message */
+        message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
-        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account. */
+        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. */
         reply_markup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
         /** @deprecated Use `reply_parameters` instead. */
         reply_to_message_id?: number;
@@ -604,9 +645,11 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding */
         protect_content?: boolean;
+        /** Unique identifier of the message effect to be added to the message */
+        message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
-        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account. */
+        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. */
         reply_markup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
         /** @deprecated Use `reply_parameters` instead. */
         reply_to_message_id?: number;
@@ -713,7 +756,7 @@ export type ApiMethods<F> = {
         can_invite_users?: boolean;
         /** True if the administrator can post stories to the chat */
         can_post_stories?: boolean;
-        /** True if the administrator can edit stories posted by other users */
+        /** Pass True if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive */
         can_edit_stories?: boolean;
         /** True if the administrator can delete stories posted by other users */
         can_delete_stories?: boolean;
@@ -866,11 +909,11 @@ export type ApiMethods<F> = {
         /** Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) */
         chat_id: number | string;
     }): true;
-    /** Use this method to get up to date information about the chat. Returns a Chat object on success. */
+    /** Use this method to get up-to-date information about the chat. Returns a ChatFullInfo object on success. */
     getChat(args: {
         /** Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) */
         chat_id: number | string;
-    }): ChatFromGetChat;
+    }): ChatFullInfo;
     /** Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of ChatMember objects. */
     getChatAdministrators(args: {
         /** Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) */
@@ -1016,7 +1059,7 @@ export type ApiMethods<F> = {
         /** Unique identifier of the business connection */
         business_connection_id: string;
     }): BusinessConnection;
-    /** Use this method to change the list of the bot's commands. See https://core.telegram.org/bots#commands for more details about bot commands. Returns True on success. */
+    /** Use this method to change the list of the bot's commands. See https://core.telegram.org/bots/features#commands for more details about bot commands. Returns True on success. */
     setMyCommands(args: {
         /** A list of bot commands to be set as the list of the bot's commands. At most 100 commands can be specified. */
         commands: readonly BotCommand[];
@@ -1132,6 +1175,8 @@ export type ApiMethods<F> = {
         parse_mode?: ParseMode;
         /** A list of special entities that appear in the caption, which can be specified instead of parse_mode */
         caption_entities?: MessageEntity[];
+        /** Pass True, if the caption must be shown above the message media. Supported only for animation, photo and video messages. */
+        show_caption_above_media?: boolean;
         /** An object for an inline keyboard. */
         reply_markup?: InlineKeyboardMarkup;
     }): (Update.Edited & Message.CaptionableMessage) | true;
@@ -1207,9 +1252,11 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Unique identifier of the message effect to be added to the message */
+        message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
-        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account. */
+        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. */
         reply_markup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
         /** @deprecated Use `reply_parameters` instead. */
         reply_to_message_id?: number;
@@ -1368,13 +1415,13 @@ export type ApiMethods<F> = {
         description: string;
         /** Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. */
         payload: string;
-        /** Payment provider token, obtained via @BotFather */
-        provider_token: string;
-        /** Three-letter ISO 4217 currency code, see more on currencies */
+        /** Payment provider token, obtained via BotFather. Pass an empty string for payments in Telegram Stars. */
+        provider_token?: string;
+        /** Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars. */
         currency: string;
-        /** Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.) */
+        /** Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars. */
         prices: readonly LabeledPrice[];
-        /** The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_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). Defaults to 0 */
+        /** The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_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). Defaults to 0. Not supported for payments in Telegram Stars. */
         max_tip_amount?: number;
         /** An array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount. */
         suggested_tip_amounts?: number[];
@@ -1390,24 +1437,26 @@ export type ApiMethods<F> = {
         photo_width?: number;
         /** Photo height */
         photo_height?: number;
-        /** Pass True if you require the user's full name to complete the order */
+        /** Pass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars. */
         need_name?: boolean;
-        /** Pass True if you require the user's phone number to complete the order */
+        /** Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars. */
         need_phone_number?: boolean;
-        /** Pass True if you require the user's email address to complete the order */
+        /** Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars. */
         need_email?: boolean;
-        /** Pass True if you require the user's shipping address to complete the order */
+        /** Pass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars. */
         need_shipping_address?: boolean;
-        /** Pass True if the user's phone number should be sent to provider */
+        /** Pass True if the user's phone number should be sent to provider. Ignored for payments in Telegram Stars. */
         send_phone_number_to_provider?: boolean;
-        /** Pass True if the user's email address should be sent to provider */
+        /** Pass True if the user's email address should be sent to provider. Ignored for payments in Telegram Stars. */
         send_email_to_provider?: boolean;
-        /** Pass True if the final price depends on the shipping method */
+        /** Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars. */
         is_flexible?: boolean;
         /** Sends the message silently. Users will receive a notification with no sound. */
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Unique identifier of the message effect to be added to the message */
+        message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
         /** An object for an inline keyboard. If empty, one 'Pay total price' button will be shown. If not empty, the first button must be a Pay button. */
@@ -1423,8 +1472,8 @@ export type ApiMethods<F> = {
         description: string;
         /** Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. */
         payload: string;
-        /** Payment provider token, obtained via BotFather */
-        provider_token: string;
+        /** Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars. */
+        provider_token?: string;
         /** Three-letter ISO 4217 currency code, see more on currencies */
         currency: string;
         /** Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.) */
@@ -1478,6 +1527,13 @@ export type ApiMethods<F> = {
         /** Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!"). Telegram will display this message to the user. */
         error_message?: string;
     }): true;
+    /** Refunds a successful payment in Telegram Stars. Returns True on success. */
+    refundStarPayment(args: {
+        /** Identifier of the user whose payment will be refunded */
+        user_id: number;
+        /** Telegram payment identifier */
+        telegram_payment_charge_id: string;
+    }): true;
     /** Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success.
   
     Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues. */
@@ -1501,9 +1557,11 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Unique identifier of the message effect to be added to the message */
+        message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
-        /** An object for an inline keyboard. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game. Not supported for messages sent on behalf of a business account. */
+        /** An object for an inline keyboard. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game. */
         reply_markup?: InlineKeyboardMarkup;
         /** @deprecated Use `reply_parameters` instead. */
         reply_to_message_id?: number;
@@ -1567,6 +1625,8 @@ export interface InputMediaPhoto<F> {
     media: F | string;
     /** Caption of the photo to be sent, 0-1024 characters after entities parsing */
     caption?: string;
+    /** Pass True, if the caption must be shown above the message media */
+    show_caption_above_media?: boolean;
     /** Mode for parsing entities in the photo caption. See formatting options for more details. */
     parse_mode?: ParseMode;
     /** List of special entities that appear in the caption, which can be specified instead of parse_mode */
@@ -1584,6 +1644,8 @@ export interface InputMediaVideo<F> {
     thumbnail?: F;
     /** Caption of the video to be sent, 0-1024 characters after entities parsing */
     caption?: string;
+    /** Pass True, if the caption must be shown above the message media */
+    show_caption_above_media?: boolean;
     /** Mode for parsing entities in the video caption. See formatting options for more details. */
     parse_mode?: ParseMode;
     /** List of special entities that appear in the caption, which can be specified instead of parse_mode */
@@ -1609,6 +1671,8 @@ export interface InputMediaAnimation<F> {
     thumbnail?: F;
     /** Caption of the animation to be sent, 0-1024 characters after entities parsing */
     caption?: string;
+    /** Pass True, if the caption must be shown above the message media */
+    show_caption_above_media?: boolean;
     /** Mode for parsing entities in the animation caption. See formatting options for more details. */
     parse_mode?: ParseMode;
     /** List of special entities that appear in the caption, which can be specified instead of parse_mode */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grammyjs/types",
-  "version": "3.6.2",
+  "version": "3.8.0",
   "description": "Telegram Bot API type declarations for grammY",
   "main": "mod.js",
   "repository": {

package/payment.d.ts

@@ -14,7 +14,7 @@ export interface Invoice {
     description: string;
     /** Unique bot deep-linking parameter that can be used to generate this invoice */
     start_parameter: string;
-    /** Three-letter ISO 4217 currency code */
+    /** Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars */
     currency: string;
     /** 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). */
     total_amount: number;
@@ -56,7 +56,7 @@ export interface ShippingOption {
 }
 /** This object contains basic information about a successful payment. */
 export interface SuccessfulPayment {
-    /** Three-letter ISO 4217 currency code */
+    /** Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars */
     currency: string;
     /** 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). */
     total_amount: number;
@@ -88,7 +88,7 @@ export interface PreCheckoutQuery {
     id: string;
     /** User who sent the query */
     from: User;
-    /** Three-letter ISO 4217 currency code */
+    /** Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars */
     currency: string;
     /** 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). */
     total_amount: number;

package/update.d.ts

@@ -39,7 +39,7 @@ export interface Update {
     edited_channel_post?: Message & Update.Edited & Update.Channel;
     /** The bot was connected to or disconnected from a business account, or a user edited an existing connection with the bot */
     business_connection?: BusinessConnection;
-    /** New non-service message from a connected business account */
+    /** New message from a connected business account */
     business_message?: Message & Update.Private;
     /** New version of a message from a connected business account */
     edited_business_message?: Message & Update.Edited & Update.Private;