@telegram.ts/types 1.19.1 → 1.21.0

package/package.json

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

@@ -77,11 +77,11 @@ export type ApiMethods = {
     timeout?: number;
     /** A list of the update types you want your bot to receive. For example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (default). If not specified, the previous setting will be used.
 
-    Please note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time. */
+    Please note that this parameter doesn't affect updates created before the call to getUpdates, so unwanted updates may be received for a short period of time. */
     allowed_updates?: ReadonlyArray<Exclude<keyof Update, "update_id">>;
   }): Update[];
 
-  /** Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success.
+  /** Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized Update. In case of an unsuccessful request (a request with response HTTP status code different from 2XY), we will repeat the request  and give up after a reasonable amount of attempts. Returns True on success.
 
   If you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header “X-Telegram-Bot-Api-Secret-Token” with the secret token as content.
 
@@ -170,6 +170,8 @@ export type ApiMethods = {
     message_thread_id?: number;
     /** Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername) */
     from_chat_id: number | string;
+    /** New start timestamp for the copied video in the message */
+    video_start_timestamp?: number;
     /** Sends the message silently. Users will receive a notification with no sound. */
     disable_notification?: boolean;
     /** Protects the contents of the forwarded message from forwarding and saving */
@@ -202,6 +204,8 @@ export type ApiMethods = {
     message_thread_id?: number;
     /** Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername) */
     from_chat_id: number | string;
+    /** New start timestamp for the copied video in the message */
+    video_start_timestamp?: number;
     /** Message identifier in the chat specified in from_chat_id */
     message_id: number;
     /** New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept */
@@ -384,6 +388,10 @@ export type ApiMethods = {
     height?: number;
     /** Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. */
     thumbnail?: Buffer | ReadStream | string;
+    /** Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. */
+    cover?: Buffer | ReadStream | string;
+    /** Start timestamp for the video in the message */
+    start_timestamp?: number;
     /** Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing */
     caption?: string;
     /** Mode for parsing entities in the video caption. See formatting options for more details. */
@@ -859,7 +867,7 @@ export type ApiMethods = {
     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 of some types 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. */
   setMessageReaction(args: {
     /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
     chat_id: number | string;
@@ -1689,9 +1697,9 @@ 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#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. */
+    /** 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 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";
   }): true;
 
@@ -1703,15 +1711,19 @@ export type ApiMethods = {
     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. */
+  /** Returns the list of gifts that can be sent by the bot to users and chennel chats. 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. */
+  /** Sends a gift to the given user or channel chat. The gift can't be converted to Telegram Stars by the receiver. Returns True on success. */
   sendGift(args: {
-    /** Unique identifier of the target user that will receive the gift */
-    user_id: number;
+    /** Required if chat_id is not specified. Unique identifier of the target user who will receive the gift. */
+    user_id?: number;
+    /** Required if user_id is not specified. Unique identifier for the chat or username of the channel (in the format @channelusername) that will receive the gift. */
+    chat_id?: number | string;
     /** Identifier of the gift */
     gift_id: string;
+    /** Pass True to pay for the gift upgrade from the bot's balance, thereby making the upgrade free for the receiver */
+    pay_for_upgrade?: boolean;
     /** 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. */
@@ -1883,6 +1895,34 @@ export type ApiMethods = {
     is_canceled: boolean;
   }): true;
 
+  /** Verifies a user on behalf of the organization which is represented by the bot. Returns True on success. */
+  verifyUser(args: {
+    /** Unique identifier of the target user */
+    user_id: number;
+    /** Custom description for the verification; 0-70 characters. Must be empty if the organization isn't allowed to provide a custom verification description. */
+    custom_description?: string;
+  }): true;
+
+  /** Verifies a chat on behalf of the organization which is represented by the bot. Returns True on success. */
+  verifyChat(args: {
+    /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
+    chat_id: number | string;
+    /** Custom description for the verification; 0-70 characters. Must be empty if the organization isn't allowed to provide a custom verification description. */
+    custom_description?: string;
+  }): true;
+
+  /** Removes verification from a user who is currently verified on behalf of the organization represented by the bot. Returns True on success. */
+  removeUserVerification(args: {
+    /** Unique identifier of the target user */
+    user_id: number;
+  }): true;
+
+  /** Removes verification from a chat that is currently verified on behalf of the organization represented by the bot. Returns True on success. */
+  removeChatVerification(args: {
+    /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
+    chat_id: number | string;
+  }): true;
+
   /** If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned. */
   answerShippingQuery(args: {
     /** Unique identifier for the query to be answered */
@@ -1891,7 +1931,7 @@ export type ApiMethods = {
     ok: boolean;
     /** Required if ok is True. An array of available shipping options. */
     shipping_options?: readonly ShippingOption[];
-    /** Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. "Sorry, delivery to your desired address is unavailable'). Telegram will display this message to the user. */
+    /** Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. "Sorry, delivery to your desired address is unavailable"). Telegram will display this message to the user. */
     error_message?: string;
   }): true;
 
@@ -1992,7 +2032,7 @@ export type ApiMethods = {
 export interface InputSticker {
   /** The added sticker. 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. Animated and video stickers can't be uploaded via HTTP URL. */
   sticker: Buffer | ReadStream | string;
-  /** Format of the added sticker, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, “video” for a WEBM video */
+  /** Format of the added sticker, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, “video” for a .WEBM video */
   format: "static" | "animated" | "video";
   /** List of 1-20 emoji associated with the sticker */
   emoji_list: string[];
@@ -2041,6 +2081,10 @@ export interface InputMediaVideo {
   media: Buffer | ReadStream | string;
   /** Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. */
   thumbnail?: Buffer | ReadStream | string;
+  /** Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. */
+  cover?: Buffer | ReadStream | string;
+  /** Start timestamp for the video in the message */
+  start_timestamp?: number;
   /** Caption of the video to be sent, 0-1024 characters after entities parsing */
   caption?: string;
   /** Pass True, if the caption must be shown above the message media */
@@ -2148,6 +2192,10 @@ export interface InputPaidMediaVideo {
   media: Buffer | ReadStream | string;
   /** Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » */
   thumbnail?: Buffer | ReadStream | string;
+  /** Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. */
+  cover?: Buffer | ReadStream | string;
+  /** Start timestamp for the video in the message */
+  start_timestamp?: number;
   /** Video width */
   width?: number;
   /** Video height */

package/src/inlineTypes.d.ts

@@ -80,8 +80,6 @@ export interface InlineQueryResultArticle {
   reply_markup?: InlineKeyboardMarkup;
   /** URL of the result */
   url?: string;
-  /** Pass True if you don't want the URL to be shown in the message */
-  hide_url?: boolean;
   /** Short description of the result */
   description?: string;
   /** Url of the thumbnail for the result */
@@ -128,7 +126,7 @@ export interface InlineQueryResultGif {
   type: "gif";
   /** Unique identifier for this result, 1-64 bytes */
   id: string;
-  /** A valid URL for the GIF file. File size must not exceed 1MB */
+  /** A valid URL for the GIF file */
   gif_url: string;
   /** Width of the GIF */
   gif_width?: number;
@@ -161,7 +159,7 @@ export interface InlineQueryResultMpeg4Gif {
   type: "mpeg4_gif";
   /** Unique identifier for this result, 1-64 bytes */
   id: string;
-  /** A valid URL for the MPEG4 file. File size must not exceed 1MB */
+  /** A valid URL for the MPEG4 file */
   mpeg4_url: string;
   /** Video width */
   mpeg4_width?: number;

package/src/invoiceTypes.d.ts

@@ -178,6 +178,7 @@ export interface AffiliateInfo {
 /** This object describes the source of a transaction, or its recipient for outgoing transactions. Currently, it can be one of
 
 - TransactionPartnerUser
+- TransactionPartnerChat
 - TransactionPartnerFragment
 - TransactionPartnerAffiliateProgram
 - TransactionPartnerTelegramAds
@@ -208,7 +209,17 @@ export interface TransactionPartnerUser {
   /** Bot-specified paid media payload */
   paid_media_payload?: string;
   /** The gift sent to the user by the bot */
-  gift?: string;
+  gift?: Gift;
+}
+
+/** Describes a transaction with a chat. */
+export interface TransactionPartnerChat {
+  /** Type of the transaction partner, always “chat” */
+  type: "chat";
+  /** Information about the chat */
+  chat: Chat;
+  /** The gift sent to the chat by the bot */
+  gift?: Gift;
 }
 
 /** Describes the affiliate program that issued the affiliate commission received via this transaction. */
@@ -287,6 +298,8 @@ export interface Gift {
   sticker: Sticker;
   /** The number of Telegram Stars that must be paid to send the sticker */
   star_count: number;
+  /** The number of Telegram Stars that must be paid to upgrade the gift to a unique one */
+  upgrade_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 */

package/src/messageTypes.d.ts

@@ -712,6 +712,10 @@ export interface Video {
   duration: number;
   /** Video thumbnail */
   thumbnail?: PhotoSize;
+  /** Available sizes of the cover of the video in the message */
+  cover?: PhotoSize[];
+  /** Timestamp in seconds from which the video will play in the message */
+  start_timestamp?: number;
   /** Original filename as defined by sender */
   file_name?: string;
   /** MIME type of the file as defined by sender */
@@ -1041,7 +1045,7 @@ export interface BackgroundTypeWallpaper {
   is_moving?: true;
 }
 
-/** The background is a PNG or TGV (gzipped subset of SVG with MIME type “application/x-tgwallpattern”) pattern to be combined with the background fill chosen by the user. */
+/** The background is a .PNG or .TGV (gzipped subset of SVG with MIME type “application/x-tgwallpattern”) pattern to be combined with the background fill chosen by the user. */
 export interface BackgroundTypePattern {
   /** Type of the background, always “pattern” */
   type: "pattern";