@telegram.ts/types 1.4.0 → 1.6.0

package/src/markupTypes.d.ts

@@ -1,10 +1,12 @@
-import type { ChatAdministratorRights, User } from "./manageTypes.js";
-import type { Message } from "./messageTypes.js";
+import type { ChatAdministratorRights, User } from "./manageTypes";
+import type { MaybeInaccessibleMessage } from "./messageTypes";
+
 /** This object represents an inline keyboard that appears right next to the message it belongs to. */
 export interface InlineKeyboardMarkup {
   /** Array of button rows, each represented by an Array of InlineKeyboardButton objects */
   inline_keyboard: InlineKeyboardButton[][];
 }
+
 export declare namespace InlineKeyboardButton {
   interface AbstractInlineKeyboardButton {
     /** Label text on the button */
@@ -27,9 +29,7 @@ export declare namespace InlineKeyboardButton {
     login_url: LoginUrl;
   }
   export interface SwitchInlineButton extends AbstractInlineKeyboardButton {
-    /** If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. Can be empty, in which case just the bot's username will be inserted.
-
-    Note: This offers an easy way for users to start using your bot in inline mode when they are currently in a private chat with it. Especially useful when combined with switch_pm... actions – in this case the user will be automatically returned to the chat they switched from, skipping the chat selection screen. */
+    /** If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. Can be empty, in which case just the bot's username will be inserted. */
     switch_inline_query: string;
   }
   export interface SwitchInlineCurrentChatButton
@@ -56,8 +56,8 @@ export declare namespace InlineKeyboardButton {
     NOTE: This type of button must always be the first button in the first row and can only be used in invoice messages. */
     pay: boolean;
   }
-  export {};
 }
+
 /** This object represents one button of an inline keyboard. You must use exactly one of the optional fields. */
 export type InlineKeyboardButton =
   | InlineKeyboardButton.CallbackButton
@@ -69,6 +69,7 @@ export type InlineKeyboardButton =
   | InlineKeyboardButton.SwitchInlineChosenChatButton
   | InlineKeyboardButton.UrlButton
   | InlineKeyboardButton.WebAppButton;
+
 /** This object represents a parameter of the inline keyboard button used to automatically authorize a user. Serves as a great replacement for the Telegram Login Widget when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in.
 Telegram apps support these buttons as of version 5.7. */
 export interface LoginUrl {
@@ -83,6 +84,7 @@ export interface LoginUrl {
   /** Pass True to request the permission for your bot to send messages to the user. */
   request_write_access?: boolean;
 }
+
 /** This object represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query. */
 export interface SwitchInlineQueryChosenChat {
   /** The default inline query to be inserted in the input field. If left empty, only the bot's username will be inserted */
@@ -96,18 +98,20 @@ export interface SwitchInlineQueryChosenChat {
   /** True, if channel chats can be chosen */
   allow_channel_chats?: boolean;
 }
+
 /** A placeholder, currently holds no information. Use BotFather to set up your game. */
 export interface CallbackGame {}
+
 /** This object represents an incoming callback query from a callback button in an inline keyboard. If the button that originated the query was attached to a message sent by the bot, the field message will be present. If the button was attached to a message sent via the bot (in inline mode), the field inline_message_id will be present. Exactly one of the fields data or game_short_name will be present.
 
-NOTE: After the user presses a callback button, Telegram clients will display a progress bar until you call answerCallbackQuery. It is, therefore, necessary to react by calling answerCallbackQuery even if no notification to the user is needed (e.g., without specifying any of the optional parameters). */
+ NOTE: After the user presses a callback button, Telegram clients will display a progress bar until you call answerCallbackQuery. It is, therefore, necessary to react by calling answerCallbackQuery even if no notification to the user is needed (e.g., without specifying any of the optional parameters). */
 export interface CallbackQuery {
   /** Unique identifier for this query */
   id: string;
   /** Sender */
   from: User;
-  /** Message with the callback button that originated the query. Note that message content and message date will not be available if the message is too old */
-  message?: Message;
+  /** Message sent by the bot with the callback button that originated the query */
+  message?: MaybeInaccessibleMessage;
   /** Identifier of the message sent via the bot in inline mode, that originated the query. */
   inline_message_id?: string;
   /** Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games. */
@@ -117,6 +121,7 @@ export interface CallbackQuery {
   /** Short name of a Game to be returned, serves as the unique identifier for the game */
   game_short_name?: string;
 }
+
 /** This object represents a custom keyboard with reply options (see Introduction to bots for details and examples). */
 export interface ReplyKeyboardMarkup {
   /** Array of button rows, each represented by an Array of KeyboardButton objects */
@@ -134,51 +139,55 @@ export interface ReplyKeyboardMarkup {
   Example: A user requests to change the bot's language, bot replies to the request with a keyboard to select the new language. Other users in the group don't see the keyboard. */
   selective?: boolean;
 }
+
 export declare namespace KeyboardButton {
-  interface CommonButton {
+  export interface CommonButton {
     /** Text of the button. If none of the optional fields are used, it will be sent as a message when the button is pressed */
     text: string;
   }
-  interface RequestUserButton extends CommonButton {
-    /** If specified, pressing the button will open a list of suitable users. Tapping on any user will send their identifier to the bot in a “user_shared” service message. Available in private chats only. */
-    request_user: KeyboardButtonRequestUser;
+  export interface RequestUsersButton extends CommonButton {
+    /** If specified, pressing the button will open a list of suitable users. Identifiers of selected users will be sent to the bot in a “users_shared” service message. Available in private chats only. */
+    request_users: KeyboardButtonRequestUsers;
   }
-  interface RequestChatButton extends CommonButton {
+  export interface RequestChatButton extends CommonButton {
     /** If specified, pressing the button will open a list of suitable chats. Tapping on a chat will send its identifier to the bot in a “chat_shared” service message. Available in private chats only. */
     request_chat: KeyboardButtonRequestChat;
   }
-  interface RequestContactButton extends CommonButton {
+  export interface RequestContactButton extends CommonButton {
     /** If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only. */
     request_contact: boolean;
   }
-  interface RequestLocationButton extends CommonButton {
+  export interface RequestLocationButton extends CommonButton {
     /** If True, the user's current location will be sent when the button is pressed. Available in private chats only. */
     request_location: boolean;
   }
-  interface RequestPollButton extends CommonButton {
+  export interface RequestPollButton extends CommonButton {
     /** If specified, the user will be asked to create a poll and send it to the bot when the button is pressed. Available in private chats only. */
     request_poll: KeyboardButtonPollType;
   }
-  interface WebAppButton extends CommonButton {
+  export interface WebAppButton extends CommonButton {
     /** If specified, the described Web App will be launched when the button is pressed. The Web App will be able to send a “web_app_data” service message. Available in private chats only. */
     web_app: WebAppInfo;
   }
 }
-/** This object represents one button of the reply keyboard. For simple text buttons, String can be used instead of this object to specify the button text. The optional fields web_app, request_user, request_chat, request_contact, request_location, and request_poll are mutually exclusive. */
+
+/** This object represents one button of the reply keyboard. For simple text buttons, String can be used instead of this object to specify the button text. The optional fields web_app, request_users, request_chat, request_contact, request_location, and request_poll are mutually exclusive. */
 export type KeyboardButton =
   | KeyboardButton.CommonButton
-  | KeyboardButton.RequestUserButton
+  | KeyboardButton.RequestUsersButton
   | KeyboardButton.RequestChatButton
   | KeyboardButton.RequestContactButton
   | KeyboardButton.RequestLocationButton
   | KeyboardButton.RequestPollButton
   | KeyboardButton.WebAppButton
   | string;
+
 /** This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed. */
 export interface KeyboardButtonPollType {
   /** If quiz is passed, the user will be allowed to create only polls in the quiz mode. If regular is passed, only regular polls will be allowed. Otherwise, the user will be allowed to create a poll of any type. */
   type?: "quiz" | "regular";
 }
+
 /** Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup). */
 export interface ReplyKeyboardRemove {
   /** Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup) */
@@ -188,6 +197,7 @@ export interface ReplyKeyboardRemove {
   Example: A user votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet. */
   selective?: boolean;
 }
+
 /** Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode.
 
 Example: A poll bot for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll:
@@ -205,20 +215,25 @@ export interface ForceReply {
   /** Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message. */
   selective?: boolean;
 }
+
 /** Describes a Web App. */
 export interface WebAppInfo {
   /** An HTTPS URL of a Web App to be opened with additional data as specified in Initializing Web Apps */
   url: string;
 }
-/** This object defines the criteria used to request a suitable user. The identifier of the selected user will be shared with the bot when the corresponding button is pressed. */
-export interface KeyboardButtonRequestUser {
-  /** Signed 32-bit identifier of the request, which will be received back in the UserShared object. Must be unique within the message */
+
+/** This object defines the criteria used to request suitable users. The identifiers of the selected users will be shared with the bot when the corresponding button is pressed. */
+export interface KeyboardButtonRequestUsers {
+  /** Signed 32-bit identifier of the request that will be received back in the UsersShared object. Must be unique within the message */
   request_id: number;
-  /** Pass True to request a bot, pass False to request a regular user. If not specified, no additional restrictions are applied. */
+  /** Pass True to request bots, pass False to request regular users. If not specified, no additional restrictions are applied. */
   user_is_bot?: boolean;
-  /** Pass True to request a premium user, pass False to request a non-premium user. If not specified, no additional restrictions are applied. */
+  /** Pass True to request premium users, pass False to request non-premium users. If not specified, no additional restrictions are applied. */
   user_is_premium?: boolean;
+  /** The maximum number of users to be selected; 1-10. Defaults to 1. */
+  max_quantity?: boolean;
 }
+
 /** This object defines the criteria used to request a suitable chat. The identifier of the selected chat will be shared with the bot when the corresponding button is pressed. */
 export interface KeyboardButtonRequestChat {
   /** Signed 32-bit identifier of the request, which will be received back in the ChatShared object. Must be unique within the message */