@telegram.ts/types 1.14.2 → 1.15.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@telegram.ts/types",
-  "version": "1.14.2",
+  "version": "1.15.0",
   "description": "Comprehensive Type Declarations for Telegram Bot API with telegramsjs",
   "main": "./src/index.js",
   "types": "./src/index.d.ts",

package/src/apiMethodsTypes.d.ts

@@ -1,4 +1,5 @@
 import type { ReadStream } from "node:fs";
+import type { Buffer } from "node:buffer";
 import type {
   InlineQueryResult,
   InlineQueryResultsButton,
@@ -618,10 +619,12 @@ export type ApiMethods = {
     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[];
+    /** 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. */

package/src/invoiceTypes.d.ts

@@ -177,6 +177,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. */
@@ -218,3 +220,11 @@ 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/src/manageTypes.d.ts

@@ -898,14 +898,16 @@ export interface ChatBoostSourceGiftCode {
   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/src/messageTypes.d.ts

@@ -1156,8 +1156,11 @@ export interface SharedUser {
   photo?: PhotoSize[];
 }
 
-/** This object represents a service message about the creation of a scheduled giveaway. Currently holds no information. */
-export interface GiveawayCreated {}
+/** 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 {
@@ -1175,7 +1178,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;
 }
 
@@ -1193,7 +1198,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;
@@ -1213,6 +1220,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. */

package/src/updateTypes.d.ts

@@ -17,7 +17,11 @@ import type {
   Poll,
   PollAnswer,
 } from "./messageTypes";
-import type { PreCheckoutQuery, ShippingQuery } from "./invoiceTypes";
+import type {
+  PaidMediaPurchased,
+  PreCheckoutQuery,
+  ShippingQuery,
+} from "./invoiceTypes";
 
 /**
  * Namespace used internally to define more accurate message update types.
@@ -164,4 +168,7 @@ export interface Update {
 
   /** 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;
 }