@grammyjs/types 3.19.0 → 3.21.0

package/checklist.d.ts

@@ -0,0 +1,70 @@
+import type { User } from "./manage.js";
+import type { Message, MessageEntity, ParseMode } from "./message.js";
+/** Describes a task in a checklist. */
+export interface ChecklistTask {
+    /** Unique identifier of the task */
+    id: number;
+    /** Text of the task */
+    text: string;
+    /** Special entities that appear in the task text */
+    text_entities?: MessageEntity[];
+    /** User that completed the task; omitted if the task wasn't completed */
+    completed_by_user?: User;
+    /** Point in time (Unix timestamp) when the task was completed; 0 if the task wasn't completed */
+    completion_date?: number;
+}
+/** Describes a checklist. */
+export interface Checklist {
+    /** Title of the checklist */
+    title: string;
+    /** Special entities that appear in the checklist title */
+    title_entities?: MessageEntity[];
+    /** List of tasks in the checklist */
+    tasks: ChecklistTask[];
+    /** True, if users other than the creator of the list can add tasks to the list */
+    others_can_add_tasks?: true;
+    /** True, if users other than the creator of the list can mark tasks as done or not done */
+    others_can_mark_tasks_as_done?: true;
+}
+/** Describes a task to add to a checklist. */
+export interface InputChecklistTask {
+    /** Unique identifier of the task; must be positive and unique among all task identifiers currently present in the checklist */
+    id: number;
+    /** Text of the task; 1-100 characters after entities parsing */
+    text: string;
+    /** Mode for parsing entities in the text. See formatting options for more details. */
+    parse_mode?: string;
+    /** List of special entities that appear in the text, which can be specified instead of parse_mode. Currently, only bold, italic, underline, strikethrough, spoiler, and custom_emoji entities are allowed. */
+    text_entities?: MessageEntity[];
+}
+/** Describes a checklist to create. */
+export interface InputChecklist {
+    /** Title of the checklist; 1-255 characters after entities parsing */
+    title: string;
+    /** Mode for parsing entities in the title. See formatting options for more details. */
+    parse_mode?: ParseMode;
+    /** List of special entities that appear in the title, which can be specified instead of parse_mode. Currently, only bold, italic, underline, strikethrough, spoiler, and custom_emoji entities are allowed. */
+    title_entities?: MessageEntity[];
+    /** List of 1-30 tasks in the checklist */
+    tasks: InputChecklistTask[];
+    /** Pass True if other users can add tasks to the checklist */
+    others_can_add_tasks?: boolean;
+    /** Pass True if other users can mark tasks as done or not done in the checklist */
+    others_can_mark_tasks_as_done?: true;
+}
+/** Describes a service message about checklist tasks marked as done or not done. */
+export interface ChecklistTasksDone {
+    /** Message containing the checklist whose tasks were marked as done or not done. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply. */
+    checklist_message?: Message;
+    /** Identifiers of the tasks that were marked as done */
+    marked_as_done_task_ids?: number[];
+    /** Identifiers of the tasks that were marked as not done */
+    marked_as_not_done_task_ids?: number[];
+}
+/** Describes a service message about tasks added to a checklist. */
+export interface ChecklistTasksAdded {
+    /** Message containing the checklist to which the tasks were added. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply. */
+    checklist_message?: Message;
+    /** List of tasks added to the checklist */
+    tasks: ChecklistTask[];
+}

package/manage.d.ts

@@ -21,6 +21,17 @@ export interface WebhookInfo {
     /** 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">>;
 }
+/** This object describes the types of gifts that can be gifted to a user or a chat. */
+export interface AcceptedGiftTypes {
+    /** True, if unlimited regular gifts are accepted */
+    unlimited_gifts: boolean;
+    /** True, if limited regular gifts are accepted */
+    limited_gifts: boolean;
+    /** True, if unique gifts or gifts that can be upgraded to unique for free are accepted */
+    unique_gifts: boolean;
+    /** True, if a Telegram Premium subscription is accepted */
+    premium_subscription: boolean;
+}
 /** This object represents a Telegram user or bot. */
 export interface User {
     /** Unique identifier for this user or bot. */
@@ -192,8 +203,8 @@ export declare namespace ChatFullInfo {
         pinned_message?: Message;
         /** Default chat member permissions, for groups and supergroups */
         permissions?: undefined;
-        /** True, if gifts can be sent to the chat */
-        can_send_gift?: true;
+        /** Information about types of gifts that are accepted by the chat or by the corresponding user for private chats */
+        accepted_gift_types: AcceptedGiftTypes;
         /** True, if paid media messages can be sent or forwarded to the channel chat. The field is available only for channel chats. */
         can_send_paid_media?: undefined;
         /** For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds */
@@ -552,7 +563,7 @@ export interface ChatInviteLink {
 export interface ChatAdministratorRights {
     /** True, if the user's presence in the chat is hidden */
     is_anonymous: boolean;
-    /** True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege. */
+    /** True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege. */
     can_manage_chat: boolean;
     /** True, if the administrator can delete messages of other users */
     can_delete_messages: boolean;
@@ -572,7 +583,7 @@ export interface ChatAdministratorRights {
     can_edit_stories: boolean;
     /** True, if the administrator can delete stories posted by other users */
     can_delete_stories: boolean;
-    /** True, if the administrator can post messages in the channel, or access channel statistics; for channels only */
+    /** True, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only */
     can_post_messages?: boolean;
     /** True, if the administrator can edit messages of other users and can pin messages; for channels only */
     can_edit_messages?: boolean;
@@ -629,7 +640,7 @@ export interface ChatMemberAdministrator {
     can_be_edited: boolean;
     /** True, if the user's presence in the chat is hidden */
     is_anonymous: boolean;
-    /** True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege. */
+    /** True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege. */
     can_manage_chat: boolean;
     /** True, if the administrator can delete messages of other users */
     can_delete_messages: boolean;
@@ -649,7 +660,7 @@ export interface ChatMemberAdministrator {
     can_edit_stories: boolean;
     /** True, if the administrator can delete stories posted by other users */
     can_delete_stories: boolean;
-    /** True, if the administrator can post messages in the channel, or access channel statistics; for channels only */
+    /** True, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only */
     can_post_messages?: boolean;
     /** True, if the administrator can edit messages of other users and can pin messages; for channels only */
     can_edit_messages?: boolean;
@@ -691,7 +702,7 @@ export interface ChatMemberRestricted {
     can_send_video_notes: boolean;
     /** True, if the user is allowed to send voice notes */
     can_send_voice_notes: boolean;
-    /** True, if the user is allowed to send polls */
+    /** True, if the user is allowed to send polls and checklists */
     can_send_polls: boolean;
     /** True, if the user is allowed to send animations, games, stickers and use inline bots */
     can_send_other_messages: boolean;
@@ -755,7 +766,7 @@ export interface ChatPermissions {
     can_send_video_notes?: boolean;
     /** True, if the user is allowed to send voice notes */
     can_send_voice_notes?: boolean;
-    /** True, if the user is allowed to send polls */
+    /** True, if the user is allowed to send polls and checklists */
     can_send_polls?: boolean;
     /** True, if the user is allowed to send animations, games, stickers and use inline bots */
     can_send_other_messages?: boolean;
@@ -901,6 +912,37 @@ export interface UserChatBoosts {
     /** The list of boosts added to the chat by the user */
     boosts: ChatBoost[];
 }
+/** Represents the rights of a business bot. */
+export interface BusinessBotRights {
+    /** True, if the bot can send and edit messages in the private chats that had incoming messages in the last 24 hours */
+    can_reply?: true;
+    /** True, if the bot can mark incoming private messages as read */
+    can_read_messages?: true;
+    /** True, if the bot can delete messages sent by the bot */
+    can_delete_outgoing_messages?: true;
+    /** True, if the bot can delete all private messages in managed chats */
+    can_delete_all_messages?: true;
+    /** True, if the bot can edit the first and last name of the business account */
+    can_edit_name?: true;
+    /** True, if the bot can edit the bio of the business account */
+    can_edit_bio?: true;
+    /** True, if the bot can edit the profile photo of the business account */
+    can_edit_profile_photo?: true;
+    /** True, if the bot can edit the username of the business account */
+    can_edit_username?: true;
+    /** True, if the bot can change the privacy settings pertaining to gifts for the business account */
+    can_change_gift_settings?: true;
+    /** True, if the bot can view gifts and the amount of Telegram Stars owned by the business account */
+    can_view_gifts_and_stars?: true;
+    /** True, if the bot can convert regular gifts owned by the business account to Telegram Stars */
+    can_convert_gifts_to_stars?: true;
+    /** True, if the bot can transfer and upgrade gifts owned by the business account */
+    can_transfer_and_upgrade_gifts?: true;
+    /** True, if the bot can transfer Telegram Stars received by the business account to its own account, or use them to upgrade and transfer gifts */
+    can_transfer_stars?: true;
+    /** True, if the bot can post, edit and delete stories on behalf of the business account */
+    can_manage_stories?: true;
+}
 /** Describes the connection of the bot with a business account. */
 export interface BusinessConnection {
     /** Unique identifier of the business connection */
@@ -911,8 +953,8 @@ export interface BusinessConnection {
     user_chat_id: number;
     /** Date the connection was established in Unix time */
     date: number;
-    /** True, if the bot can act on behalf of the business account in chats that were active in the last 24 hours */
-    can_reply: boolean;
+    /** Rights of the business bot */
+    rights?: BusinessBotRights;
     /** True, if the connection is active */
     is_enabled: boolean;
 }

package/message.d.ts

@@ -1,7 +1,8 @@
+import type { Checklist, ChecklistTasksAdded, ChecklistTasksDone } from "./checklist.js";
 import type { Chat, User } from "./manage.js";
 import type { InlineKeyboardMarkup } from "./markup.js";
 import type { PassportData } from "./passport.js";
-import type { Invoice, RefundedPayment, SuccessfulPayment } from "./payment.js";
+import type { GiftInfo, Invoice, PaidMessagePriceChanged, RefundedPayment, SuccessfulPayment, UniqueGiftInfo } from "./payment.js";
 type MsgWith<P extends keyof Message> = Record<P, NonNullable<Message[P]>>;
 export declare namespace Message {
     interface ServiceMessage {
@@ -55,6 +56,8 @@ export declare namespace Message {
         link_preview_options?: LinkPreviewOptions;
         /** Unique identifier of the message effect added to the message */
         effect_id?: string;
+        /** The number of Telegram Stars that were paid by the sender of the message to send it */
+        paid_star_count?: number;
         /** Inline keyboard attached to the message. login_url buttons are represented as ordinary url buttons. */
         reply_markup?: InlineKeyboardMarkup;
     }
@@ -87,6 +90,10 @@ export declare namespace Message {
     type VenueMessage = LocationMessage & MsgWith<"venue">;
     type LocationMessage = CommonMessage & MsgWith<"location">;
     type PaidMediaMessage = CommonMessage & MsgWith<"paid_media">;
+    type DirectMessagePriceChangedMessage = ServiceMessage & MsgWith<"direct_message_price_changed">;
+    type ChecklistMessage = CommonMessage & MsgWith<"checklist">;
+    type ChecklistTasksDoneMessage = ServiceMessage & MsgWith<"checklist_tasks_done">;
+    type ChecklistTasksAddedMessage = ServiceMessage & MsgWith<"checklist_tasks_added">;
     type NewChatMembersMessage = ServiceMessage & MsgWith<"new_chat_members">;
     type LeftChatMemberMessage = ServiceMessage & MsgWith<"left_chat_member">;
     type NewChatTitleMessage = ServiceMessage & MsgWith<"new_chat_title">;
@@ -120,6 +127,9 @@ export declare namespace Message {
     type GiveawayMessage = ServiceMessage & MsgWith<"giveaway">;
     type GiveawayWinnersMessage = ServiceMessage & MsgWith<"giveaway_winners">;
     type GiveawayCompletedMessage = ServiceMessage & MsgWith<"giveaway_completed">;
+    type GiftMessage = ServiceMessage & MsgWith<"gift">;
+    type UniqueGiftMessage = ServiceMessage & MsgWith<"unique_gift">;
+    type PaidMessagePriceChangedMessage = ServiceMessage & MsgWith<"paid_message_price_changed">;
     type VideoChatScheduledMessage = ServiceMessage & MsgWith<"video_chat_scheduled">;
     type VideoChatStartedMessage = ServiceMessage & MsgWith<"video_chat_started">;
     type VideoChatEndedMessage = ServiceMessage & MsgWith<"video_chat_ended">;
@@ -167,6 +177,12 @@ export interface Message extends Message.MediaMessage {
     location?: Location;
     /** Message contains paid media; information about the paid media */
     paid_media?: PaidMediaInfo;
+    /** Message is a checklist */
+    checklist?: Checklist;
+    /** Service message: some tasks in a checklist were marked as done or not done */
+    checklist_tasks_done?: ChecklistTasksDone;
+    /** Service message: tasks were added to a checklist */
+    checklist_tasks_added?: ChecklistTasksAdded;
     /** New members that were added to the group or supergroup and information about them (the bot itself may be one of these members) */
     new_chat_members?: User[];
     /** A member was removed from the group, information about them (this member may be the bot itself) */
@@ -232,6 +248,14 @@ export interface Message extends Message.MediaMessage {
     giveaway_winners?: GiveawayWinners;
     /** Service message: a giveaway without public winners was completed */
     giveaway_completed?: GiveawayCompleted;
+    /** Service message: a regular gift was sent or received */
+    gift?: GiftInfo;
+    /** Service message: a unique gift was sent or received */
+    unique_gift?: UniqueGiftInfo;
+    /** Service message: the price for paid messages has changed in the chat */
+    paid_message_price_changed?: PaidMessagePriceChanged;
+    /** Service message: the price for paid messages in the corresponding direct messages chat of a channel has changed */
+    direct_message_price_changed?: DirectMessagePriceChanged;
     /** Service message: video chat scheduled */
     video_chat_scheduled?: VideoChatScheduled;
     /** Service message: video chat started */
@@ -473,6 +497,8 @@ export interface ExternalReplyInfo {
     paid_media?: PaidMediaInfo;
     /** Message is a native poll, information about the poll */
     poll?: Poll;
+    /** Message is a checklist */
+    checklist?: Checklist;
     /** Message is a venue, information about the venue */
     venue?: Venue;
 }
@@ -1006,6 +1032,13 @@ export interface WriteAccessAllowed {
     /** True, if the access was granted when the bot was added to the attachment or side menu */
     from_attachment_menu?: boolean;
 }
+/** Describes a service message about a change in the price of direct messages sent to a channel chat. */
+export interface DirectMessagePriceChanged {
+    /** True, if direct messages are enabled for the channel chat; false otherwise */
+    are_direct_messages_enabled: boolean;
+    /** The new number of Telegram Stars that must be paid by users for each direct message sent to the channel. Defaults to 0. */
+    direct_message_star_count?: number;
+}
 /** 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/methods.d.ts

@@ -1,11 +1,13 @@
+import type { InputChecklist } from "./checklist.js";
 import type { InlineQueryResult, InlineQueryResultsButton } from "./inline.js";
 import type { LanguageCode } from "./langs.js";
-import type { BotCommand, BusinessConnection, ChatAdministratorRights, ChatFullInfo, ChatInviteLink, ChatMember, ChatMemberAdministrator, ChatMemberOwner, ChatPermissions, ForumTopic, UserChatBoosts, UserFromGetMe, UserProfilePhotos, WebhookInfo } from "./manage.js";
+import type { AcceptedGiftTypes, BotCommand, BusinessConnection, ChatAdministratorRights, ChatFullInfo, ChatInviteLink, ChatMember, ChatMemberAdministrator, ChatMemberOwner, ChatPermissions, ForumTopic, UserChatBoosts, UserFromGetMe, UserProfilePhotos, WebhookInfo } from "./manage.js";
 import type { ForceReply, InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove } from "./markup.js";
-import type { File, GameHighScore, InputPollOption, LinkPreviewOptions, MaskPosition, Message, MessageEntity, MessageId, ParseMode, Poll, PreparedInlineMessage, ReactionType, ReplyParameters, SentWebAppMessage, Sticker, StickerSet } from "./message.js";
+import type { File, GameHighScore, InputPollOption, LinkPreviewOptions, MaskPosition, Message, MessageEntity, MessageId, ParseMode, Poll, PreparedInlineMessage, ReactionType, ReplyParameters, SentWebAppMessage, Sticker, StickerSet, Story } from "./message.js";
 import type { PassportElementError } from "./passport.js";
-import type { Gifts, LabeledPrice, ShippingOption, StarTransactions } from "./payment.js";
+import type { Gifts, LabeledPrice, OwnedGifts, ShippingOption, StarAmount, StarTransactions } from "./payment.js";
 import type { BotCommandScope, BotDescription, BotName, BotShortDescription, MenuButton } from "./settings.js";
+import { StoryArea } from "./story.js";
 import type { Update } from "./update.js";
 /** Extracts the parameters of a given method name */
 type Params<F, M extends keyof ApiMethods<F>> = Parameters<ApiMethods<F>[M]>;
@@ -665,7 +667,7 @@ export type ApiMethods<F> = {
         question_parse_mode?: ParseMode;
         /** A list of special entities that appear in the poll question. It can be specified instead of question_parse_mode */
         question_entities?: MessageEntity[];
-        /** A list of 2-10 answer options */
+        /** A list of 2-12 answer options */
         options: InputPollOption[];
         /** True, if the poll needs to be anonymous, defaults to True */
         is_anonymous?: boolean;
@@ -702,6 +704,38 @@ export type ApiMethods<F> = {
         /** @deprecated Use `reply_parameters` instead. */
         reply_to_message_id?: number;
     }): Message.PollMessage;
+    /** Use this method to send a checklist on behalf of a connected business account. On success, the sent Message is returned. */
+    sendChecklist(args: {
+        /** Unique identifier of the business connection on behalf of which the message will be sent */
+        business_connection_id: string;
+        /** Unique identifier for the target chat */
+        chat_id: number;
+        /** An object for the checklist to send */
+        checklist: InputChecklist;
+        /** Sends the message silently. Users will receive a notification with no sound. */
+        disable_notification?: boolean;
+        /** Protects the contents of the sent message from forwarding and saving */
+        protect_content?: boolean;
+        /** Unique identifier of the message effect to be added to the message */
+        message_effect_id?: string;
+        /** An object for description of the message to reply to */
+        reply_parameters?: ReplyParameters;
+        /** An object for an inline keyboard */
+        reply_markup?: InlineKeyboardMarkup;
+    }): Message.ChecklistMessage;
+    /** Use this method to edit a checklist on behalf of a connected business account. On success, the edited Message is returned. */
+    editMessageChecklist(args: {
+        /** Unique identifier of the business connection on behalf of which the message will be sent */
+        business_connection_id: string;
+        /** Unique identifier for the target chat */
+        chat_id: number;
+        /** Unique identifier for the target message */
+        message_id: number;
+        /** An object for the new checklist */
+        checklist: InputChecklist;
+        /** An object for the new inline keyboard for the message */
+        reply_markup?: InlineKeyboardMarkup;
+    }): Message.ChecklistMessage;
     /** Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned. */
     sendDice(args: {
         /** Unique identifier of the business connection on behalf of which the message will be sent */
@@ -822,7 +856,7 @@ export type ApiMethods<F> = {
         user_id: number;
         /** Pass True if the administrator's presence in the chat is hidden */
         is_anonymous?: boolean;
-        /** Pass True if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege. */
+        /** Pass True if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege. */
         can_manage_chat?: boolean;
         /** Pass True if the administrator can delete messages of other users */
         can_delete_messages?: boolean;
@@ -842,7 +876,7 @@ export type ApiMethods<F> = {
         can_edit_stories?: boolean;
         /** True if the administrator can delete stories posted by other users */
         can_delete_stories?: boolean;
-        /** True if the administrator can post messages in the channel, or access channel statistics; for channels only */
+        /** Pass True if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only */
         can_post_messages?: boolean;
         /** True if the administrator can edit messages of other users and can pin messages; for channels only */
         can_edit_messages?: boolean;
@@ -1248,6 +1282,8 @@ export type ApiMethods<F> = {
         /** Pass True to get default administrator rights of the bot in channels. Otherwise, default administrator rights of the bot for groups and supergroups will be returned. */
         for_channels?: boolean;
     }): ChatAdministratorRights;
+    /** A method to get the current Telegram Stars balance of the bot. Requires no parameters. On success, returns a StarAmount object. */
+    getMyStarBalance(): StarAmount;
     /** Use this method to edit text and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent. */
     editMessageText(args: {
         /** Unique identifier of the business connection on behalf of which the message to be edited was sent */
@@ -1352,6 +1388,168 @@ export type ApiMethods<F> = {
         /** A list of 1-100 identifiers of messages to delete. See deleteMessage for limitations on which messages can be deleted */
         message_ids: number[];
     }): true;
+    /** Delete messages on behalf of a business account. Requires the can_delete_outgoing_messages business bot right to delete messages sent by the bot itself, or the can_delete_all_messages business bot right to delete any message. Returns True on success. */
+    deleteBusinessMessages(args: {
+        /** Unique identifier of the business connection on behalf of which to delete the messages */
+        business_connection_id: string;
+        /** A list of 1-100 identifiers of messages to delete. All messages must be from the same chat. See deleteMessage for limitations on which messages can be deleted */
+        message_ids: number[];
+    }): true;
+    /** Changes the first and last name of a managed business account. Requires the can_change_name business bot right. Returns True on success. */
+    setBusinessAccountName(args: {
+        /** Unique identifier of the business connection */
+        business_connection_id: string;
+        /** The new value of the first name for the business account; 1-64 characters */
+        first_name: string;
+        /** The new value of the last name for the business account; 0-64 characters */
+        last_name?: string;
+    }): true;
+    /** Changes the username of a managed business account. Requires the can_change_username business bot right. Returns True on success. */
+    setBusinessAccountUsername(args: {
+        /** Unique identifier of the business connection */
+        business_connection_id: string;
+        /** The new value of the username for the business account; 0-32 characters */
+        username?: string;
+    }): true;
+    /** Changes the bio of a managed business account. Requires the can_change_bio business bot right. Returns True on success. */
+    setBusinessAccountBio(args: {
+        /** Unique identifier of the business connection */
+        business_connection_id: string;
+        /** The new value of the bio for the business account; 0-140 characters */
+        bio?: string;
+    }): true;
+    /** Changes the profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success. */
+    setBusinessAccountProfilePhoto(args: {
+        /** Unique identifier of the business connection */
+        business_connection_id: string;
+        /** The new profile photo to set */
+        photo: InputProfilePhoto<F>;
+        /** Pass True to set the public photo, which will be visible even if the main photo is hidden by the business account's privacy settings. An account can have only one public photo. */
+        is_public?: boolean;
+    }): true;
+    /** Removes the current profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success. */
+    removeBusinessAccountProfilePhoto(args: {
+        /** Unique identifier of the business connection */
+        business_connection_id: string;
+        /** Pass True to remove the public photo, which is visible even if the main photo is hidden by the business account's privacy settings. After the main photo is removed, the previous profile photo (if present) becomes the main photo. */
+        is_public?: boolean;
+    }): true;
+    /** Changes the privacy settings pertaining to incoming gifts in a managed business account. Requires the can_change_gift_settings business bot right. Returns True on success. */
+    setBusinessAccountGiftSettings(args: {
+        /** Unique identifier of the business connection */
+        business_connection_id: string;
+        /** Pass True, if a button for sending a gift to the user or by the business account must always be shown in the input field */
+        show_gift_button: boolean;
+        /** Types of gifts accepted by the business account */
+        accepted_gift_types: AcceptedGiftTypes;
+    }): true;
+    /** Returns the amount of Telegram Stars owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns StarAmount on success. */
+    getBusinessAccountStarBalance(args: {
+        /** Unique identifier of the business connection */
+        business_connection_id: string;
+    }): StarAmount;
+    /** Transfers Telegram Stars from the business account balance to the bot's balance. Requires the can_transfer_stars business bot right. Returns True on success. */
+    transferBusinessAccountStars(args: {
+        /** Unique identifier of the business connection */
+        business_connection_id: string;
+        /** Number of Telegram Stars to transfer; 1-10000 */
+        star_count: number;
+    }): true;
+    /** Returns the gifts received and owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns OwnedGifts on success. */
+    getBusinessAccountGifts(args: {
+        /** Unique identifier of the business connection */
+        business_connection_id: string;
+        /** Pass True to exclude gifts that aren't saved to the account's profile page */
+        exclude_unsaved?: boolean;
+        /** Pass True to exclude gifts that are saved to the account's profile page */
+        exclude_saved?: boolean;
+        /** Pass True to exclude gifts that can be purchased an unlimited number of times */
+        exclude_unlimited?: boolean;
+        /** Pass True to exclude gifts that can be purchased a limited number of times */
+        exclude_limited?: boolean;
+        /** Pass True to exclude unique gifts */
+        exclude_unique?: boolean;
+        /** Pass True to sort results by gift price instead of send date. Sorting is applied before pagination. */
+        sort_by_price?: boolean;
+        /** Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results */
+        offset?: string;
+        /** The maximum number of gifts to be returned; 1-100. Defaults to 100 */
+        limit?: number;
+    }): OwnedGifts;
+    /** Converts a given regular gift to Telegram Stars. Requires the can_convert_gifts_to_stars business bot right. Returns True on success. */
+    convertGiftToStars(args: {
+        /** Unique identifier of the business connection */
+        business_connection_id: string;
+        /** Unique identifier of the regular gift that should be converted to Telegram Stars */
+        owned_gift_id: string;
+    }): true;
+    /** Upgrades a given regular gift to a unique gift. Requires the can_transfer_and_upgrade_gifts business bot right. Additionally requires the can_transfer_stars business bot right if the upgrade is paid. Returns True on success. */
+    upgradeGift(args: {
+        /** Unique identifier of the business connection */
+        business_connection_id: string;
+        /** Unique identifier of the regular gift that should be upgraded to a unique one */
+        owned_gift_id: string;
+        /** Pass True to keep the original gift text, sender and receiver in the upgraded gift */
+        keep_original_details?: boolean;
+        /** The amount of Telegram Stars that will be paid for the upgrade from the business account balance. If gift.prepaid_upgrade_star_count > 0, then pass 0, otherwise, the can_transfer_stars business bot right is required and gift.upgrade_star_count must be passed. */
+        star_count?: number;
+    }): true;
+    /** Transfers an owned unique gift to another user. Requires the can_transfer_and_upgrade_gifts business bot right. Requires can_transfer_stars business bot right if the transfer is paid. Returns True on success. */
+    transferGift(args: {
+        /** Unique identifier of the business connection */
+        business_connection_id: string;
+        /** Unique identifier of the regular gift that should be transferred */
+        owned_gift_id: string;
+        /** Unique identifier of the chat which will own the gift. The chat must be active in the last 24 hours. */
+        new_owner_chat_id: number;
+        /** The amount of Telegram Stars that will be paid for the transfer from the business account balance. If positive, then the can_transfer_stars business bot right is required. */
+        star_count: number;
+    }): true;
+    /** Posts a story on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success. */
+    postStory(args: {
+        /** Unique identifier of the business connection */
+        business_connection_id: string;
+        /** Content of the story */
+        content: InputStoryContent<F>;
+        /** Period after which the story is moved to the archive, in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400 */
+        active_period: number;
+        /** Caption of the story, 0-2048 characters after entities parsing */
+        caption?: string;
+        /** Mode for parsing entities in the story caption. See formatting options for more details. */
+        parse_mode?: ParseMode;
+        /** A list of special entities that appear in the caption, which can be specified instead of parse_mode */
+        caption_entities?: MessageEntity[];
+        /** A list of clickable areas to be shown on the story */
+        areas?: StoryArea[];
+        /** Pass True to keep the story accessible after it expires */
+        post_to_chat_page?: boolean;
+        /** Pass True if the content of the story must be protected from forwarding and screenshotting */
+        protect_content?: boolean;
+    }): Story;
+    /** Edits a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success. */
+    editStory(args: {
+        /** Unique identifier of the business connection */
+        business_connection_id: string;
+        /** Unique identifier of the story to edit */
+        story_id: number;
+        /** Content of the story */
+        content: InputStoryContent<F>;
+        /** Caption of the story, 0-2048 characters after entities parsing */
+        caption?: string;
+        /** Mode for parsing entities in the story caption. See formatting options for more details. */
+        parse_mode?: ParseMode;
+        /** A list of special entities that appear in the caption, which can be specified instead of parse_mode */
+        caption_entities?: MessageEntity[];
+        /** A list of clickable areas to be shown on the story */
+        areas?: StoryArea;
+    }): Story;
+    /** Deletes a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns True on success. */
+    deleteStory(args: {
+        /** Unique identifier of the business connection */
+        business_connection_id: string;
+        /** Unique identifier of the story to delete */
+        story_id: number;
+    }): true;
     /** Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. On success, the sent Message is returned. */
     sendSticker(args: {
         /** Unique identifier of the business connection on behalf of which the message will be sent */
@@ -1508,13 +1706,28 @@ export type ApiMethods<F> = {
         gift_id: string;
         /** Pass True to pay for the gift upgrade from the bot's balance, thereby making the upgrade free for the receiver */
         pay_for_upgrade?: boolean;
-        /** Text that will be shown along with the gift; 0-255 characters */
+        /** Text that will be shown along with the gift; 0-128 characters */
         text?: string;
         /** Mode for parsing entities in the text. See formatting options for more details. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, and “custom_emoji” are ignored. */
         text_parse_mode?: ParseMode;
         /** A list of special entities that appear in the gift text. It can be specified instead of text_parse_mode. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, and “custom_emoji” are ignored. */
         text_entities?: MessageEntity[];
     }): Gifts;
+    /** Gifts a Telegram Premium subscription to the given user. Returns True on success. */
+    giftPremiumSubscription(args: {
+        /** Unique identifier of the target user who will receive a Telegram Premium subscription */
+        user_id: number;
+        /** Number of months the Telegram Premium subscription will be active for the user; must be one of 3, 6, or 12 */
+        month_count: 3 | 6 | 12;
+        /** Number of Telegram Stars to pay for the Telegram Premium subscription; must be 1000 for 3 months, 1500 for 6 months, and 2500 for 12 months */
+        star_count: 1000 | 1500 | 2500;
+        /** Text that will be shown along with the service message about the subscription; 0-128 characters */
+        text?: string;
+        /** Mode for parsing entities in the text. See formatting options for more details. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, and “custom_emoji” are ignored. */
+        text_parse_mode?: ParseMode;
+        /** A list of special entities that appear in the gift text. It can be specified instead of text_parse_mode. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, and “custom_emoji” are ignored. */
+        text_entities?: MessageEntity[];
+    }): true;
     /** Use this method to send answers to an inline query. On success, True is returned.
     No more than 50 results per query are allowed.
   
@@ -1732,6 +1945,15 @@ export type ApiMethods<F> = {
         /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
         chat_id: number | string;
     }): true;
+    /** Marks incoming message as read on behalf of a business account. Requires the can_read_messages business bot right. Returns True on success. */
+    readBusinessMessage(args: {
+        /** Unique identifier of the business connection on behalf of which to read the message */
+        business_connection_id: string;
+        /** Unique identifier of the chat in which the message was received. The chat must have been active in the last 24 hours. */
+        chat_id: number;
+        /** Unique identifier of the message to mark as read */
+        message_id: number;
+    }): true;
     /** Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success.
   
     Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues. */
@@ -1961,4 +2183,50 @@ export interface InputPaidMediaVideo<F> {
     /** Pass True if the uploaded video is suitable for streaming */
     supports_streaming?: boolean;
 }
+/** This object describes a profile photo to set. Currently, it can be one of
+
+- InputProfilePhotoStatic
+- InputProfilePhotoAnimated */
+export type InputProfilePhoto<F> = InputProfilePhotoStatic<F> | InputProfilePhotoAnimated<F>;
+/** A static profile photo in the .JPG format. */
+export interface InputProfilePhotoStatic<F> {
+    /** Type of the profile photo, must be “static” */
+    type: "static";
+    /** The static profile photo. Profile photos can't be reused and can only be uploaded as a new file, so you can pass “attach://<file_attach_name>” if the photo was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » */
+    photo: F;
+}
+/** An animated profile photo in the MPEG4 format. */
+export interface InputProfilePhotoAnimated<F> {
+    /** Type of the profile photo, must be “animated” */
+    type: "animated";
+    /** The animated profile photo. Profile photos can't be reused and can only be uploaded as a new file, so you can pass “attach://<file_attach_name>” if the photo was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » */
+    animation: F;
+    /** Timestamp in seconds of the frame that will be used as the static profile photo. Defaults to 0.0. */
+    main_frame_timestamp?: number;
+}
+/** This object describes the content of a story to post. Currently, it can be one of
+
+- InputStoryContentPhoto
+- InputStoryContentVideo */
+export type InputStoryContent<F> = InputStoryContentPhoto<F> | InputStoryContentVideo<F>;
+/** Describes a photo to post as a story. */
+export interface InputStoryContentPhoto<F> {
+    /** Type of the content, must be “photo” */
+    type: "photo";
+    /** The photo to post as a story. The photo must be of the size 1080x1920 and must not exceed 10 MB. The photo can't be reused and can only be uploaded as a new file, so you can pass “attach://<file_attach_name>” if the photo was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » */
+    photo: F;
+}
+/** Describes a video to post as a story. */
+export interface InputStoryContentVideo<F> {
+    /** Type of the content, must be “video” */
+    type: "video";
+    /** The video to post as a story. The video must be of the size 720x1280, streamable, encoded with H.265 codec, with key frames added each second in the MPEG4 format, and must not exceed 30 MB. The video can't be reused and can only be uploaded as a new file, so you can pass “attach://<file_attach_name>” if the video was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » */
+    video: F;
+    /** Precise duration of the video in seconds; 0-60 */
+    duration?: number;
+    /** Timestamp in seconds of the frame that will be used as the static cover for the story. Defaults to 0.0. */
+    cover_frame_timestamp?: number;
+    /** Pass True if the video has no sound */
+    is_animation?: boolean;
+}
 export {};

package/mod.d.ts

@@ -1,4 +1,5 @@
 export * from "./api.js";
+export * from "./checklist.js";
 export * from "./inline.js";
 export * from "./manage.js";
 export * from "./markup.js";
@@ -7,5 +8,6 @@ export * from "./methods.js";
 export * from "./passport.js";
 export * from "./payment.js";
 export * from "./settings.js";
+export * from "./story.js";
 export * from "./update.js";
 export * from "./langs.js";

package/package.json

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

package/payment.d.ts

@@ -1,5 +1,5 @@
 import type { Chat, User } from "./manage.js";
-import type { PaidMedia, Sticker } from "./message.js";
+import type { MessageEntity, PaidMedia, Sticker } from "./message.js";
 /** This object represents a portion of the price for goods or services. */
 export interface LabeledPrice {
     /** Portion label */
@@ -171,20 +171,24 @@ export type TransactionPartner = TransactionPartnerUser | TransactionPartnerChat
 export interface TransactionPartnerUser {
     /** Type of the transaction partner, always “user” */
     type: "user";
+    /** Type of the transaction, currently one of “invoice_payment” for payments via invoices, “paid_media_payment” for payments for paid media, “gift_purchase” for gifts sent by the bot, “premium_purchase” for Telegram Premium subscriptions gifted by the bot, “business_account_transfer” for direct transfers from managed business accounts */
+    transaction_type: "invoice_payment" | "paid_media_payment" | "gift_purchase" | "premium_purchase" | "business_account_transfer";
     /** Information about the user */
     user: User;
-    /** Information about the affiliate that received a commission via this transaction */
+    /** Information about the affiliate that received a commission via this transaction. Can be available only for “invoice_payment” and “paid_media_payment” transactions. */
     affiliate?: AffiliateInfo;
-    /** Bot-specified invoice payload */
+    /** Bot-specified invoice payload. Can be available only for “invoice_payment” transactions. */
     invoice_payload?: string;
-    /** The duration of the paid subscription */
+    /** The duration of the paid subscription. Can be available only for “invoice_payment” transactions. */
     subscription_period?: number;
-    /** Information about the paid media bought by the user */
+    /** Information about the paid media bought by the user; for “paid_media_payment” transactions only */
     paid_media?: PaidMedia[];
-    /** Bot-specified paid media payload */
+    /** Bot-specified paid media payload. Can be available only for “paid_media_payment” transactions. */
     paid_media_payload?: string;
-    /** The gift sent to the user by the bot */
+    /** The gift sent to the user by the bot; for “gift_purchase” transactions only */
     gift?: Gift;
+    /** Number of months the gifted Telegram Premium subscription will be active for; for “premium_purchase” transactions only */
+    premium_subscription_duration?: number;
 }
 /** Describes a transaction with a chat. */
 export interface TransactionPartnerChat {
@@ -275,3 +279,166 @@ export interface Gifts {
     /** The list of gifts */
     gifts: Gift[];
 }
+/** This object describes the model of a unique gift. */
+export interface UniqueGiftModel {
+    /** Name of the model */
+    name: string;
+    /** The sticker that represents the unique gift */
+    sticker: Sticker;
+    /** The number of unique gifts that receive this model for every 1000 gifts upgraded */
+    rarity_per_mille: number;
+}
+/** This object describes the symbol shown on the pattern of a unique gift. */
+export interface UniqueGiftSymbol {
+    /** Name of the symbol */
+    name: string;
+    /** The sticker that represents the unique gift */
+    sticker: Sticker;
+    /** The number of unique gifts that receive this model for every 1000 gifts upgraded */
+    rarity_per_mille: number;
+}
+/** This object describes the colors of the backdrop of a unique gift. */
+export interface UniqueGiftBackdropColors {
+    /** The color in the center of the backdrop in RGB format */
+    center_color: number;
+    /** The color on the edges of the backdrop in RGB format */
+    edge_color: number;
+    /** The color to be applied to the symbol in RGB format */
+    symbol_color: number;
+    /** The color for the text on the backdrop in RGB format */
+    text_color: number;
+}
+/** This object describes the backdrop of a unique gift. */
+export interface UniqueGiftBackdrop {
+    /** Name of the backdrop */
+    name: string;
+    /** Colors of the backdrop */
+    colors: UniqueGiftBackdropColors;
+    /** The number of unique gifts that receive this backdrop for every 1000 gifts upgraded */
+    rarity_per_mille: number;
+}
+/** This object describes a unique gift that was upgraded from a regular gift. */
+export interface UniqueGift {
+    /** Human-readable name of the regular gift from which this unique gift was upgraded */
+    base_name: string;
+    /** Unique name of the gift. This name can be used in https://t.me/nft/... links and story areas */
+    name: string;
+    /** Unique number of the upgraded gift among gifts upgraded from the same regular gift */
+    number: number;
+    /** Model of the gift */
+    model: UniqueGiftModel;
+    /** Symbol of the gift */
+    symbol: UniqueGiftSymbol;
+    /** Backdrop of the gift */
+    backdrop: UniqueGiftBackdrop;
+}
+/** Describes a service message about a regular gift that was sent or received. */
+export interface GiftInfo {
+    /** Information about the gift */
+    gift: Gift;
+    /** Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts */
+    owned_gift_id?: string;
+    /** Number of Telegram Stars that can be claimed by the receiver by converting the gift; omitted if conversion to Telegram Stars is impossible */
+    convert_star_count?: number;
+    /** Number of Telegram Stars that were prepaid by the sender for the ability to upgrade the gift */
+    prepaid_upgrade_star_count?: number;
+    /** True, if the gift can be upgraded to a unique gift */
+    can_be_upgraded?: true;
+    /** Text of the message that was added to the gift */
+    text?: string;
+    /** Special entities that appear in the text */
+    entities?: MessageEntity[];
+    /** True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them */
+    is_private?: true;
+}
+/** Describes a service message about a unique gift that was sent or received. */
+export interface UniqueGiftInfo {
+    /** Information about the gift */
+    gift: UniqueGift;
+    /** Origin of the gift. Currently, either “upgrade” for gifts upgraded from regular gifts, “transfer” for gifts transferred from other users or channels, or “resale” for gifts bought from other users */
+    origin: "upgrade" | "transfer" | "resale";
+    /** Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts */
+    owned_gift_id?: string;
+    /** Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer the gift */
+    transfer_star_count?: number;
+    /** For gifts bought from other users, the price paid for the gift */
+    last_resale_star_count?: number;
+    /** Point in time (Unix timestamp) when the gift can be transferred. If it is in the past, then the gift can be transferred now */
+    next_transfer_date?: string;
+}
+/** Describes a service message about a change in the price of paid messages within a chat. */
+export interface PaidMessagePriceChanged {
+    /** The new number of Telegram Stars that must be paid by non-administrator users of the supergroup chat for each sent message */
+    paid_message_star_count: number;
+}
+/** Describes an amount of Telegram Stars. */
+export interface StarAmount {
+    /** Integer amount of Telegram Stars, rounded to 0; can be negative */
+    amount: number;
+    /** The number of 1/1000000000 shares of Telegram Stars; from -999999999 to 999999999; can be negative if and only if amount is non-positive */
+    nanostar_amount?: number;
+}
+/** This object describes a gift received and owned by a user or a chat. Currently, it can be one of
+
+- OwnedGiftRegular
+- OwnedGiftUnique */
+export type OwnedGift = OwnedGiftRegular | OwnedGiftUnique;
+/** Describes a regular gift owned by a user or a chat. */
+export interface OwnedGiftRegular {
+    /** Type of the gift, always “regular” */
+    type: "regular";
+    /** Information about the regular gift */
+    gift: Gift;
+    /** Unique identifier of the gift for the bot; for gifts received on behalf of business accounts only */
+    owned_gift_id?: string;
+    /** Sender of the gift if it is a known user */
+    sender_user?: User;
+    /** Date the gift was sent in Unix time */
+    send_date: number;
+    /** Text of the message that was added to the gift */
+    text?: string;
+    /** Special entities that appear in the text */
+    entities?: MessageEntity[];
+    /** True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them */
+    is_private?: true;
+    /** True, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only */
+    is_saved?: true;
+    /** True, if the gift can be upgraded to a unique gift; for gifts received on behalf of business accounts only */
+    can_be_upgraded?: true;
+    /** True, if the gift was refunded and isn't available anymore */
+    was_refunded?: true;
+    /** Number of Telegram Stars that can be claimed by the receiver instead of the gift; omitted if the gift cannot be converted to Telegram Stars */
+    convert_star_count?: number;
+    /** Number of Telegram Stars that were paid by the sender for the ability to upgrade the gift */
+    prepaid_upgrade_star_count?: number;
+}
+/** Describes a unique gift received and owned by a user or a chat. */
+export interface OwnedGiftUnique {
+    /** Type of the gift, always “unique” */
+    type: "unique";
+    /** Information about the unique gift */
+    gift: UniqueGift;
+    /** Unique identifier of the received gift for the bot; for gifts received on behalf of business accounts only */
+    owned_gift_id?: string;
+    /** Sender of the gift if it is a known user */
+    sender_user?: User;
+    /** Date the gift was sent in Unix time */
+    send_date: number;
+    /** True, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only */
+    is_saved?: true;
+    /** True, if the gift can be transferred to another owner; for gifts received on behalf of business accounts only */
+    can_be_transferred?: true;
+    /** Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer the gift */
+    transfer_star_count?: number;
+    /** Point in time (Unix timestamp) when the gift can be transferred. If it is in the past, then the gift can be transferred now */
+    next_transfer_date?: string;
+}
+/** Contains the list of gifts received and owned by a user or a chat. */
+export interface OwnedGifts {
+    /** The total number of gifts owned by the user or the chat */
+    total_count: number;
+    /** The list of gifts */
+    gifts: OwnedGift[];
+    /** Offset for the next request. If empty, then there are no more results */
+    next_offset?: string;
+}

package/story.d.ts

@@ -0,0 +1,89 @@
+import type { ReactionType } from "./message.js";
+/** Describes the position of a clickable area within a story. */
+export interface StoryAreaPosition {
+    /** The abscissa of the area's center, as a percentage of the media width */
+    x_percentage: number;
+    /** The ordinate of the area's center, as a percentage of the media height */
+    y_percentage: number;
+    /** The width of the area's rectangle, as a percentage of the media width */
+    width_percentage: number;
+    /** The height of the area's rectangle, as a percentage of the media height */
+    height_percentage: number;
+    /** The clockwise rotation angle of the rectangle, in degrees; 0-360 */
+    rotation_angle: number;
+    /** The radius of the rectangle corner rounding, as a percentage of the media width */
+    corner_radius_percentage: number;
+}
+/** Describes the physical address of a location. */
+export interface LocationAddress {
+    /** The two-letter ISO 3166-1 alpha-2 country code of the country where the location is located */
+    country_code: string;
+    /** State of the location */
+    state?: string;
+    /** City of the location */
+    city?: string;
+    /** Street address of the location */
+    street?: string;
+}
+/** Describes the type of a clickable area on a story. Currently, it can be one of
+
+- StoryAreaTypeLocation
+- StoryAreaTypeSuggestedReaction
+- StoryAreaTypeLink
+- StoryAreaTypeWeather
+- StoryAreaTypeUniqueGift */
+export type StoryAreaType = StoryAreaTypeLocation | StoryAreaTypeSuggestedReaction | StoryAreaTypeLink | StoryAreaTypeWeather | StoryAreaTypeUniqueGift;
+/** Describes a story area pointing to a location. Currently, a story can have up to 10 location areas. */
+export interface StoryAreaTypeLocation {
+    /** Type of the area, always “location” */
+    type: "location";
+    /** Location latitude in degrees */
+    latitude: number;
+    /** Location longitude in degrees */
+    longitude: number;
+    /** Address of the location */
+    address?: LocationAddress;
+}
+/** Describes a story area pointing to a suggested reaction. Currently, a story can have up to 5 suggested reaction areas. */
+export interface StoryAreaTypeSuggestedReaction {
+    /** Type of the area, always “suggested_reaction” */
+    type: "suggested_reaction";
+    /** Type of the reaction */
+    reaction_type: ReactionType;
+    /** Pass True if the reaction area has a dark background */
+    is_dark?: boolean;
+    /** Pass True if reaction area corner is flipped */
+    is_flipped?: boolean;
+}
+/** Describes a story area pointing to an HTTP or tg:// link. Currently, a story can have up to 3 link areas. */
+export interface StoryAreaTypeLink {
+    /** Type of the area, always “link” */
+    type: "link";
+    /** HTTP or tg:// URL to be opened when the area is clicked */
+    url: string;
+}
+/** Describes a story area containing weather information. Currently, a story can have up to 3 weather areas. */
+export interface StoryAreaTypeWeather {
+    /** Type of the area, always “weather” */
+    type: "weather";
+    /** Temperature, in degree Celsius */
+    temperature: number;
+    /** Emoji representing the weather */
+    emoji: string;
+    /** A color of the area background in the ARGB format */
+    background_color: number;
+}
+/** Describes a story area pointing to a unique gift. Currently, a story can have at most 1 unique gift area. */
+export interface StoryAreaTypeUniqueGift {
+    /** Type of the area, always “unique_gift” */
+    type: "unique_gift";
+    /** Unique name of the gift */
+    name: string;
+}
+/** Describes a clickable area on a story media. */
+export interface StoryArea {
+    /** Position of the area */
+    position: StoryAreaPosition;
+    /** Type of the area */
+    type: StoryAreaType;
+}