@grammyjs/types 3.15.0 → 3.17.0

package/message.d.ts

@@ -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 */
@@ -755,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. */
@@ -1480,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.
   
@@ -1505,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) */
@@ -1570,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 */
@@ -1582,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. */
@@ -1645,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. */

package/package.json

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

package/payment.d.ts

@@ -1,5 +1,5 @@
-import type { User } from "./manage.js";
-import type { PaidMedia } from "./message.js";
+import type { Chat, User } from "./manage.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 */
@@ -138,26 +144,55 @@ export interface RevenueWithdrawalStateFailed {
     /** Type of the state, always “failed” */
     type: "failed";
 }
+/** Contains information about the affiliate that received a commission via this transaction. */
+export interface AffiliateInfo {
+    /** The bot or the user that received an affiliate commission if it was received by a bot or a user */
+    affiliate_user?: User;
+    /** The chat that received an affiliate commission if it was received by a chat */
+    affiliate_chat?: Chat;
+    /** The number of Telegram Stars received by the affiliate for each 1000 Telegram Stars received by the bot from referred users */
+    commission_per_mille: number;
+    /** Integer amount of Telegram Stars received by the affiliate from the transaction, rounded to 0; can be negative for refunds */
+    amount: number;
+    /** The number of 1/1000000000 shares of Telegram Stars received by the affiliate; from -999999999 to 999999999; can be negative for refunds */
+    nanostar_amount?: number;
+}
 /** This object describes the source of a transaction, or its recipient for outgoing transactions. Currently, it can be one of
 
 - TransactionPartnerUser
+- TransactionPartnerAffiliateProgram
 - TransactionPartnerFragment
 - TransactionPartnerTelegramAds
 - TransactionPartnerTelegramApi
 - TransactionPartnerOther */
-export type TransactionPartner = TransactionPartnerUser | TransactionPartnerFragment | TransactionPartnerTelegramAds | TransactionPartnerTelegramApi | TransactionPartnerOther;
+export type TransactionPartner = TransactionPartnerUser | TransactionPartnerAffiliateProgram | TransactionPartnerFragment | TransactionPartnerTelegramAds | TransactionPartnerTelegramApi | TransactionPartnerOther;
 /** Describes a transaction with a user. */
 export interface TransactionPartnerUser {
     /** Type of the transaction partner, always “user” */
     type: "user";
     /** Information about the user */
     user: User;
+    /** Information about the affiliate that received a commission via this transaction */
+    affiliate?: AffiliateInfo;
     /** 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 the affiliate program that issued the affiliate commission received via this transaction. */
+export interface TransactionPartnerAffiliateProgram {
+    /** Type of the transaction partner, always “affiliate_program” */
+    type: "affiliate_program";
+    /** Information about the bot that sponsored the affiliate program */
+    sponsor_user?: User;
+    /** The number of Telegram Stars received by the bot for each 1000 Telegram Stars received by the affiliate program sponsor from referred users */
+    commission_per_mille: number;
 }
 /** Describes a withdrawal transaction with Fragment. */
 export interface TransactionPartnerFragment {
@@ -187,8 +222,10 @@ export interface TransactionPartnerOther {
 export interface StarTransaction {
     /** 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 */
+    /** Integer amount of Telegram Stars transferred by the transaction */
     amount: number;
+    /** The number of 1/1000000000 shares of Telegram Stars transferred by the transaction; from 0 to 999999999 */
+    nanostar_amount?: number;
     /** Date the transaction was created in Unix time */
     date: number;
     /** Source of an incoming transaction (e.g., a user purchasing goods or services, Fragment refunding a failed withdrawal). Only for incoming transactions */
@@ -208,3 +245,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[];
+}