@grammyjs/types 3.23.0 → 3.24.0

package/checklist.d.ts

@@ -35,7 +35,7 @@ export interface InputChecklistTask {
     /** Text of the task; 1-100 characters after entities parsing */
     text: string;
     /** Mode for parsing entities in the text. See formatting options for more details. */
-    parse_mode?: string;
+    parse_mode?: ParseMode;
     /** List of special entities that appear in the text, which can be specified instead of parse_mode. Currently, only bold, italic, underline, strikethrough, spoiler, and custom_emoji entities are allowed. */
     text_entities?: MessageEntity[];
 }

package/manage.d.ts

@@ -1,4 +1,4 @@
-import type { Location, Message, PhotoSize, ReactionType, Sticker } from "./message.js";
+import type { Audio, 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. */
@@ -69,7 +69,19 @@ export interface UserFromGetMe extends User {
     /** 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;
+    has_topics_enabled: boolean;
+    /** True, if the bot allows users to create and delete topics in private chats. Returned only in getMe. */
+    allows_users_to_create_topics: boolean;
+}
+/** Describes a service message about the chat owner leaving the chat. */
+export interface ChatOwnerLeft {
+    /** The user which will be the new owner of the chat if the previous owner does not return to the chat */
+    new_owner?: User;
+}
+/** Describes a service message about an ownership change in the chat. */
+export interface ChatOwnerChanged {
+    /** The new owner of the chat */
+    new_owner: User;
 }
 /** This object describes the rating of a user based on their Telegram Star spendings. */
 export interface UserRating {
@@ -187,6 +199,8 @@ export declare namespace ChatFullInfo {
         max_reaction_count: number;
         /** Chat photo */
         photo?: ChatPhoto;
+        /** For private chats, the first audio added to the profile of the user */
+        first_profile_audio?: Audio;
         /** If non-empty, the list of all active chat usernames; for private chats, supergroups and channels */
         active_usernames?: string[];
         /** For private chats, the date of birth of the user */
@@ -288,6 +302,8 @@ export declare namespace ChatFullInfo {
         max_reaction_count: number;
         /** Chat photo */
         photo?: ChatPhoto;
+        /** For private chats, the first audio added to the profile of the user */
+        first_profile_audio?: undefined;
         /** If non-empty, the list of all active chat usernames; for private chats, supergroups and channels */
         active_usernames?: undefined;
         /** For private chats, the date of birth of the user */
@@ -389,6 +405,8 @@ export declare namespace ChatFullInfo {
         max_reaction_count: number;
         /** Chat photo */
         photo?: ChatPhoto;
+        /** For private chats, the first audio added to the profile of the user */
+        first_profile_audio?: undefined;
         /** If non-empty, the list of all active chat usernames; for private chats, supergroups and channels */
         active_usernames?: string[];
         /** For private chats, the date of birth of the user */
@@ -490,6 +508,8 @@ export declare namespace ChatFullInfo {
         max_reaction_count: number;
         /** Chat photo */
         photo?: ChatPhoto;
+        /** For private chats, the first audio added to the profile of the user */
+        first_profile_audio?: undefined;
         /** If non-empty, the list of all active chat usernames; for private chats, supergroups and channels */
         active_usernames?: string[];
         /** For private chats, the date of birth of the user */
@@ -579,6 +599,13 @@ export interface UserProfilePhotos {
     /** Requested profile pictures (in up to 4 sizes each) */
     photos: PhotoSize[][];
 }
+/** This object represents the audios displayed on a user's profile. */
+export interface UserProfileAudios {
+    /** Total number of profile audios for the target user */
+    total_count: number;
+    /** Requested profile audios */
+    audios: Audio[];
+}
 /** This object represents a chat photo. */
 export interface ChatPhoto {
     /** File identifier of small (160x160) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed. */

package/markup.d.ts

@@ -9,6 +9,10 @@ export declare namespace InlineKeyboardButton {
     interface AbstractInlineKeyboardButton {
         /** Label text on the button */
         text: string;
+        /** Unique identifier of the custom emoji shown before the text of the button. Can only be used by bots that purchased additional usernames on Fragment or in the messages directly sent by the bot to private, group and supergroup chats if the owner of the bot has a Telegram Premium subscription. */
+        icon_custom_emoji_id?: string;
+        /** Style of the button. Must be one of “danger” (red), “success” (green) or “primary” (blue). If omitted, then an app-specific style is used. */
+        style?: "danger" | "success" | "primary";
     }
     interface UrlButton extends AbstractInlineKeyboardButton {
         /** HTTP or tg:// URL to be opened when the button is pressed. Links tg://user?id=<user_id> can be used to mention a user by their identifier without using a username, if this is allowed by their privacy settings. */
@@ -57,7 +61,7 @@ export declare namespace InlineKeyboardButton {
         pay: boolean;
     }
 }
-/** This object represents one button of an inline keyboard. You must use exactly one of the optional fields. */
+/** This object represents one button of an inline keyboard. Exactly one of the fields other than text, icon_custom_emoji_id, and style must be used to specify the type of the button. */
 export type InlineKeyboardButton = InlineKeyboardButton.CallbackButton | InlineKeyboardButton.GameButton | InlineKeyboardButton.LoginButton | InlineKeyboardButton.PayButton | InlineKeyboardButton.SwitchInlineButton | InlineKeyboardButton.SwitchInlineCurrentChatButton | InlineKeyboardButton.SwitchInlineChosenChatButton | InlineKeyboardButton.CopyTextButtonButton | 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. */
@@ -127,8 +131,12 @@ export interface ReplyKeyboardMarkup {
 }
 export declare namespace KeyboardButton {
     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 of the button. If none of the fields other than text, icon_custom_emoji_id, and style are used, it will be sent as a message when the button is pressed */
         text: string;
+        /** Unique identifier of the custom emoji shown before the text of the button. Can only be used by bots that purchased additional usernames on Fragment or in the messages directly sent by the bot to private, group and supergroup chats if the owner of the bot has a Telegram Premium subscription. */
+        icon_custom_emoji_id?: string;
+        /** Style of the button. Must be one of “danger” (red), “success” (green) or “primary” (blue). If omitted, then an app-specific style is used. */
+        style?: "danger" | "success" | "primary";
     }
     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. */
@@ -155,7 +163,7 @@ export declare namespace KeyboardButton {
         web_app: WebAppInfo;
     }
 }
-/** This object represents one button of the reply keyboard. At most one of the optional fields must be used to specify type of the button. For simple text buttons, String can be used instead of this object to specify the button text. */
+/** This object represents one button of the reply keyboard. At most one of the fields other than text, icon_custom_emoji_id, and style must be used to specify the type of the button. For simple text buttons, String can be used instead of this object to specify the button text. */
 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 {

package/message.d.ts

@@ -1,5 +1,5 @@
 import type { Checklist, ChecklistTasksAdded, ChecklistTasksDone } from "./checklist.js";
-import type { Chat, User } from "./manage.js";
+import type { Chat, ChatOwnerChanged, ChatOwnerLeft, User } from "./manage.js";
 import type { InlineKeyboardMarkup } from "./markup.js";
 import type { PassportData } from "./passport.js";
 import type { GiftInfo, Invoice, PaidMessagePriceChanged, RefundedPayment, SuccessfulPayment, SuggestedPostApprovalFailed, SuggestedPostApproved, SuggestedPostDeclined, SuggestedPostInfo, SuggestedPostPaid, SuggestedPostPrice, SuggestedPostRefunded, UniqueGiftInfo } from "./payment.js";
@@ -106,6 +106,8 @@ export declare namespace Message {
     type SuggestedPostDeclinedMessage = ServiceMessage & MsgWith<"suggested_post_declined">;
     type SuggestedPostPaidMessage = ServiceMessage & MsgWith<"suggested_post_paid">;
     type SuggestedPostRefundedMessage = ServiceMessage & MsgWith<"suggested_post_refunded">;
+    type ChatOwnerLeftMessage = ServiceMessage & MsgWith<"chat_owner_left">;
+    type ChatOwnerChangedMessage = ServiceMessage & MsgWith<"chat_owner_changed">;
     type NewChatMembersMessage = ServiceMessage & MsgWith<"new_chat_members">;
     type LeftChatMemberMessage = ServiceMessage & MsgWith<"left_chat_member">;
     type NewChatTitleMessage = ServiceMessage & MsgWith<"new_chat_title">;
@@ -208,6 +210,10 @@ export interface Message extends Message.MediaMessage {
     suggested_post_paid?: SuggestedPostPaid;
     /** Service message: payment for a suggested post was refunded */
     suggested_post_refunded?: SuggestedPostRefunded;
+    /** Service message: chat owner has left */
+    chat_owner_left?: ChatOwnerLeft;
+    /** Service message: chat owner has changed */
+    chat_owner_changed?: ChatOwnerChanged;
     /** New members that were added to the group or supergroup and information about them (the bot itself may be one of these members) */
     new_chat_members?: User[];
     /** A member was removed from the group, information about them (this member may be the bot itself) */
@@ -698,6 +704,23 @@ export interface Video {
     mime_type?: string;
     /** File size in bytes */
     file_size?: number;
+    /** List of available qualities of the video. */
+    qualities?: VideoQuality[];
+}
+/** This object represents a video file of a specific quality. */
+export interface VideoQuality {
+    /** 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;
+    /** Video width */
+    width: number;
+    /** Video height */
+    height: number;
+    /** Codec that was used to encode the video, for example, “h264”, “h265”, or “av01” */
+    codec: string;
+    /** File size in bytes. It can be bigger than 2^31 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 value. */
+    file_size?: number;
 }
 /** This object represents a video message (available in Telegram apps as of v.4.0). */
 export interface VideoNote {

package/methods.d.ts

@@ -1,7 +1,7 @@
 import type { InputChecklist } from "./checklist.js";
 import type { InlineQueryResult, InlineQueryResultsButton } from "./inline.js";
 import type { LanguageCode } from "./langs.js";
-import type { AcceptedGiftTypes, BotCommand, BusinessConnection, ChatAdministratorRights, ChatFullInfo, ChatInviteLink, ChatMember, ChatMemberAdministrator, ChatMemberOwner, ChatPermissions, ForumTopic, UserChatBoosts, UserFromGetMe, UserProfilePhotos, WebhookInfo } from "./manage.js";
+import type { AcceptedGiftTypes, BotCommand, BusinessConnection, ChatAdministratorRights, ChatFullInfo, ChatInviteLink, ChatMember, ChatMemberAdministrator, ChatMemberOwner, ChatPermissions, ForumTopic, UserChatBoosts, UserFromGetMe, UserProfileAudios, UserProfilePhotos, WebhookInfo } from "./manage.js";
 import type { ForceReply, InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove } from "./markup.js";
 import type { File, GameHighScore, InputPollOption, LinkPreviewOptions, MaskPosition, Message, MessageEntity, MessageId, ParseMode, Poll, PreparedInlineMessage, ReactionType, ReplyParameters, SentWebAppMessage, Sticker, StickerSet, Story, SuggestedPostParameters } from "./message.js";
 import type { PassportElementError } from "./passport.js";
@@ -883,6 +883,15 @@ export type ApiMethods<F> = {
         /** Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100. */
         limit?: number;
     }): UserProfilePhotos;
+    /** Use this method to get a list of profile audios for a user. Returns a UserProfileAudios object. */
+    getUserProfileAudios(args: {
+        /** Unique identifier of the target user */
+        user_id: number;
+        /** Sequential number of the first audio to be returned. By default, all audios are returned. */
+        offset?: number;
+        /** Limits the number of audios to be retrieved. Values between 1-100 are accepted. Defaults to 100. */
+        limit?: number;
+    }): UserProfileAudios;
     /** 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 */
@@ -1195,7 +1204,7 @@ export type ApiMethods<F> = {
     }): true;
     /** Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of Sticker objects. */
     getForumTopicIconStickers(): Sticker[];
-    /** Use this method to create a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns information about the created topic as a ForumTopic object. */
+    /** Use this method to create a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator right. Returns information about the created topic as a ForumTopic object. */
     createForumTopic(args: {
         /** Unique identifier for the target chat or username of the target supergroup (in the format `@supergroupusername`) */
         chat_id: number | string;
@@ -1411,6 +1420,13 @@ export type ApiMethods<F> = {
         /** A two-letter ISO 639-1 language code or an empty string */
         language_code?: LanguageCode;
     }): BotShortDescription;
+    /** Changes the profile photo of the bot. Returns True on success. */
+    setMyProfilePhoto(args: {
+        /** The new profile photo to set */
+        photo: InputProfilePhoto<F>;
+    }): true;
+    /** Removes the profile photo of the bot. Requires no parameters. Returns True on success. */
+    removeMyProfilePhoto(): true;
     /** Use this method to change the bot's menu button in a private chat, or the default menu button. Returns True on success. */
     setChatMenuButton(args: {
         /** Unique identifier for the target private chat. If not specified, default bot's menu button will be changed */
@@ -1889,7 +1905,7 @@ export type ApiMethods<F> = {
         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;
+    }): true;
     /** Gifts a Telegram Premium subscription to the given user. Returns True on success. */
     giftPremiumSubscription(args: {
         /** Unique identifier of the target user who will receive a Telegram Premium subscription */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grammyjs/types",
-  "version": "3.23.0",
+  "version": "3.24.0",
   "description": "Telegram Bot API type declarations for grammY",
   "main": "mod.js",
   "repository": {

package/payment.d.ts

@@ -308,8 +308,10 @@ export interface UniqueGiftModel {
     name: string;
     /** The sticker that represents the unique gift */
     sticker: Sticker;
-    /** The number of unique gifts that receive this model for every 1000 gifts upgraded */
+    /** The number of unique gifts that receive this model for every 1000 gift upgrades. Always 0 for crafted gifts. */
     rarity_per_mille: number;
+    /** Rarity of the model if it is a crafted model. Currently, can be “uncommon”, “rare”, “epic”, or “legendary”. */
+    rarity?: "uncommon" | "rare" | "epic" | "legendary";
 }
 /** This object describes the symbol shown on the pattern of a unique gift. */
 export interface UniqueGiftSymbol {
@@ -364,6 +366,8 @@ export interface UniqueGift {
     backdrop: UniqueGiftBackdrop;
     /** The color scheme that can be used by the gift's owner for the chat's name, replies to messages and link previews */
     colors?: UniqueGiftColors;
+    /** True, if the gift was used to craft another gift and isn't available anymore */
+    is_burned?: true;
 }
 /** This object contains information about the color scheme for a user's name, message replies and link previews based on a unique gift. */
 export interface UniqueGiftColors {