@grammyjs/types 3.17.0 → 3.18.0

package/inline.d.ts

@@ -55,8 +55,6 @@ export interface InlineQueryResultArticle {
     reply_markup?: InlineKeyboardMarkup;
     /** URL of the result */
     url?: string;
-    /** Pass True if you don't want the URL to be shown in the message */
-    hide_url?: boolean;
     /** Short description of the result */
     description?: string;
     /** Url of the thumbnail for the result */
@@ -103,7 +101,7 @@ export interface InlineQueryResultGif {
     type: "gif";
     /** Unique identifier for this result, 1-64 bytes */
     id: string;
-    /** A valid URL for the GIF file. File size must not exceed 1MB */
+    /** A valid URL for the GIF file */
     gif_url: string;
     /** Width of the GIF */
     gif_width?: number;
@@ -136,7 +134,7 @@ export interface InlineQueryResultMpeg4Gif {
     type: "mpeg4_gif";
     /** Unique identifier for this result, 1-64 bytes */
     id: string;
-    /** A valid URL for the MPEG4 file. File size must not exceed 1MB */
+    /** A valid URL for the MPEG4 file */
     mpeg4_url: string;
     /** Video width */
     mpeg4_width?: number;

package/manage.d.ts

@@ -136,11 +136,11 @@ export declare namespace ChatFullInfo {
         type: "private";
         /** Title, for supergroups, channels and group chats */
         title?: undefined;
-        /**  Username, for private chats, supergroups and channels if available */
+        /** Username, for private chats, supergroups and channels if available */
         username?: string;
-        /**  First name of the other party in a private chat */
+        /** First name of the other party in a private chat */
         first_name: string;
-        /**  Last name of the other party in a private chat */
+        /** Last name of the other party in a private chat */
         last_name?: string;
         /** True, if the supergroup chat is a forum (has topics enabled) */
         is_forum?: undefined;
@@ -170,7 +170,7 @@ export declare namespace ChatFullInfo {
         profile_accent_color_id?: number;
         /** Custom emoji identifier of the emoji chosen by the chat for its profile background */
         profile_background_custom_emoji_id?: string;
-        /**  Custom emoji identifier of the emoji status of the chat or the other party in a private chat */
+        /** Custom emoji identifier of the emoji status of the chat or the other party in a private chat */
         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 */
         emoji_status_expiration_date?: number;
@@ -186,7 +186,7 @@ export declare namespace ChatFullInfo {
         join_by_request?: undefined;
         /** Description, for groups, supergroups and channel chats */
         description?: undefined;
-        /**  Primary invite link, for groups, supergroups and channel chats */
+        /** Primary invite link, for groups, supergroups and channel chats */
         invite_link?: undefined;
         /** The most recent pinned message (by sending date) */
         pinned_message?: Message;
@@ -194,9 +194,9 @@ export declare namespace ChatFullInfo {
         permissions?: undefined;
         /** For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds */
         slow_mode_delay?: undefined;
-        /**  For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions */
+        /** For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions */
         unrestrict_boost_count?: undefined;
-        /**  The time after which all messages sent to the chat will be automatically deleted; in seconds */
+        /** The time after which all messages sent to the chat will be automatically deleted; in seconds */
         message_auto_delete_time?: number;
         /** True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators. */
         has_aggressive_anti_spam_enabled?: undefined;
@@ -227,11 +227,11 @@ export declare namespace ChatFullInfo {
         type: "group";
         /** Title, for supergroups, channels and group chats */
         title: string;
-        /**  Username, for private chats, supergroups and channels if available */
+        /** Username, for private chats, supergroups and channels if available */
         username?: undefined;
-        /**  First name of the other party in a private chat */
+        /** First name of the other party in a private chat */
         first_name?: undefined;
-        /**  Last name of the other party in a private chat */
+        /** Last name of the other party in a private chat */
         last_name?: undefined;
         /** True, if the supergroup chat is a forum (has topics enabled) */
         is_forum?: undefined;
@@ -261,7 +261,7 @@ export declare namespace ChatFullInfo {
         profile_accent_color_id?: number;
         /** Custom emoji identifier of the emoji chosen by the chat for its profile background */
         profile_background_custom_emoji_id?: string;
-        /**  Custom emoji identifier of the emoji status of the chat or the other party in a private chat */
+        /** Custom emoji identifier of the emoji status of the chat or the other party in a private chat */
         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 */
         emoji_status_expiration_date?: number;
@@ -277,7 +277,7 @@ export declare namespace ChatFullInfo {
         join_by_request?: undefined;
         /** Description, for groups, supergroups and channel chats */
         description?: string;
-        /**  Primary invite link, for groups, supergroups and channel chats */
+        /** Primary invite link, for groups, supergroups and channel chats */
         invite_link?: string;
         /** The most recent pinned message (by sending date) */
         pinned_message?: Message;
@@ -285,9 +285,9 @@ export declare namespace ChatFullInfo {
         permissions?: ChatPermissions;
         /** For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds */
         slow_mode_delay?: undefined;
-        /**  For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions */
+        /** For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions */
         unrestrict_boost_count?: undefined;
-        /**  The time after which all messages sent to the chat will be automatically deleted; in seconds */
+        /** The time after which all messages sent to the chat will be automatically deleted; in seconds */
         message_auto_delete_time?: number;
         /** True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators. */
         has_aggressive_anti_spam_enabled?: undefined;
@@ -318,11 +318,11 @@ export declare namespace ChatFullInfo {
         type: "supergroup";
         /** Title, for supergroups, channels and group chats */
         title: string;
-        /**  Username, for private chats, supergroups and channels if available */
+        /** Username, for private chats, supergroups and channels if available */
         username?: string;
-        /**  First name of the other party in a private chat */
+        /** First name of the other party in a private chat */
         first_name?: undefined;
-        /**  Last name of the other party in a private chat */
+        /** Last name of the other party in a private chat */
         last_name?: undefined;
         /** True, if the supergroup chat is a forum (has topics enabled) */
         is_forum?: true;
@@ -352,7 +352,7 @@ export declare namespace ChatFullInfo {
         profile_accent_color_id?: number;
         /** Custom emoji identifier of the emoji chosen by the chat for its profile background */
         profile_background_custom_emoji_id?: string;
-        /**  Custom emoji identifier of the emoji status of the chat or the other party in a private chat */
+        /** Custom emoji identifier of the emoji status of the chat or the other party in a private chat */
         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 */
         emoji_status_expiration_date?: number;
@@ -368,7 +368,7 @@ export declare namespace ChatFullInfo {
         join_by_request?: true;
         /** Description, for groups, supergroups and channel chats */
         description?: string;
-        /**  Primary invite link, for groups, supergroups and channel chats */
+        /** Primary invite link, for groups, supergroups and channel chats */
         invite_link?: string;
         /** The most recent pinned message (by sending date) */
         pinned_message?: Message;
@@ -376,9 +376,9 @@ export declare namespace ChatFullInfo {
         permissions?: ChatPermissions;
         /** For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds */
         slow_mode_delay?: number;
-        /**  For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions */
+        /** For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions */
         unrestrict_boost_count?: number;
-        /**  The time after which all messages sent to the chat will be automatically deleted; in seconds */
+        /** The time after which all messages sent to the chat will be automatically deleted; in seconds */
         message_auto_delete_time?: number;
         /** True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators. */
         has_aggressive_anti_spam_enabled?: true;
@@ -409,11 +409,11 @@ export declare namespace ChatFullInfo {
         type: "channel";
         /** Title, for supergroups, channels and group chats */
         title: string;
-        /**  Username, for private chats, supergroups and channels if available */
+        /** Username, for private chats, supergroups and channels if available */
         username?: string;
-        /**  First name of the other party in a private chat */
+        /** First name of the other party in a private chat */
         first_name?: undefined;
-        /**  Last name of the other party in a private chat */
+        /** Last name of the other party in a private chat */
         last_name?: undefined;
         /** True, if the supergroup chat is a forum (has topics enabled) */
         is_forum?: undefined;
@@ -443,7 +443,7 @@ export declare namespace ChatFullInfo {
         profile_accent_color_id?: number;
         /** Custom emoji identifier of the emoji chosen by the chat for its profile background */
         profile_background_custom_emoji_id?: string;
-        /**  Custom emoji identifier of the emoji status of the chat or the other party in a private chat */
+        /** Custom emoji identifier of the emoji status of the chat or the other party in a private chat */
         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 */
         emoji_status_expiration_date?: number;
@@ -459,7 +459,7 @@ export declare namespace ChatFullInfo {
         join_by_request?: undefined;
         /** Description, for groups, supergroups and channel chats */
         description?: string;
-        /**  Primary invite link, for groups, supergroups and channel chats */
+        /** Primary invite link, for groups, supergroups and channel chats */
         invite_link?: string;
         /** The most recent pinned message (by sending date) */
         pinned_message?: Message;
@@ -467,9 +467,9 @@ export declare namespace ChatFullInfo {
         permissions?: undefined;
         /** For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds */
         slow_mode_delay?: undefined;
-        /**  For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions */
+        /** For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions */
         unrestrict_boost_count?: undefined;
-        /**  The time after which all messages sent to the chat will be automatically deleted; in seconds */
+        /** The time after which all messages sent to the chat will be automatically deleted; in seconds */
         message_auto_delete_time?: number;
         /** True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators. */
         has_aggressive_anti_spam_enabled?: undefined;

package/message.d.ts

@@ -905,7 +905,7 @@ export interface BackgroundTypeWallpaper {
     /** True, if the background moves slightly when the device is tilted */
     is_moving?: true;
 }
-/** The background is a PNG or TGV (gzipped subset of SVG with MIME type “application/x-tgwallpattern”) pattern to be combined with the background fill chosen by the user. */
+/** The background is a .PNG or .TGV (gzipped subset of SVG with MIME type “application/x-tgwallpattern”) pattern to be combined with the background fill chosen by the user. */
 export interface BackgroundTypePattern {
     /** Type of the background, always “pattern” */
     type: "pattern";

package/methods.d.ts

@@ -29,10 +29,10 @@ export type ApiMethods<F> = {
         timeout?: number;
         /** A list of the update types you want your bot to receive. For example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (default). If not specified, the previous setting will be used.
     
-        Please note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time. */
+        Please note that this parameter doesn't affect updates created before the call to getUpdates, so unwanted updates may be received for a short period of time. */
         allowed_updates?: ReadonlyArray<Exclude<keyof Update, "update_id">>;
     }): Update[];
-    /** Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success.
+    /** Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized Update. In case of an unsuccessful request (a request with response HTTP status code different from 2XY), we will repeat the request and give up after a reasonable amount of attempts. Returns True on success.
   
     If you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header “X-Telegram-Bot-Api-Secret-Token” with the secret token as content.
   
@@ -1476,9 +1476,9 @@ export type ApiMethods<F> = {
         name: string;
         /** User identifier of the sticker set owner */
         user_id: number;
-        /** A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see https://core.telegram.org/stickers#animation-requirements for animated sticker technical requirements), or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files ». Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail. */
+        /** A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see https://core.telegram.org/stickers#animation-requirements for animated sticker technical requirements), or a .WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files ». Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail. */
         thumbnail?: F | string;
-        /** Format of the thumbnail, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, or “video” for a WEBM video */
+        /** Format of the thumbnail, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, or “video” for a .WEBM video */
         format: "static" | "animated" | "video";
     }): true;
     /** Use this method to set the thumbnail of a custom emoji sticker set. Returns True on success. */
@@ -1496,6 +1496,8 @@ export type ApiMethods<F> = {
         user_id: number;
         /** Identifier of the gift */
         gift_id: string;
+        /** Pass True to pay for the gift upgrade from the bot's balance, thereby making the upgrade free for the receiver */
+        pay_for_upgrade?: boolean;
         /** 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. */
@@ -1696,6 +1698,30 @@ export type ApiMethods<F> = {
         /** 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;
+    /** Verifies a user on behalf of the organization which is represented by the bot. Returns True on success. */
+    verifyUser(args: {
+        /** Unique identifier of the target user */
+        user_id: number;
+        /** Custom description for the verification; 0-70 characters. Must be empty if the organization isn't allowed to provide a custom verification description. */
+        custom_description?: string;
+    }): true;
+    /** Verifies a chat on behalf of the organization which is represented by the bot. Returns True on success. */
+    verifyChat(args: {
+        /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
+        chat_id: number | string;
+        /** Custom description for the verification; 0-70 characters. Must be empty if the organization isn't allowed to provide a custom verification description. */
+        custom_description?: string;
+    }): true;
+    /** Removes verification from a user who is currently verified on behalf of the organization represented by the bot. Returns True on success. */
+    removeUserVerification(args: {
+        /** Unique identifier of the target user */
+        user_id: number;
+    }): true;
+    /** Removes verification from a chat that is currently verified on behalf of the organization represented by the bot. Returns True on success. */
+    removeChatVerification(args: {
+        /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
+        chat_id: number | string;
+    }): true;
     /** Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success.
   
     Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues. */
@@ -1765,7 +1791,7 @@ export type ApiMethods<F> = {
 export interface InputSticker<F> {
     /** The added sticker. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. Animated and video stickers can't be uploaded via HTTP URL. */
     sticker: F | string;
-    /** Format of the added sticker, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, “video” for a WEBM video */
+    /** Format of the added sticker, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, “video” for a .WEBM video */
     format: "static" | "animated" | "video";
     /** List of 1-20 emoji associated with the sticker */
     emoji_list: string[];

package/package.json

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

package/payment.d.ts

@@ -253,6 +253,8 @@ export interface Gift {
     sticker: Sticker;
     /** The number of Telegram Stars that must be paid to send the sticker */
     star_count: number;
+    /** The number of Telegram Stars that must be paid to upgrade the gift to a unique one */
+    upgrade_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 */