@grammyjs/types 2.7.2 → 2.8.0

package/README.md

@@ -73,3 +73,19 @@ Consequently, the type `InputFile` is not defined in this library.
 Instead, grammY specifies its own version of what an `InputFile` is, hence automatically adjusting `@grammyjs/types` with a custom `InputFile` type used throughout all affected methods and interfaces.
 This is possible by what we call a _proxy type_.
 grammY then imports the proxy type called `InputProxyType` and parametrises it with its version of `InputFile`.
+
+## Differences to the Bot API
+
+Some documentation strings are intentionally different from what is written on the website.
+The actual type definitions themselves are never different.
+
+1. No formatting.
+   We do not leverage the markdown capabilities of JSDoc for the sake of easier copying and thus reduced maintenance efforts.
+2. No mentions of `JSON-serialized`.
+   As underlying libraries handle serialization, these words are removed from the explantions.
+3. No mentions of integer numbers that exceed 2^31 but not 2^51.
+   All numbers are 64-bit floats in JS, so this is irrelevant.
+   Note that JS bit operators cast numbers to 32-bit integers and back, but we deliberately ignore this because people who use bit operators on identifiers or file sizes should know what they're doing, and they should also know that it's a bad idea.
+4. No `More info on Sending Files »`.
+   File handling is abstracted away by the underlying library.
+   Also, without the links, it's useless anyway.

package/api.d.ts

@@ -16,7 +16,7 @@ All methods in the Bot API are case-insensitive.
 All queries must be made using UTF-8. */
 export type ApiResponse<T> = ApiError | ApiSuccess<T>;
 
-/** Contains information about why a request was unsuccessful. */
+/** 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. */
   migrate_to_chat_id?: number;

package/deno.jsonc

@@ -0,0 +1 @@
+{ "fmt": { "options": { "indentWidth": 2, "proseWrap": "preserve" } } }

package/inline.d.ts

@@ -13,7 +13,7 @@ export interface InlineQuery {
   query: string;
   /** Offset of the results to be returned, can be controlled by the bot */
   offset: string;
-  /** Type of the chat, from which the inline query was sent. Can be either "sender" for a private chat with the inline query sender, "private", "group", "supergroup", or "channel". The chat type should be always known for requests sent from official clients and most third-party clients, unless the request was sent from a secret chat */
+  /** Type of the chat from which the inline query was sent. Can be either “sender” for a private chat with the inline query sender, “private”, “group”, “supergroup”, or “channel”. The chat type should be always known for requests sent from official clients and most third-party clients, unless the request was sent from a secret chat */
   chat_type?: "sender" | Chat["type"];
   /** Sender location, only for bots that request user location */
   location?: Location;
@@ -136,7 +136,7 @@ export interface InlineQueryResultGif {
   gif_duration?: number;
   /** URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result */
   thumb_url: string;
-  /** MIME type of the thumbnail, must be one of "image/jpeg", "image/gif", or "video/mp4". Defaults to "image/jpeg" */
+  /** MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg” */
   thumb_mime_type?: "image/jpeg" | "image/gif" | "video/mp4";
   /** Title for the result */
   title?: string;
@@ -156,7 +156,7 @@ export interface InlineQueryResultMpeg4Gif {
   type: "mpeg4_gif";
   /** Unique identifier for this result, 1-64 bytes */
   id: string;
-  /** A valid URL for the MP4 file. File size must not exceed 1MB */
+  /** A valid URL for the MPEG4 file. File size must not exceed 1MB */
   mpeg4_url: string;
   /** Video width */
   mpeg4_width?: number;
@@ -166,7 +166,7 @@ export interface InlineQueryResultMpeg4Gif {
   mpeg4_duration?: number;
   /** URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result */
   thumb_url: string;
-  /** MIME type of the thumbnail, must be one of "image/jpeg", "image/gif", or "video/mp4". Defaults to "image/jpeg" */
+  /** MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg” */
   thumb_mime_type?: "image/jpeg" | "image/gif" | "video/mp4";
   /** Title for the result */
   title?: string;
@@ -190,7 +190,7 @@ export interface InlineQueryResultVideo {
   id: string;
   /** A valid URL for the embedded video player or video file */
   video_url: string;
-  /** Mime type of the content of video url, "text/html" or "video/mp4" */
+  /** MIME type of the content of the video URL, “text/html” or “video/mp4” */
   mime_type: "text/html" | "video/mp4";
   /** URL of the thumbnail (JPEG only) for the video */
   thumb_url: string;
@@ -286,7 +286,7 @@ export interface InlineQueryResultDocument {
   caption_entities?: MessageEntity[];
   /** A valid URL for the file */
   document_url: string;
-  /** Mime type of the content of the file, either “application/pdf” or “application/zip” */
+  /** MIME type of the content of the file, either “application/pdf” or “application/zip” */
   mime_type: "application/pdf" | "application/zip";
   /** Short description of the result */
   description?: string;
@@ -322,7 +322,7 @@ export interface InlineQueryResultLocation {
   live_period?: number;
   /** The direction in which user is moving, in degrees; 1-360. For active live locations only. */
   heading?: number;
-  /** Maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only. */
+  /** The maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only. */
   proximity_alert_radius?: number;
   /** Inline keyboard attached to the message */
   reply_markup?: InlineKeyboardMarkup;
@@ -354,7 +354,7 @@ export interface InlineQueryResultVenue {
   address: string;
   /** Foursquare identifier of the venue if known */
   foursquare_id?: string;
-  /** Foursquare type of the venue, if known. (For example, "arts_entertainment/default", "arts_entertainment/aquarium" or "food/icecream".) */
+  /** Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.) */
   foursquare_type?: string;
   /** Google Places identifier of the venue */
   google_place_id?: string;
@@ -464,7 +464,7 @@ export interface InlineQueryResultCachedMpeg4Gif {
   type: "mpeg4_gif";
   /** Unique identifier for this result, 1-64 bytes */
   id: string;
-  /** A valid file identifier for the MP4 file */
+  /** A valid file identifier for the MPEG4 file */
   mpeg4_file_id: string;
   /** Title for the result */
   title?: string;
@@ -643,7 +643,7 @@ export interface InputVenueMessageContent {
   address: string;
   /** Foursquare identifier of the venue, if known */
   foursquare_id?: string;
-  /** Foursquare type of the venue, if known. (For example, "arts_entertainment/default", "arts_entertainment/aquarium" or "food/icecream".) */
+  /** Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.) */
   foursquare_type?: string;
   /** Google Places identifier of the venue */
   google_place_id?: string;
@@ -671,7 +671,7 @@ export interface InputInvoiceMessageContent {
   description: string;
   /** Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. */
   payload: string;
-  /** Payment provider token, obtained via Botfather */
+  /** Payment provider token, obtained via BotFather */
   provider_token: string;
   /** Three-letter ISO 4217 currency code, see more on currencies */
   currency: string;
@@ -681,11 +681,11 @@ export interface InputInvoiceMessageContent {
   max_tip_amount?: number;
   /** An array of suggested amounts of tip in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount. */
   suggested_tip_amounts?: number[];
-  /** An object for data about the invoice, which will be shared with the payment provider. A detailed description of the required fields should be provided by the payment provider. */
+  /** Data about the invoice, which will be shared with the payment provider. A detailed description of the required fields should be provided by the payment provider. */
   provider_data?: string;
-  /** URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for. */
+  /** URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. */
   photo_url?: string;
-  /** Photo size */
+  /** Photo size in bytes */
   photo_size?: number;
   /** Photo width */
   photo_width?: number;
@@ -699,9 +699,9 @@ export interface InputInvoiceMessageContent {
   need_email?: boolean;
   /** Pass True, if you require the user's shipping address to complete the order */
   need_shipping_address?: boolean;
-  /** Pass True, if user's phone number should be sent to provider */
+  /** Pass True, if the user's phone number should be sent to provider */
   send_phone_number_to_provider?: boolean;
-  /** Pass True, if user's email address should be sent to provider */
+  /** Pass True, if the user's email address should be sent to provider */
   send_email_to_provider?: boolean;
   /** Pass True, if the final price depends on the shipping method */
   is_flexible?: boolean;
@@ -709,7 +709,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,7 +1,7 @@
 import { Location, Message, PhotoSize } from "./message";
 import { Update } from "./update";
 
-/** Contains information about the current status of a webhook. */
+/** Describes the current status of a webhook. */
 export interface WebhookInfo {
   /** Webhook URL, may be empty if webhook is not set up */
   url?: string;
@@ -17,7 +17,7 @@ export interface WebhookInfo {
   last_error_message: string;
   /** Unix time of the most recent error that happened when trying to synchronize available updates with Telegram datacenters */
   last_synchronization_error_date?: number;
-  /** Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery */
+  /** The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery */
   max_connections: number;
   /** A list of update types the bot is subscribed to. Defaults to all update types except chat_member */
   allowed_updates: Array<Exclude<keyof Update, "update_id">>;
@@ -37,6 +37,10 @@ export interface User {
   username?: string;
   /** IETF language tag of the user's language */
   language_code?: string;
+  /** True, if this user is a Telegram Premium user */
+  is_premium?: true;
+  /** True, if this user added the bot to the attachment menu */
+  added_to_attachment_menu?: true;
 }
 
 /** This object represents a Telegram user or bot that was returned by `getMe`. */
@@ -55,7 +59,7 @@ export namespace Chat {
   // ABSTRACT
   /** Internal type holding properties that all kinds of chats share. */
   interface AbstractChat {
-    /** Type of chat, can be either "private", "group", "supergroup" or "channel" */
+    /** Type of chat, can be either “private”, “group”, “supergroup” or “channel” */
     type: string;
     /** 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. */
     id: number;
@@ -88,9 +92,7 @@ export namespace Chat {
   }
   /** Internal type representing super group chats. */
   export interface SupergroupChat
-    extends AbstractChat,
-      UserNameChat,
-      TitleChat {
+    extends AbstractChat, UserNameChat, TitleChat {
     type: "supergroup";
   }
   /** Internal type representing channel chats. */
@@ -103,6 +105,10 @@ export namespace Chat {
   interface GetChat {
     /** Chat photo. Returned only in getChat. */
     photo?: ChatPhoto;
+    /** 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;
     /** The most recent pinned message (by sending date). Returned only in getChat. */
     pinned_message?: Message;
     /** The time after which all messages sent to the chat will be automatically deleted; in seconds. Returned only in getChat. */
@@ -142,9 +148,7 @@ export namespace Chat {
   export interface GroupGetChat extends GroupChat, MultiUserGetChat {}
   /** Internal type representing supergroup chats returned from `getChat`. */
   export interface SupergroupGetChat
-    extends SupergroupChat,
-      MultiUserGetChat,
-      LargeGetChat {
+    extends SupergroupChat, MultiUserGetChat, LargeGetChat {
     /** For supergroups, the minimum allowed delay between consecutive messages sent by each unpriviledged user; in seconds. Returned only in getChat. */
     slow_mode_delay?: number;
     /** For supergroups, name of group sticker set. Returned only in getChat. */
@@ -206,7 +210,7 @@ export interface ChatInviteLink {
   name?: string;
   /** Point in time (Unix timestamp) when the link will expire or has been expired */
   expire_date?: number;
-  /** Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999 */
+  /** The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999 */
   member_limit?: number;
   /** Number of pending join requests created using this link */
   pending_join_request_count?: number;
@@ -255,7 +259,7 @@ export type ChatMember =
 
 /** Represents a chat member that owns the chat and has all administrator privileges. */
 export interface ChatMemberOwner {
-  /** The member's status in the chat, always "creator" */
+  /** The member's status in the chat, always “creator” */
   status: "creator";
   /** Information about the user */
   user: User;
@@ -267,7 +271,7 @@ export interface ChatMemberOwner {
 
 /** Represents a chat member that has some additional privileges. */
 export interface ChatMemberAdministrator {
-  /** The member's status in the chat, always "administrator" */
+  /** The member's status in the chat, always “administrator” */
   status: "administrator";
   /** Information about the user */
   user: User;
@@ -301,7 +305,7 @@ export interface ChatMemberAdministrator {
 
 /** Represents a chat member that has no additional privileges or restrictions. */
 export interface ChatMemberMember {
-  /** The member's status in the chat, always "member" */
+  /** The member's status in the chat, always “member” */
   status: "member";
   /** Information about the user */
   user: User;
@@ -309,7 +313,7 @@ export interface ChatMemberMember {
 
 /** Represents a chat member that is under certain restrictions in the chat. Supergroups only. */
 export interface ChatMemberRestricted {
-  /** The member's status in the chat, always "restricted" */
+  /** The member's status in the chat, always “restricted” */
   status: "restricted";
   /** Information about the user */
   user: User;
@@ -337,7 +341,7 @@ export interface ChatMemberRestricted {
 
 /** Represents a chat member that isn't currently a member of the chat, but may join it themselves. */
 export interface ChatMemberLeft {
-  /** The member's status in the chat, always "left" */
+  /** The member's status in the chat, always “left” */
   status: "left";
   /** Information about the user */
   user: User;
@@ -345,7 +349,7 @@ export interface ChatMemberLeft {
 
 /** Represents a chat member that was banned in the chat and can't return to the chat or view chat messages. */
 export interface ChatMemberBanned {
-  /** The member's status in the chat, always "kicked" */
+  /** The member's status in the chat, always “kicked” */
   status: "kicked";
   /** Information about the user */
   user: User;
@@ -425,7 +429,7 @@ export interface 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, if known */
+  /** 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;

package/markup.d.ts

@@ -13,7 +13,7 @@ export namespace InlineKeyboardButton {
     text: string;
   }
   export 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 ID without using a username, if this is allowed by their privacy settings. */
+    /** 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 ID without using a username, if this is allowed by their privacy settings. */
     url: string;
   }
   export interface CallbackButton extends AbstractInlineKeyboardButton {
@@ -25,7 +25,7 @@ export namespace InlineKeyboardButton {
     web_app: WebAppInfo;
   }
   export interface LoginButton extends AbstractInlineKeyboardButton {
-    /** An HTTP URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget. */
+    /** An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget. */
     login_url: LoginUrl;
   }
   export interface SwitchInlineButton extends AbstractInlineKeyboardButton {
@@ -98,7 +98,7 @@ export interface CallbackQuery {
   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. */
   chat_instance: string;
-  /** Data associated with the callback button. Be aware that the message, which originated the query, can contain no callback buttons with this data. */
+  /** Data associated with the callback button. Be aware that the message originated the query can contain no callback buttons with this data. */
   data?: string;
   /** Short name of a Game to be returned, serves as the unique identifier for the game */
   game_short_name?: string;
@@ -176,7 +176,7 @@ Explain the user how to send a command with parameters (e.g. /newpoll question a
 
 Guide the user through a step-by-step process. 'Please send me your question', 'Cool, now let's add the first answer option', 'Great. Keep adding answer options, then send /done when you're ready'.
 
-The last option is definitely more attractive. And if you use ForceReply in your bot's questions, it will receive the user's answers even if it only receives replies, commands and mentions — without any extra work for the user. */
+The last option is definitely more attractive. And if you use ForceReply in your bot's questions, it will receive the user's answers even if it only receives replies, commands and mentions - without any extra work for the user. */
 export interface ForceReply {
   /** Shows reply interface to the user, as if they manually selected the bot's message and tapped 'Reply' */
   force_reply: true;
@@ -186,7 +186,7 @@ export interface ForceReply {
   selective?: boolean;
 }
 
-/** Contains information about a Web App. */
+/** Describes a Web App. */
 export interface WebAppInfo {
   /** An HTTPS URL of a Web App to be opened with additional data as specified in Initializing Web Apps */
   url: string;

package/message.d.ts

@@ -1,5 +1,5 @@
 import { InlineKeyboardMarkup } from "./markup";
-import { Chat, User } from "./manage";
+import { Chat, File, User } from "./manage";
 import { PassportData } from "./passport";
 import { Invoice, SuccessfulPayment } from "./payment";
 
@@ -47,7 +47,7 @@ export namespace Message {
     reply_markup?: InlineKeyboardMarkup;
   }
   export interface CaptionableMessage extends CommonMessage {
-    /** Caption for the animation, audio, document, photo, video or voice, 0-1024 characters */
+    /** Caption for the animation, audio, document, photo, video or voice */
     caption?: string;
     /** For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption */
     caption_entities?: MessageEntity[];
@@ -72,50 +72,66 @@ export namespace Message {
   export type PollMessage = CommonMessage & MsgWith<"poll">;
   export type LocationMessage = CommonMessage & MsgWith<"location">;
   export type VenueMessage = LocationMessage & MsgWith<"venue">;
-  export type NewChatMembersMessage = ServiceMessage &
-    MsgWith<"new_chat_members">;
-  export type LeftChatMemberMessage = ServiceMessage &
-    MsgWith<"left_chat_member">;
+  export type NewChatMembersMessage =
+    & ServiceMessage
+    & MsgWith<"new_chat_members">;
+  export type LeftChatMemberMessage =
+    & ServiceMessage
+    & MsgWith<"left_chat_member">;
   export type NewChatTitleMessage = ServiceMessage & MsgWith<"new_chat_title">;
   export type NewChatPhotoMessage = ServiceMessage & MsgWith<"new_chat_photo">;
-  export type DeleteChatPhotoMessage = ServiceMessage &
-    MsgWith<"delete_chat_photo">;
-  export type GroupChatCreatedMessage = ServiceMessage &
-    MsgWith<"group_chat_created">;
-  export type SupergroupChatCreated = ServiceMessage &
-    MsgWith<"supergroup_chat_created">;
-  export type ChannelChatCreatedMessage = ServiceMessage &
-    MsgWith<"channel_chat_created">;
-  export type MessageAutoDeleteTimerChangedMessage = ServiceMessage &
-    MsgWith<"message_auto_delete_timer_changed">;
-  export type MigrateToChatIdMessage = ServiceMessage &
-    MsgWith<"migrate_to_chat_id">;
-  export type MigrateFromChatIdMessage = ServiceMessage &
-    MsgWith<"migrate_from_chat_id">;
+  export type DeleteChatPhotoMessage =
+    & ServiceMessage
+    & MsgWith<"delete_chat_photo">;
+  export type GroupChatCreatedMessage =
+    & ServiceMessage
+    & MsgWith<"group_chat_created">;
+  export type SupergroupChatCreated =
+    & ServiceMessage
+    & MsgWith<"supergroup_chat_created">;
+  export type ChannelChatCreatedMessage =
+    & ServiceMessage
+    & MsgWith<"channel_chat_created">;
+  export type MessageAutoDeleteTimerChangedMessage =
+    & ServiceMessage
+    & MsgWith<"message_auto_delete_timer_changed">;
+  export type MigrateToChatIdMessage =
+    & ServiceMessage
+    & MsgWith<"migrate_to_chat_id">;
+  export type MigrateFromChatIdMessage =
+    & ServiceMessage
+    & MsgWith<"migrate_from_chat_id">;
   export type PinnedMessageMessage = ServiceMessage & MsgWith<"pinned_message">;
   export type InvoiceMessage = ServiceMessage & MsgWith<"invoice">;
-  export type SuccessfulPaymentMessage = ServiceMessage &
-    MsgWith<"successful_payment">;
-  export type ConnectedWebsiteMessage = ServiceMessage &
-    MsgWith<"connected_website">;
+  export type SuccessfulPaymentMessage =
+    & ServiceMessage
+    & MsgWith<"successful_payment">;
+  export type ConnectedWebsiteMessage =
+    & ServiceMessage
+    & MsgWith<"connected_website">;
   export type PassportDataMessage = ServiceMessage & MsgWith<"passport_data">;
-  export type ProximityAlertTriggeredMessage = ServiceMessage &
-    MsgWith<"proximity_alert_triggered">;
-  export type VideoChatScheduledMessage = ServiceMessage &
-    MsgWith<"video_chat_scheduled">;
-  export type VideoChatStartedMessage = ServiceMessage &
-    MsgWith<"video_chat_started">;
-  export type VideoChatEndedMessage = ServiceMessage &
-    MsgWith<"video_chat_ended">;
-  export type VideoChatParticipantsInvitedMessage = ServiceMessage &
-    MsgWith<"video_chat_participants_invited">;
+  export type ProximityAlertTriggeredMessage =
+    & ServiceMessage
+    & MsgWith<"proximity_alert_triggered">;
+  export type VideoChatScheduledMessage =
+    & ServiceMessage
+    & MsgWith<"video_chat_scheduled">;
+  export type VideoChatStartedMessage =
+    & ServiceMessage
+    & MsgWith<"video_chat_started">;
+  export type VideoChatEndedMessage =
+    & ServiceMessage
+    & MsgWith<"video_chat_ended">;
+  export type VideoChatParticipantsInvitedMessage =
+    & ServiceMessage
+    & MsgWith<"video_chat_participants_invited">;
   export type WebAppDataMessage = ServiceMessage & MsgWith<"web_app_data">;
 }
 
 type ReplyMessage = Message & { reply_to_message: undefined };
 
 export interface Message extends Message.MediaMessage {
-  /** For text messages, the actual UTF-8 text of the message, 0-4096 characters */
+  /** For text messages, the actual UTF-8 text of the message */
   text?: string;
   /** For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text */
   entities?: MessageEntity[];
@@ -200,7 +216,7 @@ export interface MessageId {
   message_id: number;
 }
 
-/** Contains information about an inline message sent by a Web App on behalf of a user. */
+/** Describes an inline message sent by a Web App on behalf of a user. */
 export interface SentWebAppMessage {
   /** Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message. */
   inline_message_id: string;
@@ -211,7 +227,7 @@ export interface SentWebAppMessage {
 Note that Telegram clients will display an **alert** to the user before opening an inline link ('Open this link?' together with the full URL).
 
 Message entities can be nested, providing following restrictions are met:
-- If two entities have common characters then one of them is fully contained inside another.
+- If two entities have common characters, then one of them is fully contained inside another.
 - bold, italic, underline, strikethrough, and spoiler entities can contain and can be part of any other entities, except pre and code.
 - All other entities can't contain each other.
 
@@ -299,7 +315,7 @@ export type ParseMode = "Markdown" | "MarkdownV2" | "HTML";
 
 export namespace MessageEntity {
   interface AbstractMessageEntity {
-    /** Type of the entity. Currently, can be "mention" (@username), "hashtag" (#hashtag), "cashtag" ($USD), "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), "code" (monowidth string), "pre" (monowidth block), "text_link" (for clickable text URLs), "text_mention" (for users without usernames) */
+    /** Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “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), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames) */
     type: string;
     /** Offset in UTF-16 code units to the start of the entity */
     offset: number;
@@ -324,17 +340,17 @@ export namespace MessageEntity {
   }
   export interface TextLinkMessageEntity extends AbstractMessageEntity {
     type: "text_link";
-    /** For "text_link" only, url that will be opened after user taps on the text */
+    /** For “text_link” only, URL that will be opened after user taps on the text */
     url: string;
   }
   export interface TextMentionMessageEntity extends AbstractMessageEntity {
     type: "text_mention";
-    /** For "text_mention" only, the mentioned user */
+    /** For “text_mention” only, the mentioned user */
     user: User;
   }
   export interface PreMessageEntity extends AbstractMessageEntity {
     type: "pre";
-    /** For "pre" only, the programming language of the entity text */
+    /** For “pre” only, the programming language of the entity text */
     language?: string;
   }
 }
@@ -436,7 +452,7 @@ export interface Video {
   thumb?: PhotoSize;
   /** Original filename as defined by sender */
   file_name?: string;
-  /** Mime type of a file as defined by sender */
+  /** MIME type of the file as defined by sender */
   mime_type?: string;
   /** File size in bytes */
   file_size?: number;
@@ -526,7 +542,7 @@ export interface Poll {
   is_closed: boolean;
   /** True, if the poll is anonymous */
   is_anonymous: boolean;
-  /** Poll type, currently can be "regular" or "quiz" */
+  /** Poll type, currently can be “regular” or “quiz” */
   type: "regular" | "quiz";
   /** True, if the poll allows multiple answers */
   allows_multiple_answers: boolean;
@@ -554,7 +570,7 @@ export interface Location {
   live_period?: number;
   /** The direction in which user is moving, in degrees; 1-360. For active live locations only. */
   heading?: number;
-  /** Maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only. */
+  /** The maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only. */
   proximity_alert_radius?: number;
 }
 
@@ -568,7 +584,7 @@ export interface Venue {
   address: string;
   /** Foursquare identifier of the venue */
   foursquare_id?: string;
-  /** Foursquare type of the venue. (For example, "arts_entertainment/default", "arts_entertainment/aquarium" or "food/icecream".) */
+  /** Foursquare type of the venue. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.) */
   foursquare_type?: string;
   /** Google Places identifier of the venue */
   google_place_id?: string;
@@ -613,11 +629,11 @@ export interface VideoChatParticipantsInvited {
   users: User[];
 }
 
-/** Contains data sent from a Web App to the bot. */
+/** Describes data sent from a Web App to the bot. */
 export interface WebAppData {
   /** The data. Be aware that a bad client can send arbitrary data in this field. */
   data: string;
-  /** Text of the web_app keyboard button, from which the Web App was opened. Be aware that a bad client can send arbitrary data in this field. */
+  /** Text of the web_app keyboard button from which the Web App was opened. Be aware that a bad client can send arbitrary data in this field. */
   button_text: string;
 }
 
@@ -641,6 +657,8 @@ export interface Sticker {
   emoji?: string;
   /** Name of the sticker set to which the sticker belongs */
   set_name?: string;
+  /** Premium animation for the sticker, if the sticker is premium  */
+  premium_animation?: File;
   /** For mask stickers, the position where the mask should be placed */
   mask_position?: MaskPosition;
   /** File size in bytes */
@@ -667,7 +685,7 @@ export interface StickerSet {
 
 /** This object describes the position on faces where a mask should be placed by default. */
 export interface MaskPosition {
-  /** The part of the face relative to which the mask should be placed. One of "forehead", "eyes", "mouth", or "chin". */
+  /** The part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”. */
   point: "forehead" | "eyes" | "mouth" | "chin";
   /** Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. For example, choosing -1.0 will place mask just to the left of the default mask position. */
   x_shift: number;

package/package.json

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

package/passport.d.ts

@@ -1,4 +1,4 @@
-/** Contains information about Telegram Passport data shared with the bot by the user. */
+/** Describes Telegram Passport data shared with the bot by the user. */
 export interface PassportData {
   /** Array with information about documents and other Telegram Passport elements that was shared with the bot */
   data: EncryptedPassportElement[];
@@ -18,9 +18,9 @@ export interface PassportFile {
   file_date: number;
 }
 
-/** Contains information about documents or other Telegram Passport elements shared with the bot by the user. */
+/** Describes documents or other Telegram Passport elements shared with the bot by the user. */
 export interface EncryptedPassportElement {
-  /** Element type. One of "personal_details", "passport", "driver_license", "identity_card", "internal_passport", "address", "utility_bill", "bank_statement", "rental_agreement", "passport_registration", "temporary_registration", "phone_number", "email". */
+  /** Element type. One of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”, “phone_number”, “email”. */
   type:
     | "personal_details"
     | "passport"
@@ -35,27 +35,27 @@ export interface EncryptedPassportElement {
     | "temporary_registration"
     | "phone_number"
     | "email";
-  /** Base64-encoded encrypted Telegram Passport element data provided by the user, available for "personal_details", "passport", "driver_license", "identity_card", "internal_passport" and "address" types. Can be decrypted and verified using the accompanying EncryptedCredentials. */
+  /** Base64-encoded encrypted Telegram Passport element data provided by the user, available for “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport” and “address” types. Can be decrypted and verified using the accompanying EncryptedCredentials. */
   data?: string;
-  /** User's verified phone number, available only for "phone_number" type */
+  /** User's verified phone number, available only for “phone_number” type */
   phone_number?: string;
-  /** User's verified email address, available only for "email" type */
+  /** User's verified email address, available only for “email” type */
   email?: string;
-  /** Array of encrypted files with documents provided by the user, available for "utility_bill", "bank_statement", "rental_agreement", "passport_registration" and "temporary_registration" types. Files can be decrypted and verified using the accompanying EncryptedCredentials. */
+  /** Array of encrypted files with documents provided by the user, available for “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials. */
   files?: PassportFile[];
-  /** Encrypted file with the front side of the document, provided by the user. Available for "passport", "driver_license", "identity_card" and "internal_passport". The file can be decrypted and verified using the accompanying EncryptedCredentials. */
+  /** Encrypted file with the front side of the document, provided by the user. Available for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials. */
   front_side?: PassportFile;
-  /** Encrypted file with the reverse side of the document, provided by the user. Available for "driver_license" and "identity_card". The file can be decrypted and verified using the accompanying EncryptedCredentials. */
+  /** Encrypted file with the reverse side of the document, provided by the user. Available for “driver_license” and “identity_card”. The file can be decrypted and verified using the accompanying EncryptedCredentials. */
   reverse_side?: PassportFile;
-  /** Encrypted file with the selfie of the user holding a document, provided by the user; available for "passport", "driver_license", "identity_card" and "internal_passport". The file can be decrypted and verified using the accompanying EncryptedCredentials. */
+  /** Encrypted file with the selfie of the user holding a document, provided by the user; available for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials. */
   selfie?: PassportFile;
-  /** Array of encrypted files with translated versions of documents provided by the user. Available if requested for "passport", "driver_license", "identity_card", "internal_passport", "utility_bill", "bank_statement", "rental_agreement", "passport_registration" and "temporary_registration" types. Files can be decrypted and verified using the accompanying EncryptedCredentials. */
+  /** Array of encrypted files with translated versions of documents provided by the user. Available if requested for “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials. */
   translation?: PassportFile[];
   /** Base64-encoded element hash for using in PassportElementErrorUnspecified */
   hash: string;
 }
 
-/** Contains data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes. */
+/** Describes data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes. */
 export interface EncryptedCredentials {
   /** Base64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for EncryptedPassportElement decryption and authentication */
   data: string;
@@ -91,7 +91,7 @@ export type PassportElementError =
 export interface PassportElementErrorDataField {
   /** Error source, must be data */
   source: "data";
-  /** The section of the user's Telegram Passport which has the error, one of "personal_details", "passport", "driver_license", "identity_card", "internal_passport", "address" */
+  /** The section of the user's Telegram Passport which has the error, one of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address” */
   type:
     | "personal_details"
     | "passport"
@@ -111,7 +111,7 @@ export interface PassportElementErrorDataField {
 export interface PassportElementErrorFrontSide {
   /** Error source, must be front_side */
   source: "front_side";
-  /** The section of the user's Telegram Passport which has the issue, one of "passport", "driver_license", "identity_card", "internal_passport" */
+  /** The section of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport” */
   type: "passport" | "driver_license" | "identity_card" | "internal_passport";
   /** Base64-encoded hash of the file with the front side of the document */
   file_hash: string;
@@ -123,7 +123,7 @@ export interface PassportElementErrorFrontSide {
 export interface PassportElementErrorReverseSide {
   /** Error source, must be reverse_side */
   source: "reverse_side";
-  /** The section of the user's Telegram Passport which has the issue, one of "driver_license", "identity_card" */
+  /** The section of the user's Telegram Passport which has the issue, one of “driver_license”, “identity_card” */
   type: "driver_license" | "identity_card";
   /** Base64-encoded hash of the file with the reverse side of the document */
   file_hash: string;
@@ -135,7 +135,7 @@ export interface PassportElementErrorReverseSide {
 export interface PassportElementErrorSelfie {
   /** Error source, must be selfie */
   source: "selfie";
-  /** The section of the user's Telegram Passport which has the issue, one of "passport", "driver_license", "identity_card", "internal_passport" */
+  /** The section of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport” */
   type: "passport" | "driver_license" | "identity_card" | "internal_passport";
   /** Base64-encoded hash of the file with the selfie */
   file_hash: string;
@@ -147,7 +147,7 @@ export interface PassportElementErrorSelfie {
 export interface PassportElementErrorFile {
   /** Error source, must be file */
   source: "file";
-  /** The section of the user's Telegram Passport which has the issue, one of "utility_bill", "bank_statement", "rental_agreement", "passport_registration", "temporary_registration" */
+  /** The section of the user's Telegram Passport which has the issue, one of “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration” */
   type:
     | "utility_bill"
     | "bank_statement"
@@ -164,7 +164,7 @@ export interface PassportElementErrorFile {
 export interface PassportElementErrorFiles {
   /** Error source, must be files */
   source: "files";
-  /** The section of the user's Telegram Passport which has the issue, one of "utility_bill", "bank_statement", "rental_agreement", "passport_registration", "temporary_registration" */
+  /** The section of the user's Telegram Passport which has the issue, one of “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration” */
   type:
     | "utility_bill"
     | "bank_statement"
@@ -181,7 +181,7 @@ export interface PassportElementErrorFiles {
 export interface PassportElementErrorTranslationFile {
   /** Error source, must be translation_file */
   source: "translation_file";
-  /** Type of element of the user's Telegram Passport which has the issue, one of "passport", "driver_license", "identity_card", "internal_passport", "utility_bill", "bank_statement", "rental_agreement", "passport_registration", "temporary_registration" */
+  /** Type of element of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration” */
   type:
     | "passport"
     | "driver_license"
@@ -202,7 +202,7 @@ export interface PassportElementErrorTranslationFile {
 export interface PassportElementErrorTranslationFiles {
   /** Error source, must be translation_files */
   source: "translation_files";
-  /** Type of element of the user's Telegram Passport which has the issue, one of "passport", "driver_license", "identity_card", "internal_passport", "utility_bill", "bank_statement", "rental_agreement", "passport_registration", "temporary_registration" */
+  /** Type of element of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration” */
   type:
     | "passport"
     | "driver_license"

package/payment.d.ts

@@ -24,7 +24,7 @@ export interface Invoice {
 
 /** This object represents a shipping address. */
 export interface ShippingAddress {
-  /** ISO 3166-1 alpha-2 country code */
+  /** Two-letter ISO 3166-1 alpha-2 country code */
   country_code: string;
   /** State, if applicable */
   state: string;
@@ -70,7 +70,7 @@ export interface SuccessfulPayment {
   invoice_payload: string;
   /** Identifier of the shipping option chosen by the user */
   shipping_option_id?: string;
-  /** Order info provided by the user */
+  /** Order information provided by the user */
   order_info?: OrderInfo;
   /** Telegram payment identifier */
   telegram_payment_charge_id: string;
@@ -104,6 +104,6 @@ export interface PreCheckoutQuery {
   invoice_payload: string;
   /** Identifier of the shipping option chosen by the user */
   shipping_option_id?: string;
-  /** Order info provided by the user */
+  /** Order information provided by the user */
   order_info?: OrderInfo;
 }

package/proxied.d.ts

@@ -42,12 +42,8 @@ type Params<M extends keyof InputFileProxy<F>["Telegram"], F> = Parameters<
 export interface InputFileProxy<F> {
   /** Utility type providing the argument type for the given method name or `{}` if the method does not take any parameters */
   Opts: {
-    [M in keyof InputFileProxy<F>["Telegram"]]: Params<
-      M,
-      F
-    >[0] extends undefined
-      ? {}
-      : NonNullable<Params<M, F>[0]>;
+    [M in keyof InputFileProxy<F>["Telegram"]]: Params<M, F>[0] extends
+      undefined ? {} : NonNullable<Params<M, F>[0]>;
   };
 
   /** Wrapper type to bundle all methods of the Telegram API */
@@ -64,36 +60,38 @@ export interface InputFileProxy<F> {
       limit?: number;
       /** Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only. */
       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 (default). If not specified, the previous setting will be used.
+      /** 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 (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. */
       allowed_updates?: readonly string[];
     }): 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, we will give up after a reasonable amount of attempts. Returns True on success.
 
-    If you'd like to make sure that the Webhook request comes from Telegram, we recommend using a secret path in the URL, e.g. https://www.example.com/<token>. Since nobody else knows your bot's token, you can be pretty sure it's us.
+    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.
 
     Notes
     1. You will not be able to receive updates using getUpdates for as long as an outgoing webhook is set up.
     2. To use a self-signed certificate, you need to upload your public key certificate using certificate parameter. Please upload as InputFile, sending a String will not work.
     3. Ports currently supported for Webhooks: 443, 80, 88, 8443.
 
-    NEW! If you're having any trouble setting up webhooks, please check out this amazing guide to Webhooks. */
+    If you're having any trouble setting up webhooks, please check out this amazing guide to webhooks. */
     setWebhook(args: {
-      /** HTTPS url to send updates to. Use an empty string to remove webhook integration */
+      /** HTTPS URL to send updates to. Use an empty string to remove webhook integration */
       url: string;
       /** Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details. */
       certificate?: F;
       /** The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS */
       ip_address?: string;
-      /** Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput. */
+      /** The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput. */
       max_connections?: 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 (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 setWebhook, so unwanted updates may be received for a short period of time. */
-      allowed_updates?: ReadonlyArray<Exclude<keyof Update, "update_id">>;
-      /** Pass True to drop all pending updates */
-      drop_pending_updates?: boolean;
+      /** 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 (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 setWebhook, so unwanted updates may be received for a short period of time. */
+       allowed_updates?: ReadonlyArray<Exclude<keyof Update, "update_id">>;
+       /** Pass True to drop all pending updates */
+       drop_pending_updates?: boolean;
+       /** A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you. */
+       secret_token?: string;
     }): true;
 
     /** Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success. */
@@ -284,7 +282,7 @@ export interface InputFileProxy<F> {
         | ForceReply;
     }): Message.DocumentMessage;
 
-    /** Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future. */
+    /** Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future. */
     sendVideo(args: {
       /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
       chat_id: number | string;
@@ -389,7 +387,7 @@ export interface InputFileProxy<F> {
     }): Message.VoiceMessage;
 
     /** Use this method to send video messages. On success, the sent Message is returned.
-    As of v.4.0, Telegram clients support rounded square mp4 videos of up to 1 minute long. */
+    As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. */
     sendVideoNote(args: {
       /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
       chat_id: number | string;
@@ -457,7 +455,7 @@ export interface InputFileProxy<F> {
       live_period?: number;
       /** The direction in which user is moving, in degrees; 1-360. For active live locations only. */
       heading?: number;
-      /** Maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only. */
+      /** The maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only. */
       proximity_alert_radius?: number;
       /** Sends the message silently. Users will receive a notification with no sound. */
       disable_notification?: boolean;
@@ -491,7 +489,7 @@ export interface InputFileProxy<F> {
       horizontal_accuracy?: number;
       /** The direction in which user is moving, in degrees; 1-360. For active live locations only. */
       heading?: number;
-      /** Maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only. */
+      /** The maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only. */
       proximity_alert_radius?: number;
       /** An object for a new inline keyboard. */
       reply_markup?: InlineKeyboardMarkup;
@@ -523,7 +521,7 @@ export interface InputFileProxy<F> {
       address: string;
       /** Foursquare identifier of the venue */
       foursquare_id?: string;
-      /** Foursquare type of the venue, if known. (For example, "arts_entertainment/default", "arts_entertainment/aquarium" or "food/icecream".) */
+      /** Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.) */
       foursquare_type?: string;
       /** Google Places identifier of the venue */
       google_place_id?: string;
@@ -583,7 +581,7 @@ export interface InputFileProxy<F> {
       options: readonly string[];
       /** True, if the poll needs to be anonymous, defaults to True */
       is_anonymous?: boolean;
-      /** Poll type, "quiz" or "regular", defaults to "regular" */
+      /** Poll type, “quiz” or “regular”, defaults to “regular” */
       type?: "quiz" | "regular";
       /** True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False */
       allows_multiple_answers?: boolean;
@@ -672,11 +670,11 @@ export interface InputFileProxy<F> {
       limit?: number;
     }): UserProfilePhotos;
 
-    /** Use this method to get basic info about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>, where <file_path> is taken from the response. 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 again.
+    /** Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>, where <file_path> is taken from the response. 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 again.
 
     Note: This function may not preserve the original file name and MIME type. You should save the file's MIME type and name (if available) when the File object is received. */
     getFile(args: {
-      /** File identifier to get info about */
+      /** File identifier to get information about */
       file_id: string;
     }): File;
 
@@ -798,7 +796,7 @@ export interface InputFileProxy<F> {
       name?: string;
       /** Point in time (Unix timestamp) when the link will expire */
       expire_date?: number;
-      /** Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999 */
+      /** The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999 */
       member_limit?: number;
       /** True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified */
       creates_join_request?: boolean;
@@ -814,7 +812,7 @@ export interface InputFileProxy<F> {
       name?: string;
       /** Point in time (Unix timestamp) when the link will expire */
       expire_date?: number;
-      /** Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999 */
+      /** The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999 */
       member_limit?: number;
       /** True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified */
       creates_join_request?: boolean;
@@ -950,7 +948,7 @@ export interface InputFileProxy<F> {
 
     /** Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.
 
-    Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via @Botfather and accept the terms. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter. */
+    Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via @BotFather and accept the terms. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter. */
     answerCallbackQuery(args: {
       /** Unique identifier for the query to be answered */
       callback_query_id: string;
@@ -958,7 +956,7 @@ export interface InputFileProxy<F> {
       text?: string;
       /** If True, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false. */
       show_alert?: boolean;
-      /** URL that will be opened by the user's client. If you have created a Game and accepted the conditions via @Botfather, specify the URL that opens your game — note that this will only work if the query comes from a callback_game button.
+      /** URL that will be opened by the user's client. If you have created a Game and accepted the conditions via @BotFather, specify the URL that opens your game - note that this will only work if the query comes from a callback_game button.
 
       Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter. */
       url?: string;
@@ -1156,7 +1154,7 @@ export interface InputFileProxy<F> {
     createNewStickerSet(args: {
       /** User identifier of created sticker set owner */
       user_id: number;
-      /** Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can contain only english letters, digits and underscores. Must begin with a letter, can't contain consecutive underscores and must end in "_by_<bot username>". <bot_username> is case insensitive. 1-64 characters. */
+      /** Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can contain only English letters, digits and underscores. Must begin with a letter, can't contain consecutive underscores and must end in "_by_<bot username>". <bot_username> is case insensitive. 1-64 characters. */
       name: string;
       /** Sticker set title, 1-64 characters */
       title: string;
@@ -1212,7 +1210,7 @@ export interface InputFileProxy<F> {
       name: string;
       /** User identifier of the sticker set owner */
       user_id: number;
-      /** A PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a TGS animation with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#animated-sticker-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-sticker-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 info on Sending Files ». Animated sticker set thumbnails can't be uploaded via HTTP URL. */
+      /** A PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a TGS animation with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#animated-sticker-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-sticker-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. Animated sticker set thumbnails can't be uploaded via HTTP URL. */
       thumb?: F | string;
     }): true;
 
@@ -1255,7 +1253,7 @@ export interface InputFileProxy<F> {
       description: string;
       /** Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. */
       payload: string;
-      /** Payments provider token, obtained via Botfather */
+      /** Payment provider token, obtained via BotFather */
       provider_token: string;
       /** Three-letter ISO 4217 currency code, see more on currencies */
       currency: string;
@@ -1271,7 +1269,7 @@ export interface InputFileProxy<F> {
       provider_data?: string;
       /** URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for. */
       photo_url?: string;
-      /** Photo size */
+      /** Photo size in bytes */
       photo_size?: number;
       /** Photo width */
       photo_width?: number;
@@ -1285,9 +1283,9 @@ export interface InputFileProxy<F> {
       need_email?: boolean;
       /** Pass True, if you require the user's shipping address to complete the order */
       need_shipping_address?: boolean;
-      /** Pass True, if user's phone number should be sent to provider */
+      /** Pass True, if the user's phone number should be sent to provider */
       send_phone_number_to_provider?: boolean;
-      /** Pass True, if user's email address should be sent to provider */
+      /** Pass True, if the user's email address should be sent to provider */
       send_email_to_provider?: boolean;
       /** Pass True, if the final price depends on the shipping method */
       is_flexible?: boolean;
@@ -1303,6 +1301,50 @@ export interface InputFileProxy<F> {
       reply_markup?: InlineKeyboardMarkup;
     }): Message.InvoiceMessage;
 
+    /** Use this method to create a link for an invoice. Returns the created invoice link as String on success. */
+    createInvoiceLink(args: {
+      /** Product name, 1-32 characters */
+      title: string;
+      /** Product description, 1-255 characters */
+      description: string;
+      /** Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. */
+      payload: string;
+      /** Payment provider token, obtained via BotFather */
+      provider_token: string;
+      /** Three-letter ISO 4217 currency code, see more on currencies */
+      currency: string;
+      /** Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.) */
+      prices: LabeledPrice[];
+      /** The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0 */
+      max_tip_amount?: number;
+      /** An array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount. */
+      suggested_tip_amounts?: number[];
+      /** Data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider. */
+      provider_data?: string;
+      /** URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. */
+      photo_url?: string;
+      /** Photo size in bytes */
+      photo_size?: number;
+      /** Photo width */
+      photo_width?: number;
+      /** Photo height */
+      photo_height?: number;
+      /** Pass True, if you require the user's full name to complete the order */
+      need_name?: boolean;
+      /** Pass True, if you require the user's phone number to complete the order */
+      need_phone_number?: boolean;
+      /** Pass True, if you require the user's email address to complete the order */
+      need_email?: boolean;
+      /** Pass True, if you require the user's shipping address to complete the order */
+      need_shipping_address?: boolean;
+      /** Pass True, if the user's phone number should be sent to the provider */
+      send_phone_number_to_provider?: boolean;
+      /** Pass True, if the user's email address should be sent to the provider */
+      send_email_to_provider?: boolean;
+      /** Pass True, if the final price depends on the shipping method */
+      is_flexible?: boolean;
+    }): string;
+
     /** If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned. */
     answerShippingQuery(args: {
       /** Unique identifier for the query to be answered */
@@ -1339,7 +1381,7 @@ export interface InputFileProxy<F> {
     sendGame(args: {
       /** Unique identifier for the target chat */
       chat_id: number;
-      /** Short name of the game, serves as the unique identifier for the game. Set up your games via Botfather. */
+      /** Short name of the game, serves as the unique identifier for the game. Set up your games via BotFather. */
       game_short_name: string;
       /** Sends the message silently. Users will receive a notification with no sound. */
       disable_notification?: boolean;
@@ -1373,7 +1415,7 @@ export interface InputFileProxy<F> {
 
     /** Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. On success, returns an Array of GameHighScore objects.
 
-    This method will currently return scores for the target user, plus two of their closest neighbors on each side. Will also return the top three users if the user and his neighbors are not among them. Please note that this behavior is subject to change. */
+    This method will currently return scores for the target user, plus two of their closest neighbors on each side. Will also return the top three users if the user and their neighbors are not among them. Please note that this behavior is subject to change. */
     getGameHighScores(args: {
       /** Target user id */
       user_id: number;

package/update.d.ts

@@ -38,13 +38,13 @@ export namespace Update {
 /** This object represents an incoming update.
 At most one of the optional parameters can be present in any given update. */
 export interface Update {
-  /** The update's unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you're using Webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order. If there are no new updates for at least a week, then identifier of the next update will be chosen randomly instead of sequentially. */
+  /** The update's unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you're using webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order. If there are no new updates for at least a week, then identifier of the next update will be chosen randomly instead of sequentially. */
   update_id: number;
-  /** New incoming message of any kind — text, photo, sticker, etc. */
+  /** New incoming message of any kind - text, photo, sticker, etc. */
   message?: Message;
   /** New version of a message that is known to the bot and was edited */
   edited_message?: Message;
-  /** New incoming channel post of any kind — text, photo, sticker, etc. */
+  /** New incoming channel post of any kind - text, photo, sticker, etc. */
   channel_post?: Message;
   /** New version of a channel post that is known to the bot and was edited */
   edited_channel_post?: Message;