@grammyjs/types 2.9.0 → 2.10.0

package/manage.d.ts

@@ -94,6 +94,8 @@ export namespace Chat {
   export interface SupergroupChat
     extends AbstractChat, UserNameChat, TitleChat {
     type: "supergroup";
+    /** True, if the supergroup chat is a forum (has topics enabled) */
+    is_forum?: true;
   }
   /** Internal type representing channel chats. */
   export interface ChannelChat extends AbstractChat, UserNameChat, TitleChat {
@@ -116,6 +118,11 @@ export namespace Chat {
     /** True, if messages from the chat can't be forwarded to other chats. Returned only in getChat. */
     has_protected_content?: true;
   }
+  /** Internal type holding properties that those private, supergroup, and channel chats returned from `getChat` share. */
+  interface NonGroupGetChat extends GetChat {
+    /** If non-empty, the list of all active chat usernames; for private chats, supergroups and channels. Returned only in getChat. */
+    active_usernames?: string[];
+  }
   /** Internal type holding properties that those group, supergroup, and channel chats returned from `getChat` share. */
   interface NonPrivateGetChat extends GetChat {
     /** Description, for groups, supergroups and channel chats. Returned only in getChat. */
@@ -138,7 +145,10 @@ export namespace Chat {
 
   // ==> GET CHATS
   /** Internal type representing private chats returned from `getChat`. */
-  export interface PrivateGetChat extends PrivateChat, GetChat {
+  export 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;
     /** 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. */
@@ -150,7 +160,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, NonGroupGetChat, 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. */
@@ -159,7 +169,8 @@ export namespace Chat {
     location?: ChatLocation;
   }
   /** Internal type representing channel chats returned from `getChat`. */
-  export interface ChannelGetChat extends ChannelChat, LargeGetChat {}
+  export interface ChannelGetChat
+    extends ChannelChat, NonGroupGetChat, LargeGetChat {}
 }
 
 /** This object represents a chat. */
@@ -242,6 +253,8 @@ export interface ChatAdministratorRights {
   can_edit_messages?: boolean;
   /** True, if the user is allowed to pin messages; groups and supergroups only */
   can_pin_messages?: boolean;
+  /** True, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only */
+  can_manage_topics?: boolean;
 }
 
 /** This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported:
@@ -301,6 +314,8 @@ export interface ChatMemberAdministrator {
   can_edit_messages?: boolean;
   /** True, if the user is allowed to pin messages; groups and supergroups only */
   can_pin_messages?: boolean;
+  /** True, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only */
+  can_manage_topics?: boolean;
   /** Custom title for this user */
   custom_title?: string;
 }
@@ -327,6 +342,8 @@ export interface ChatMemberRestricted {
   can_invite_users: boolean;
   /** True, if the user is allowed to pin messages */
   can_pin_messages: boolean;
+  /** True, if the user is allowed to create forum topics */
+  can_manage_topics: boolean;
   /** True, if the user is allowed to send text messages, contacts, locations and venues */
   can_send_messages: boolean;
   /** True, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes */
@@ -407,6 +424,8 @@ export interface ChatPermissions {
   can_invite_users?: boolean;
   /** True, if the user is allowed to pin messages. Ignored in public supergroups */
   can_pin_messages?: boolean;
+  /** True, if the user is allowed to create forum topics. If omitted defaults to the value of can_pin_messages */
+  can_manage_topics?: boolean;
 }
 
 /** Represents a location to which a chat is connected. */
@@ -417,6 +436,18 @@ export interface ChatLocation {
   address: string;
 }
 
+/** This object represents a forum topic. */
+export interface ForumTopic {
+  /** Unique identifier of the forum topic */
+  message_thread_id: number;
+  /** Name of the topic */
+  name: string;
+  /** Color of the topic icon in RGB format */
+  icon_color: number;
+  /** Unique identifier of the custom emoji shown as the topic icon */
+  icon_custom_emoji_id?: string;
+}
+
 /** This object represents a bot command. */
 export interface BotCommand {
   /** Text of the command; 1-32 characters. Can contain only lowercase English letters, digits and underscores. */

package/message.d.ts

@@ -9,6 +9,8 @@ export namespace Message {
   interface ServiceMessage {
     /** Unique message identifier inside this chat */
     message_id: number;
+    /** Unique identifier of a message thread or a forum topic to which the message belongs; for supergroups only */
+    message_thread_id?: number;
     /** Sender of the message; empty for messages sent to channels. For backward compatibility, the field contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat. */
     from?: User;
     /** Sender of the message, sent on behalf of a chat. For example, the channel itself for channel posts, the supergroup itself for messages from anonymous group administrators, the linked channel for messages automatically forwarded to the discussion group. For backward compatibility, the field from contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat. */
@@ -17,6 +19,8 @@ export namespace Message {
     date: number;
     /** Conversation the message belongs to */
     chat: Chat;
+    /** True, if the message is sent to a forum topic */
+    is_topic_message?: boolean;
   }
   interface CommonMessage extends ServiceMessage {
     /** For forwarded messages, sender of the original message */
@@ -113,6 +117,15 @@ export namespace Message {
   export type ProximityAlertTriggeredMessage =
     & ServiceMessage
     & MsgWith<"proximity_alert_triggered">;
+  export type ForumTopicCreatedMessage =
+    & ServiceMessage
+    & MsgWith<"forum_topic_created">;
+  export type ForumTopicClosedMessage =
+    & ServiceMessage
+    & MsgWith<"forum_topic_closed">;
+  export type ForumTopicReopenedMessage =
+    & ServiceMessage
+    & MsgWith<"forum_topic_reopened">;
   export type VideoChatScheduledMessage =
     & ServiceMessage
     & MsgWith<"video_chat_scheduled">;
@@ -197,7 +210,12 @@ export interface Message extends Message.MediaMessage {
   passport_data?: PassportData;
   /** Service message. A user in the chat triggered another user's proximity alert while sharing Live Location. */
   proximity_alert_triggered?: ProximityAlertTriggered;
-  /** Service message: voice chat scheduled */
+  /** Service message: forum topic created */
+  forum_topic_created?: ForumTopicCreated;
+  /** Service message: forum topic closed */
+  forum_topic_closed?: ForumTopicClosed;
+  /** Service message: forum topic reopened */
+  forum_topic_reopened?: ForumTopicReopened;
   /** Service message: video chat scheduled */
   video_chat_scheduled?: VideoChatScheduled;
   /** Service message: video chat started */
@@ -614,6 +632,22 @@ export interface MessageAutoDeleteTimerChanged {
   message_auto_delete_time: number;
 }
 
+/** This object represents a service message about a new forum topic created in the chat. */
+export interface ForumTopicCreated {
+  /** Name of the topic */
+  name: string;
+  /** Color of the topic icon in RGB format */
+  icon_color: number;
+  /** Unique identifier of the custom emoji shown as the topic icon */
+  icon_custom_emoji_id?: string;
+}
+
+/** This object represents a service message about a forum topic closed in the chat. Currently holds no information. */
+export interface ForumTopicClosed {}
+
+/** This object represents a service message about a forum topic reopened in the chat. Currently holds no information. */
+export interface ForumTopicReopened {}
+
 /** This object represents a service message about a video chat scheduled in the chat. */
 export interface VideoChatScheduled {
   /** Point in time (Unix timestamp) when the video chat is supposed to be started by a chat administrator */

package/package.json

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

package/proxied.d.ts

@@ -16,6 +16,7 @@ import {
   ChatMemberOwner,
   ChatPermissions,
   File,
+  ForumTopic,
   UserFromGetMe,
   UserProfilePhotos,
   WebhookInfo,
@@ -49,7 +50,7 @@ export interface InputFileProxy<F> {
       undefined ? {} : NonNullable<Params<M, F>[0]>;
   };
 
-  /** Wrapper type to bundle all methods of the Telegram API */
+  /** Wrapper type to bundle all methods of the Telegram Bot API */
   Telegram: {
     /** Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.
 
@@ -66,7 +67,7 @@ export interface InputFileProxy<F> {
       /** 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[];
+      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.
@@ -120,6 +121,8 @@ export interface InputFileProxy<F> {
     sendMessage(args: {
       /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
       chat_id: number | string;
+      /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
+      message_thread_id?: number;
       /** Text of the message to be sent, 1-4096 characters after entities parsing */
       text: string;
       /** Mode for parsing entities in the message text. See formatting options for more details. */
@@ -148,6 +151,8 @@ export interface InputFileProxy<F> {
     forwardMessage(args: {
       /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
       chat_id: number | string;
+      /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
+      message_thread_id?: number;
       /** Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername) */
       from_chat_id: number | string;
       /** Sends the message silently. Users will receive a notification with no sound. */
@@ -162,6 +167,8 @@ export interface InputFileProxy<F> {
     copyMessage(args: {
       /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
       chat_id: number | string;
+      /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
+      message_thread_id?: number;
       /** Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername) */
       from_chat_id: number | string;
       /** Message identifier in the chat specified in from_chat_id */
@@ -192,6 +199,8 @@ export interface InputFileProxy<F> {
     sendPhoto(args: {
       /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
       chat_id: number | string;
+      /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
+      message_thread_id?: number;
       /** Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. */
       photo: F | string;
       /** Photo caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsing */
@@ -222,6 +231,8 @@ export interface InputFileProxy<F> {
     sendAudio(args: {
       /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
       chat_id: number | string;
+      /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
+      message_thread_id?: number;
       /** Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. */
       audio: F | string;
       /** Audio caption, 0-1024 characters after entities parsing */
@@ -258,6 +269,8 @@ export interface InputFileProxy<F> {
     sendDocument(args: {
       /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
       chat_id: number | string;
+      /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
+      message_thread_id?: number;
       /** File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), 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. */
       document: F | string;
       /** Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. */
@@ -290,6 +303,8 @@ export interface InputFileProxy<F> {
     sendVideo(args: {
       /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
       chat_id: number | string;
+      /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
+      message_thread_id?: number;
       /** Video to send. Pass a file_id as String to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data. */
       video: F | string;
       /** Duration of sent video in seconds */
@@ -328,6 +343,8 @@ export interface InputFileProxy<F> {
     sendAnimation(args: {
       /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
       chat_id: number | string;
+      /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
+      message_thread_id?: number;
       /** Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. */
       animation: F | string;
       /** Duration of sent animation in seconds */
@@ -364,6 +381,8 @@ export interface InputFileProxy<F> {
     sendVoice(args: {
       /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
       chat_id: number | string;
+      /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
+      message_thread_id?: number;
       /** Audio file to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), 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. */
       voice: F | string;
       /** Voice message caption, 0-1024 characters after entities parsing */
@@ -395,6 +414,8 @@ export interface InputFileProxy<F> {
     sendVideoNote(args: {
       /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
       chat_id: number | string;
+      /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
+      message_thread_id?: number;
       /** Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data.. Sending video notes by a URL is currently unsupported */
       video_note: F | string;
       /** Duration of sent video in seconds */
@@ -424,6 +445,8 @@ export interface InputFileProxy<F> {
       /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
       chat_id: number | string;
       /** An array describing messages to be sent, must include 2-10 items */
+      /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
+      message_thread_id?: number;
       media: ReadonlyArray<
         | InputFileProxy<F>["InputMediaAudio"]
         | InputFileProxy<F>["InputMediaDocument"]
@@ -449,6 +472,8 @@ export interface InputFileProxy<F> {
     sendLocation(args: {
       /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
       chat_id: number | string;
+      /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
+      message_thread_id?: number;
       /** Latitude of the location */
       latitude: number;
       /** Longitude of the location */
@@ -515,6 +540,8 @@ export interface InputFileProxy<F> {
     sendVenue(args: {
       /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
       chat_id: number | string;
+      /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
+      message_thread_id?: number;
       /** Latitude of the venue */
       latitude: number;
       /** Longitude of the venue */
@@ -551,6 +578,8 @@ export interface InputFileProxy<F> {
     sendContact(args: {
       /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
       chat_id: number | string;
+      /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
+      message_thread_id?: number;
       /** Contact's phone number */
       phone_number: string;
       /** Contact's first name */
@@ -579,6 +608,8 @@ export interface InputFileProxy<F> {
     sendPoll(args: {
       /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
       chat_id: number | string;
+      /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
+      message_thread_id?: number;
       /** Poll question, 1-300 characters */
       question: string;
       /** A list of answer options, 2-10 strings 1-100 characters each */
@@ -623,6 +654,8 @@ export interface InputFileProxy<F> {
     sendDice(args: {
       /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
       chat_id: number | string;
+      /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
+      message_thread_id?: number;
       /** Emoji on which the dice throw animation is based. Currently, must be one of "🎲", "🎯", "🏀", "⚽", "🎳", or "🎰". Dice can have values 1-6 for "🎲", "🎯" and "🎳", values 1-5 for "🏀" and "⚽", and values 1-64 for "🎰". Defaults to "🎲" */
       emoji?: string;
       /** Sends the message silently. Users will receive a notification with no sound. */
@@ -748,6 +781,8 @@ export interface InputFileProxy<F> {
       can_invite_users?: boolean;
       /** Pass True if the administrator can pin messages, supergroups only */
       can_pin_messages?: boolean;
+      /** Pass True if the user is allowed to create, rename, close, and reopen forum topics, supergroups only */
+      can_manage_topics?: boolean;
     }): true;
 
     /** Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success. */
@@ -864,7 +899,7 @@ export interface InputFileProxy<F> {
     setChatTitle(args: {
       /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
       chat_id: number | string;
-      /** New chat title, 1-255 characters */
+      /** New chat title, 1-128 characters */
       title: string;
     }): true;
 
@@ -1104,6 +1139,7 @@ export interface InputFileProxy<F> {
 
     /** Use this method to delete a message, including service messages, with the following limitations:
     - A message can only be deleted if it was sent less than 48 hours ago.
+    - Service messages about a supergroup, channel, or forum topic creation can't be deleted.
     - A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.
     - Bots can delete outgoing messages in private chats, groups, and supergroups.
     - Bots can delete incoming messages in private chats.
@@ -1257,6 +1293,8 @@ export interface InputFileProxy<F> {
     sendInvoice(args: {
       /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
       chat_id: number | string;
+      /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
+      message_thread_id?: number;
       /** Product name, 1-32 characters */
       title: string;
       /** Product description, 1-255 characters */
@@ -1391,6 +1429,8 @@ export interface InputFileProxy<F> {
     sendGame(args: {
       /** Unique identifier for the target chat */
       chat_id: number;
+      /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
+      message_thread_id?: number;
       /** 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. */
@@ -1436,6 +1476,65 @@ export interface InputFileProxy<F> {
       /** Required if chat_id and message_id are not specified. Identifier of the inline message */
       inline_message_id?: string;
     }): GameHighScore[];
+
+    /** Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of Sticker objects. */
+    getForumTopicIconStickers(): Sticker[];
+
+    /** Use this method to create a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns information about the created topic as a ForumTopic object. */
+    createForumTopic(args: {
+      /** Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) */
+      chat_id: number | string;
+      /** Topic name, 1-128 characters */
+      name: string;
+      /** Color of the topic icon in RGB format. Currently, must be one of 0x6FB9F0, 0xFFD67E, 0xCB86DB, 0x8EEE98, 0xFF93B2, or 0xFB6F5F */
+      icon_color?: number;
+      /** Unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers */
+      icon_custom_emoji_id?: string;
+    }): ForumTopic[];
+
+    /** Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success. */
+    editForumTopic(args: {
+      /** Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) */
+      chat_id: number | string;
+      /** Unique identifier for the target message thread of the forum topic */
+      message_thread_id: number;
+      /** New topic name, 1-128 characters */
+      name: string;
+      /** New unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers */
+      icon_custom_emoji_id: string;
+    }): true;
+
+    /** Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success. */
+    closeForumTopic(args: {
+      /** Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) */
+      chat_id: number | string;
+      /** Unique identifier for the target message thread of the forum topic */
+      message_thread_id: number;
+    }): true;
+
+    /** Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success. */
+    reopenForumTopic(args: {
+      /** Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) */
+      chat_id: number | string;
+      /** Unique identifier for the target message thread of the forum topic */
+      message_thread_id: number;
+    }): true;
+
+    /** Use this method to delete a forum topic along with all its messages in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success. */
+    deleteForumTopic(args: {
+      /** Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) */
+      chat_id: number | string;
+      /** Unique identifier for the target message thread of the forum topic */
+      message_thread_id: number;
+    }): true;
+
+    /** Use this method to clear the list of pinned messages in a 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. */
+    unpinAllForumTopicMessages(args: {
+      /** Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) */
+      chat_id: number | string;
+      /** Unique identifier for the target message thread of the forum topic */
+      message_thread_id: number;
+    }): true;
   };
 
   /** This object represents the content of a media message to be sent. It should be one of