@grammyjs/types 3.13.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 {
@@ -842,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

@@ -1020,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 {
@@ -1039,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. */
@@ -1056,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;
@@ -1075,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 {

package/methods.d.ts

@@ -527,10 +527,12 @@ export type ApiMethods<F> = {
         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. */
@@ -672,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 */
@@ -1479,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;
@@ -1536,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.13.0",
+  "version": "3.14.0",
   "description": "Telegram Bot API type declarations for grammY",
   "main": "mod.js",
   "repository": {

package/payment.d.ts

@@ -155,6 +155,8 @@ export interface TransactionPartnerUser {
     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 {
@@ -191,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;
 }