@telegram.ts/types 1.12.1 → 1.14.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@telegram.ts/types",
-  "version": "1.12.1",
+  "version": "1.14.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

@@ -154,8 +154,6 @@ export type ApiMethods = {
       | ReplyKeyboardMarkup
       | ReplyKeyboardRemove
       | ForceReply;
-    /** @deprecated Use `reply_parameters` instead. */
-    reply_to_message_id?: number;
   }): Message.TextMessage;
 
   /** Use this method to forward messages of any kind. Service messages and messages with protected content can't be forwarded. On success, the sent Message is returned. */
@@ -220,8 +218,6 @@ export type ApiMethods = {
       | ReplyKeyboardMarkup
       | ReplyKeyboardRemove
       | ForceReply;
-    /** @deprecated Use `reply_parameters` instead. */
-    reply_to_message_id?: number;
   }): MessageId;
 
   /** Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages,  and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageId of the sent messages is returned. */
@@ -276,8 +272,6 @@ export type ApiMethods = {
       | ReplyKeyboardMarkup
       | ReplyKeyboardRemove
       | ForceReply;
-    /** @deprecated Use `reply_parameters` instead. */
-    reply_to_message_id?: number;
   }): Message.PhotoMessage;
 
   /** Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.
@@ -320,8 +314,6 @@ export type ApiMethods = {
       | ReplyKeyboardMarkup
       | ReplyKeyboardRemove
       | ForceReply;
-    /** @deprecated Use `reply_parameters` instead. */
-    reply_to_message_id?: number;
   }): Message.AudioMessage;
 
   /** Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future. */
@@ -358,8 +350,6 @@ export type ApiMethods = {
       | ReplyKeyboardMarkup
       | ReplyKeyboardRemove
       | ForceReply;
-    /** @deprecated Use `reply_parameters` instead. */
-    reply_to_message_id?: number;
   }): Message.DocumentMessage;
 
   /** Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future. */
@@ -406,8 +396,6 @@ export type ApiMethods = {
       | ReplyKeyboardMarkup
       | ReplyKeyboardRemove
       | ForceReply;
-    /** @deprecated Use `reply_parameters` instead. */
-    reply_to_message_id?: number;
   }): Message.VideoMessage;
 
   /** Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future. */
@@ -452,8 +440,6 @@ export type ApiMethods = {
       | ReplyKeyboardMarkup
       | ReplyKeyboardRemove
       | ForceReply;
-    /** @deprecated Use `reply_parameters` instead. */
-    reply_to_message_id?: number;
   }): Message.AnimationMessage;
 
   /** Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future. */
@@ -488,8 +474,6 @@ export type ApiMethods = {
       | ReplyKeyboardMarkup
       | ReplyKeyboardRemove
       | ForceReply;
-    /** @deprecated Use `reply_parameters` instead. */
-    reply_to_message_id?: number;
   }): Message.VoiceMessage;
 
   /** Use this method to send video messages. On success, the sent Message is returned.
@@ -523,8 +507,6 @@ export type ApiMethods = {
       | ReplyKeyboardMarkup
       | ReplyKeyboardRemove
       | ForceReply;
-    /** @deprecated Use `reply_parameters` instead. */
-    reply_to_message_id?: number;
   }): Message.VideoNoteMessage;
 
   /** Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Messages that were sent is returned. */
@@ -547,8 +529,6 @@ export type ApiMethods = {
     message_effect_id?: string;
     /** Description of the message to reply to */
     reply_parameters?: ReplyParameters;
-    /** @deprecated Use `reply_parameters` instead. */
-    reply_to_message_id?: number;
   }): Array<
     | Message.AudioMessage
     | Message.DocumentMessage
@@ -590,8 +570,6 @@ export type ApiMethods = {
       | ReplyKeyboardMarkup
       | ReplyKeyboardRemove
       | ForceReply;
-    /** @deprecated Use `reply_parameters` instead. */
-    reply_to_message_id?: number;
   }): Message.LocationMessage;
 
   /** Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. */
@@ -636,6 +614,8 @@ export type ApiMethods = {
 
   /** Use this method to send paid media to channel chats. On success, the sent Message is returned. */
   sendPaidMedia(args: {
+    /** Unique identifier of the business connection on behalf of which the message will be sent */
+    business_connection_id?: string;
     /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
     chat_id: number | string;
     /** The number of Telegram Stars that must be paid to buy access to the media */
@@ -702,8 +682,6 @@ export type ApiMethods = {
       | ReplyKeyboardMarkup
       | ReplyKeyboardRemove
       | ForceReply;
-    /** @deprecated Use `reply_parameters` instead. */
-    reply_to_message_id?: number;
   }): Message.VenueMessage;
 
   /** Use this method to send phone contacts. On success, the sent Message is returned. */
@@ -736,8 +714,6 @@ export type ApiMethods = {
       | ReplyKeyboardMarkup
       | ReplyKeyboardRemove
       | ForceReply;
-    /** @deprecated Use `reply_parameters` instead. */
-    reply_to_message_id?: number;
   }): Message.ContactMessage;
 
   /** Use this method to send a native poll. On success, the sent Message is returned. */
@@ -790,8 +766,6 @@ export type ApiMethods = {
       | ReplyKeyboardMarkup
       | ReplyKeyboardRemove
       | ForceReply;
-    /** @deprecated Use `reply_parameters` instead. */
-    reply_to_message_id?: number;
   }): Message.PollMessage;
 
   /** Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned. */
@@ -818,8 +792,6 @@ export type ApiMethods = {
       | ReplyKeyboardMarkup
       | ReplyKeyboardRemove
       | ForceReply;
-    /** @deprecated Use `reply_parameters` instead. */
-    reply_to_message_id?: number;
   }): Message.DiceMessage;
 
   /** Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success.
@@ -879,8 +851,7 @@ export type ApiMethods = {
     file_id: string;
   }): File;
 
-  /** Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
-   * @deprecated Use `banChatMember` instead. */
+  /** Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success. */
   kickChatMember: ApiMethods["banChatMember"];
 
   /** Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success. */
@@ -1031,6 +1002,28 @@ export type ApiMethods = {
     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 channel 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) */
@@ -1087,6 +1080,8 @@ export type ApiMethods = {
 
   /** Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns True on success. */
   pinChatMessage(args: {
+    /** Unique identifier of the business connection on behalf of which the message will be pinned */
+    business_connection_id?: string;
     /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
     chat_id: number | string;
     /** Identifier of a message to pin */
@@ -1097,9 +1092,11 @@ export type ApiMethods = {
 
   /** Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns True on success. */
   unpinChatMessage(args: {
+    /** Unique identifier of the business connection on behalf of which the message will be unpinned */
+    business_connection_id?: string;
     /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
     chat_id: number | string;
-    /** Identifier of a message to unpin. If not specified, the most recent pinned message (by sending date) will be unpinned. */
+    /** Identifier of the message to unpin. Required if business_connection_id is specified. If not specified, the most recent pinned message (by sending date) will be unpinned. */
     message_id?: number;
   }): true;
 
@@ -1127,10 +1124,6 @@ export type ApiMethods = {
     chat_id: number | string;
   }): Array<ChatMemberOwner | ChatMemberAdministrator>;
 
-  /** Use this method to get the number of members in a chat. Returns Int on success.
-   * @deprecated Use `getChatMemberCount` instead. */
-  getChatMembersCount: ApiMethods["getChatMemberCount"];
-
   /** Use this method to get the number of members in a chat. Returns Int on success. */
   getChatMemberCount(args: {
     /** Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) */
@@ -1526,8 +1519,6 @@ export type ApiMethods = {
       | ReplyKeyboardMarkup
       | ReplyKeyboardRemove
       | ForceReply;
-    /** @deprecated Use `reply_parameters` instead. */
-    reply_to_message_id?: number;
   }): Message.StickerMessage;
 
   /** Use this method to get a sticker set. On success, a StickerSet object is returned. */
@@ -1648,7 +1639,7 @@ export type ApiMethods = {
     name: string;
     /** User identifier of the sticker set owner */
     user_id: number;
-    /** A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see https://core.telegram.org/stickers#animated-sticker-requirements for animated sticker technical requirements), or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files ». Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail. */
+    /** A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see https://core.telegram.org/stickers#animation-requirements for animated sticker technical requirements), or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files ». Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail. */
     thumbnail?: Buffer | ReadStream | string;
     /** Format of the thumbnail, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, or “video” for a WEBM video */
     format: "static" | "animated" | "video";
@@ -1747,8 +1738,6 @@ export type ApiMethods = {
     reply_parameters?: ReplyParameters;
     /** An object for an inline keyboard. If empty, one 'Pay total price' button will be shown. If not empty, the first button must be a Pay button. */
     reply_markup?: InlineKeyboardMarkup;
-    /** @deprecated Use `reply_parameters` instead. */
-    reply_to_message_id?: number;
   }): Message.InvoiceMessage;
 
   /** Use this method to create a link for an invoice. Returns the created invoice link as String on success. */
@@ -1863,8 +1852,6 @@ export type ApiMethods = {
     reply_parameters?: ReplyParameters;
     /** An object for an inline keyboard. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game. */
     reply_markup?: InlineKeyboardMarkup;
-    /** @deprecated Use `reply_parameters` instead. */
-    reply_to_message_id?: number;
   }): Message.GameMessage;
 
   /** Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user's current score in the chat and force is False. */

package/src/invoiceTypes.d.ts

@@ -1,4 +1,5 @@
 import type { User } from "./manageTypes";
+import type { PaidMedia } from "./messageTypes";
 
 /** This object represents a portion of the price for goods or services. */
 export interface LabeledPrice {
@@ -174,6 +175,8 @@ export interface TransactionPartnerUser {
   user: User;
   /** Bot-specified invoice payload */
   invoice_payload?: string;
+  /** Information about the paid media bought by the user */
+  paid_media?: PaidMedia[];
 }
 
 /** Describes a withdrawal transaction with Fragment. */

package/src/manageTypes.d.ts

@@ -60,7 +60,9 @@ export interface UserFromGetMe extends User {
   /** True, if the bot supports inline queries. Returned only in getMe. */
   supports_inline_queries: boolean;
   /** True, if the bot can be connected to a Telegram Business account to receive its messages. Returned only in getMe. */
-  can_connect_to_business?: boolean;
+  can_connect_to_business: boolean;
+  /** True, if the bot has main Web App. Returned only in getMe. */
+  has_main_web_app: boolean;
 }
 
 export declare namespace Chat {
@@ -240,7 +242,7 @@ export declare namespace ChatFullInfo {
     /** Type of the chat, can be either “private”, “group”, “supergroup” or “channel” */
     type: "group";
     /** Title, for supergroups, channels and group chats */
-    title?: string;
+    title: string;
     /**  Username, for private chats, supergroups and channels if available */
     username?: undefined;
     /**  First name of the other party in a private chat */
@@ -331,7 +333,7 @@ export declare namespace ChatFullInfo {
     /** Type of the chat, can be either “private”, “group”, “supergroup” or “channel” */
     type: "supergroup";
     /** Title, for supergroups, channels and group chats */
-    title?: string;
+    title: string;
     /**  Username, for private chats, supergroups and channels if available */
     username?: string;
     /**  First name of the other party in a private chat */
@@ -422,7 +424,7 @@ export declare namespace ChatFullInfo {
     /** Type of the chat, can be either “private”, “group”, “supergroup” or “channel” */
     type: "channel";
     /** Title, for supergroups, channels and group chats */
-    title?: string;
+    title: string;
     /**  Username, for private chats, supergroups and channels if available */
     username?: string;
     /**  First name of the other party in a private chat */
@@ -688,6 +690,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. */

package/src/messageTypes.d.ts

@@ -1,7 +1,11 @@
 import type { Chat, User } from "./manageTypes";
 import type { InlineKeyboardMarkup } from "./markupTypes";
 import type { PassportData } from "./passportTypes";
-import type { Invoice, RefundedPayment, SuccessfulPayment } from "./invoiceTypes";
+import type {
+  Invoice,
+  RefundedPayment,
+  SuccessfulPayment,
+} from "./invoiceTypes";
 
 type MsgWith<P extends keyof Message> = Record<P, NonNullable<Message[P]>>;
 
@@ -1331,8 +1335,12 @@ 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 {
@@ -1423,6 +1431,12 @@ export interface ReactionTypeCustomEmoji {
   custom_emoji: 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 */