@grammyjs/types 3.22.1 → 3.23.0

package/checklist.d.ts

@@ -1,4 +1,4 @@
-import type { User } from "./manage.js";
+import type { Chat, User } from "./manage.js";
 import type { Message, MessageEntity, ParseMode } from "./message.js";
 /** Describes a task in a checklist. */
 export interface ChecklistTask {
@@ -8,8 +8,10 @@ export interface ChecklistTask {
     text: string;
     /** Special entities that appear in the task text */
     text_entities?: MessageEntity[];
-    /** User that completed the task; omitted if the task wasn't completed */
+    /** User that completed the task; omitted if the task wasn't completed by a user */
     completed_by_user?: User;
+    /** Chat that completed the task; omitted if the task wasn't completed by a chat */
+    completed_by_chat?: Chat;
     /** Point in time (Unix timestamp) when the task was completed; 0 if the task wasn't completed */
     completion_date?: number;
 }

package/inline.d.ts

@@ -621,7 +621,7 @@ export interface InputInvoiceMessageContent {
     description: string;
     /** Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes. */
     payload: string;
-    /** Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars. */
+    /** Payment provider token, obtained via `@BotFather`. Pass an empty string for payments in Telegram Stars. */
     provider_token?: string;
     /** Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars. */
     currency: string;
@@ -658,7 +658,7 @@ export interface InputInvoiceMessageContent {
 }
 /** Represents a result of an inline query that was chosen by the user and sent to their chat partner.
 
-Note: It is necessary to enable inline feedback via @BotFather in order to receive these objects in updates. */
+Note: It is necessary to enable inline feedback via `@BotFather` in order to receive these objects in updates. */
 export interface ChosenInlineResult {
     /** The unique identifier for the result that was chosen */
     result_id: string;

package/manage.d.ts

@@ -1,4 +1,5 @@
 import type { Location, Message, PhotoSize, ReactionType, Sticker } from "./message.js";
+import type { UniqueGiftColors } from "./payment.js";
 import type { Update } from "./update.js";
 /** Describes the current status of a webhook. */
 export interface WebhookInfo {
@@ -31,6 +32,8 @@ export interface AcceptedGiftTypes {
     unique_gifts: boolean;
     /** True, if a Telegram Premium subscription is accepted */
     premium_subscription: boolean;
+    /** True, if transfers of unique gifts from channels are accepted */
+    gifts_from_channels: boolean;
 }
 /** This object represents a Telegram user or bot. */
 export interface User {
@@ -65,6 +68,19 @@ export interface UserFromGetMe extends User {
     can_connect_to_business: boolean;
     /** True, if the bot has main Web App. Returned only in getMe. */
     has_main_web_app: boolean;
+    /** True, if the bot has forum topic mode enabled in private chats. Returned only in getMe. */
+    has_topics_enabled?: boolean;
+}
+/** This object describes the rating of a user based on their Telegram Star spendings. */
+export interface UserRating {
+    /** Current level of the user, indicating their reliability when purchasing digital goods and services. A higher level suggests a more trustworthy customer; a negative level is likely reason for concern. */
+    level: number;
+    /** Numerical value of the user's rating; the higher the rating, the better */
+    rating: number;
+    /** The rating value required to get the current level */
+    current_level_rating: number;
+    /** The rating value required to get to the next level; omitted if the maximum level was reached */
+    next_level_rating?: number;
 }
 export declare namespace Chat {
     /** Internal type for private chats */
@@ -163,6 +179,8 @@ export declare namespace ChatFullInfo {
         last_name?: string;
         /** True, if the supergroup chat is a forum (has topics enabled) */
         is_forum?: undefined;
+        /** True, if the chat is the direct messages chat of a channel */
+        is_direct_messages?: undefined;
         /** 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. */
         accent_color_id: number;
         /** The maximum number of reactions that can be set on a message in the chat */
@@ -179,8 +197,14 @@ export declare namespace ChatFullInfo {
         business_location?: BusinessLocation;
         /** For private chats with business accounts, the opening hours of the business */
         business_opening_hours?: BusinessOpeningHours;
+        /** For private chats, the rating of the user if any */
+        rating?: UserRating;
+        /** The color scheme based on a unique gift that must be used for the chat's name, message replies and link previews */
+        unique_gift_colors?: UniqueGiftColors;
         /** For private chats, the personal channel of the user */
         personal_chat?: Chat;
+        /** Information about the corresponding channel chat; for direct messages chats only */
+        parent_chat?: undefined;
         /** List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed. */
         available_reactions?: ReactionType[];
         /** Custom emoji identifier of the emoji chosen by the chat for the reply header and link preview background */
@@ -237,8 +261,6 @@ export declare namespace ChatFullInfo {
         custom_emoji_sticker_set_name?: undefined;
         /** Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. */
         linked_chat_id?: undefined;
-        /** Information about the corresponding channel chat; for direct messages chats only */
-        parent_chat?: undefined;
         /** For supergroups, the location to which the supergroup is connected */
         location?: undefined;
     }
@@ -258,6 +280,8 @@ export declare namespace ChatFullInfo {
         last_name?: undefined;
         /** True, if the supergroup chat is a forum (has topics enabled) */
         is_forum?: undefined;
+        /** True, if the chat is the direct messages chat of a channel */
+        is_direct_messages?: undefined;
         /** 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. */
         accent_color_id: number;
         /** The maximum number of reactions that can be set on a message in the chat */
@@ -274,8 +298,14 @@ export declare namespace ChatFullInfo {
         business_location?: undefined;
         /** For private chats with business accounts, the opening hours of the business */
         business_opening_hours?: undefined;
+        /** For private chats, the rating of the user if any */
+        rating?: undefined;
+        /** The color scheme based on a unique gift that must be used for the chat's name, message replies and link previews */
+        unique_gift_colors?: UniqueGiftColors;
         /** For private chats, the personal channel of the user */
         personal_chat?: undefined;
+        /** Information about the corresponding channel chat; for direct messages chats only */
+        parent_chat?: undefined;
         /** List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed. */
         available_reactions?: ReactionType[];
         /** Custom emoji identifier of the emoji chosen by the chat for the reply header and link preview background */
@@ -306,8 +336,8 @@ export declare namespace ChatFullInfo {
         pinned_message?: Message;
         /** Default chat member permissions, for groups and supergroups */
         permissions?: ChatPermissions;
-        /** True, if gifts can be sent to the chat */
-        can_send_gift?: true;
+        /** Information about types of gifts that are accepted by the chat or by the corresponding user for private chats */
+        accepted_gift_types: AcceptedGiftTypes;
         /** True, if paid media messages can be sent or forwarded to the channel chat. The field is available only for channel chats. */
         can_send_paid_media?: undefined;
         /** For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds */
@@ -332,8 +362,6 @@ export declare namespace ChatFullInfo {
         custom_emoji_sticker_set_name?: undefined;
         /** Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. */
         linked_chat_id?: undefined;
-        /** Information about the corresponding channel chat; for direct messages chats only */
-        parent_chat?: undefined;
         /** For supergroups, the location to which the supergroup is connected */
         location?: undefined;
     }
@@ -353,6 +381,8 @@ export declare namespace ChatFullInfo {
         last_name?: undefined;
         /** True, if the supergroup chat is a forum (has topics enabled) */
         is_forum?: true;
+        /** True, if the chat is the direct messages chat of a channel */
+        is_direct_messages?: true;
         /** 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. */
         accent_color_id: number;
         /** The maximum number of reactions that can be set on a message in the chat */
@@ -369,8 +399,14 @@ export declare namespace ChatFullInfo {
         business_location?: undefined;
         /** For private chats with business accounts, the opening hours of the business */
         business_opening_hours?: undefined;
+        /** For private chats, the rating of the user if any */
+        rating?: undefined;
+        /** The color scheme based on a unique gift that must be used for the chat's name, message replies and link previews */
+        unique_gift_colors?: UniqueGiftColors;
         /** For private chats, the personal channel of the user */
         personal_chat?: undefined;
+        /** Information about the corresponding channel chat; for direct messages chats only */
+        parent_chat?: Chat.ChannelChat;
         /** List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed. */
         available_reactions?: ReactionType[];
         /** Custom emoji identifier of the emoji chosen by the chat for the reply header and link preview background */
@@ -401,8 +437,8 @@ export declare namespace ChatFullInfo {
         pinned_message?: Message;
         /** Default chat member permissions, for groups and supergroups */
         permissions?: ChatPermissions;
-        /** True, if gifts can be sent to the chat */
-        can_send_gift?: true;
+        /** Information about types of gifts that are accepted by the chat or by the corresponding user for private chats */
+        accepted_gift_types: AcceptedGiftTypes;
         /** True, if paid media messages can be sent or forwarded to the channel chat. The field is available only for channel chats. */
         can_send_paid_media?: undefined;
         /** For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds */
@@ -427,8 +463,6 @@ export declare namespace ChatFullInfo {
         custom_emoji_sticker_set_name?: string;
         /** Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. */
         linked_chat_id?: number;
-        /** Information about the corresponding channel chat; for direct messages chats only */
-        parent_chat?: Chat.ChannelChat;
         /** For supergroups, the location to which the supergroup is connected */
         location?: ChatLocation;
     }
@@ -448,6 +482,8 @@ export declare namespace ChatFullInfo {
         last_name?: undefined;
         /** True, if the supergroup chat is a forum (has topics enabled) */
         is_forum?: undefined;
+        /** True, if the chat is the direct messages chat of a channel */
+        is_direct_messages?: undefined;
         /** 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. */
         accent_color_id: number;
         /** The maximum number of reactions that can be set on a message in the chat */
@@ -464,8 +500,14 @@ export declare namespace ChatFullInfo {
         business_location?: undefined;
         /** For private chats with business accounts, the opening hours of the business */
         business_opening_hours?: undefined;
+        /** For private chats, the rating of the user if any */
+        rating?: undefined;
+        /** The color scheme based on a unique gift that must be used for the chat's name, message replies and link previews */
+        unique_gift_colors?: UniqueGiftColors;
         /** For private chats, the personal channel of the user */
         personal_chat?: undefined;
+        /** Information about the corresponding channel chat; for direct messages chats only */
+        parent_chat?: undefined;
         /** List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed. */
         available_reactions?: ReactionType[];
         /** Custom emoji identifier of the emoji chosen by the chat for the reply header and link preview background */
@@ -496,8 +538,8 @@ export declare namespace ChatFullInfo {
         pinned_message?: Message;
         /** Default chat member permissions, for groups and supergroups */
         permissions?: undefined;
-        /** True, if gifts can be sent to the chat */
-        can_send_gift?: true;
+        /** Information about types of gifts that are accepted by the chat or by the corresponding user for private chats */
+        accepted_gift_types: AcceptedGiftTypes;
         /** True, if paid media messages can be sent or forwarded to the channel chat. The field is available only for channel chats. */
         can_send_paid_media?: true;
         /** For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds */
@@ -522,8 +564,6 @@ export declare namespace ChatFullInfo {
         custom_emoji_sticker_set_name?: undefined;
         /** Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. */
         linked_chat_id?: number;
-        /** Information about the corresponding channel chat; for direct messages chats only */
-        parent_chat?: undefined;
         /** For supergroups, the location to which the supergroup is connected */
         location?: undefined;
     }
@@ -853,6 +893,8 @@ export interface ForumTopic {
     message_thread_id: number;
     /** Name of the topic */
     name: string;
+    /** True, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed by the bot */
+    is_name_implicit?: true;
     /** Color of the topic icon in RGB format */
     icon_color: number;
     /** Unique identifier of the custom emoji shown as the topic icon */

package/markup.d.ts

@@ -120,7 +120,7 @@ export interface ReplyKeyboardMarkup {
     one_time_keyboard?: boolean;
     /** The placeholder to be shown in the input field when the keyboard is active; 1-64 characters */
     input_field_placeholder?: string;
-    /** Use this parameter if you want to show the keyboard to 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 to a message in the same chat and forum topic, sender of the original message.
+    /** Use this parameter if you want to show the keyboard to 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 to a message in the same chat and forum topic, sender of the original message.
   
     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;
@@ -166,7 +166,7 @@ export interface KeyboardButtonPollType {
 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) */
     remove_keyboard: true;
-    /** Use this parameter if you want to remove the keyboard for 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 to a message in the same chat and forum topic, sender of the original message.
+    /** Use this parameter if you want to remove the keyboard for 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 to a message in the same chat and forum topic, sender of the original message.
   
     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;
@@ -185,7 +185,7 @@ export interface ForceReply {
     force_reply: true;
     /** The placeholder to be shown in the input field when the reply is active; 1-64 characters */
     input_field_placeholder?: string;
-    /** 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 to a message in the same chat and forum topic, sender of the original message. */
+    /** 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 to a message in the same chat and forum topic, sender of the original message. */
     selective?: boolean;
 }
 /** This object represents an inline keyboard button that copies specified text to the clipboard. */

package/message.d.ts

@@ -8,7 +8,7 @@ export declare namespace Message {
     interface ServiceMessage {
         /** Unique message identifier inside this chat. In specific instances (e.g., message containing a video sent to a big chat), the server might automatically schedule a message instead of sending it immediately. In such cases, this field will be 0 and the relevant message will be unusable until it is actually sent */
         message_id: number;
-        /** Unique identifier of a message thread or a forum topic to which the message belongs; for supergroups only */
+        /** Unique identifier of a message thread or forum topic to which the message belongs; for supergroups and private chats only */
         message_thread_id?: number;
         /** Sender of the message; may be empty for messages sent to channels. For backward compatibility, if the message was sent on behalf of a chat, the field contains a fake sender user in non-channel chats */
         from?: User;
@@ -20,7 +20,7 @@ export declare namespace Message {
         business_connection_id?: string;
         /** Chat the message belongs to */
         chat: Chat;
-        /** True, if the message is sent to a forum topic */
+        /** True, if the message is sent to a topic in a forum supergroup or a private chat with the bot */
         is_topic_message?: boolean;
         /** Information about the direct messages chat topic that contains the message */
         direct_messages_topic?: DirectMessagesTopic;
@@ -79,7 +79,7 @@ export declare namespace Message {
         /** True, if the message media is covered by a spoiler animation */
         has_media_spoiler?: true;
     }
-    type TextMessage = CommonMessage & MsgWith<"text">;
+    type TextMessage = CommonMessage & MsgWith<"text"> & Partial<MsgWith<"entities">>;
     type AudioMessage = CaptionableMessage & MsgWith<"audio">;
     type DocumentMessage = CaptionableMessage & MsgWith<"document">;
     type AnimationMessage = DocumentMessage & MsgWith<"animation">;
@@ -141,6 +141,7 @@ export declare namespace Message {
     type GiveawayCompletedMessage = ServiceMessage & MsgWith<"giveaway_completed">;
     type GiftMessage = ServiceMessage & MsgWith<"gift">;
     type UniqueGiftMessage = ServiceMessage & MsgWith<"unique_gift">;
+    type GiftUpgradeSentMessage = ServiceMessage & MsgWith<"gift_upgrade_sent">;
     type PaidMessagePriceChangedMessage = ServiceMessage & MsgWith<"paid_message_price_changed">;
     type VideoChatScheduledMessage = ServiceMessage & MsgWith<"video_chat_scheduled">;
     type VideoChatStartedMessage = ServiceMessage & MsgWith<"video_chat_started">;
@@ -274,6 +275,8 @@ export interface Message extends Message.MediaMessage {
     giveaway_completed?: GiveawayCompleted;
     /** Service message: a regular gift was sent or received */
     gift?: GiftInfo;
+    /** Service message: upgrade of a gift was purchased after the gift was sent */
+    gift_upgrade_sent?: GiftInfo;
     /** Service message: a unique gift was sent or received */
     unique_gift?: UniqueGiftInfo;
     /** Service message: the price for paid messages has changed in the chat */
@@ -370,7 +373,7 @@ Please note:
 - Inside `pre` and `code` entities, all '`' and '\' characters must be escaped with a preceding '\' character.
 - Inside the `(...)` part of the inline link and custom emoji definition, all ')' and '\' must be escaped with a preceding '\' character.
 - In all other places characters '_', '*', '[', ']', '(', ')', '~', '`', '>', '#', '+', '-', '=', '|', '{', '}', '.', '!' must be escaped with the preceding character '\'.
-- In case of ambiguity between `italic` and `underline` entities `__` is always greadily treated from left to right as beginning or end of an `underline` entity, so instead of `___italic underline___` use `___italic underline_**__`, adding an empty bold entity as a separator.
+- In case of ambiguity between `italic` and `underline` entities `__` is always greedily treated from left to right as beginning or end of an `underline` entity, so instead of `___italic underline___` use `___italic underline_**__`, adding an empty bold entity as a separator.
 - A valid emoji must be provided as an alternative value for the custom emoji. The emoji will be shown instead of the custom emoji in places where a custom emoji cannot be displayed (e.g., system notifications) or if the message is forwarded by a non-premium user. It is recommended to use the emoji from the emoji field of the custom emoji sticker.
 - Custom emoji entities can only be used by bots that purchased additional usernames on Fragment.
 
@@ -424,12 +427,12 @@ Please note:
 
 - Entities must not be nested, use parse mode MarkdownV2 instead.
 - There is no way to specify “underline”, “strikethrough”, “spoiler”, “blockquote”, “expandable_blockquote” and “custom_emoji” entities, use parse mode MarkdownV2 instead.
-- To escape characters '_', '*', '`', '[' outside of an entity, prepend the characters '\' before them.
+- To escape characters '_', '*', '`', '[' outside of an entity, prepend the character '\' before them.
 - Escaping inside entities is not allowed, so entity must be closed first and reopened again: use `_snake_\__case_` for italic `snake_case` and `*2*\**2=4*` for bold `2*2=4`. */
 export type ParseMode = "Markdown" | "MarkdownV2" | "HTML";
 export declare namespace MessageEntity {
     interface AbstractMessageEntity {
-        /** Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag or #hashtag@chatusername), “cashtag” ($USD or $USD@chatusername), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler” (spoiler message), “blockquote” (block quotation), “expandable_blockquote” (collapsed-by-default block quotation), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames), “custom_emoji” (for inline custom emoji stickers) */
+        /** Type of the entity. Currently, can be “mention” (`@username`), “hashtag” (#hashtag or `#hashtag@chatusername`), “cashtag” ($USD or `$USD@chatusername`), “bot_command” (`/start@jobs_bot`), “url” (https://telegram.org), “email” (`do-not-reply@telegram.org`), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler” (spoiler message), “blockquote” (block quotation), “expandable_blockquote” (collapsed-by-default block quotation), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames), “custom_emoji” (for inline custom emoji stickers) */
         type: string;
         /** Offset in UTF-16 code units to the start of the entity */
         offset: number;
@@ -530,7 +533,7 @@ export interface ExternalReplyInfo {
 export interface ReplyParameters {
     /** Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified */
     message_id: number;
-    /** If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername). Not supported for messages sent on behalf of a business account and messages from channel direct messages chats. */
+    /** If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format `@channelusername`). Not supported for messages sent on behalf of a business account and messages from channel direct messages chats. */
     chat_id?: number | string;
     /** Identifier of the specific checklist task to be replied to */
     checklist_task_id?: number;
@@ -992,6 +995,8 @@ export interface ChatBackground {
 export interface ForumTopicCreated {
     /** Name of the topic */
     name: string;
+    /** True, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed by the bot */
+    is_name_implicit?: true;
     /** Color of the topic icon in RGB format */
     icon_color: number;
     /** Unique identifier of the custom emoji shown as the topic icon */