@grammyjs/types 3.1.3 → 3.2.0

package/manage.d.ts

@@ -130,6 +130,8 @@ export declare namespace Chat {
     interface PrivateGetChat extends PrivateChat, NonGroupGetChat, GetChat {
         /** Custom emoji identifier of emoji status of the other party in a private chat. Returned only in getChat. */
         emoji_status_custom_emoji_id?: string;
+        /** Expiration date of the emoji status of the other party in a private chat, if any. Returned only in getChat. */
+        emoji_status_expiration_date?: number;
         /** Bio of the other party in a private chat. Returned only in getChat. */
         bio?: string;
         /** True, if privacy settings of the other party in the private chat allows to use tg://user?id=<user_id> links only in chats with the user. Returned only in getChat. */

package/markup.d.ts

@@ -27,9 +27,7 @@ export declare namespace InlineKeyboardButton {
         login_url: LoginUrl;
     }
     interface SwitchInlineButton extends AbstractInlineKeyboardButton {
-        /** If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. Can be empty, in which case just the bot's username will be inserted.
-    
-        Note: This offers an easy way for users to start using your bot in inline mode when they are currently in a private chat with it. Especially useful when combined with switch_pm... actions – in this case the user will be automatically returned to the chat they switched from, skipping the chat selection screen. */
+        /** If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. Can be empty, in which case just the bot's username will be inserted. */
         switch_inline_query: string;
     }
     interface SwitchInlineCurrentChatButton extends AbstractInlineKeyboardButton {

package/message.d.ts

@@ -66,6 +66,7 @@ export declare namespace Message {
     type AnimationMessage = DocumentMessage & MsgWith<"animation">;
     type PhotoMessage = MediaMessage & MsgWith<"photo">;
     type StickerMessage = CommonMessage & MsgWith<"sticker">;
+    type StoryMessage = CommonMessage & MsgWith<"story">;
     type VideoMessage = MediaMessage & MsgWith<"video">;
     type VideoNoteMessage = CommonMessage & MsgWith<"video_note">;
     type VoiceMessage = CaptionableMessage & MsgWith<"voice">;
@@ -125,6 +126,8 @@ export interface Message extends Message.MediaMessage {
     photo?: PhotoSize[];
     /** Message is a sticker, information about the sticker */
     sticker?: Sticker;
+    /** Message is a forwarded story */
+    story?: Story;
     /** Message is a video, information about the video */
     video?: Video;
     /** Message is a video note, information about the video message */
@@ -255,11 +258,11 @@ Please note:
 
 - Any character with code between 1 and 126 inclusively can be escaped anywhere with a preceding '\' character, in which case it is treated as an ordinary character and not a part of the markup. This implies that '\' character usually must be escaped with a preceding '\' character.
 - Inside `pre` and `code` entities, all '`' and '\' characters must be escaped with a preceding '\' character.
-- Inside `(...)` part of inline link definition, all ')' and '\' must be escaped with a preceding '\' character.
-- A valid emoji must be provided as an alternative value for the custom emoji. The emoji will be shown instead of the custom emoji in places where a custom emoji cannot be displayed (e.g., system notifications) or if the message is forwarded by a non-premium user. It is recommended to use the emoji from the emoji field of the custom emoji sticker.
-- Custom emoji entities can only be used by bots that purchased additional usernames on Fragment.
+- Inside the `(...)` part of the inline link and custom emoji definition, all ')' and '\' must be escaped with a preceding '\' character.
 - In all other places characters '_', '*', '[', ']', '(', ')', '~', '`', '>', '#', '+', '-', '=', '|', '{', '}', '.', '!' must be escaped with the preceding character '\'.
 - In case of ambiguity between `italic` and `underline` entities `__` is always greadily treated from left to right as beginning or end of `underline` entity, so instead of `___italic underline___` use `___italic underline_\r__`, where `\r` is a character with code 13, which will be ignored.
+- A valid emoji must be provided as an alternative value for the custom emoji. The emoji will be shown instead of the custom emoji in places where a custom emoji cannot be displayed (e.g., system notifications) or if the message is forwarded by a non-premium user. It is recommended to use the emoji from the emoji field of the custom emoji sticker.
+- Custom emoji entities can only be used by bots that purchased additional usernames on Fragment.
 
 #### HTML style
 To use this mode, pass *HTML* in the *parse_mode* field. The following tags are currently supported:
@@ -497,9 +500,11 @@ export interface PollOption {
 export interface PollAnswer {
     /** Unique poll identifier */
     poll_id: string;
-    /** The user, who changed the answer to the poll */
-    user: User;
-    /** 0-based identifiers of answer options, chosen by the user. May be empty if the user retracted their vote. */
+    /** The chat that changed the answer to the poll, if the voter is anonymous */
+    voter_chat?: Chat;
+    /** The user that changed the answer to the poll, if the voter isn't anonymous */
+    user?: User;
+    /** 0-based identifiers of chosen answer options. May be empty if the vote was retracted. */
     option_ids: number[];
 }
 /** This object contains information about a poll. */
@@ -563,6 +568,9 @@ export interface Venue {
     /** Google Places type of the venue. (See supported types.) */
     google_place_type?: string;
 }
+/** This object represents a message about a forwarded story in the chat. Currently holds no information. */
+export interface Story {
+}
 /** This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user. */
 export interface ProximityAlertTriggered {
     /** User that triggered the alert */

package/methods.d.ts

@@ -903,6 +903,11 @@ export type ApiMethods<F> = {
         /** Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) */
         chat_id: number | string;
     }): true;
+    /** Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success. */
+    unpinAllGeneralForumTopicMessages(args: {
+        /** Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) */
+        chat_id: number | string;
+    }): true;
     /** 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. */
@@ -1226,7 +1231,7 @@ export type ApiMethods<F> = {
         results: readonly InlineQueryResult[];
         /** The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300. */
         cache_time?: number;
-        /** Pass True if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query */
+        /** Pass True if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query. */
         is_personal?: boolean;
         /** Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don't support pagination. Offset length can't exceed 64 bytes. */
         next_offset?: string;

package/package.json

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