@grammyjs/types 3.3.0 → 3.4.0

package/api.d.ts

@@ -15,7 +15,7 @@ All queries must be made using UTF-8. */
 export type ApiResponse<T> = ApiError | ApiSuccess<T>;
 /** Describes why a request was unsuccessful. */
 export interface ResponseParameters {
-    /** The group has been migrated to a supergroup with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier. */
+    /** The group has been migrated to a supergroup with the specified identifier. */
     migrate_to_chat_id?: number;
     /** In case of exceeding flood control, the number of seconds left to wait before the request can be repeated */
     retry_after?: number;

package/inline.d.ts

@@ -1,6 +1,6 @@
 import type { Chat, User } from "./manage.js";
 import type { InlineKeyboardMarkup, WebAppInfo } from "./markup.js";
-import type { Location, MessageEntity, ParseMode } from "./message.js";
+import type { LinkPreviewOptions, Location, MessageEntity, ParseMode } from "./message.js";
 import type { LabeledPrice } from "./payment.js";
 /** This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results. */
 export interface InlineQuery {
@@ -573,8 +573,8 @@ export interface InputTextMessageContent {
     parse_mode?: ParseMode;
     /** List of special entities that appear in message text, which can be specified instead of parse_mode */
     entities?: MessageEntity[];
-    /** Disables link previews for links in the sent message */
-    disable_web_page_preview?: boolean;
+    /** Link preview generation options for the message */
+    link_preview_options?: LinkPreviewOptions;
 }
 /** Represents the content of a location message to be sent as the result of an inline query. */
 export interface InputLocationMessageContent {

package/manage.d.ts

@@ -1,4 +1,4 @@
-import type { Location, Message, PhotoSize } from "./message.js";
+import type { Location, Message, PhotoSize, ReactionType } from "./message.js";
 import type { Update } from "./update.js";
 /** Describes the current status of a webhook. */
 export interface WebhookInfo {
@@ -23,7 +23,7 @@ export interface WebhookInfo {
 }
 /** This object represents a Telegram user or bot. */
 export interface User {
-    /** Unique identifier for this user or bot. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. */
+    /** Unique identifier for this user or bot. */
     id: number;
     /** True, if this user is a bot */
     is_bot: boolean;
@@ -54,7 +54,7 @@ export interface UserFromGetMe extends User {
 export declare namespace Chat {
     /** Internal type holding properties that all kinds of chats share. */
     interface AbstractChat {
-        /** Unique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier. */
+        /** Unique identifier for this chat. */
         id: number;
         /** Type of chat, can be either “private”, “group”, “supergroup” or “channel” */
         type: string;
@@ -103,35 +103,44 @@ export declare namespace Chat {
         has_protected_content?: true;
     }
     /** Internal type holding properties that those private, supergroup, and channel chats returned from `getChat` share. */
-    interface NonGroupGetChat extends GetChat {
+    interface NonGroupGetChat {
         /** If non-empty, the list of all active chat usernames; for private chats, supergroups and channels. Returned only in getChat. */
         active_usernames?: string[];
     }
     /** Internal type holding properties that those group, supergroup, and channel chats returned from `getChat` share. */
-    interface NonPrivateGetChat extends GetChat {
+    interface NonPrivateGetChat {
         /** Description, for groups, supergroups and channel chats. Returned only in getChat. */
         description?: string;
         /** Primary invite link, for groups, supergroups and channel chats. Returned only in getChat. */
         invite_link?: string;
+        /** List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed. Returned only in getChat. */
+        available_reactions?: ReactionType[];
     }
     /** Internal type holding properties that those group and supergroup chats returned from `getChat` share. */
-    interface MultiUserGetChat extends NonPrivateGetChat {
+    interface MultiUserGetChat {
         /** Default chat member permissions, for groups and supergroups. Returned only in getChat. */
         permissions?: ChatPermissions;
         /** True, if the bot can change the group sticker set. Returned only in getChat. */
         can_set_sticker_set?: true;
     }
+    /** Internal type holding properties that those private and channel chats returned from `getChat` share. */
+    interface NonMultiUserGetChat {
+        /** Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See accent colors for more details. Returned only in getChat. */
+        accent_color_id: number;
+        /** Custom emoji identifier of emoji chosen by the chat for the reply header and link preview background. Returned only in getChat. */
+        background_custom_emoji_id?: string;
+        /** Custom emoji identifier of the emoji status of the chat or the other party in a private chat. Returned only in getChat. */
+        emoji_status_custom_emoji_id?: string;
+        /** Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any. Returned only in getChat. */
+        emoji_status_expiration_date?: number;
+    }
     /** Internal type holding properties that those supergroup and channel chats returned from `getChat` share. */
-    interface LargeGetChat extends NonPrivateGetChat {
-        /** Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. Returned only in getChat. */
+    interface LargeGetChat {
+        /** Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. Returned only in getChat. */
         linked_chat_id?: number;
     }
     /** Internal type representing private chats returned from `getChat`. */
-    interface PrivateGetChat extends PrivateChat, NonGroupGetChat, GetChat {
-        /** Custom emoji identifier of emoji status of the other party in a private chat. Returned only in getChat. */
-        emoji_status_custom_emoji_id?: string;
-        /** Expiration date of the emoji status of the other party in a private chat in Unix time, if any. Returned only in getChat. */
-        emoji_status_expiration_date?: number;
+    interface PrivateGetChat extends PrivateChat, GetChat, NonGroupGetChat, NonMultiUserGetChat {
         /** Bio of the other party in a private chat. Returned only in getChat. */
         bio?: string;
         /** True, if privacy settings of the other party in the private chat allows to use tg://user?id=<user_id> links only in chats with the user. Returned only in getChat. */
@@ -140,16 +149,18 @@ export declare namespace Chat {
         has_restricted_voice_and_video_messages?: true;
     }
     /** Internal type representing group chats returned from `getChat`. */
-    interface GroupGetChat extends GroupChat, MultiUserGetChat {
+    interface GroupGetChat extends GroupChat, GetChat, NonPrivateGetChat, MultiUserGetChat {
     }
     /** Internal type representing supergroup chats returned from `getChat`. */
-    interface SupergroupGetChat extends SupergroupChat, NonGroupGetChat, MultiUserGetChat, LargeGetChat {
+    interface SupergroupGetChat extends SupergroupChat, GetChat, NonGroupGetChat, NonPrivateGetChat, MultiUserGetChat, LargeGetChat {
         /** True, if users need to join the supergroup before they can send messages. Returned only in getChat. */
         join_to_send_messages?: true;
         /** True, if all users directly joining the supergroup need to be approved by supergroup administrators. Returned only in getChat. */
         join_by_request?: true;
         /** For supergroups, the minimum allowed delay between consecutive messages sent by each unpriviledged user; in seconds. Returned only in getChat. */
         slow_mode_delay?: number;
+        /** True, if new chat members will have access to old messages; available only to chat administrators. Returned only in getChat. */
+        has_visible_history?: boolean;
         /** True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators. Returned only in getChat. */
         has_aggressive_anti_spam_enabled?: true;
         /** For supergroups, name of group sticker set. Returned only in getChat. */
@@ -158,7 +169,11 @@ export declare namespace Chat {
         location?: ChatLocation;
     }
     /** Internal type representing channel chats returned from `getChat`. */
-    interface ChannelGetChat extends ChannelChat, NonGroupGetChat, LargeGetChat {
+    interface ChannelGetChat extends ChannelChat, GetChat, NonGroupGetChat, NonPrivateGetChat, NonMultiUserGetChat, LargeGetChat {
+        /** Identifier of the accent color for the chat's profile background. See profile accent colors for more details. Returned only in getChat. */
+        profile_accent_color_id?: number;
+        /** Custom emoji identifier of the emoji chosen by the chat for its profile background. Returned only in getChat. */
+        profile_background_custom_emoji_id?: string;
     }
 }
 /** This object represents a chat. */
@@ -208,13 +223,13 @@ export interface ChatInviteLink {
 export interface ChatAdministratorRights {
     /** True, if the user's presence in the chat is hidden */
     is_anonymous: boolean;
-    /** True, if the administrator can access the chat event log, chat statistics, boost list in channels, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege */
+    /** True, if the administrator can access the chat event log, boost list in channels, see channel members, report spam messages, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege */
     can_manage_chat: boolean;
     /** True, if the administrator can delete messages of other users */
     can_delete_messages: boolean;
     /** True, if the administrator can manage video chats */
     can_manage_video_chats: boolean;
-    /** True, if the administrator can restrict, ban or unban chat members */
+    /** True, if the administrator can restrict, ban or unban chat members, or access supergroup statistics */
     can_restrict_members: boolean;
     /** True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user) */
     can_promote_members: boolean;
@@ -222,7 +237,7 @@ export interface ChatAdministratorRights {
     can_change_info: boolean;
     /** True, if the user is allowed to invite new users to the chat */
     can_invite_users: boolean;
-    /** True, if the administrator can post messages in the channel; channels only */
+    /** True, if the administrator can post messages in the channel, or access channel statistics; channels only */
     can_post_messages?: boolean;
     /** True, if the administrator can edit messages of other users and can pin messages; channels only */
     can_edit_messages?: boolean;
@@ -237,6 +252,23 @@ export interface ChatAdministratorRights {
     /** True, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only */
     can_manage_topics?: boolean;
 }
+/** This object represents changes in the status of a chat member. */
+export interface ChatMemberUpdated {
+    /** Chat the user belongs to */
+    chat: Chat;
+    /** Performer of the action, which resulted in the change */
+    from: User;
+    /** Date the change was done in Unix time */
+    date: number;
+    /** Previous information about the chat member */
+    old_chat_member: ChatMember;
+    /** New information about the chat member */
+    new_chat_member: ChatMember;
+    /** Chat invite link, which was used by the user to join the chat; for joining by invite link events only. */
+    invite_link?: ChatInviteLink;
+    /** True, if the user joined the chat via a chat folder invite link */
+    via_chat_folder_invite_link?: boolean;
+}
 /** This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported:
 - ChatMemberOwner
 - ChatMemberAdministrator
@@ -266,13 +298,13 @@ export interface ChatMemberAdministrator {
     can_be_edited: boolean;
     /** True, if the user's presence in the chat is hidden */
     is_anonymous: boolean;
-    /** True, if the administrator can access the chat event log, chat statistics, boost list in channels, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege */
+    /** True, if the administrator can access the chat event log, boost list in channels, see channel members, report spam messages, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege */
     can_manage_chat: boolean;
     /** True, if the administrator can delete messages of other users */
     can_delete_messages: boolean;
     /** True, if the administrator can manage video chats */
     can_manage_video_chats: boolean;
-    /** True, if the administrator can restrict, ban or unban chat members */
+    /** True, if the administrator can restrict, ban or unban chat members, or access supergroup statistics */
     can_restrict_members: boolean;
     /** True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user) */
     can_promote_members: boolean;
@@ -280,7 +312,7 @@ export interface ChatMemberAdministrator {
     can_change_info: boolean;
     /** True, if the user is allowed to invite new users to the chat */
     can_invite_users: boolean;
-    /** True, if the administrator can post messages in the channel; channels only */
+    /** True, if the administrator can post messages in the channel, or access channel statistics; channels only */
     can_post_messages?: boolean;
     /** True, if the administrator can edit messages of other users and can pin messages; channels only */
     can_edit_messages?: boolean;
@@ -312,7 +344,7 @@ export interface ChatMemberRestricted {
     user: User;
     /** True, if the user is a member of the chat at the moment of the request */
     is_member: boolean;
-    /** True, if the user is allowed to send text messages, contacts, invoices, locations and venues */
+    /** True, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices, locations and venues */
     can_send_messages: boolean;
     /** True, if the user is allowed to send audios */
     can_send_audios: boolean;
@@ -359,30 +391,13 @@ export interface ChatMemberBanned {
     /** Date when restrictions will be lifted for this user; Unix time. If 0, then the user is banned forever */
     until_date: number;
 }
-/** This object represents changes in the status of a chat member. */
-export interface ChatMemberUpdated {
-    /** Chat the user belongs to */
-    chat: Chat;
-    /** Performer of the action, which resulted in the change */
-    from: User;
-    /** Date the change was done in Unix time */
-    date: number;
-    /** Previous information about the chat member */
-    old_chat_member: ChatMember;
-    /** New information about the chat member */
-    new_chat_member: ChatMember;
-    /** Chat invite link, which was used by the user to join the chat; for joining by invite link events only. */
-    invite_link?: ChatInviteLink;
-    /** True, if the user joined the chat via a chat folder invite link */
-    via_chat_folder_invite_link?: boolean;
-}
 /** Represents a join request sent to a chat. */
 export interface ChatJoinRequest {
     /** Chat to which the request was sent */
     chat: Chat.SupergroupChat | Chat.ChannelChat;
     /** User that sent the join request */
     from: User;
-    /** Identifier of a private chat with the user who sent the join request. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot can use this identifier for 24 hours to send messages until the join request is processed, assuming no other administrator contacted the user. */
+    /** Identifier of a private chat with the user who sent the join request. The bot can use this identifier for 5 minutes to send messages until the join request is processed, assuming no other administrator contacted the user. */
     user_chat_id: number;
     /** Date the request was sent in Unix time */
     date: number;
@@ -393,7 +408,7 @@ export interface ChatJoinRequest {
 }
 /** Describes actions that a non-administrator user is allowed to take in a chat. */
 export interface ChatPermissions {
-    /** True, if the user is allowed to send text messages, contacts, invoices, locations and venues */
+    /** True, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices, locations and venues */
     can_send_messages?: boolean;
     /** True, if the user is allowed to send audios */
     can_send_audios?: boolean;
@@ -447,14 +462,64 @@ export interface BotCommand {
     /** Description of the command; 1-256 characters. */
     description: string;
 }
-/** This object represents a file ready to be downloaded. The file can be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>. 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. */
-export interface File {
-    /** Identifier for this file, which can be used to download or reuse the file */
-    file_id: string;
-    /** Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. */
-    file_unique_id: string;
-    /** File size in bytes */
-    file_size?: number;
-    /** File path. Use https://api.telegram.org/file/bot<token>/<file_path> to get the file. */
-    file_path?: string;
+/** This object describes the source of a chat boost. It can be one of
+
+- ChatBoostSourcePremium
+- ChatBoostSourceGiftCode
+- ChatBoostSourceGiveaway */
+export type ChatBoostSource = ChatBoostSourcePremium | ChatBoostSourceGiftCode | ChatBoostSourceGiveaway;
+/** The boost was obtained by subscribing to Telegram Premium or by gifting a Telegram Premium subscription to another user. */
+export interface ChatBoostSourcePremium {
+    /** Source of the boost, always “premium” */
+    source: "premium";
+    /** User that boosted the chat */
+    user: User;
+}
+/** The boost was obtained by the creation of Telegram Premium gift codes to boost a chat. Each such code boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription. */
+export interface ChatBoostSourceGiftCode {
+    /** Source of the boost, always “gift_code” */
+    source: "gift_code";
+    /** User for which the gift code was created */
+    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. */
+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;
+}
+/** This object contains information about a chat boost. */
+export interface ChatBoost {
+    /** Unique identifier of the boost */
+    boost_id: string;
+    /** Point in time (Unix timestamp) when the chat was boosted */
+    add_date: number;
+    /** Point in time (Unix timestamp) when the boost will automatically expire, unless the booster's Telegram Premium subscription is prolonged */
+    expiration_date: number;
+    /** Source of the added boost */
+    source: ChatBoostSource;
+}
+/** This object represents a boost added to a chat or changed. */
+export interface ChatBoostUpdated {
+    /** Chat which was boosted */
+    chat: Chat;
+    /** Infomation about the chat boost */
+    boost: ChatBoost;
+}
+/** This object represents a boost removed from a chat. */
+export interface ChatBoostRemoved {
+    /** Chat which was boosted */
+    chat: Chat;
+    /** Unique identifier of the boost */
+    boost_id: string;
+    /** Point in time (Unix timestamp) when the boost was removed */
+    remove_date: number;
+    /** Source of the removed boost */
+    source: ChatBoostSource;
+}
+/** This object represents a list of boosts added to a chat by a user. */
+export interface UserChatBoosts {
+    /** The list of boosts added to the chat by the user */
+    boosts: ChatBoost[];
 }

package/markup.d.ts

@@ -1,5 +1,5 @@
 import type { ChatAdministratorRights, User } from "./manage.js";
-import type { Message } from "./message.js";
+import type { MaybeInaccessibleMessage } from "./message.js";
 /** 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 */
@@ -93,8 +93,8 @@ export interface CallbackQuery {
     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. */
@@ -126,9 +126,9 @@ export declare namespace KeyboardButton {
         /** 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;
+    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 {
         /** 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. */
@@ -151,8 +151,8 @@ export declare namespace KeyboardButton {
         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. */
-export type KeyboardButton = KeyboardButton.CommonButton | KeyboardButton.RequestUserButton | KeyboardButton.RequestChatButton | KeyboardButton.RequestContactButton | KeyboardButton.RequestLocationButton | KeyboardButton.RequestPollButton | KeyboardButton.WebAppButton | string;
+/** 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.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. */
@@ -189,14 +189,16 @@ 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 {