@telegram.ts/types 1.17.1 → 1.18.0

package/package.json

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

@@ -38,6 +38,7 @@ import type {
   MessageId,
   ParseMode,
   Poll,
+  PreparedInlineMessage,
   ReactionType,
   ReplyParameters,
   SentWebAppMessage,
@@ -46,6 +47,7 @@ import type {
 } from "./messageTypes";
 import type { PassportElementError } from "./passportTypes";
 import type {
+  Gifts,
   LabeledPrice,
   ShippingOption,
   StarTransactions,
@@ -879,6 +881,16 @@ export type ApiMethods = {
     limit?: number;
   }): UserProfilePhotos;
 
+  /** Changes the emoji status for a given user that previously allowed the bot to manage their emoji status via the Mini App method requestEmojiStatusAccess. Returns True on success. */
+  setUserEmojiStatus(args: {
+    /** Unique identifier of the target user */
+    user_id: number;
+    /** Custom emoji identifier of the emoji status to set. Pass an empty string to remove the status. */
+    emoji_status_custom_emoji_id?: string;
+    /** Expiration date of the emoji status, if any */
+    emoji_status_expiration_date?: number;
+  }): true;
+
   /** Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>, where <file_path> is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile again.
 
   Note: This function may not preserve the original file name and MIME type. You should save the file's MIME type and name (if available) when the File object is received. */
@@ -1691,6 +1703,23 @@ 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. */
+  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. */
+  sendGift(args: {
+    /** Unique identifier of the target user that will receive the gift */
+    user_id: number;
+    /** Identifier of the gift */
+    gift_id: string;
+    /** 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. */
+    text_parse_mode?: ParseMode;
+    /** A list of special entities that appear in the gift text. It can be specified instead of text_parse_mode. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, and “custom_emoji” are ignored. */
+    text_entities?: MessageEntity[];
+  }): Gifts;
+
   /** Use this method to send answers to an inline query. On success, True is returned.
   No more than 50 results per query are allowed.
 
@@ -1718,6 +1747,22 @@ export type ApiMethods = {
     result: InlineQueryResult;
   }): SentWebAppMessage;
 
+  /** Stores a message that can be sent by a user of a Mini App. Returns a PreparedInlineMessage object. */
+  savePreparedInlineMessage(args: {
+    /** Unique identifier of the target user that can use the prepared message */
+    user_id: number;
+    /** An object describing the message to be sent */
+    result: InlineQueryResult;
+    /** Pass True if the message can be sent to private chats with users */
+    allow_user_chats?: boolean;
+    /** Pass True if the message can be sent to private chats with bots */
+    allow_bot_chats?: boolean;
+    /** Pass True if the message can be sent to group and supergroup chats */
+    allow_group_chats?: boolean;
+    /** Pass True if the message can be sent to channel chats */
+    allow_channel_chats?: boolean;
+  }): PreparedInlineMessage;
+
   /** Use this method to send invoices. On success, the sent Message is returned. */
   sendInvoice(args: {
     /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
@@ -1782,6 +1827,8 @@ export type ApiMethods = {
 
   /** Use this method to create a link for an invoice. Returns the created invoice link as String on success. */
   createInvoiceLink(args: {
+    /** Unique identifier of the business connection on behalf of which the link will be created */
+    business_connection_id?: string;
     /** Product name, 1-32 characters */
     title: string;
     /** Product description, 1-255 characters */
@@ -1794,6 +1841,8 @@ export type ApiMethods = {
     currency: string;
     /** Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.) */
     prices: LabeledPrice[];
+    /** The number of seconds the subscription will be active for before the next payment. The currency must be set to “XTR” (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. */
+    subscription_period?: number;
     /** The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0 */
     max_tip_amount?: number;
     /** An array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount. */
@@ -1824,6 +1873,16 @@ export type ApiMethods = {
     is_flexible?: boolean;
   }): string;
 
+  /** Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars. Returns True on success. */
+  editUserStarSubscription(args: {
+    /** Identifier of the user whose subscription will be edited */
+    user_id: number;
+    /** Telegram payment identifier for the subscription */
+    telegram_payment_charge_id: string;
+    /** Pass True to cancel extension of the user subscription; the subscription must be active up to the end of the current subscription period. Pass False to allow the user to re-enable a subscription that was previously canceled by the bot. */
+    is_canceled: boolean;
+  }): 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 */

package/src/invoiceTypes.d.ts

@@ -69,6 +69,12 @@ export interface SuccessfulPayment {
   total_amount: number;
   /** Bot specified invoice payload */
   invoice_payload: string;
+  /** Expiration date of the subscription, in Unix time; for recurring payments only */
+  subscription_expiration_date?: number;
+  /** True, if the payment is a recurring payment for a subscription */
+  is_recurring?: true;
+  /** True, if the payment is the first payment for a subscription */
+  is_first_recurring?: true;
   /** Identifier of the shipping option chosen by the user */
   shipping_option_id?: string;
   /** Order information provided by the user */
@@ -175,12 +181,16 @@ export interface TransactionPartnerUser {
   type: "user";
   /** Information about the user */
   user: User;
+  /** The duration of the paid subscription */
+  subscription_period?: number;
   /** 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;
+  /** The gift sent to the user by the bot */
+  gift?: string;
 }
 
 /** Describes a withdrawal transaction with Fragment. */
@@ -238,3 +248,23 @@ export interface PaidMediaPurchased {
   /** Bot-specified paid media payload */
   paid_media_payload: string;
 }
+
+/** This object represents a gift that can be sent by the bot. */
+export interface Gift {
+  /** Unique identifier of the gift */
+  id: string;
+  /** The sticker that represents the gift */
+  sticker: Sticker;
+  /** The number of Telegram Stars that must be paid to send the sticker */
+  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 */
+  remaining_count?: number;
+}
+
+/** This object represent a list of gifts. */
+export interface Gifts {
+  /** The list of gifts */
+  gifts: Gift[];
+}

package/src/markupTypes.d.ts

@@ -44,7 +44,7 @@ export declare namespace InlineKeyboardButton {
     /** If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent on behalf of a Telegram Business account. */
     switch_inline_query_chosen_chat: SwitchInlineQueryChosenChat;
   }
-  export interface CopyTextButton extends AbstractInlineKeyboardButton {
+  export interface CopyTextButtonButton extends AbstractInlineKeyboardButton {
     /**  Description of the button that copies the specified text to the clipboard. */
     copy_text: CopyTextButton;
   }
@@ -71,7 +71,7 @@ export type InlineKeyboardButton =
   | InlineKeyboardButton.SwitchInlineButton
   | InlineKeyboardButton.SwitchInlineCurrentChatButton
   | InlineKeyboardButton.SwitchInlineChosenChatButton
-  | InlineKeyboardButton.CopyTextButton
+  | InlineKeyboardButton.CopyTextButtonButton
   | InlineKeyboardButton.UrlButton
   | InlineKeyboardButton.WebAppButton;
 

package/src/messageTypes.d.ts

@@ -1483,3 +1483,11 @@ export interface MessageReactionCountUpdated {
   /** List of reactions that are present on the message */
   reactions: ReactionCount[];
 }
+
+/** Describes an inline message to be sent by a user of a Mini App. */
+export interface PreparedInlineMessage {
+  /** Unique identifier of the prepared message */
+  id: string;
+  /** Expiration date of the prepared message, in Unix time. Expired prepared messages can no longer be used */
+  expiration_date: number;
+}