@mtkruto/node 0.78.0 → 0.79.0

package/esm/client/5_client_dispatcher.js

@@ -0,0 +1,2141 @@
+/**
+ * MTKruto - Cross-runtime JavaScript library for building Telegram clients
+ * Copyright (C) 2023-2026 Roj <https://roj.im/>
+ *
+ * This file is part of MTKruto.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+import { getLogger } from "../1_utilities.js";
+import { DOWNLOAD_MAX_CHUNK_SIZE } from "../4_constants.js";
+import * as errors from "../4_errors.js";
+import { Composer } from "./4_composer.js";
+import { signIn } from "./2_sign_in.js";
+export class ClientDispatcher extends Composer {
+    #worker;
+    #id;
+    #L;
+    #LsignIn;
+    // deno-lint-ignore no-explicit-any
+    #pendingRequests = new Array();
+    constructor(worker, id) {
+        super();
+        this.#worker = worker;
+        this.#id = id;
+        this.#L = getLogger("ClientController").branch(this.#id + "");
+        this.#LsignIn = this.#L.branch("signIn");
+    }
+    /** @internal */
+    async handleResponse(response) {
+        if (response.clientId !== this.#id) {
+            return;
+        }
+        this.#L.debug("handling response message", response);
+        if (response.isError) {
+            this.#pendingRequests[response.id]?.reject(this.#constructError(response.data));
+        }
+        else {
+            if (response.id === -1) {
+                try {
+                    await this.handleUpdate(this, response.data);
+                }
+                catch (err) {
+                    this.#L.error("Error handling update:", err);
+                }
+            }
+            else {
+                this.#pendingRequests[response.id]?.resolve(response.data);
+            }
+        }
+        // clean up pending requests
+        if (response.id === 0) {
+            this.#pendingRequests.shift();
+        }
+        else if (response.id === this.#pendingRequests.length - 1) {
+            this.#pendingRequests.pop();
+        }
+    }
+    #constructError(error) {
+        switch (error.name) {
+            case "TelegramError":
+                return errors.constructTelegramError({
+                    _: "rpc_error",
+                    error_code: error.args[0].error_code,
+                    error_message: error.args[0].error_message,
+                }, error.args.call);
+            case "ConnectionError":
+                return new errors.ConnectionError(error.args[0]);
+            case "AccessError":
+                return new errors.AccessError(error.args[0]);
+            case "InputError":
+                return new errors.InputError(error.args[0]);
+            case "TransportError":
+                return new errors.TransportError(error.args[0]);
+            case "TLError":
+                return new errors.TLError(error.args[0], error.args[1]);
+            default:
+                return new TypeError("Unknown error");
+        }
+    }
+    get id() {
+        return this.#id;
+    }
+    async #dispatch(method, ...args) {
+        // deno-lint-ignore no-explicit-any
+        const promiseWithResolvers = Promise.withResolvers();
+        const index = this.#pendingRequests.push(promiseWithResolvers) - 1;
+        const request = {
+            clientId: this.#id,
+            id: index,
+            method,
+            args,
+        };
+        this.#L.debug("posted message to worker", request);
+        this.#worker.postMessage(request);
+        return await promiseWithResolvers.promise;
+    }
+    #isInited = false;
+    async init(params) {
+        if (this.#isInited) {
+            return;
+        }
+        this.#isInited = true;
+        return await this.#dispatch("initClient", params);
+    }
+    async connect() {
+        return await this.#dispatch("connect");
+    }
+    async disconnect() {
+        return await this.#dispatch("disconnect");
+    }
+    async start(params) {
+        await this.connect();
+        await this.signIn(params);
+    }
+    /**
+     * Send a user verification code.
+     *
+     * @param phoneNumber The phone number to send the code to.
+     * @method ac
+     */
+    async sendCode(phoneNumber) {
+        return await this.#dispatch("sendCode", phoneNumber);
+    }
+    /**
+     * Check if a code entered by the user was the same as the verification code.
+     *
+     * @param code A code entered by the user.
+     * @method ac
+     */
+    async checkCode(code) {
+        return await this.#dispatch("checkCode", code);
+    }
+    /**
+     * Get the user account password's hint.
+     *
+     * @method ac
+     */
+    async getPasswordHint() {
+        return await this.#dispatch("getPasswordHint");
+    }
+    /**
+     * Check whether a password entered by the user is the same as the account's one.
+     *
+     * @param password The password to check
+     * @returns The result of the check.
+     */
+    async checkPassword(password) {
+        return await this.#dispatch("checkPassword", password);
+    }
+    /**
+     * Check whether a bot token is valid.
+     *
+     * @param password The password to check
+     * @returns The result of the check.
+     */
+    async checkBotToken(botToken) {
+        return await this.#dispatch("checkBotToken", botToken);
+    }
+    /**
+     * Signs in using the provided parameters if not already signed in.
+     * If no parameters are provided, the credentials will be prompted in runtime.
+     *
+     * Notes:
+     * 1. Requires the `apiId` and `apiHash` paramters to be passed when constructing the client.
+     * 3. Reconnects the client to the appropriate DC in case of MIGRATE_X errors.
+     */
+    async signIn(params) {
+        await signIn(this, this.#LsignIn, params);
+    }
+    async signOut() {
+        return await this.#dispatch("signOut");
+    }
+    async exportAuthString() {
+        return await this.#dispatch("exportAuthString");
+    }
+    async importAuthString(authString) {
+        return await this.#dispatch("importAuthString", authString);
+    }
+    /**
+     * Get a chat's inputPeer. Useful when calling API functions directly.
+     *
+     * @param id The identifier of a chat.
+     */
+    async getInputPeer(id) {
+        return await this.#dispatch("getInputPeer", id);
+    }
+    /**
+     * Get a channel or a supergroup's inputChannel. Useful when calling API functions directly.
+     *
+     * @param id The identifier of the channel or the supergroup.
+     */
+    async getInputChannel(id) {
+        return await this.#dispatch("getInputChannel", id);
+    }
+    /**
+     * Get a user's inputUser. Useful when calling API functions directly.
+     *
+     * @param id The identifier of the user.
+     */
+    async getInputUser(id) {
+        return await this.#dispatch("getInputUser", id);
+    }
+    //
+    // ========================= ACCOUNT ========================= //
+    //
+    /**
+     * Get information on the currently authorized user.
+     *
+     * @method ac
+     * @returns Information on the currently authorized user.
+     */
+    async getMe() {
+        return await this.#dispatch("getMe");
+    }
+    /**
+     * Show a username in the current account, a bot account, a supergroup, or a channel's profile. User-only.
+     *
+     * @method ac
+     * @param id `"me"`, a bot ID, a supergroup ID, or a channel ID.
+     * @param username The username to show.
+     */
+    async showUsername(id, username) {
+        return await this.#dispatch("showUsername", id, username);
+    }
+    /**
+     * Hide a username from the current account, a bot account, a supergroup, or a channel's profile. User-only.
+     *
+     * @method ac
+     * @param id `"me"`, a bot ID, a supergroup ID, or a channel ID.
+     * @param username The username to hide.
+     */
+    async hideUsername(id, username) {
+        return await this.#dispatch("hideUsername", id, username);
+    }
+    /**
+     * Reorder the usernames of the current account, a bot account, a supergroup, or a channel's profile. User-only.
+     *
+     * @method ac
+     * @param id `"me"`, a bot ID, a supergroup ID, or a channel ID.
+     * @param order The new order to use.
+     * @returns Whether the order was changed.
+     */
+    async reorderUsernames(id, order) {
+        return await this.#dispatch("reorderUsernames", id, order);
+    }
+    /**
+     * Hide all usernames from a supergroup or a channel's profile. User-only.
+     *
+     * @method ac
+     * @param id A supergroup ID or a channel ID.
+     * @returns Whether any username was hidden.
+     */
+    async hideUsernames(id) {
+        return await this.#dispatch("hideUsernames", id);
+    }
+    /**
+     * Get a business connection. Bot-only.
+     *
+     * @method ac
+     * @param id The identifier of the business connection.
+     * @cache
+     */
+    async getBusinessConnection(id) {
+        return await this.#dispatch("getBusinessConnection", id);
+    }
+    /**
+     * Set the current account's online status. User-only.
+     *
+     * @method ac
+     * @param online The new online status.
+     */
+    async setOnline(online) {
+        return await this.#dispatch("setOnline", online);
+    }
+    /**
+     * Set the current account's emoji status. User-only.
+     *
+     * @method ac
+     * @param id The identifier of the emoji to be used as the new status.
+     */
+    async setEmojiStatus(id, params) {
+        return await this.#dispatch(id, params);
+    }
+    /**
+     * Set the emoji status of a bot's user. Bot-only.
+     *
+     * @method ac
+     * @param userId The identifier of a user of the bot.
+     * @param id The identifier of the emoji to be used as the new status.
+     */
+    async setUserEmojiStatus(userId, id, params) {
+        return await this.#dispatch("setUserEmojiStatus", userId, id, params);
+    }
+    /**
+     * Update the profile of the current user. At least one parameter must be specified. User-only.
+     *
+     * @method ac
+     */
+    async updateProfile(params) {
+        return await this.#dispatch("updateProfile", params);
+    }
+    /**
+     * Set the birthday of the current user. User-only.
+     *
+     * @method ac
+     */
+    async setBirthday(params) {
+        return await this.#dispatch("setBirthday", params);
+    }
+    /**
+     * Set the personal channel of the current user. User-only.
+     *
+     * @method ac
+     */
+    async setPersonalChannel(params) {
+        return await this.#dispatch("setPersonalChannel", params);
+    }
+    /**
+     * Set the name color of the current user. User-only.
+     *
+     * @method ac
+     * @param color The identifier of the color to set.
+     */
+    async setNameColor(color, params) {
+        return await this.#dispatch("setNameColor", color, params);
+    }
+    /**
+     * Set the profile color of the current user. User-only.
+     *
+     * @method ac
+     * @param color The identifier of the color to set.
+     */
+    async setProfileColor(color, params) {
+        return await this.#dispatch("setProfileColor", color, params);
+    }
+    /**
+     * Set the location of the current user. User-only.
+     *
+     * @method ac
+     */
+    async setLocation(params) {
+        return await this.#dispatch("setLocation", params);
+    }
+    //
+    // ========================= MESSAGES ========================= //
+    //
+    /**
+     * Send a text message.
+     *
+     * @method ms
+     * @param chatId The identifier of a chat to send the message to.
+     * @param text The message's text.
+     * @returns The sent text message.
+     */
+    async sendMessage(chatId, text, params) {
+        return await this.#dispatch("sendMessage", chatId, text, params);
+    }
+    /**
+     * Send a photo.
+     *
+     * @method ms
+     * @param chatId The identifier of a chat to send the photo to.
+     * @param photo The photo to send.
+     * @returns The sent photo.
+     */
+    async sendPhoto(chatId, photo, params) {
+        return await this.#dispatch("sendPhoto", chatId, photo, params);
+    }
+    /**
+     * Send a document.
+     *
+     * @method ms
+     * @param chatId The identifier of a chat to send the document to.
+     * @param document The document to send.
+     * @returns The sent document.
+     */
+    async sendDocument(chatId, document, params) {
+        return await this.#dispatch("sendDocument", chatId, document, params);
+    }
+    /**
+     * Send a sticker.
+     *
+     * @method ms
+     * @param chatId The identifier of a chat to send the sticker to.
+     * @param document The sticker to send.
+     * @returns The sent sticker.
+     */
+    async sendSticker(chatId, sticker, params) {
+        return await this.#dispatch("sendSticker", chatId, sticker, params);
+    }
+    /**
+     * Send a video.
+     *
+     * @method ms
+     * @param chatId The identifier of a chat to send the video to.
+     * @param video The video to send.
+     * @returns The sent video.
+     */
+    async sendVideo(chatId, video, params) {
+        return await this.#dispatch("sendVideo", chatId, video, params);
+    }
+    /**
+     * Send an animation.
+     *
+     * @method ms
+     * @param chatId The identifier of a chat to send the animation to.
+     * @param animation The animation to send.
+     * @returns The sent animation.
+     */
+    async sendAnimation(chatId, animation, params) {
+        return await this.#dispatch("sendAnimation", chatId, animation, params);
+    }
+    /**
+     * Send a voice message.
+     *
+     * @method ms
+     * @param chatId The identifier of a chat to send the voice message to.
+     * @param voice The voice to send.
+     * @returns The sent voice message.
+     */
+    async sendVoice(chatId, voice, params) {
+        return await this.#dispatch("sendVoice", chatId, voice, params);
+    }
+    /**
+     * Send an audio file.
+     *
+     * @method ms
+     * @param chatId The identifier of a chat to send the audio file to.
+     * @param audio The audio to send.
+     * @returns The sent audio file.
+     */
+    async sendAudio(chatId, audio, params) {
+        return await this.#dispatch("sendAudio", chatId, audio, params);
+    }
+    /**
+     * Send a media group.
+     *
+     * @method ms
+     * @param chatId The identifier of a chat to send the media group to.
+     * @param media The media to include in the media group. Animations are not allowed. All of them must be of the same media type, but an exception is that photos and videos can be mixed.
+     * @returns The sent messages.
+     */
+    async sendMediaGroup(chatId, media, params) {
+        return await this.#dispatch("sendMediaGroup", chatId, media, params);
+    }
+    /**
+     * Send a video note.
+     *
+     * @method ms
+     * @param chatId The identifier of a chat to send the video note to.
+     * @param videoNote The video note to send.
+     * @returns The sent video note.
+     */
+    async sendVideoNote(chatId, videoNote, params) {
+        return await this.#dispatch("sendVideoNote", chatId, videoNote, params);
+    }
+    /**
+     * Send a location.
+     *
+     * @method ms
+     * @param chatId The identifier of a chat to send the location to.
+     * @param latitude The location's latitude.
+     * @param longitude The location's longitude.
+     * @returns The sent location.
+     */
+    async sendLocation(chatId, latitude, longitude, params) {
+        return await this.#dispatch("sendLocation", chatId, latitude, longitude, params);
+    }
+    /**
+     * Send a contact.
+     *
+     * @method ms
+     * @param chatId The identifier of a chat to send the contact to.
+     * @param firstName The contact's first name.
+     * @param number The contact's phone number.
+     * @returns The sent contact.
+     */
+    async sendContact(chatId, firstName, number, params) {
+        return await this.#dispatch("sendContact", chatId, firstName, number, params);
+    }
+    /**
+     * Send a dice.
+     *
+     * @method ms
+     * @param chatId The identifier of a chat to send the dice to.
+     * @returns The sent dice.
+     */
+    async sendDice(chatId, params) {
+        return await this.#dispatch("sendDice", chatId, params);
+    }
+    /**
+     * Send a venue.
+     *
+     * @method ms
+     * @param chatId The identifier of a chat to send the venue to.
+     * @param latitude The latitude of the venue.
+     * @param longitude The longitude of the venue.
+     * @param title The title of the venue.
+     * @param address The written address of the venue.
+     * @returns The sent venue.
+     */
+    async sendVenue(chatId, latitude, longitude, title, address, params) {
+        return await this.#dispatch("sendVenue", chatId, latitude, longitude, title, address, params);
+    }
+    /**
+     * Send a poll.
+     *
+     * @method ms
+     * @param chatId The identifier of a chat to send the poll to.
+     * @param question The poll's question.
+     * @param options The poll's options.
+     * @returns The sent poll.
+     */
+    async sendPoll(chatId, question, options, params) {
+        return await this.#dispatch("sendPoll", chatId, question, options, params);
+    }
+    /**
+     * Send an invoice. Bot-only.
+     *
+     * @method ms
+     * @param chatId The identifier of a chat to send the invoice to.
+     * @param title The invoice's title.
+     * @param description The invoice's description.
+     * @param payload The invoice's payload.
+     * @param currency The invoice's currency.
+     * @param prices The invoice's price tags.
+     * @returns The sent invoice.
+     */
+    async sendInvoice(chatId, title, description, payload, currency, prices, params) {
+        return await this.#dispatch("sendInvoice", chatId, title, description, payload, currency, prices, params);
+    }
+    /**
+     * Edit a message's text.
+     *
+     * @method ms
+     * @param chatId The identifier of the chat which the message belongs to.
+     * @param messageId The identifier of the message.
+     * @param text The new text of the message.
+     * @returns The edited text message.
+     */
+    async editMessageText(chatId, messageId, text, params) {
+        return await this.#dispatch("editMessageText", chatId, messageId, text, params);
+    }
+    /**
+     * Edit a message's caption.
+     *
+     * @method ms
+     * @param chatId The identifier of the chat which the message belongs to.
+     * @param messageId The identifier of the message.
+     * @param text The new caption of the message.
+     * @returns The edited message.
+     */
+    async editMessageCaption(chatId, messageId, params) {
+        return await this.#dispatch("editMessageCaption", chatId, messageId, params);
+    }
+    /**
+     * Edit a message's media.
+     *
+     * @method ms
+     * @param chatId The identifier of the chat which the message belongs to.
+     * @param messageId The identifier of the message.
+     * @param media The new media of the message.
+     * @returns The edited message.
+     */
+    async editMessageMedia(chatId, messageId, media, params) {
+        return await this.#dispatch("editMessageMedia", chatId, messageId, media, params);
+    }
+    /**
+     * Edit an inline message's media.
+     *
+     * @method ms
+     * @param inlineMessageId The identifier of the inline message.
+     * @param media The new media of the message.
+     */
+    async editInlineMessageMedia(inlineMessageId, media, params) {
+        return await this.#dispatch("editInlineMessageMedia", inlineMessageId, media, params);
+    }
+    /**
+     * Edit an inline message's text. Bot-only.
+     *
+     * @method ms
+     * @param inlineMessageId The identifier of the inline message.
+     * @param text The new text of the message.
+     */
+    async editInlineMessageText(inlineMessageId, text, params) {
+        return await this.#dispatch("editInlineMessageText", inlineMessageId, text, params);
+    }
+    /**
+     * Edit an inline message's caption. Bot-only.
+     *
+     * @method ms
+     * @param inlineMessageId The identifier of the inline message.
+     */
+    async editInlineMessageCaption(inlineMessageId, params) {
+        return await this.#dispatch("editInlineMessageCaption", inlineMessageId, params);
+    }
+    /**
+     * Edit a message's reply markup.
+     *
+     * @method ms
+     * @param chatId The identifier of the chat which the message belongs to.
+     * @param messageId The identifier of the message.
+     * @returns The edited message.
+     */
+    async editMessageReplyMarkup(chatId, messageId, params) {
+        return await this.#dispatch("editMessageReplyMarkup", chatId, messageId, params);
+    }
+    /**
+     * Edit an inline message's reply markup. Bot-only.
+     *
+     * @method ms
+     * @param inlineMessageId The identifier of the inline message.
+     */
+    async editInlineMessageReplyMarkup(inlineMessageId, params) {
+        return await this.#dispatch("editInlineMessageReplyMarkup", inlineMessageId, params);
+    }
+    /**
+     * Edit a message's live location.
+     *
+     * @method ms
+     * @param chatId The identifier of the chat which the message belongs to.
+     * @param messageId The identifier of the message.
+     * @param latitude The new latitude.
+     * @param longitude The new longitude.
+     * @returns The edited location message.
+     */
+    async editMessageLiveLocation(chatId, messageId, latitude, longitude, params) {
+        return await this.#dispatch("editMessageLiveLocation", chatId, messageId, latitude, longitude, params);
+    }
+    /**
+     * Edit an inline message's live location. Bot-only.
+     *
+     * @method ms
+     * @param inlineMessageId The identifier of the inline message.
+     * @param latitude The new latitude.
+     * @param longitude The new longitude.
+     * @returns The edited location message.
+     */
+    async editInlineMessageLiveLocation(inlineMessageId, latitude, longitude, params) {
+        return await this.#dispatch("editInlineMessageLiveLocation", inlineMessageId, latitude, longitude, params);
+    }
+    /**
+     * Retrieve multiple messages.
+     *
+     * @method ms
+     * @param chatId The identifier of a chat to retrieve the messages from.
+     * @param messageIds The identifiers of the messages to retrieve.
+     * @example ```ts
+     * const message = await client.getMessages("@MTKruto", [210, 212]): Promise<void>;
+     * ```
+     * @returns The retrieved messages.
+     * @cache
+     */
+    async getMessages(chatId, messageIds) {
+        return await this.#dispatch("getMessages", chatId, messageIds);
+    }
+    /**
+     * Retrieve a single message.
+     *
+     * @method ms
+     * @param chatId The identifier of a chat.
+     * @param messageId The identifier of the message to retrieve.
+     * @example ```ts
+     * const message = await client.getMessage("@MTKruto", 212): Promise<void>;
+     * ```
+     * @returns The retrieved message.
+     * @cache
+     */
+    async getMessage(chatId, messageId) {
+        return await this.#dispatch("getMessage", chatId, messageId);
+    }
+    /**
+     * Retrieve a message using its link.
+     *
+     * @method ms
+     * @param link A message link.
+     * @example ```ts
+     * const message = await client.resolveMessageLink("https://t.me/MTKruto/212"): Promise<void>;
+     * ```
+     * @returns The message that was linked to.
+     */
+    async resolveMessageLink(link) {
+        return await this.#dispatch("resolveMessageLink", link);
+    }
+    /**
+     * Delete multiple messages.
+     *
+     * @method ms
+     * @param chatId The identifier of the chat which the message belongs to.
+     * @param messageIds The identifiers of the messages to delete.
+     */
+    async deleteMessages(chatId, messageIds, params) {
+        return await this.#dispatch("deleteMessages", chatId, messageIds, params);
+    }
+    /**
+     * Delete a single message.
+     *
+     * @method ms
+     * @param chatId The identifier of the chat which the message belongs to.
+     * @param messageId The identifier of the message to delete.
+     */
+    async deleteMessage(chatId, messageId, params) {
+        return await this.#dispatch("deleteMessage", chatId, messageId, params);
+    }
+    /**
+     * Delete all messages sent by a specific member of a chat. User-only.
+     *
+     * @method ms
+     * @param chatId The identifier of a chat. Must be a supergroup.
+     * @param memberId The identifier of the member.
+     */
+    async deleteChatMemberMessages(chatId, memberId) {
+        return await this.#dispatch("deleteChatMemberMessages", chatId, memberId);
+    }
+    /**
+     * Delete multiple scheduled messages.
+     *
+     * @method ms
+     * @param chatId The identifier of a chat.
+     * @param messageIds The identifiers of the scheduled messages to delete.
+     */
+    async deleteScheduledMessages(chatId, messageIds) {
+        return await this.#dispatch("deleteScheduledMessages", chatId, messageIds);
+    }
+    /**
+     * Delete a scheduled message.
+     *
+     * @method ms
+     * @param chatId The identifier of a chat.
+     * @param messageId The identifier of the scheduled message to delete.
+     */
+    async deleteScheduledMessage(chatId, messageId) {
+        return await this.#dispatch("deleteScheduledMessage", chatId, messageId);
+    }
+    /**
+     * Send multiple scheduled messages before their schedule.
+     *
+     * @method ms
+     * @param chatId The identifier of a chat.
+     * @param messageIds The identifiers of the scheduled messages to send.
+     */
+    async sendScheduledMessages(chatId, messageIds) {
+        return await this.#dispatch("sendScheduledMessages", chatId, messageIds);
+    }
+    /**
+     * Send a scheduled message before its schedule.
+     *
+     * @method ms
+     * @param chatId The identifier of a chat.
+     * @param messageId The identifier of the scheduled message to send.
+     */
+    async sendScheduledMessage(chatId, messageId) {
+        return await this.#dispatch("sendScheduledMessage", chatId, messageId);
+    }
+    /**
+     * Pin a message in a chat.
+     *
+     * @method ms
+     * @param chatId The identifier of a chat.
+     * @param messageId The identifier of the message.
+     */
+    async pinMessage(chatId, messageId, params) {
+        return await this.#dispatch("pinMessage", chatId, messageId, params);
+    }
+    /**
+     * Unpin a pinned message.
+     *
+     * @method ms
+     * @param chatId The identifier of a chat.
+     * @param messageId The identifier of the message.
+     */
+    async unpinMessage(chatId, messageId, params) {
+        return await this.#dispatch("unpinMessage", chatId, messageId, params);
+    }
+    /**
+     * Unpin all pinned messages.
+     *
+     * @method ms
+     * @param chatId The identifier of a chat.
+     */
+    async unpinMessages(chatId) {
+        return await this.#dispatch("unpinMessages", chatId);
+    }
+    /**
+     * Forward multiple messages.
+     *
+     * @method ms
+     * @param from The identifier of a chat to forward the messages from.
+     * @param to The identifier of a chat to forward the messages to.
+     * @param messageIds The identifiers of the messages to forward.
+     * @returns The forwarded messages.
+     */
+    async forwardMessages(from, to, messageIds, params) {
+        return await this.#dispatch("forwardMessages", from, to, messageIds, params);
+    }
+    /**
+     * Forward a single message.
+     *
+     * @method ms
+     * @param from The identifier of a chat to forward the message from.
+     * @param to The identifier of a chat to forward the message to.
+     * @param messageId The identifier of the message to forward.
+     * @returns The forwarded message.
+     */
+    async forwardMessage(from, to, messageId, params) {
+        return await this.#dispatch("forwardMessage", from, to, messageId, params);
+    }
+    /**
+     * Stop a poll.
+     *
+     * @method ms
+     * @param chatId The chat that includes the poll.
+     * @param messageId The idenfifier of the poll's message.
+     * @returns The new state of the poll.
+     */
+    async stopPoll(chatId, messageId, params) {
+        return await this.#dispatch("stopPoll", chatId, messageId, params);
+    }
+    /**
+     * Send a chat action.
+     *
+     * @method ms
+     * @param chatId The identifier of a chat to send the chat action to.
+     * @param action The chat action.
+     * @param messageThreadId The thread to send the chat action to.
+     */
+    async sendChatAction(chatId, action, params) {
+        return await this.#dispatch("sendChatAction", chatId, action, params);
+    }
+    /**
+     * Search for messages. User-only.
+     *
+     * @method ms
+     */
+    async searchMessages(params) {
+        return await this.#dispatch("searchMessages", params);
+    }
+    /**
+     * Mark messages as read. User-only.
+     *
+     * @method ms
+     * @param chatId The identifier of the chat which the messages belong to.
+     * @param untilMessageId The identifier of the message that will be marked as read, along with any other unread messages before it.
+     */
+    async readMessages(chatId, untilMessageId) {
+        return await this.#dispatch("readMessages", chatId, untilMessageId);
+    }
+    /**
+     * Start a bot. User-only.
+     *
+     * @method ms
+     * @param botId The identifier of the bot to start.
+     * @returns The start message.
+     */
+    async startBot(botId, params) {
+        return await this.#dispatch("startBot", botId, params);
+    }
+    /**
+     * Transcribe a voice message. User-only.
+     *
+     * @method ms
+     * @param chatId The identifier of the chat which the message belongs to.
+     * @param messageId The identifier of the message.
+     * @cache
+     */
+    async transcribeVoice(chatId, messageId) {
+        return await this.#dispatch("transcribeVoice", chatId, messageId);
+    }
+    /**
+     * Get a sticker set.
+     *
+     * @method ms
+     * @param name The name of the sticker set or its link.
+     */
+    async getStickerSet(name) {
+        return await this.#dispatch("getStickerSet", name);
+    }
+    /*
+     * Get the link preview for a message that is about to be sent. User-only.
+     *
+     * @method ms
+     * @param text The message's text.
+     */
+    async getLinkPreview(text, params) {
+        return await this.#dispatch("getLinkPreview", text, params);
+    }
+    /**
+     * Open a mini app. User-only.
+     *
+     * @method ms
+     * @param botId The identifier of a bot with the mini app.
+     * @param chatId The identifier of the chat from which the mini app is opened.
+     * @cache
+     */
+    async openMiniApp(botId, chatId, params) {
+        return await this.#dispatch("openMiniApp", botId, chatId, params);
+    }
+    /**
+     * Get a progress ID that can be passed to relevant send* methods to receive upload progress updates for them.
+     *
+     * @method ms
+     * @cache
+     */
+    async getProgressId() {
+        return await this.#dispatch("getProgressId");
+    }
+    /**
+     * Get messages saved from a specific chat.
+     *
+     * @method ms
+     * @param chatId The identifier of a chat.
+     */
+    async getSavedMessages(chatId, params) {
+        return await this.#dispatch("getSavedMessages", chatId, params);
+    }
+    /**
+     * Get a list of saved chats.
+     *
+     * @method ms
+     */
+    async getSavedChats(params) {
+        return await this.#dispatch("getSavedChats", params);
+    }
+    /**
+     * Get a list of reactions made to a message. User-only.
+     *
+     * @param chatId The identifier of a chat.
+     * @param messageId The identifier of the message.
+     * @method ms
+     */
+    async getMessageReactions(chatId, messageId, params) {
+        return await this.#dispatch("getMessageReactions", chatId, messageId, params);
+    }
+    //
+    // ========================= POLLS ========================= //
+    //
+    /**
+     * Cast a vote. User-only.
+     *
+     * @method pl
+     * @param chatId The identifier of the chat that includes the poll.
+     * @param messageId The identifier of the message that includes the poll.
+     * @param optionIndexes The indexes of the options to cast for.
+     */
+    async vote(chatId, messageId, optionIndexes) {
+        return await this.#dispatch("vote", chatId, messageId, optionIndexes);
+    }
+    /**
+     * Retract a vote. User-only.
+     *
+     * @method pl
+     * @param chatId The identifier of the chat that includes the poll.
+     * @param messageId The identifier of the message that includes the poll.
+     */
+    async retractVote(chatId, messageId) {
+        return await this.#dispatch("retractVote", chatId, messageId);
+    }
+    //
+    // ========================= FILES ========================= //
+    //
+    /**
+     * Download a chunk of a file.
+     *
+     * @method fs
+     * @param fileId The identifier of a file.
+     * @example ```ts
+     * const chunk = await client.downloadChunk(fileId, { chunkSize: 256 * 1024 });
+     * ```
+     * @returns The downloaded chunk.
+     * @cache file
+     */
+    async downloadChunk(fileId, params) {
+        return await this.#dispatch("downloadChunk", fileId, params);
+    }
+    /**
+     * Download a file.
+     *
+     * @method fs
+     * @param fileId The identifier of the file to download.
+     * @example ```ts
+     * for await (const chunk of client.download(fileId, { chunkSize: 256 * 1024 })) {
+     *   await outFile.write(chunk): Promise<void>;
+     * }
+     * ```
+     * @returns A generator yielding the contents of the file.
+     * @cache file
+     */
+    async *download(fileId, params) {
+        let offset = 0;
+        const chunkSize = params?.chunkSize ?? DOWNLOAD_MAX_CHUNK_SIZE;
+        while (true) {
+            const chunk = await this.downloadChunk(fileId, { chunkSize, offset });
+            yield chunk;
+            if (chunk.length < chunkSize) {
+                break;
+            }
+            else {
+                offset += chunk.length;
+            }
+        }
+    }
+    /**
+     * Get custom emoji documents for download.
+     *
+     * @method fs
+     * @param id Identifier of one or more of custom emojis.
+     * @returns The custom emoji documents.
+     * @cache
+     */
+    async getCustomEmojiStickers(id) {
+        return await this.#dispatch("getCustomEmojiStickers", id);
+    }
+    //
+    // ========================= CHATS ========================= //
+    //
+    /**
+     * Get chats from a chat list. User-only.
+     *
+     * @method ch
+     */
+    async getChats(params) {
+        return await this.#dispatch("getChats", params);
+    }
+    /**
+     * Get a chat.
+     *
+     * @method ch
+     * @cache
+     */
+    async getChat(chatId) {
+        return await this.#dispatch("getChat", chatId);
+    }
+    /**
+     * Get chat history. User-only.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat.
+     */
+    async getHistory(chatId, params) {
+        return await this.#dispatch("getHistory", chatId, params);
+    }
+    /**
+     * Set a chat's available reactions. User-only.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat.
+     * @param availableReactions The new available reactions.
+     */
+    async setAvailableReactions(chatId, availableReactions) {
+        return await this.#dispatch("setAvailableReactions", chatId, availableReactions);
+    }
+    /**
+     * Set a chat's photo.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat.
+     * @param photo A photo to set as the chat's photo.
+     */
+    async setChatPhoto(chatId, photo, params) {
+        return await this.#dispatch("setChatPhoto", chatId, photo, params);
+    }
+    /**
+     * Delete a chat's photo.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat.
+     */
+    async deleteChatPhoto(chatId) {
+        return await this.#dispatch("deleteChatPhoto", chatId);
+    }
+    /**
+     * Ban a member from a chat.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat.
+     * @param memberId The identifier of the member.
+     */
+    async banChatMember(chatId, memberId, params) {
+        return await this.#dispatch("banChatMember", chatId, memberId, params);
+    }
+    /**
+     * Unban a member from a chat.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat. Must be a supergroup.
+     * @param memberId The identifier of the member.
+     */
+    async unbanChatMember(chatId, memberId) {
+        return await this.#dispatch("unbanChatMember", chatId, memberId);
+    }
+    /**
+     * Kick a member from a chat. Same as a banChatMember call followed by unbanChatMember.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat. Must be a supergroup.
+     * @param memberId The identifier of the member.
+     */
+    async kickChatMember(chatId, memberId) {
+        return await this.#dispatch("kickChatMember", chatId, memberId);
+    }
+    /**
+     * Set the rights of a chat member.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat. Must be a supergroup.
+     * @param memberId The identifier of the member.
+     */
+    async setChatMemberRights(chatId, memberId, params) {
+        return await this.#dispatch("setChatMemberRights", chatId, memberId, params);
+    }
+    /**
+     * Get the administrators of a chat.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat.
+     * @returns The chat's administrators.
+     */
+    async getChatAdministrators(chatId) {
+        return await this.#dispatch("getChatAdministrators", chatId);
+    }
+    /**
+     * Enable join requests in a chat. User-only.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat. Must be a channel or a supergroup.
+     */
+    async enableJoinRequests(chatId) {
+        return await this.#dispatch("enableJoinRequests", chatId);
+    }
+    /**
+     * Disable join requests in a chat. User-only.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat. Must be a channel or a supergroup.
+     */
+    async disableJoinRequests(chatId) {
+        return await this.#dispatch("disableJoinRequests", chatId);
+    }
+    /**
+     * Get inactive chats. User-only.
+     *
+     * @method ch
+     * @retuns A list of inactive chats the current user is member of.
+     */
+    async getInactiveChats() {
+        return await this.#dispatch("getInactiveChats");
+    }
+    /**
+     * Get the invite links created for a chat. User-only.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat.
+     * @returns The invite links created for the chat. This might be a subset of the results if they were less than `limit`. The parameters `afterDate` and `afterInviteLink` can be used for pagination.
+     */
+    async getCreatedInviteLinks(chatId, params) {
+        return await this.#dispatch("getCreatedInviteLinks", chatId, params);
+    }
+    /**
+     * Join a chat. User-only.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat.
+     */
+    async joinChat(chatId) {
+        return await this.#dispatch("joinChat", chatId);
+    }
+    /**
+     * Leave a chat.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat.
+     */
+    async leaveChat(chatId) {
+        return await this.#dispatch("leaveChat", chatId);
+    }
+    /**
+     * Get information on a user's chat membership.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat.
+     * @param userId The identifier of the user.
+     */
+    async getChatMember(chatId, userId) {
+        return await this.#dispatch("getChatMember", chatId, userId);
+    }
+    /**
+     * Get the members of a chat.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat.
+     */
+    async getChatMembers(chatId, params) {
+        return await this.#dispatch("getChatMembers", chatId, params);
+    }
+    /**
+     * Set a chat's sticker set.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat. Must be a supergroup.
+     * @param setName The name of the set.
+     */
+    async setChatStickerSet(chatId, setName) {
+        return await this.#dispatch("setChatStickerSet", chatId, setName);
+    }
+    /**
+     * Delete a chat's sticker set.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat. Must be a supergroup.
+     */
+    async deleteChatStickerSet(chatId) {
+        return await this.#dispatch("deleteChatStickerSet", chatId);
+    }
+    /**
+     * Set the number of boosts required to circument a chat's default restrictions. User-only.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat.
+     * @param boosts The number of boosts required to circumvent its restrictions.
+     */
+    async setBoostsRequiredToCircumventRestrictions(chatId, boosts) {
+        return await this.#dispatch("setBoostsRequiredToCircumventRestrictions", chatId, boosts);
+    }
+    /**
+     * Create an invite link.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat to create the invite link for.
+     * @returns The newly created invite link.
+     */
+    async createInviteLink(chatId, params) {
+        return await this.#dispatch("createInviteLink", chatId, params);
+    }
+    /**
+     * Approve a join request.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat with the join request.
+     * @param userId The user who made the join request.
+     */
+    async approveJoinRequest(chatId, userId) {
+        return await this.#dispatch("approveJoinRequest", chatId, userId);
+    }
+    /**
+     * Decline a join request.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat with the join request.
+     * @param userId The user who made the join request.
+     */
+    async declineJoinRequest(chatId, userId) {
+        return await this.#dispatch("declineJoinRequest", chatId, userId);
+    }
+    /**
+     * Approve all join requests. User-only.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat with the join requests.
+     */
+    async approveJoinRequests(chatId, params) {
+        return await this.#dispatch("approveJoinRequests", chatId, params);
+    }
+    /**
+     * Decline all join requests. User-only.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat with the join requests.
+     */
+    async declineJoinRequests(chatId, params) {
+        return await this.#dispatch("declineJoinRequests", chatId, params);
+    }
+    /**
+     * Get pending join requests in a chat. User-only.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat with the join requests.
+     */
+    async getJoinRequests(chatId, params) {
+        return await this.#dispatch("getJoinRequests", chatId, params);
+    }
+    /**
+     * Add a single user to a chat.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat to add the user to.
+     * @param userId The identifier of the user to add to the chat.
+     * @returns An array of FailedInvitation that has at most a length of 1. If empty, it means that the user was added.
+     */
+    async addChatMember(chatId, userId, params) {
+        return await this.#dispatch("addChatMember", chatId, userId, params);
+    }
+    /**
+     * Add multiple users at once to a channel or a supergroup.
+     *
+     * @method ch
+     * @param chatId The identifier of the channel or supergroup to add the users to.
+     * @param userId The identifiers of the users to add to the channel or supergroup.
+     * @returns An array of FailedInvitation that has at most a length that is the same as that of the parameter userIds. If empty, it means that all the provided users were added.
+     */
+    async addChatMembers(chatId, userIds) {
+        return await this.#dispatch("addChatMembers", chatId, userIds);
+    }
+    /**
+     * Open a chat.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat to open.
+     */
+    async openChat(chatId, params) {
+        return await this.#dispatch("openChat", chatId, params);
+    }
+    /**
+     * Close a chat previously opened by openChat.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat to close.
+     */
+    async closeChat(chatId) {
+        return await this.#dispatch("closeChat", chatId);
+    }
+    /**
+     * Create a group. User-only.
+     *
+     * @method ch
+     * @param title The title of the group.
+     * @returns The created group.
+     */
+    async createGroup(title, params) {
+        return await this.#dispatch("createGroup", title, params);
+    }
+    /**
+     * Create a supergroup. User-only.
+     *
+     * @method ch
+     * @param title The title of the supergroup.
+     * @returns The created supergroup.
+     */
+    async createSupergroup(title, params) {
+        return await this.#dispatch("createSupergroup", title, params);
+    }
+    /**
+     * Create a channel. User-only.
+     *
+     * @method ch
+     * @param title The title of the channel.
+     * @returns The created channel.
+     */
+    async createChannel(title, params) {
+        return await this.#dispatch("createChannel", title, params);
+    }
+    /**
+     * Set the time to live of the messages of a chat. User-only.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat.
+     * @param messageTtl The time to live of the messages in seconds.
+     */
+    async setMessageTtl(chatId, messageTtl) {
+        return await this.#dispatch("setMessageTtl", chatId, messageTtl);
+    }
+    /**
+     * Archive multiple chats. User-only.
+     *
+     * @method ch
+     * @param chatIds The identifiers of the chats to archive.
+     */
+    async archiveChats(chatIds) {
+        return await this.#dispatch("archiveChats", chatIds);
+    }
+    /**
+     * Archive a single chat. User-only.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat.
+     */
+    async archiveChat(chatId) {
+        return await this.#dispatch("archiveChat", chatId);
+    }
+    /**
+     * Unarchive multiple chats. User-only.
+     *
+     * @method ch
+     * @param chatIds The identifiers of the chats to unarchive.
+     */
+    async unarchiveChats(chatIds) {
+        return await this.#dispatch("unarchiveChats", chatIds);
+    }
+    /**
+     * Unarchive a single chat. User-only.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat.
+     */
+    async unarchiveChat(chatId) {
+        return await this.#dispatch("unarchiveChat", chatId);
+    }
+    /**
+     * Get common chats between a user and the current one. User-only.
+     *
+     * @method ch
+     * @param userId The identifier of the user to get the common chats with them.
+     */
+    async getCommonChats(userId, params) {
+        return await this.#dispatch("getCommonChats", userId, params);
+    }
+    /**
+     * Get the settings of a chat. User-only.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat.
+     */
+    async getChatSettings(chatId) {
+        return await this.#dispatch("getChatSettings", chatId);
+    }
+    /**
+     * Disable business bots in a private chat. User-only.
+     *
+     * @method ch
+     * @param chatId The identifier of the private chat to disable business bots in.
+     */
+    async disableBusinessBots(chatId) {
+        return await this.#dispatch("disableBusinessBots", chatId);
+    }
+    /**
+     * Enable business bots in a private chat. User-only.
+     *
+     * @method ch
+     * @param chatId The identifier of the private chat to enable business bots in.
+     */
+    async enableBusinessBots(chatId) {
+        return await this.#dispatch("enableBusinessBots", chatId);
+    }
+    /**
+     * Disable slow mode in a group. User-only.
+     *
+     * @method ch
+     * @param chatId The identifier of the group to disable slow mode in.
+     */
+    async disableSlowMode(chatId) {
+        return await this.#dispatch("disableSlowMode", chatId);
+    }
+    /**
+     * Change slow mode in a group. User-only.
+     *
+     * @method ch
+     * @param chatId The identifier of the group to change slow mode in.
+     * @param duration New slow mode duration.
+     */
+    async setSlowMode(chatId, duration) {
+        return await this.#dispatch("setSlowMode", chatId, duration);
+    }
+    /**
+     * Change the title of a chat.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat.
+     * @param title The new title.
+     */
+    async setChatTitle(chatId, title) {
+        return await this.#dispatch("setChatTitle", chatId, title);
+    }
+    /**
+     * Change the description of a chat.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat.
+     * @param description The new description.
+     */
+    async setChatDescription(chatId, description) {
+        return await this.#dispatch("setChatDescription", chatId, description);
+    }
+    /**
+     * Hide or show the member list of a group to non-admins. User-only.
+     *
+     * @method ch
+     * @param chatId The identifier of the group.
+     * @param visible Whether the member list of the group should be visible.
+     */
+    async setMemberListVisibility(chatId, visible) {
+        return await this.#dispatch("setMemberListVisibility", chatId, visible);
+    }
+    /**
+     * Enable or disable topics in a group. User-only.
+     *
+     * @method ch
+     * @param chatId The identifier of the group.
+     * @param enabled Whether topics should be enabled in the group.
+     * @param tabs Whether topics should be displayed as tabs.
+     */
+    async setTopicsEnabled(chatId, enabled, tabs) {
+        return await this.#dispatch("setTopicsEnabled", chatId, enabled, tabs);
+    }
+    /**
+     * Enable or disable automatic anti-spam in a group. User-only.
+     *
+     * @method ch
+     * @param chatId The identifier of the group.
+     * @param enabled Whether automatic anti-spam should be enabled in the group.
+     */
+    async setAntispamEnabled(chatId, enabled) {
+        return await this.#dispatch("setAntispamEnabled", chatId, enabled);
+    }
+    /**
+     * Enable or disable post signatures in a channel. User-only.
+     *
+     * @method ch
+     * @param chatId The identifier of the channel.
+     * @param enabled Whether post signatures should be enabled in the channel.
+     */
+    async setSignaturesEnabled(chatId, enabled, params) {
+        return await this.#dispatch("setSignaturesEnabled", chatId, enabled, params);
+    }
+    /**
+     * Delete a chat. User-only.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat.
+     */
+    async deleteChat(chatId) {
+        return await this.#dispatch("deleteChat", chatId);
+    }
+    /**
+     * Get discussion chat suggestions. User-only.
+     *
+     * @method ch
+     */
+    async getDiscussionChatSuggestions() {
+        return await this.#dispatch("getDiscussionChatSuggestions");
+    }
+    /**
+     * Set a channel's discussion chat. User-only.
+     *
+     * @method ch
+     * @param chatId The identifier of a channel.
+     * @param discussionChatId The identifier of a chat to use as discussion for the channel.
+     */
+    async setDiscussionChat(chatId, discussionChatId) {
+        return await this.#dispatch("setDiscussionChat", chatId, discussionChatId);
+    }
+    /**
+     * Transfer the ownership of a chat. User-only.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat.
+     * @param userId The identifier of the new owner.
+     * @param password The password of the current account.
+     */
+    async transferChatOwnership(chatId, userId, password) {
+        return await this.#dispatch("transferChatOwnership", chatId, userId, password);
+    }
+    /**
+     * Create a forum topic.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat.
+     * @param title The title of the topic.
+     * @returns The created topic.
+     */
+    async createTopic(chatId, title, params) {
+        return await this.#dispatch("createTopic", chatId, title, params);
+    }
+    /**
+     * Edit a forum topic.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat.
+     * @param topicId The identifier of the topic.
+     * @param title The new title of the topic.
+     * @returns The new topic.
+     */
+    async editTopic(chatId, topicId, title, params) {
+        return await this.#dispatch("editTopic", chatId, topicId, title, params);
+    }
+    /**
+     * Hide the general forum topic.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat.
+     */
+    async hideGeneralTopic(chatId) {
+        return await this.#dispatch("hideGeneralTopic", chatId);
+    }
+    /**
+     * Show the general forum topic.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat.
+     */
+    async showGeneralTopic(chatId) {
+        return await this.#dispatch("showGeneralTopic", chatId);
+    }
+    /**
+     * Close a forum topic.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat.
+     * @param topicId The identifier of the topic.
+     */
+    async closeTopic(chatId, topicId) {
+        return await this.#dispatch("closeTopic", chatId, topicId);
+    }
+    /**
+     * Reopen a forum topic.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat.
+     * @param topicId The identifier of the topic.
+     */
+    async reopenTopic(chatId, topicId) {
+        return await this.#dispatch("reopenTopic", chatId, topicId);
+    }
+    /**
+     * Pin a forum topic.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat.
+     * @param topicId The identifier of the topic.
+     */
+    async pinTopic(chatId, topicId) {
+        return await this.#dispatch("pinTopic", chatId, topicId);
+    }
+    /**
+     * Unpin a forum topic.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat.
+     * @param topicId The identifier of the topic.
+     */
+    async unpinTopic(chatId, topicId) {
+        return await this.#dispatch("unpinTopic", chatId, topicId);
+    }
+    /**
+     * Promote a chat member.
+     *
+     * @method ch
+     * @param chatId The identifier of a chat.
+     * @param userId The identifier of the user to promote.
+     */
+    async promoteChatMember(chatId, userId, params) {
+        return await this.#dispatch("promoteChatMember", chatId, userId, params);
+    }
+    //
+    // ========================= CALLBACK QUERIES ========================= //
+    //
+    /**
+     * Send a callback query. User-only.
+     *
+     * @method cq
+     * @param botId The identifier of the bot to send the callback query to.
+     * @param messageId The identifier of the message that includes at a button responsible for the callback query question.
+     * @param question The callback query's question.
+     * @returns The bot's answer to the callback query.
+     * @cache
+     */
+    async sendCallbackQuery(botId, messageId, question) {
+        return await this.#dispatch("sendCallbackQuery", botId, messageId, question);
+    }
+    /**
+     * Answer a callback query. Bot-only.
+     *
+     * @method cq
+     * @param id ID of the callback query to answer.
+     */
+    async answerCallbackQuery(id, params) {
+        return await this.#dispatch("answerCallbackQuery", id, params);
+    }
+    //
+    // ========================= INLINE QUERIES ========================= //
+    //
+    /**
+     * Send an inline query. User-only.
+     *
+     * @method iq
+     * @param botId The identifier of a bot to send the inline query to.
+     * @param chatId The identifier of the chat from which the inline query is sent.
+     * @returns The bot's answer to the inline query.
+     * @cache
+     */
+    async sendInlineQuery(botId, chatId, params) {
+        return await this.#dispatch("sendInlineQuery", botId, chatId, params);
+    }
+    /**
+     * Answer an inline query. Bot-only.
+     *
+     * @method iq
+     * @param id The identifier of the inline query to answer.
+     * @param results The results to answer with.
+     */
+    async answerInlineQuery(id, results, params) {
+        return await this.#dispatch("answerInlineQuery", id, results, params);
+    }
+    //
+    // ========================= BOTS ========================= //
+    //
+    /**
+     * Set the bot's description in the given language. Bot-only.
+     *
+     * @method bs
+     */
+    async setMyDescription(params) {
+        return await this.#dispatch("setMyDescription", params);
+    }
+    /**
+     * Set the bot's name in the given language. Bot-only.
+     *
+     * @method bs
+     */
+    async setMyName(params) {
+        return await this.#dispatch("setMyName", params);
+    }
+    /**
+     * Set the bot's short description in the given language. Bot-only.
+     *
+     * @method bs
+     */
+    async setMyShortDescription(params) {
+        return await this.#dispatch("setMyShortDescription", params);
+    }
+    /**
+     * Get the bot's description in the given language. Bot-only.
+     *
+     * @method bs
+     * @returns The current bot's description in the specified language.
+     */
+    async getMyDescription(params) {
+        return await this.#dispatch("getMyDescription", params);
+    }
+    /**
+     * Get the bot's name in the given language. Bot-only.
+     *
+     * @method bs
+     * @returns The current bot's name in the specified language.
+     */
+    async getMyName(params) {
+        return await this.#dispatch("getMyName", params);
+    }
+    /**
+     * Get the bot's short description in the given language. Bot-only.
+     *
+     * @method bs
+     * @returns The current bot's short description in the specified language.
+     */
+    async getMyShortDescription(params) {
+        return await this.#dispatch("getMyShortDescription", params);
+    }
+    /**
+     * Set the bot's commands in the given scope and/or language. Bot-only.
+     *
+     * @method bs
+     * @param commands The commands to set.
+     */
+    async setMyCommands(commands, params) {
+        return await this.#dispatch("setMyCommands", commands, params);
+    }
+    /**
+     * Get the bot's commands in the given scope and/or language. Bot-only.
+     *
+     * @method bs
+     * @returns The current bot's commands in the specified language.
+     */
+    async getMyCommands(params) {
+        return await this.#dispatch("getMyCommands", params);
+    }
+    //
+    // ========================= REACTIONS ========================= //
+    //
+    /**
+     * Change reactions made to a message.
+     *
+     * @method re
+     * @param chatId The identifier of the chat which the message belongs to.
+     * @param messageId The identifier of the message to add the reaction to.
+     * @param reactions The new reactions.
+     */
+    async setReactions(chatId, messageId, reactions, params) {
+        return await this.#dispatch("setReactions", chatId, messageId, reactions, params);
+    }
+    /**
+     * Make a reaction to a message.
+     *
+     * @method re
+     * @param chatId The identifier of the chat which the message belongs to.
+     * @param messageId The identifier of the message to add the reaction to.
+     * @param reaction The reaction to add.
+     */
+    async addReaction(chatId, messageId, reaction, params) {
+        return await this.#dispatch("addReaction", chatId, messageId, reaction, params);
+    }
+    /**
+     * Undo a reaction made to a message.
+     *
+     * @method re
+     * @param chatId The identifier of the chat which the message belongs to.
+     * @param messageId The identifier of the message which the reaction was made to.
+     * @param reaction The reaction to remove.
+     */
+    async removeReaction(chatId, messageId, reaction) {
+        return await this.#dispatch("removeReaction", chatId, messageId, reaction);
+    }
+    //
+    // ========================= STORIES ========================= //
+    //
+    /**
+     * Create a story. User-only.
+     *
+     * @method st
+     * @param content The content of the story.
+     * @returns The created story.
+     */
+    async createStory(chatId, content, params) {
+        return await this.#dispatch("createStory", chatId, content, params);
+    }
+    /**
+     * Retrieve multiple stories. User-only.
+     *
+     * @method st
+     * @param chatId The identifier of a chat.
+     * @param storyIds The identifiers of the stories to retrieve.
+     * @returns The retrieved stories.
+     */
+    async getStories(chatId, storyIds) {
+        return await this.#dispatch("getStories", chatId, storyIds);
+    }
+    /**
+     * Retrieve a single story. User-only.
+     *
+     * @method st
+     * @param chatId The identifier of a chat.
+     * @param storyId The identifier of the story to retrieve.
+     * @returns The retrieved story.
+     */
+    async getStory(chatId, storyId) {
+        return await this.#dispatch("getStory", chatId, storyId);
+    }
+    /**
+     * Delete multiple stories. User-only.
+     *
+     * @method st
+     * @param chatId The identifier of a chat.
+     * @param storyIds The identifiers of the stories to delete.
+     */
+    async deleteStories(chatId, storyIds) {
+        return await this.#dispatch("deleteStories", chatId, storyIds);
+    }
+    /**
+     * Delete a single story. User-only.
+     *
+     * @method st
+     * @param chatId The identifier of a chat.
+     * @param storyId The identifier of the story to delete.
+     */
+    async deleteStory(chatId, storyId) {
+        return await this.#dispatch("deleteStory", chatId, storyId);
+    }
+    /**
+     * Add multiple stories to highlights. User-only.
+     *
+     * @method st
+     * @param chatId The identifier of a chat.
+     * @param storyIds The identifiers of the stories to add to highlights.
+     */
+    async addStoriesToHighlights(chatId, storyIds) {
+        return await this.#dispatch("addStoriesToHighlights", chatId, storyIds);
+    }
+    /**
+     * Add a single story to highlights. User-only.
+     *
+     * @method st
+     * @param chatId The identifier of a chat.
+     * @param storyId The identifier of the story to add to highlights.
+     */
+    async addStoryToHighlights(chatId, storyId) {
+        return await this.#dispatch("addStoryToHighlights", chatId, storyId);
+    }
+    /**
+     * Remove multiple stories from highlights. User-only.
+     *
+     * @method st
+     * @param chatId The identifier of a chat.
+     * @param storyIds The identifiers of the stories to remove from highlights.
+     */
+    async removeStoriesFromHighlights(chatId, storyIds) {
+        return await this.#dispatch("removeStoriesFromHighlights", chatId, storyIds);
+    }
+    /**
+     * Remove a single story from highlights. User-only.
+     *
+     * @method st
+     * @param chatId The identifier of a chat.
+     * @param storyId The identifier of the story to remove from highlights.
+     */
+    async removeStoryFromHighlights(chatId, storyId) {
+        return await this.#dispatch("removeStoryFromHighlights", chatId, storyId);
+    }
+    //
+    // ========================= MISC ========================= //
+    //
+    /**
+     * Get network statistics. This might not always be available.
+     *
+     * @method mc
+     */
+    async getNetworkStatistics() {
+        return await this.#dispatch("getNetworkStatistics");
+    }
+    /**
+     * Block a user. User-only.
+     *
+     * @method mc
+     * @param userId The identifier of the user to block.
+     */
+    async blockUser(userId) {
+        return await this.#dispatch("blockUser", userId);
+    }
+    /**
+     * Unblock a user. User-only.
+     *
+     * @method mc
+     * @param userId The identifier of the user to unblock.
+     */
+    async unblockUser(userId) {
+        return await this.#dispatch("unblockUser", userId);
+    }
+    //
+    // ========================= VIDEO CHATS ========================= //
+    //
+    /**
+     * Start a video chat. User-only.
+     *
+     * @method vc
+     * @param chatId The identifier of a chat to start the video chat in.
+     * @returns The started video chat.
+     */
+    async startVideoChat(chatId, params) {
+        return await this.#dispatch("startVideoChat", chatId, params);
+    }
+    /**
+     * Schedule a video chat. User-only.
+     *
+     * @method vc
+     * @param chatId The identifier of a chat to schedule the video chat in.
+     * @param startAt A point in time within the future in which the video chat will be started.
+     * @returns The scheduled video chat.
+     */
+    async scheduleVideoChat(chatId, startAt, params) {
+        return await this.#dispatch("scheduleVideoChat", chatId, startAt, params);
+    }
+    /**
+     * Join a video chat. User-only.
+     *
+     * @method vc
+     * @param id The identifier of a video chat retrieved from getChat, startVideoChat, or scheduleVideoChat.
+     * @param params_ WebRTC connection parameters.
+     * @returns Parameters to be passed to the used WebRTC library.
+     */
+    async joinVideoChat(id, params_, params) {
+        return await this.#dispatch("joinVideoChat", id, params_, params);
+    }
+    /**
+     * Leave a video chat. User-only.
+     *
+     * @method vc
+     * @param id The identifier of a video chat retrieved from getChat, startVideoChat, or scheduleVideoChat.
+     */
+    async leaveVideoChat(id) {
+        return await this.#dispatch("leaveVideoChat", id);
+    }
+    /**
+     * Join a live stream. User-only.
+     *
+     * @method vc
+     * @param id The identifier of a video chat retrieved from getChat, startVideoChat, or scheduleVideoChat.
+     */
+    async joinLiveStream(id) {
+        return await this.#dispatch("joinLiveStream", id);
+    }
+    /**
+     * Get a video chat. User-only.
+     *
+     * @method vc
+     * @param id The identifier of a video chat retrieved from getChat, startVideoChat, or scheduleVideoChat.
+     * @cache
+     */
+    async getVideoChat(id) {
+        return await this.#dispatch("getVideoChat", id);
+    }
+    /**
+     * Get live stream channels. User-only.
+     *
+     * @method vc
+     * @param id The identifier of a video chat retrieved from getChat, startVideoChat, or scheduleVideoChat.
+     */
+    async getLiveStreamChannels(id) {
+        return await this.#dispatch("getLiveStreamChannels", id);
+    }
+    /**
+     * Download a live stream segment. User-only.
+     *
+     * @method vc
+     * @param id The identifier of a video chat retrieved from getChat, startVideoChat, or scheduleVideoChat.
+     * @param channelId Stream channel ID.
+     * @param scale Stream channel scale.
+     * @param timestamp Millisecond timestamp of the chunk to download.
+     */
+    async downloadLiveStreamSegment(id, channelId, scale, timestamp, params) {
+        return await this.#dispatch("downloadLiveStreamSegment", id, channelId, scale, timestamp, params);
+    }
+    //
+    // ========================= PAYMENTS ========================= //
+    //
+    /**
+     * Answer a pre-checkout query. Bot-only.
+     *
+     * @method pa
+     * @param preCheckoutQueryId The identifier of the pre-checkout query.
+     * @param ok Whether the checkout is going to be processed.
+     */
+    async answerPreCheckoutQuery(preCheckoutQueryId, ok, params) {
+        return await this.#dispatch("answerPreCheckoutQuery", preCheckoutQueryId, ok, params);
+    }
+    /**
+     * Refund a star payment. Bot-only.
+     *
+     * @method pa
+     * @param userId The identifier of the user that was charged.
+     * @param telegramPaymentChargeId The identifier of the charge.
+     */
+    async refundStarPayment(userId, telegramPaymentChargeId) {
+        return await this.#dispatch("refundStarPayment", userId, telegramPaymentChargeId);
+    }
+    //
+    // ========================= CONTACTS ========================= //
+    //
+    /**
+     * Get contacts. User-only.
+     *
+     * @method co
+     */
+    async getContacts() {
+        return await this.#dispatch("getContacts");
+    }
+    /**
+     * Delete multiple contacts. User-only.
+     *
+     * @method co
+     * @param userIds The identifiers of contacts to delete.
+     */
+    async deleteContacts(userIds) {
+        return await this.#dispatch("deleteContacts", userIds);
+    }
+    /**
+     * Delete a single contact. User-only.
+     *
+     * @method co
+     * @param userId The identifier of the contact to delete.
+     */
+    async deleteContact(userId) {
+        return await this.#dispatch("deleteContact", userId);
+    }
+    /**
+     * Add a contact. User-only.
+     *
+     * @method co
+     * @param userId The identifier of the user to add as contact.
+     */
+    async addContact(userId, params) {
+        return await this.#dispatch("addContact", userId, params);
+    }
+    //
+    // ========================= TRANSLATIONS ========================= //
+    //
+    /**
+     * Get translations. User-only.
+     *
+     * @method ta
+     * @cache
+     */
+    async getTranslations(params) {
+        return await this.#dispatch("getTranslations", params);
+    }
+    //
+    // ========================= GIFTS ========================= //
+    //
+    /**
+     * Get available gifts.
+     *
+     * @method gf
+     */
+    async getGifts() {
+        return await this.#dispatch("getGifts");
+    }
+    /**
+     * Get gifts claimed by a user or a channel. User-only.
+     *
+     * @method gf
+     * @param chatId The identifier of a user or a channel to get gifts for.
+     */
+    async getClaimedGifts(chatId, params) {
+        return await this.#dispatch("getClaimedGifts", chatId, params);
+    }
+    /**
+     * Send a gift.
+     *
+     * @method gf
+     * @param chatId The identifier of a user or a channel to send the gift to.
+     * @param giftId The identifier of the gift to send.
+     */
+    async sendGift(chatId, giftId, params) {
+        return await this.#dispatch("sendGift", chatId, giftId, params);
+    }
+    /**
+     * Sell a gift.
+     *
+     * @method gf
+     * @param userId The identifier of the user that sent the gift.
+     * @param messageId The identifier of the service message announcing the receival of the gift.
+     */
+    async sellGift(userId, messageId) {
+        return await this.#dispatch("sellGift", userId, messageId);
+    }
+    /**
+     * Get a gift using its slug.
+     *
+     * @method gf
+     * @param slug The slug of a gift.
+     */
+    async getGift(slug) {
+        return await this.#dispatch("getGift", slug);
+    }
+}