@grammyjs/types 3.14.0 → 3.16.0

package/markup.d.ts

@@ -40,6 +40,10 @@ export declare namespace InlineKeyboardButton {
         /** If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent on behalf of a Telegram Business account. */
         switch_inline_query_chosen_chat: SwitchInlineQueryChosenChat;
     }
+    interface CopyTextButtonButton extends AbstractInlineKeyboardButton {
+        /** Description of the button that copies the specified text to the clipboard. */
+        copy_text: CopyTextButton;
+    }
     interface GameButton extends AbstractInlineKeyboardButton {
         /** Description of the game that will be launched when the user presses the button.
     
@@ -54,7 +58,7 @@ export declare namespace InlineKeyboardButton {
     }
 }
 /** This object represents one button of an inline keyboard. You must use exactly one of the optional fields. */
-export type InlineKeyboardButton = InlineKeyboardButton.CallbackButton | InlineKeyboardButton.GameButton | InlineKeyboardButton.LoginButton | InlineKeyboardButton.PayButton | InlineKeyboardButton.SwitchInlineButton | InlineKeyboardButton.SwitchInlineCurrentChatButton | InlineKeyboardButton.SwitchInlineChosenChatButton | InlineKeyboardButton.UrlButton | InlineKeyboardButton.WebAppButton;
+export type InlineKeyboardButton = InlineKeyboardButton.CallbackButton | InlineKeyboardButton.GameButton | InlineKeyboardButton.LoginButton | InlineKeyboardButton.PayButton | InlineKeyboardButton.SwitchInlineButton | InlineKeyboardButton.SwitchInlineCurrentChatButton | InlineKeyboardButton.SwitchInlineChosenChatButton | InlineKeyboardButton.CopyTextButtonButton | InlineKeyboardButton.UrlButton | InlineKeyboardButton.WebAppButton;
 /** This object represents a parameter of the inline keyboard button used to automatically authorize a user. Serves as a great replacement for the Telegram Login Widget when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in.
 Telegram apps support these buttons as of version 5.7. */
 export interface LoginUrl {
@@ -184,6 +188,11 @@ export interface ForceReply {
     /** Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply to a message in the same chat and forum topic, sender of the original message. */
     selective?: boolean;
 }
+/** This object represents an inline keyboard button that copies specified text to the clipboard. */
+export interface CopyTextButton {
+    /** The text to be copied to the clipboard; 1-256 characters */
+    text: string;
+}
 /** Describes a Web App. */
 export interface WebAppInfo {
     /** An HTTPS URL of a Web App to be opened with additional data as specified in Initializing Web Apps */

package/message.d.ts

@@ -5,7 +5,7 @@ import type { Invoice, RefundedPayment, SuccessfulPayment } from "./payment.js";
 type MsgWith<P extends keyof Message> = Record<P, NonNullable<Message[P]>>;
 export declare namespace Message {
     interface ServiceMessage {
-        /** Unique message identifier inside this chat */
+        /** Unique message identifier inside this chat. In specific instances (e.g., message containing a video sent to a big chat), the server might automatically schedule a message instead of sending it immediately. In such cases, this field will be 0 and the relevant message will be unusable until it is actually sent */
         message_id: number;
         /** Unique identifier of a message thread or a forum topic to which the message belongs; for supergroups only */
         message_thread_id?: number;
@@ -245,7 +245,7 @@ export interface Message extends Message.MediaMessage {
 }
 /** This object represents a unique message identifier. */
 export interface MessageId {
-    /** Unique message identifier */
+    /** Unique message identifier. In specific instances (e.g., message containing a video sent to a big chat), the server might automatically schedule a message instead of sending it immediately. In such cases, this field will be 0 and the relevant message will be unusable until it is actually sent */
     message_id: number;
 }
 /** Describes an inline message sent by a Web App on behalf of a user. */
@@ -381,7 +381,7 @@ Please note:
 export type ParseMode = "Markdown" | "MarkdownV2" | "HTML";
 export declare namespace MessageEntity {
     interface AbstractMessageEntity {
-        /** Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler” (spoiler message), “blockquote” (block quotation), “expandable_blockquote” (collapsed-by-default block quotation), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames), “custom_emoji” (for inline custom emoji stickers) */
+        /** Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag or #hashtag@chatusername), “cashtag” ($USD or $USD@chatusername), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler” (spoiler message), “blockquote” (block quotation), “expandable_blockquote” (collapsed-by-default block quotation), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames), “custom_emoji” (for inline custom emoji stickers) */
         type: string;
         /** Offset in UTF-16 code units to the start of the entity */
         offset: number;
@@ -1247,4 +1247,11 @@ export interface MessageReactionCountUpdated {
     /** List of reactions that are present on the message */
     reactions: ReactionCount[];
 }
+/** Describes an inline message to be sent by a user of a Mini App. */
+export interface PreparedInlineMessage {
+    /** Unique identifier of the prepared message */
+    id: string;
+    /** Expiration date of the prepared message, in Unix time. Expired prepared messages can no longer be used */
+    expiration_date: number;
+}
 export {};

package/methods.d.ts

@@ -1,13 +1,12 @@
 import type { InlineQueryResult, InlineQueryResultsButton } from "./inline.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 { LanguageCode } from "./langs.js";
+import type { BotCommand, BusinessConnection, ChatAdministratorRights, ChatFullInfo, ChatInviteLink, ChatMember, ChatMemberAdministrator, ChatMemberOwner, ChatPermissions, ForumTopic, UserChatBoosts, UserFromGetMe, UserProfilePhotos, WebhookInfo } from "./manage.js";
 import type { ForceReply, InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove } from "./markup.js";
-import type { File, GameHighScore, InputPollOption, 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, PreparedInlineMessage, ReactionType, ReplyParameters, SentWebAppMessage, Sticker, StickerSet } from "./message.js";
 import type { PassportElementError } from "./passport.js";
-import type { LabeledPrice, ShippingOption, StarTransactions } from "./payment.js";
+import type { Gifts, LabeledPrice, ShippingOption, StarTransactions } from "./payment.js";
 import type { BotCommandScope, BotDescription, BotName, BotShortDescription, MenuButton } from "./settings.js";
 import type { Update } from "./update.js";
-import type { LanguageCode } from "./langs.js";
 /** Extracts the parameters of a given method name */
 type Params<F, M extends keyof ApiMethods<F>> = Parameters<ApiMethods<F>[M]>;
 /** Utility type providing the argument type for the given method name or `{}` if the method does not take any parameters */
@@ -94,6 +93,8 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance */
+        allow_paid_broadcast?: boolean;
         /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
@@ -155,6 +156,8 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance */
+        allow_paid_broadcast?: boolean;
         /** 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 reply keyboard or to force a reply from the user. */
@@ -203,6 +206,8 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance */
+        allow_paid_broadcast?: boolean;
         /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
@@ -242,6 +247,8 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance */
+        allow_paid_broadcast?: boolean;
         /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
@@ -275,6 +282,8 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance */
+        allow_paid_broadcast?: boolean;
         /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
@@ -318,6 +327,8 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance */
+        allow_paid_broadcast?: boolean;
         /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
@@ -359,6 +370,8 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance */
+        allow_paid_broadcast?: boolean;
         /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
@@ -390,6 +403,8 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance */
+        allow_paid_broadcast?: boolean;
         /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
@@ -420,6 +435,8 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance */
+        allow_paid_broadcast?: boolean;
         /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
@@ -435,14 +452,16 @@ export type ApiMethods<F> = {
         business_connection_id?: string;
         /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
         chat_id: number | string;
-        /** An array describing messages to be sent, must include 2-10 items */
         /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
         message_thread_id?: number;
+        /** An array describing messages to be sent, must include 2-10 items */
         media: ReadonlyArray<InputMediaAudio<F> | InputMediaDocument<F> | InputMediaPhoto<F> | InputMediaVideo<F>>;
         /** Sends the messages silently. Users will receive a notification with no sound. */
         disable_notification?: boolean;
         /** Protects the contents of the sent messages from forwarding and saving */
         protect_content?: boolean;
+        /** Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance */
+        allow_paid_broadcast?: boolean;
         /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
@@ -474,6 +493,8 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance */
+        allow_paid_broadcast?: boolean;
         /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
@@ -545,6 +566,8 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance */
+        allow_paid_broadcast?: boolean;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
         /** Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user */
@@ -578,6 +601,8 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance */
+        allow_paid_broadcast?: boolean;
         /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
@@ -607,6 +632,8 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance */
+        allow_paid_broadcast?: boolean;
         /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
@@ -656,6 +683,8 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance */
+        allow_paid_broadcast?: boolean;
         /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
@@ -679,6 +708,8 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding */
         protect_content?: boolean;
+        /** Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance */
+        allow_paid_broadcast?: boolean;
         /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
@@ -723,6 +754,15 @@ export type ApiMethods<F> = {
         /** Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100. */
         limit?: number;
     }): UserProfilePhotos;
+    /** Changes the emoji status for a given user that previously allowed the bot to manage their emoji status via the Mini App method requestEmojiStatusAccess. Returns True on success. */
+    setUserEmojiStatus(args: {
+        /** Unique identifier of the target user */
+        user_id: number;
+        /** Custom emoji identifier of the emoji status to set. Pass an empty string to remove the status. */
+        emoji_status_custom_emoji_id?: string;
+        /** Expiration date of the emoji status, if any */
+        emoji_status_expiration_date?: number;
+    }): true;
     /** Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>, where <file_path> is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile again.
   
     Note: This function may not preserve the original file name and MIME type. You should save the file's MIME type and name (if available) when the File object is received. */
@@ -1242,7 +1282,7 @@ export type ApiMethods<F> = {
         /** An object for an inline keyboard. */
         reply_markup?: InlineKeyboardMarkup;
     }): (Update.Edited & Message.CaptionableMessage) | true;
-    /** Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent. */
+    /** Use this method to edit animation, audio, document, photo, or video messages, or to add media to text messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent. */
     editMessageMedia(args: {
         /** Unique identifier of the business connection on behalf of which the message to be edited was sent */
         business_connection_id?: string;
@@ -1320,6 +1360,8 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance */
+        allow_paid_broadcast?: boolean;
         /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
@@ -1446,6 +1488,21 @@ export type ApiMethods<F> = {
         /** Custom emoji identifier of a sticker from the sticker set; pass an empty string to drop the thumbnail and use the first sticker as the thumbnail. */
         custom_emoji_id?: string;
     }): true;
+    /** Returns the list of gifts that can be sent by the bot to users. Requires no parameters. Returns a Gifts object. */
+    getAvailableGifts(): Gifts;
+    /** Sends a gift to the given user. The gift can't be converted to Telegram Stars by the user. Returns True on success. */
+    sendGift(args: {
+        /** Unique identifier of the target user that will receive the gift */
+        user_id: number;
+        /** Identifier of the gift */
+        gift_id: string;
+        /** Text that will be shown along with the gift; 0-255 characters */
+        text?: string;
+        /** Mode for parsing entities in the text. See formatting options for more details. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, and “custom_emoji” are ignored. */
+        text_parse_mode?: ParseMode;
+        /** A list of special entities that appear in the gift text. It can be specified instead of text_parse_mode. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, and “custom_emoji” are ignored. */
+        text_entities?: MessageEntity[];
+    }): Gifts;
     /** Use this method to send answers to an inline query. On success, True is returned.
     No more than 50 results per query are allowed.
   
@@ -1471,6 +1528,21 @@ export type ApiMethods<F> = {
         /** An object describing the message to be sent */
         result: InlineQueryResult;
     }): SentWebAppMessage;
+    /** Stores a message that can be sent by a user of a Mini App. Returns a PreparedInlineMessage object. */
+    savePreparedInlineMessage(args: {
+        /** Unique identifier of the target user that can use the prepared message */
+        user_id: number;
+        /** An object describing the message to be sent */
+        result: InlineQueryResult;
+        /** Pass True if the message can be sent to private chats with users */
+        allow_user_chats?: boolean;
+        /** Pass True if the message can be sent to private chats with bots */
+        allow_bot_chats?: boolean;
+        /** Pass True if the message can be sent to group and supergroup chats */
+        allow_group_chats?: boolean;
+        /** Pass True if the message can be sent to channel chats */
+        allow_channel_chats?: boolean;
+    }): PreparedInlineMessage;
     /** Use this method to send invoices. On success, the sent Message is returned. */
     sendInvoice(args: {
         /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
@@ -1523,6 +1595,8 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance */
+        allow_paid_broadcast?: boolean;
         /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
@@ -1534,6 +1608,8 @@ export type ApiMethods<F> = {
     }): Message.InvoiceMessage;
     /** Use this method to create a link for an invoice. Returns the created invoice link as String on success. */
     createInvoiceLink(args: {
+        /** Unique identifier of the business connection on behalf of which the link will be created */
+        business_connection_id?: string;
         /** Product name, 1-32 characters */
         title: string;
         /** Product description, 1-255 characters */
@@ -1546,6 +1622,8 @@ export type ApiMethods<F> = {
         currency: string;
         /** Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.) */
         prices: LabeledPrice[];
+        /** The number of seconds the subscription will be active for before the next payment. The currency must be set to “XTR” (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. */
+        subscription_period?: number;
         /** 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 */
         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. */
@@ -1609,6 +1687,15 @@ export type ApiMethods<F> = {
         /** Telegram payment identifier */
         telegram_payment_charge_id: string;
     }): true;
+    /** Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars. Returns True on success. */
+    editUserStarSubscription(args: {
+        /** Identifier of the user whose subscription will be edited */
+        user_id: number;
+        /** Telegram payment identifier for the subscription */
+        telegram_payment_charge_id: string;
+        /** Pass True to cancel extension of the user subscription; the subscription must be active up to the end of the current subscription period. Pass False to allow the user to re-enable a subscription that was previously canceled by the bot. */
+        is_canceled: boolean;
+    }): 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. */
@@ -1632,6 +1719,8 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding and saving */
         protect_content?: boolean;
+        /** Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance */
+        allow_paid_broadcast?: boolean;
         /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grammyjs/types",
-  "version": "3.14.0",
+  "version": "3.16.0",
   "description": "Telegram Bot API type declarations for grammY",
   "main": "mod.js",
   "repository": {
@@ -15,7 +15,7 @@
     "types"
   ],
   "scripts": {
-    "prepare": "deno task backport"
+    "prepare": "deno task build"
   },
   "author": "KnorpelSenf",
   "types": "mod.d.ts",

package/payment.d.ts

@@ -1,5 +1,5 @@
 import type { User } from "./manage.js";
-import type { PaidMedia } from "./message.js";
+import type { PaidMedia, Sticker } from "./message.js";
 /** This object represents a portion of the price for goods or services. */
 export interface LabeledPrice {
     /** Portion label */
@@ -63,6 +63,12 @@ export interface SuccessfulPayment {
     total_amount: number;
     /** Bot specified invoice payload */
     invoice_payload: string;
+    /** Expiration date of the subscription, in Unix time; for recurring payments only */
+    subscription_expiration_date?: number;
+    /** True, if the payment is a recurring payment for a subscription */
+    is_recurring?: true;
+    /** True, if the payment is the first payment for a subscription */
+    is_first_recurring?: true;
     /** Identifier of the shipping option chosen by the user */
     shipping_option_id?: string;
     /** Order information provided by the user */
@@ -143,8 +149,9 @@ export interface RevenueWithdrawalStateFailed {
 - TransactionPartnerUser
 - TransactionPartnerFragment
 - TransactionPartnerTelegramAds
+- TransactionPartnerTelegramApi
 - TransactionPartnerOther */
-export type TransactionPartner = TransactionPartnerUser | TransactionPartnerFragment | TransactionPartnerTelegramAds | TransactionPartnerOther;
+export type TransactionPartner = TransactionPartnerUser | TransactionPartnerFragment | TransactionPartnerTelegramAds | TransactionPartnerTelegramApi | TransactionPartnerOther;
 /** Describes a transaction with a user. */
 export interface TransactionPartnerUser {
     /** Type of the transaction partner, always “user” */
@@ -153,10 +160,14 @@ export interface TransactionPartnerUser {
     user: User;
     /** Bot-specified invoice payload */
     invoice_payload?: string;
+    /** The duration of the paid subscription */
+    subscription_period?: number;
     /** Information about the paid media bought by the user */
     paid_media?: PaidMedia[];
     /** Bot-specified paid media payload */
     paid_media_payload?: string;
+    /** The gift sent to the user by the bot */
+    gift?: string;
 }
 /** Describes a withdrawal transaction with Fragment. */
 export interface TransactionPartnerFragment {
@@ -170,6 +181,13 @@ export interface TransactionPartnerTelegramAds {
     /** Type of the transaction partner, always “telegram_ads” */
     type: "telegram_ads";
 }
+/** Describes a transaction with payment for paid broadcasting. */
+export interface TransactionPartnerTelegramApi {
+    /** Type of the transaction partner, always “telegram_api” */
+    type: "telegram_api";
+    /** The number of successful requests that exceeded regular limits and were therefore billed */
+    request_count: number;
+}
 /** Describes a transaction with an unknown source or recipient. */
 export interface TransactionPartnerOther {
     /** Type of the transaction partner, always “other” */
@@ -177,7 +195,7 @@ export interface TransactionPartnerOther {
 }
 /** Describes a Telegram Star transaction. */
 export interface StarTransaction {
-    /** Unique identifier of the transaction. Coincides with the identifer of the original transaction for refund transactions. Coincides with SuccessfulPayment.telegram_payment_charge_id for successful incoming payments from users. */
+    /** Unique identifier of the transaction. Coincides with the identifier of the original transaction for refund transactions. Coincides with SuccessfulPayment.telegram_payment_charge_id for successful incoming payments from users. */
     id: string;
     /** Number of Telegram Stars transferred by the transaction */
     amount: number;
@@ -200,3 +218,21 @@ export interface PaidMediaPurchased {
     /** Bot-specified paid media payload */
     paid_media_payload: string;
 }
+/** This object represents a gift that can be sent by the bot. */
+export interface Gift {
+    /** Unique identifier of the gift */
+    id: string;
+    /** The sticker that represents the gift */
+    sticker: Sticker;
+    /** The number of Telegram Stars that must be paid to send the sticker */
+    star_count: number;
+    /** The total number of the gifts of this type that can be sent; for limited gifts only */
+    total_count?: number;
+    /** The number of remaining gifts of this type that can be sent; for limited gifts only */
+    remaining_count?: number;
+}
+/** This object represent a list of gifts. */
+export interface Gifts {
+    /** The list of gifts */
+    gifts: Gift[];
+}