@grammyjs/types 3.12.0 → 3.14.0

package/inline.d.ts

@@ -621,7 +621,7 @@ export interface InputInvoiceMessageContent {
     title: string;
     /** Product description, 1-255 characters */
     description: string;
-    /** Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. */
+    /** Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes. */
     payload: string;
     /** Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars. */
     provider_token?: string;

package/manage.d.ts

@@ -535,6 +535,10 @@ export interface ChatInviteLink {
     member_limit?: number;
     /** Number of pending join requests created using this link */
     pending_join_request_count?: number;
+    /** The number of seconds the subscription will be active for before the next payment */
+    subscription_period?: number;
+    /** The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat using the link */
+    subscription_price?: number;
 }
 /** Represents the rights of an administrator in a chat. */
 export interface ChatAdministratorRights {
@@ -654,6 +658,8 @@ export interface ChatMemberMember {
     status: "member";
     /** Information about the user */
     user: User;
+    /** Date when the user's subscription will expire; Unix time */
+    until_date?: number;
 }
 /** Represents a chat member that is under certain restrictions in the chat. Supergroups only. */
 export interface ChatMemberRestricted {
@@ -840,14 +846,16 @@ export interface ChatBoostSourceGiftCode {
     /** User for which the gift code was created */
     user: User;
 }
-/** The boost was obtained by the creation of a Telegram Premium giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription. */
+/** The boost was obtained by the creation of a Telegram Premium or a Telegram Star giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription for Telegram Premium giveaways and prize_star_count / 500 times for one year for Telegram Star giveaways. */
 export interface ChatBoostSourceGiveaway {
     /** Source of the boost, always “giveaway” */
     source: "giveaway";
     /** Identifier of a message in the chat with the giveaway; the message could have been deleted already */
     giveaway_message_id: number;
-    /** User that won the prize in the giveaway if any */
+    /** User that won the prize in the giveaway if any; for Telegram Premium giveaways only */
     user?: User;
+    /** The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only */
+    prize_star_count?: number;
     /** True, if the giveaway was completed, but there was no user to win the prize */
     is_unclaimed?: true;
 }

package/message.d.ts

@@ -9,9 +9,9 @@ export declare namespace Message {
         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;
-        /** Sender of the message; empty for messages sent to channels. For backward compatibility, the field contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat. */
+        /** Sender of the message; may be empty for messages sent to channels. For backward compatibility, if the message was sent on behalf of a chat, the field contains a fake sender user in non-channel chats */
         from?: User;
-        /** Sender of the message, sent on behalf of a chat. For example, the channel itself for channel posts, the supergroup itself for messages from anonymous group administrators, the linked channel for messages automatically forwarded to the discussion group. For backward compatibility, the field from contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat. */
+        /** Sender of the message when sent on behalf of a chat. For example, the supergroup itself for messages sent by its anonymous administrators or a linked channel for messages automatically forwarded to the channel's discussion group. For backward compatibility, if the message was sent on behalf of a chat, the field from contains a fake sender user in non-channel chats. */
         sender_chat?: Chat;
         /** Date the message was sent in Unix time. It is always a positive number, representing a valid date. */
         date: number;
@@ -129,6 +129,7 @@ export declare namespace Message {
 type ReplyMessage = Message & {
     reply_to_message: undefined;
 };
+/** This object represents a message. */
 export interface Message extends Message.MediaMessage {
     /** For text messages, the actual UTF-8 text of the message */
     text?: string;
@@ -1019,8 +1020,10 @@ export interface VideoChatParticipantsInvited {
     /** New members that were invited to the video chat */
     users: User[];
 }
-/** This object represents a service message about the creation of a scheduled giveaway. Currently holds no information. */
+/** This object represents a service message about the creation of a scheduled giveaway. */
 export interface GiveawayCreated {
+    /** The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only */
+    prize_star_count?: number;
 }
 /** This object represents a message about a scheduled giveaway. */
 export interface Giveaway {
@@ -1038,7 +1041,9 @@ export interface Giveaway {
     prize_description?: string;
     /** A list of two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which eligible users for the giveaway must come. If empty, then all users can participate in the giveaway. Users with a phone number that was bought on Fragment can always participate in giveaways. */
     country_codes?: string[];
-    /** The number of months the Telegram Premium subscription won from the giveaway will be active for */
+    /** The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only */
+    prize_star_count?: number;
+    /** The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only */
     premium_subscription_month_count?: number;
 }
 /** This object represents a message about the completion of a giveaway with public winners. */
@@ -1055,7 +1060,9 @@ export interface GiveawayWinners {
     winners: User[];
     /** The number of other chats the user had to join in order to be eligible for the giveaway */
     additional_chat_count?: number;
-    /** The number of months the Telegram Premium subscription won from the giveaway will be active for */
+    /** The number of Telegram Stars that were split between giveaway winners; for Telegram Star giveaways only */
+    prize_star_count?: number;
+    /** The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only */
     premium_subscription_month_count?: number;
     /** Number of undistributed prizes */
     unclaimed_prize_count?: number;
@@ -1074,6 +1081,8 @@ export interface GiveawayCompleted {
     unclaimed_prize_count?: number;
     /** Message with the giveaway that was completed, if it wasn't deleted */
     giveaway_message?: Message;
+    /** True, if the giveaway is a Telegram Star giveaway. Otherwise, currently, the giveaway is a Telegram Premium giveaway. */
+    is_star_giveaway?: true;
 }
 /** Describes the options used for link preview generation. */
 export interface LinkPreviewOptions {
@@ -1181,8 +1190,9 @@ export interface File {
 /** This object describes the type of a reaction. Currently, it can be one of
 
 - ReactionTypeEmoji
-- ReactionTypeCustomEmoji */
-export type ReactionType = ReactionTypeEmoji | ReactionTypeCustomEmoji;
+- ReactionTypeCustomEmoji
+- ReactionTypePaid */
+export type ReactionType = ReactionTypeEmoji | ReactionTypeCustomEmoji | ReactionTypePaid;
 /** The reaction is based on an emoji. */
 export interface ReactionTypeEmoji {
     /** Type of the reaction, always “emoji” */
@@ -1197,6 +1207,11 @@ export interface ReactionTypeCustomEmoji {
     /** Custom emoji identifier */
     custom_emoji_id: string;
 }
+/** The reaction is paid. */
+export interface ReactionTypePaid {
+    /** Type of the reaction, always “paid” */
+    type: "paid";
+}
 /** Represents a reaction added to a message along with the number of times it was added. */
 export interface ReactionCount {
     /** Type of the reaction */

package/methods.d.ts

@@ -521,14 +521,18 @@ export type ApiMethods<F> = {
         /** An object for a new inline keyboard. */
         reply_markup?: InlineKeyboardMarkup;
     }): (Update.Edited & Message.LocationMessage) | true;
-    /** Use this method to send paid media to channel chats. On success, the sent Message is returned. */
+    /** Use this method to send paid media. On success, the sent Message is returned. */
     sendPaidMedia(args: {
-        /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
+        /** Unique identifier of the business connection on behalf of which the message to be edited was sent */
+        business_connection_id?: string;
+        /** Unique identifier for the target chat or username of the target channel (in the format @channelusername). If the chat is a channel, all Telegram Star proceeds from this media will be credited to the chat's balance. Otherwise, they will be credited to the bot's balance. */
         chat_id: number | string;
-        /** The number of Telegram Stars that must be paid to buy access to the media */
+        /** The number of Telegram Stars that must be paid to buy access to the media; 1-2500 */
         star_count: number;
         /** An array describing the media to be sent; up to 10 items */
         media: InputPaidMedia<F>[];
+        /** Bot-defined paid media payload, 0-128 bytes. This will not be displayed to the user, use it for your internal processes. */
+        payload?: string;
         /** Media caption, 0-1024 characters after entities parsing */
         caption?: string;
         /** Mode for parsing entities in the media caption. See formatting options for more details. */
@@ -670,7 +674,7 @@ export type ApiMethods<F> = {
         /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
         message_thread_id?: number;
         /** Emoji on which the dice throw animation is based. Currently, must be one of "🎲", "🎯", "🏀", "⚽", "🎳", or "🎰". Dice can have values 1-6 for "🎲", "🎯" and "🎳", values 1-5 for "🏀" and "⚽", and values 1-64 for "🎰". Defaults to "🎲" */
-        emoji?: string;
+        emoji?: (string & Record<never, never>) | "🎲" | "🎯" | "🏀" | "⚽" | "🎳" | "🎰";
         /** Sends the message silently. Users will receive a notification with no sound. */
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding */
@@ -699,13 +703,13 @@ export type ApiMethods<F> = {
         /** Unique identifier for the target message thread; for supergroups only */
         message_thread_id?: number;
     }): true;
-    /** Use this method to change the chosen reactions on a message. Service messages can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. In albums, bots must react to the first message. Returns True on success. */
+    /** Use this method to change the chosen reactions on a message. Service messages can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Bots can't use paid reactions. Returns True on success. */
     setMessageReaction(args: {
         /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
         chat_id: number | string;
         /** Identifier of the target message */
         message_id: number;
-        /** A list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators. */
+        /** A list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators. Paid reactions can't be used by bots. */
         reaction?: ReactionType[];
         /** Pass True to set the reaction with a big animation */
         is_big?: boolean;
@@ -866,6 +870,26 @@ export type ApiMethods<F> = {
         /** True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified */
         creates_join_request?: boolean;
     }): ChatInviteLink;
+    /** Use this method to create a subscription invite link for a channel chat. The bot must have the can_invite_users administrator rights. The link can be edited using the method editChatSubscriptionInviteLink or revoked using the method revokeChatInviteLink. Returns the new invite link as a ChatInviteLink object. */
+    createChatSubscriptionInviteLink(args: {
+        /** Unique identifier for the target channel chat or username of the target channel (in the format @channelusername) */
+        chat_id: number | string;
+        /** Invite link name; 0-32 characters */
+        name?: string;
+        /** The number of seconds the subscription will be active for before the next payment. Currently, it must always be 2592000 (30 days). */
+        subscription_period: number;
+        /** The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat; 1-2500 */
+        subscription_price: number;
+    }): ChatInviteLink;
+    /** Use this method to edit a subscription invite link created by the bot. The bot must have the can_invite_users administrator rights. Returns the edited invite link as a ChatInviteLink object. */
+    editChatSubscriptionInviteLink(args: {
+        /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
+        chat_id: number | string;
+        /** The invite link to edit */
+        invite_link: string;
+        /** Invite link name; 0-32 characters */
+        name?: string;
+    }): ChatInviteLink;
     /** Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object. */
     revokeChatInviteLink(args: {
         /** Unique identifier of the target chat or username of the target channel (in the format @channelusername) */
@@ -993,7 +1017,7 @@ export type ApiMethods<F> = {
         /** Unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers. */
         icon_custom_emoji_id?: string;
     }): ForumTopic;
-    /** Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success. */
+    /** Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success. */
     editForumTopic(args: {
         /** Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) */
         chat_id: number | string;
@@ -1032,7 +1056,7 @@ export type ApiMethods<F> = {
         /** Unique identifier for the target message thread of the forum topic */
         message_thread_id: number;
     }): true;
-    /** Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success. */
+    /** Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success. */
     editGeneralForumTopic(args: {
         /** Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) */
         chat_id: number | string;
@@ -1457,7 +1481,7 @@ export type ApiMethods<F> = {
         title: string;
         /** Product description, 1-255 characters */
         description: string;
-        /** Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. */
+        /** Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes. */
         payload: string;
         /** Payment provider token, obtained via BotFather. Pass an empty string for payments in Telegram Stars. */
         provider_token?: string;
@@ -1514,7 +1538,7 @@ export type ApiMethods<F> = {
         title: string;
         /** Product description, 1-255 characters */
         description: string;
-        /** Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. */
+        /** Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes. */
         payload: string;
         /** Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars. */
         provider_token?: string;

package/package.json

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

package/payment.d.ts

@@ -1,4 +1,5 @@
 import type { User } from "./manage.js";
+import type { PaidMedia } from "./message.js";
 /** This object represents a portion of the price for goods or services. */
 export interface LabeledPrice {
     /** Portion label */
@@ -152,6 +153,10 @@ export interface TransactionPartnerUser {
     user: User;
     /** Bot-specified invoice payload */
     invoice_payload?: string;
+    /** Information about the paid media bought by the user */
+    paid_media?: PaidMedia[];
+    /** Bot-specified paid media payload */
+    paid_media_payload?: string;
 }
 /** Describes a withdrawal transaction with Fragment. */
 export interface TransactionPartnerFragment {
@@ -188,3 +193,10 @@ export interface StarTransactions {
     /** The list of transactions */
     transactions: StarTransaction[];
 }
+/** This object contains information about a paid media purchase. */
+export interface PaidMediaPurchased {
+    /** User who purchased the media */
+    from: User;
+    /** Bot-specified paid media payload */
+    paid_media_payload: string;
+}

package/update.d.ts

@@ -2,7 +2,7 @@ import type { ChosenInlineResult, InlineQuery } from "./inline.js";
 import type { BusinessConnection, BusinessMessagesDeleted, Chat, ChatBoostRemoved, ChatBoostUpdated, ChatJoinRequest, ChatMemberUpdated, User } from "./manage.js";
 import type { CallbackQuery } from "./markup.js";
 import type { Message, MessageReactionCountUpdated, MessageReactionUpdated, Poll, PollAnswer } from "./message.js";
-import type { PreCheckoutQuery, ShippingQuery } from "./payment.js";
+import type { PaidMediaPurchased, PreCheckoutQuery, ShippingQuery } from "./payment.js";
 /** Internal namespace used to make some message types more accurate */
 export declare namespace Update {
     /** Internal type holding properties that message updates in private chats share. */
@@ -73,4 +73,6 @@ export interface Update {
     chat_boost?: ChatBoostUpdated;
     /** A boost was removed from a chat. The bot must be an administrator in the chat to receive these updates. */
     removed_chat_boost?: ChatBoostRemoved;
+    /** A user purchased paid media with a non-empty payload sent by the bot in a non-channel chat */
+    purchased_paid_media?: PaidMediaPurchased;
 }