@mtcute/core 0.16.4 → 0.16.7

package/cjs/highlevel/client.d.ts

@@ -1,44 +1,52 @@
-import EventEmitter from 'events';
-import Long from 'long';
-import { tdFileId } from '@mtcute/file-id';
-import { tl } from '@mtcute/tl';
-import { RpcCallOptions } from '../network/index.js';
-import { MaybeArray, MaybePromise, PartialExcept, PartialOnly } from '../types/index.js';
-import { BaseTelegramClientOptions } from './base.js';
-import { ITelegramClient } from './client.types.js';
-import { LogOutResult } from './methods/auth/log-out.js';
+import EventEmitter from 'node:events';
+import type Long from 'long';
+import type { tdFileId } from '@mtcute/file-id';
+import type { tl } from '@mtcute/tl';
+import type { RpcCallOptions } from '../network/index.js';
+import type { MaybeArray, MaybePromise, PartialExcept, PartialOnly } from '../types/index.js';
+import type { BaseTelegramClientOptions } from './base.js';
+import type { ITelegramClient } from './client.types.js';
+import type { AllStories, ArrayPaginated, ArrayWithTotal, Boost, BoostSlot, BoostStats, BotChatJoinRequestUpdate, BotCommands, BotReactionCountUpdate, BotReactionUpdate, BotStoppedUpdate, BusinessCallbackQuery, BusinessChatLink, BusinessConnection, BusinessMessage, BusinessWorkHoursDay, CallbackQuery, Chat, ChatEvent, ChatInviteLink, ChatInviteLinkMember, ChatJoinRequestUpdate, ChatMember, ChatMemberUpdate, ChatPreview, ChatlistPreview, ChosenInlineResult, CollectibleInfo, DeleteBusinessMessageUpdate, DeleteMessageUpdate, DeleteStoryUpdate, Dialog, FactCheck, FileDownloadLocation, FileDownloadParameters, ForumTopic, FullChat, GameHighScore, HistoryReadUpdate, InlineCallbackQuery, InlineQuery, InputChatEventFilters, InputDialogFolder, InputFileLike, InputInlineResult, InputMediaLike, InputMediaSticker, InputMessageId, InputPeerLike, InputPrivacyRule, InputReaction, InputStickerSet, InputStickerSetItem, InputText, MaybeDynamic, Message, MessageEffect, MessageMedia, MessageReactions, ParametersSkip2, ParsedUpdate, PeerReaction, PeerStories, PeersIndex, Photo, Poll, PollUpdate, PollVoteUpdate, PreCheckoutQuery, RawDocument, ReplyMarkup, SentCode, StarsStatus, StarsTransaction, Sticker, StickerSet, StickerSourceType, StickerType, StoriesStealthMode, Story, StoryInteractions, StoryUpdate, StoryViewer, StoryViewersList, TakeoutSession, TextWithEntities, TypingStatus, UploadFileLike, UploadedFile, User, UserStatusUpdate, UserTypingUpdate } from './types/index.js';
+import type { StringSessionData } from './utils/string-session.js';
+import type { ITelegramStorageProvider } from './storage/provider.js';
+import type { ParsedUpdateHandlerParams } from './updates/parsed.js';
+import type { LogOutResult } from './methods/auth/log-out.js';
 import { start } from './methods/auth/start.js';
-import { CreateGroupResult } from './methods/chats/create-group.js';
+import type { CreateGroupResult } from './methods/chats/create-group.js';
 import { getChatEventLog } from './methods/chats/get-chat-event-log.js';
 import { getChatMembers } from './methods/chats/get-chat-members.js';
-import { getForumTopics, GetForumTopicsOffset } from './methods/forums/get-forum-topics.js';
+import type { GetForumTopicsOffset } from './methods/forums/get-forum-topics.js';
+import { getForumTopics } from './methods/forums/get-forum-topics.js';
 import { getInviteLinkMembers } from './methods/invite-links/get-invite-link-members.js';
-import { getInviteLinks, GetInviteLinksOffset } from './methods/invite-links/get-invite-links.js';
-import { DeleteMessagesParams } from './methods/messages/delete-messages.js';
-import { ForwardMessageOptions } from './methods/messages/forward-messages.js';
-import { getHistory, GetHistoryOffset } from './methods/messages/get-history.js';
-import { getReactionUsers, GetReactionUsersOffset } from './methods/messages/get-reaction-users.js';
-import { searchGlobal, SearchGlobalOffset } from './methods/messages/search-global.js';
-import { searchHashtag, SearchHashtagOffset } from './methods/messages/search-hashtag.js';
-import { searchMessages, SearchMessagesOffset } from './methods/messages/search-messages.js';
-import { CommonSendParams } from './methods/messages/send-common.js';
-import { SendCopyParams } from './methods/messages/send-copy.js';
-import { SendCopyGroupParams } from './methods/messages/send-copy-group.js';
-import { sendMedia } from './methods/messages/send-media.js';
+import type { GetInviteLinksOffset } from './methods/invite-links/get-invite-links.js';
+import { getInviteLinks } from './methods/invite-links/get-invite-links.js';
+import type { DeleteMessagesParams } from './methods/messages/delete-messages.js';
+import type { ForwardMessageOptions } from './methods/messages/forward-messages.js';
+import type { GetHistoryOffset } from './methods/messages/get-history.js';
+import { getHistory } from './methods/messages/get-history.js';
+import type { GetReactionUsersOffset } from './methods/messages/get-reaction-users.js';
+import { getReactionUsers } from './methods/messages/get-reaction-users.js';
+import type { SearchGlobalOffset } from './methods/messages/search-global.js';
+import { searchGlobal } from './methods/messages/search-global.js';
+import type { SearchHashtagOffset } from './methods/messages/search-hashtag.js';
+import { searchHashtag } from './methods/messages/search-hashtag.js';
+import type { SearchMessagesOffset } from './methods/messages/search-messages.js';
+import { searchMessages } from './methods/messages/search-messages.js';
+import type { CommonSendParams } from './methods/messages/send-common.js';
+import type { SendCopyGroupParams } from './methods/messages/send-copy-group.js';
+import type { SendCopyParams } from './methods/messages/send-copy.js';
 import { sendMediaGroup } from './methods/messages/send-media-group.js';
-import { QuoteParamsFrom } from './methods/messages/send-quote.js';
+import { sendMedia } from './methods/messages/send-media.js';
+import type { QuoteParamsFrom } from './methods/messages/send-quote.js';
 import { sendText } from './methods/messages/send-text.js';
-import { CanApplyBoostResult } from './methods/premium/can-apply-boost.js';
+import type { CanApplyBoostResult } from './methods/premium/can-apply-boost.js';
 import { getBoosts } from './methods/premium/get-boosts.js';
-import { CanSendStoryResult } from './methods/stories/can-send-story.js';
+import { getStarsTransactions } from './methods/premium/get-stars-transactions.js';
+import type { CanSendStoryResult } from './methods/stories/can-send-story.js';
 import { getAllStories } from './methods/stories/get-all-stories.js';
 import { getProfileStories } from './methods/stories/get-profile-stories.js';
 import { getStoryViewers } from './methods/stories/get-story-viewers.js';
 import { getProfilePhotos } from './methods/users/get-profile-photos.js';
-import { ITelegramStorageProvider } from './storage/provider.js';
-import { AllStories, ArrayPaginated, ArrayWithTotal, Boost, BoostSlot, BoostStats, BotChatJoinRequestUpdate, BotCommands, BotReactionCountUpdate, BotReactionUpdate, BotStoppedUpdate, BusinessCallbackQuery, BusinessChatLink, BusinessConnection, BusinessMessage, BusinessWorkHoursDay, CallbackQuery, Chat, ChatEvent, ChatInviteLink, ChatInviteLinkMember, ChatJoinRequestUpdate, ChatlistPreview, ChatMember, ChatMemberUpdate, ChatPreview, ChosenInlineResult, CollectibleInfo, DeleteBusinessMessageUpdate, DeleteMessageUpdate, DeleteStoryUpdate, Dialog, FactCheck, FileDownloadLocation, FileDownloadParameters, ForumTopic, FullChat, GameHighScore, HistoryReadUpdate, InlineCallbackQuery, InlineQuery, InputChatEventFilters, InputDialogFolder, InputFileLike, InputInlineResult, InputMediaLike, InputMediaSticker, InputMessageId, InputPeerLike, InputPrivacyRule, InputReaction, InputStickerSet, InputStickerSetItem, InputText, MaybeDynamic, Message, MessageEffect, MessageMedia, MessageReactions, ParametersSkip2, ParsedUpdate, PeerReaction, PeersIndex, PeerStories, Photo, Poll, PollUpdate, PollVoteUpdate, PreCheckoutQuery, RawDocument, ReplyMarkup, SentCode, Sticker, StickerSet, StickerSourceType, StickerType, StoriesStealthMode, Story, StoryInteractions, StoryUpdate, StoryViewer, StoryViewersList, TakeoutSession, TextWithEntities, TypingStatus, UploadedFile, UploadFileLike, User, UserStatusUpdate, UserTypingUpdate } from './types/index.js';
-import { ParsedUpdateHandlerParams } from './updates/parsed.js';
-import { StringSessionData } from './utils/string-session.js';
 type TelegramClientOptions = ((PartialOnly<Omit<BaseTelegramClientOptions, 'storage'>, 'transport' | 'crypto'> & {
     /**
      * Storage to use for this client.
@@ -76,210 +84,210 @@ export interface TelegramClient extends ITelegramClient {
      * @param name  Event name
      * @param handler  Raw update handler
      */
-    on(name: 'raw_update', handler: (upd: tl.TypeUpdate | tl.TypeMessage, peers: PeersIndex) => void): this;
+    on(name: 'raw_update', handler: ((upd: tl.TypeUpdate | tl.TypeMessage, peers: PeersIndex) => void)): this;
     /**
      * Register a parsed update handler
      *
      * @param name  Event name
      * @param handler  Raw update handler
      */
-    on(name: 'update', handler: (upd: ParsedUpdate) => void): this;
+    on(name: 'update', handler: ((upd: ParsedUpdate) => void)): this;
     /**
      * Register a new message handler
      *
      * @param name  Event name
      * @param handler  New message handler
      */
-    on(name: 'new_message', handler: (upd: Message) => void): this;
+    on(name: 'new_message', handler: ((upd: Message) => void)): this;
     /**
      * Register an edit message handler
      *
      * @param name  Event name
      * @param handler  Edit message handler
      */
-    on(name: 'edit_message', handler: (upd: Message) => void): this;
+    on(name: 'edit_message', handler: ((upd: Message) => void)): this;
     /**
      * Register a message group handler
      *
      * @param name  Event name
      * @param handler  Message group handler
      */
-    on(name: 'message_group', handler: (upd: Message[]) => void): this;
+    on(name: 'message_group', handler: ((upd: Message[]) => void)): this;
     /**
      * Register a delete message handler
      *
      * @param name  Event name
      * @param handler  Delete message handler
      */
-    on(name: 'delete_message', handler: (upd: DeleteMessageUpdate) => void): this;
+    on(name: 'delete_message', handler: ((upd: DeleteMessageUpdate) => void)): this;
     /**
      * Register a chat member update handler
      *
      * @param name  Event name
      * @param handler  Chat member update handler
      */
-    on(name: 'chat_member', handler: (upd: ChatMemberUpdate) => void): this;
+    on(name: 'chat_member', handler: ((upd: ChatMemberUpdate) => void)): this;
     /**
      * Register an inline query handler
      *
      * @param name  Event name
      * @param handler  Inline query handler
      */
-    on(name: 'inline_query', handler: (upd: InlineQuery) => void): this;
+    on(name: 'inline_query', handler: ((upd: InlineQuery) => void)): this;
     /**
      * Register a chosen inline result handler
      *
      * @param name  Event name
      * @param handler  Chosen inline result handler
      */
-    on(name: 'chosen_inline_result', handler: (upd: ChosenInlineResult) => void): this;
+    on(name: 'chosen_inline_result', handler: ((upd: ChosenInlineResult) => void)): this;
     /**
      * Register a callback query handler
      *
      * @param name  Event name
      * @param handler  Callback query handler
      */
-    on(name: 'callback_query', handler: (upd: CallbackQuery) => void): this;
+    on(name: 'callback_query', handler: ((upd: CallbackQuery) => void)): this;
     /**
      * Register an inline callback query handler
      *
      * @param name  Event name
      * @param handler  Inline callback query handler
      */
-    on(name: 'inline_callback_query', handler: (upd: InlineCallbackQuery) => void): this;
+    on(name: 'inline_callback_query', handler: ((upd: InlineCallbackQuery) => void)): this;
     /**
      * Register a business callback query handler
      *
      * @param name  Event name
      * @param handler  Business callback query handler
      */
-    on(name: 'business_callback_query', handler: (upd: BusinessCallbackQuery) => void): this;
+    on(name: 'business_callback_query', handler: ((upd: BusinessCallbackQuery) => void)): this;
     /**
      * Register a poll update handler
      *
      * @param name  Event name
      * @param handler  Poll update handler
      */
-    on(name: 'poll', handler: (upd: PollUpdate) => void): this;
+    on(name: 'poll', handler: ((upd: PollUpdate) => void)): this;
     /**
      * Register a poll vote handler
      *
      * @param name  Event name
      * @param handler  Poll vote handler
      */
-    on(name: 'poll_vote', handler: (upd: PollVoteUpdate) => void): this;
+    on(name: 'poll_vote', handler: ((upd: PollVoteUpdate) => void)): this;
     /**
      * Register an user status update handler
      *
      * @param name  Event name
      * @param handler  User status update handler
      */
-    on(name: 'user_status', handler: (upd: UserStatusUpdate) => void): this;
+    on(name: 'user_status', handler: ((upd: UserStatusUpdate) => void)): this;
     /**
      * Register an user typing handler
      *
      * @param name  Event name
      * @param handler  User typing handler
      */
-    on(name: 'user_typing', handler: (upd: UserTypingUpdate) => void): this;
+    on(name: 'user_typing', handler: ((upd: UserTypingUpdate) => void)): this;
     /**
      * Register a history read handler
      *
      * @param name  Event name
      * @param handler  History read handler
      */
-    on(name: 'history_read', handler: (upd: HistoryReadUpdate) => void): this;
+    on(name: 'history_read', handler: ((upd: HistoryReadUpdate) => void)): this;
     /**
      * Register a bot stopped handler
      *
      * @param name  Event name
      * @param handler  Bot stopped handler
      */
-    on(name: 'bot_stopped', handler: (upd: BotStoppedUpdate) => void): this;
+    on(name: 'bot_stopped', handler: ((upd: BotStoppedUpdate) => void)): this;
     /**
      * Register a bot chat join request handler
      *
      * @param name  Event name
      * @param handler  Bot chat join request handler
      */
-    on(name: 'bot_chat_join_request', handler: (upd: BotChatJoinRequestUpdate) => void): this;
+    on(name: 'bot_chat_join_request', handler: ((upd: BotChatJoinRequestUpdate) => void)): this;
     /**
      * Register a chat join request handler
      *
      * @param name  Event name
      * @param handler  Chat join request handler
      */
-    on(name: 'chat_join_request', handler: (upd: ChatJoinRequestUpdate) => void): this;
+    on(name: 'chat_join_request', handler: ((upd: ChatJoinRequestUpdate) => void)): this;
     /**
      * Register a pre checkout query handler
      *
      * @param name  Event name
      * @param handler  Pre checkout query handler
      */
-    on(name: 'pre_checkout_query', handler: (upd: PreCheckoutQuery) => void): this;
+    on(name: 'pre_checkout_query', handler: ((upd: PreCheckoutQuery) => void)): this;
     /**
      * Register a story update handler
      *
      * @param name  Event name
      * @param handler  Story update handler
      */
-    on(name: 'story', handler: (upd: StoryUpdate) => void): this;
+    on(name: 'story', handler: ((upd: StoryUpdate) => void)): this;
     /**
      * Register a delete story handler
      *
      * @param name  Event name
      * @param handler  Delete story handler
      */
-    on(name: 'delete_story', handler: (upd: DeleteStoryUpdate) => void): this;
+    on(name: 'delete_story', handler: ((upd: DeleteStoryUpdate) => void)): this;
     /**
      * Register a bot reaction update handler
      *
      * @param name  Event name
      * @param handler  Bot reaction update handler
      */
-    on(name: 'bot_reaction', handler: (upd: BotReactionUpdate) => void): this;
+    on(name: 'bot_reaction', handler: ((upd: BotReactionUpdate) => void)): this;
     /**
      * Register a bot reaction count update handler
      *
      * @param name  Event name
      * @param handler  Bot reaction count update handler
      */
-    on(name: 'bot_reaction_count', handler: (upd: BotReactionCountUpdate) => void): this;
+    on(name: 'bot_reaction_count', handler: ((upd: BotReactionCountUpdate) => void)): this;
     /**
      * Register a business connection update handler
      *
      * @param name  Event name
      * @param handler  Business connection update handler
      */
-    on(name: 'business_connection', handler: (upd: BusinessConnection) => void): this;
+    on(name: 'business_connection', handler: ((upd: BusinessConnection) => void)): this;
     /**
      * Register a new business message handler
      *
      * @param name  Event name
      * @param handler  New business message handler
      */
-    on(name: 'new_business_message', handler: (upd: BusinessMessage) => void): this;
+    on(name: 'new_business_message', handler: ((upd: BusinessMessage) => void)): this;
     /**
      * Register an edit business message handler
      *
      * @param name  Event name
      * @param handler  Edit business message handler
      */
-    on(name: 'edit_business_message', handler: (upd: BusinessMessage) => void): this;
+    on(name: 'edit_business_message', handler: ((upd: BusinessMessage) => void)): this;
     /**
      * Register a business message group handler
      *
      * @param name  Event name
      * @param handler  Business message group handler
      */
-    on(name: 'business_message_group', handler: (upd: BusinessMessage[]) => void): this;
+    on(name: 'business_message_group', handler: ((upd: BusinessMessage[]) => void)): this;
     /**
      * Register a delete business message handler
      *
      * @param name  Event name
      * @param handler  Delete business message handler
      */
-    on(name: 'delete_business_message', handler: (upd: DeleteBusinessMessageUpdate) => void): this;
+    on(name: 'delete_business_message', handler: ((upd: DeleteBusinessMessageUpdate) => void)): this;
     on(name: string, handler: (...args: any[]) => void): this;
     /**
      * Wrap this client so that all RPC calls will use the specified parameters.
@@ -695,7 +703,7 @@ export interface TelegramClient extends ITelegramClient {
     /**
      * Answer a pre-checkout query.
      *
-     * **Available**: ✅ both users and bots
+     * **Available**: 🤖 bots only
      *
      * @param queryId  Pre-checkout query ID
      */
@@ -709,7 +717,7 @@ export interface TelegramClient extends ITelegramClient {
      * Does the same as passing `null` to  {@link setMyCommands}
      *
      * Learn more about scopes in the [Bot API docs](https://core.telegram.org/bots/api#botcommandscope)
-     * **Available**: ✅ both users and bots
+     * **Available**: 🤖 bots only
      *
      */
     deleteMyCommands(params?: {
@@ -810,7 +818,7 @@ export interface TelegramClient extends ITelegramClient {
      * and user language. If they are not set, empty set is returned.
      *
      * Learn more about scopes in the [Bot API docs](https://core.telegram.org/bots/api#botcommandscope)
-     * **Available**: ✅ both users and bots
+     * **Available**: 🤖 bots only
      *
      */
     getMyCommands(params?: {
@@ -850,7 +858,7 @@ export interface TelegramClient extends ITelegramClient {
     }): Promise<void>;
     /**
      * Sets a menu button for the given user.
-     * **Available**: ✅ both users and bots
+     * **Available**: 🤖 bots only
      *
      */
     setBotMenuButton(user: InputPeerLike, button: tl.TypeBotMenuButton): Promise<void>;
@@ -1942,7 +1950,7 @@ export interface TelegramClient extends ITelegramClient {
          * a wrong folder if you have multiple with the same title.
          *
          * Also note that fetching dialogs in a folder is
-         * *orders of magnitudes* slower than normal because
+         * orders of magnitudes* slower than normal because
          * of Telegram API limitations - we have to fetch all dialogs
          * and filter the ones we need manually. If possible,
          * use {@link Dialog.filterFolder} instead.
@@ -1965,7 +1973,7 @@ export interface TelegramClient extends ITelegramClient {
     /**
      * Join a chatlist by its link
      *
-     * **Available**: ✅ both users and bots
+     * **Available**: 👤 users only
      *
      * @param link  Invite link to the chatlist
      * @param params  Additional parameters
@@ -2221,7 +2229,7 @@ export interface TelegramClient extends ITelegramClient {
     /**
      * Get forum topics by their IDs
      *
-     * **Available**: ✅ both users and bots
+     * **Available**: 👤 users only
      *
      * @param chatId  Chat ID or username
      */
@@ -2272,7 +2280,7 @@ export interface TelegramClient extends ITelegramClient {
      * Reorder pinned forum topics
      *
      * Only admins with `manageTopics` permission can do this.
-     * **Available**: ✅ both users and bots
+     * **Available**: 👤 users only
      *
      */
     reorderPinnedForumTopics(params: {
@@ -2313,7 +2321,7 @@ export interface TelegramClient extends ITelegramClient {
      * Toggle whether a topic in a forum is pinned
      *
      * Only admins with `manageTopics` permission can do this.
-     * **Available**: ✅ both users and bots
+     * **Available**: 👤 users only
      *
      */
     toggleForumTopicPinned(params: {
@@ -2329,7 +2337,7 @@ export interface TelegramClient extends ITelegramClient {
      *
      * Only owner of the supergroup can change this setting.
      *
-     * **Available**: ✅ both users and bots
+     * **Available**: 👤 users only
      *
      * @param chatId  Chat ID or username
      * @param [enabled=false]  Whether the supergroup should be a forum
@@ -2959,7 +2967,7 @@ export interface TelegramClient extends ITelegramClient {
      * **Available**: ✅ both users and bots
      *
      * @param messageIds  Messages IDs
-     * @param [fromReply=false]
+     * @param [fromReply]
      *     Whether the reply to a given message should be fetched
      *     (i.e. `getMessages(msg.chat.id, msg.id, true).id === msg.replyToMessageId`)
      */
@@ -2974,7 +2982,7 @@ export interface TelegramClient extends ITelegramClient {
      *
      * @param chatId  Chat's marked ID, its username, phone or `"me"` or `"self"`
      * @param messageIds  Messages IDs
-     * @param [fromReply=false]
+     * @param [fromReply]
      *     Whether the reply to a given message should be fetched
      *     (i.e. `getMessages(msg.chat.id, msg.id, true).id === msg.replyToMessageId`)
      */
@@ -3509,6 +3517,30 @@ export interface TelegramClient extends ITelegramClient {
          */
         progressCallback?: (uploaded: number, total: number) => void;
     }): Promise<Message>;
+    /**
+     * Send a paid reaction using Telegram Stars.
+     *
+     * **Available**: 👤 users only
+     *
+     * @returns
+     *   Message to which the reaction was sent, if available.
+     *   The message is normally available for users, but may not be available for bots in PMs.
+     */
+    sendPaidReaction(params: InputMessageId & {
+        /** Whether to send the reaction anonymously */
+        anonymous?: boolean;
+        /**
+         * Number of reactions to send
+         *
+         * @default  1
+         */
+        count?: number;
+        /**
+         * Whether to dispatch the returned edit message event
+         * to the client's update handler.
+         */
+        shouldDispatch?: true;
+    }): Promise<MessageReactions>;
     /** Send a text in reply to a given quote */
     quoteWithText(message: Message, params: QuoteParamsFrom<Parameters<typeof sendText>[3]> & {
         /** Text to send */
@@ -3865,14 +3897,45 @@ export interface TelegramClient extends ITelegramClient {
      *
      */
     getMyBoostSlots(): Promise<BoostSlot[]>;
+    /**
+     * Get Telegram Stars transactions for a given peer.
+     *
+     * You can either pass `self` to get your own transactions,
+     * or a chat/bot ID to get transactions of that peer.
+     *
+     * **Available**: ✅ both users and bots
+     *
+     * @param peerId  Peer ID
+     * @param params  Additional parameters
+     */
+    getStarsTransactions(peerId: InputPeerLike, params?: {
+        /**
+         * If passed, only transactions of this direction will be returned
+         */
+        direction?: 'incoming' | 'outgoing';
+        /**
+         * Direction to sort transactions date by (default: desc)
+         */
+        sort?: 'asc' | 'desc';
+        /**
+         * If passed, will only return transactions related to  this subscription ID
+         */
+        subscriptionId?: string;
+        /** Pagination offset */
+        offset?: string;
+        /**
+         * Pagination limit
+         *
+         * @default  100
+         */
+        limit?: number;
+    }): Promise<StarsStatus>;
     /**
      * Iterate over boosters of a channel.
      *
      * Wrapper over {@link getBoosters}
-     *
      * **Available**: ✅ both users and bots
      *
-     * @returns  IDs of stories that were removed
      */
     iterBoosters(peerId: InputPeerLike, params?: Parameters<typeof getBoosts>[2] & {
         /**
@@ -3889,6 +3952,34 @@ export interface TelegramClient extends ITelegramClient {
          */
         chunkSize?: number;
     }): AsyncIterableIterator<Boost>;
+    /**
+     * Iterate over Telegram Stars transactions for a given peer.
+     *
+     * You can either pass `self` to get your own transactions,
+     * or a chat/bot ID to get transactions of that peer.
+     *
+     * Wrapper over {@link getStarsTransactions}
+     *
+     * **Available**: ✅ both users and bots
+     *
+     * @param peerId  Peer ID
+     * @param params  Additional parameters
+     */
+    iterStarsTransactions(peerId: InputPeerLike, params?: Parameters<typeof getStarsTransactions>[2] & {
+        /**
+         * Total number of boosters to fetch
+         *
+         * @default  Infinity, i.e. fetch all boosters
+         */
+        limit?: number;
+        /**
+         * Number of boosters to fetch per request
+         * Usually you don't need to change this
+         *
+         * @default  100
+         */
+        chunkSize?: number;
+    }): AsyncIterableIterator<StarsTransaction>;
     /**
      * Set current user's business introduction.
      *
@@ -4575,7 +4666,7 @@ export interface TelegramClient extends ITelegramClient {
     getCommonChats(userId: InputPeerLike): Promise<Chat[]>;
     /**
      * Gets the current default value of the Time-To-Live setting, applied to all new chats.
-     * **Available**: ✅ both users and bots
+     * **Available**: 👤 users only
      *
      */
     getGlobalTtl(): Promise<number>;
@@ -4708,7 +4799,7 @@ export interface TelegramClient extends ITelegramClient {
      * Changes the current default value of the Time-To-Live setting,
      * applied to all new chats.
      *
-     * **Available**: ✅ both users and bots
+     * **Available**: 👤 users only
      *
      * @param period  New TTL period, in seconds (or 0 to disable)
      */