@mtcute/core 0.16.7 → 0.16.9

package/highlevel/methods/messages/iter-search-messages.d.ts

@@ -0,0 +1,26 @@
+import { ITelegramClient } from '../../client.types.js';
+import { Message } from '../../types/index.js';
+import { searchMessages } from './search-messages.js';
+/**
+ * Search for messages inside a specific chat
+ *
+ * Iterable version of {@link searchMessages}
+ *
+ * @param chatId  Chat's marked ID, its username, phone or `"me"` or `"self"`.
+ * @param params  Additional search parameters
+ */
+export declare function iterSearchMessages(client: ITelegramClient, params?: Parameters<typeof searchMessages>[1] & {
+    /**
+     * Limits the number of messages to be retrieved.
+     *
+     * @default  `Infinity`, i.e. all messages are returned
+     */
+    limit?: number;
+    /**
+     * Chunk size, which will be passed as `limit` parameter
+     * for `messages.search`. Usually you shouldn't care about this.
+     *
+     * @default  `100`
+     */
+    chunkSize?: number;
+}): AsyncIterableIterator<Message>;

package/highlevel/methods/messages/pin-message.d.ts

@@ -0,0 +1,21 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputMessageId, Message } from '../../types/index.js';
+/**
+ * Pin a message in a group, supergroup, channel or PM.
+ *
+ * For supergroups/channels, you must have appropriate permissions,
+ * either as an admin, or as default permissions
+ *
+ * @returns  Service message about pinned message, if one was generated.
+ */
+export declare function pinMessage(client: ITelegramClient, params: InputMessageId & {
+    /** Whether to send a notification (only for legacy groups and supergroups) */
+    notify?: boolean;
+    /** Whether to pin for both sides (only for private chats) */
+    bothSides?: boolean;
+    /**
+     * Whether to dispatch the returned service message (if any)
+     * to the client's update handler.
+     */
+    shouldDispatch?: true;
+}): Promise<Message | null>;

package/highlevel/methods/messages/read-history.d.ts

@@ -0,0 +1,24 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike } from '../../types/index.js';
+/**
+ * Mark chat history as read.
+ *
+ * @param chatId  Chat ID
+ */
+export declare function readHistory(client: ITelegramClient, chatId: InputPeerLike, params?: {
+    /**
+     * Message up until which to read history
+     *
+     * @default  0, i.e. read everything
+     */
+    maxId?: number;
+    /**
+     * Whether to also clear all mentions in the chat
+     */
+    clearMentions?: boolean;
+    /**
+     * Whether to dispatch updates that will be generated by this call.
+     * Doesn't follow `disableNoDispatch`
+     */
+    shouldDispatch?: true;
+}): Promise<void>;

package/highlevel/methods/messages/read-reactions.d.ts

@@ -0,0 +1,14 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike } from '../../types/index.js';
+/**
+ * Mark all reactions in chat as read.
+ *
+ * @param chatId  Chat ID
+ */
+export declare function readReactions(client: ITelegramClient, chatId: InputPeerLike, params?: {
+    /**
+     * Whether to dispatch updates that will be generated by this call.
+     * Doesn't follow `disableNoDispatch`
+     */
+    shouldDispatch?: true;
+}): Promise<void>;

package/highlevel/methods/messages/search-global.d.ts

@@ -0,0 +1,51 @@
+import { tl } from '@mtcute/tl';
+import { ITelegramClient } from '../../client.types.js';
+import { ArrayPaginated, Message } from '../../types/index.js';
+export interface SearchGlobalOffset {
+    rate: number;
+    peer: tl.TypeInputPeer;
+    id: number;
+}
+/**
+ * Search for messages globally from all of your chats
+ *
+ * **Note**: Due to Telegram limitations, you can only get up to ~10000 messages
+ *
+ * @param params  Search parameters
+ */
+export declare function searchGlobal(client: ITelegramClient, params?: {
+    /**
+     * Text query string. Use `"@"` to search for mentions.
+     *
+     * @default `""` (empty string)
+     */
+    query?: string;
+    /**
+     * Limits the number of messages to be retrieved.
+     *
+     * @default  100
+     */
+    limit?: number;
+    /**
+     * Filter the results using some filter. (see {@link SearchFilters})
+     *
+     * @default  {@link SearchFilters.Empty} (i.e. will return all messages)
+     */
+    filter?: tl.TypeMessagesFilter;
+    /**
+     * Offset data used for pagination
+     */
+    offset?: SearchGlobalOffset;
+    /**
+     * Only return messages newer than this date
+     */
+    minDate?: Date | number;
+    /**
+     * Only return messages older than this date
+     */
+    maxDate?: Date | number;
+    /**
+     * Whether to only search across broadcast channels
+     */
+    onlyChannels?: boolean;
+}): Promise<ArrayPaginated<Message, SearchGlobalOffset>>;

package/highlevel/methods/messages/search-hashtag.d.ts

@@ -0,0 +1,44 @@
+import { tl } from '@mtcute/tl';
+import { ITelegramClient } from '../../client.types.js';
+import { Message } from '../../types/index.js';
+import { ArrayPaginated } from '../../types/utils.js';
+export interface SearchHashtagOffset {
+    rate: number;
+    peer: tl.TypeInputPeer;
+    id: number;
+}
+/**
+ * Perform a global hashtag search, across the entire Telegram
+ *
+ * @param hashtag  Hashtag to search for
+ * @param params  Additional parameters
+ */
+export declare function searchHashtag(client: ITelegramClient, hashtag: string, params?: {
+    /** Offset for the search */
+    offset?: SearchHashtagOffset;
+    /** Limit the number of results */
+    limit?: number;
+}): Promise<ArrayPaginated<Message, SearchHashtagOffset>>;
+/**
+ * Perform a global hashtag search, across the entire Telegram
+ *
+ * Iterable version of {@link searchHashtag}
+ *
+ * @param hashtag  Hashtag to search for
+ * @param params  Additional parameters
+ */
+export declare function iterSearchHashtag(client: ITelegramClient, hashtag: string, params?: Parameters<typeof searchHashtag>[2] & {
+    /**
+     * Limits the number of messages to be retrieved.
+     *
+     * @default  `Infinity`, i.e. all messages are returned
+     */
+    limit?: number;
+    /**
+     * Chunk size, which will be passed as `limit` parameter
+     * for `messages.search`. Usually you shouldn't care about this.
+     *
+     * @default  100
+     */
+    chunkSize?: number;
+}): AsyncIterableIterator<Message>;

package/highlevel/methods/messages/search-messages.d.ts

@@ -0,0 +1,93 @@
+import { tl } from '@mtcute/tl';
+import { ITelegramClient } from '../../client.types.js';
+import { ArrayPaginated, InputPeerLike, Message } from '../../types/index.js';
+export type SearchMessagesOffset = number;
+/**
+ * Search for messages inside a specific chat
+ *
+ * @param chatId  Chat's marked ID, its username, phone or `"me"` or `"self"`.
+ * @param params  Additional search parameters
+ */
+export declare function searchMessages(client: ITelegramClient, params?: {
+    /**
+     * Text query string. Required for text-only messages,
+     * optional for media.
+     *
+     * @default  `""` (empty string)
+     */
+    query?: string;
+    /**
+     * Chat where to search for messages.
+     *
+     * When empty, will search across common message box (i.e. private messages and legacy chats)
+     */
+    chatId?: InputPeerLike;
+    /**
+     * Offset ID for the search. Only messages earlier than this ID will be returned.
+     *
+     * @default  `0` (starting from the latest message).
+     */
+    offset?: SearchMessagesOffset;
+    /**
+     * Additional offset from {@link offset}, in resulting messages.
+     *
+     * This can be used for advanced use cases, like:
+     * - Loading 20 results newer than message with ID `MSGID`:
+     *   `offset = MSGID, addOffset = -20, limit = 20`
+     * - Loading 20 results around message with ID `MSGID`:
+     *   `offset = MSGID, addOffset = -10, limit = 20`
+     *
+     * When {@link offset} is not set, this will be relative to the last message
+     *
+     * @default  `0` (disabled)
+     */
+    addOffset?: number;
+    /**
+     * Minimum message ID to return
+     *
+     * @default  `0` (disabled).
+     */
+    minId?: number;
+    /**
+     * Maximum message ID to return.
+     *
+     * Unless {@link addOffset} is used, this will work the same as {@link offset}.
+     *
+     * @default  `0` (disabled).
+     */
+    maxId?: number;
+    /**
+     * Minimum message date to return
+     *
+     * @default  `0` (disabled).
+     */
+    minDate?: number | Date;
+    /**
+     * Maximum message date to return
+     *
+     * @default  `0` (disabled).
+     */
+    maxDate?: number | Date;
+    /**
+     * Thread ID to return only messages from this thread.
+     */
+    threadId?: number;
+    /**
+     * Limits the number of messages to be retrieved.
+     *
+     * @default  100
+     */
+    limit?: number;
+    /**
+     * Filter the results using some filter (see {@link SearchFilters})
+     *
+     * @default  {@link SearchFilters.Empty} (i.e. will return all messages)
+     */
+    filter?: tl.TypeMessagesFilter;
+    /**
+     * Search only for messages sent by a specific user.
+     *
+     * You can pass their marked ID, username, phone or `"me"` or `"self"`
+     */
+    fromUser?: InputPeerLike;
+}): Promise<ArrayPaginated<Message, SearchMessagesOffset>>;

package/highlevel/methods/messages/send-answer.d.ts

@@ -0,0 +1,12 @@
+import { ITelegramClient } from '../../client.types.js';
+import { Message } from '../../types/messages/message.js';
+import { ParametersSkip2 } from '../../types/utils.js';
+import { sendMedia } from './send-media.js';
+import { sendMediaGroup } from './send-media-group.js';
+import { sendText } from './send-text.js';
+/** Send a text to the same chat (and topic, if applicable) as a given message */
+export declare function answerText(client: ITelegramClient, message: Message, ...params: ParametersSkip2<typeof sendText>): ReturnType<typeof sendText>;
+/** Send a media to the same chat (and topic, if applicable) as a given message */
+export declare function answerMedia(client: ITelegramClient, message: Message, ...params: ParametersSkip2<typeof sendMedia>): ReturnType<typeof sendMedia>;
+/** Send a media group to the same chat (and topic, if applicable) as a given message */
+export declare function answerMediaGroup(client: ITelegramClient, message: Message, ...params: ParametersSkip2<typeof sendMediaGroup>): ReturnType<typeof sendMediaGroup>;

package/highlevel/methods/messages/send-comment.d.ts

@@ -0,0 +1,39 @@
+import { ITelegramClient } from '../../client.types.js';
+import { Message } from '../../types/messages/message.js';
+import { ParametersSkip2 } from '../../types/utils.js';
+import { sendMedia } from './send-media.js';
+import { sendMediaGroup } from './send-media-group.js';
+import { sendText } from './send-text.js';
+/**
+ * Send a text comment to a given message.
+ *
+ * If this is a normal message (not a channel post),
+ * a simple reply will be sent.
+ *
+ * @throws MtArgumentError
+ *     If this is a channel post which does not have comments section.
+ *     To check if a post has comments, use {@link Message#replies}.hasComments
+ */
+export declare function commentText(client: ITelegramClient, message: Message, ...params: ParametersSkip2<typeof sendText>): ReturnType<typeof sendText>;
+/**
+ * Send a text comment to a given message.
+ *
+ * If this is a normal message (not a channel post),
+ * a simple reply will be sent.
+ *
+ * @throws MtArgumentError
+ *     If this is a channel post which does not have comments section.
+ *     To check if a post has comments, use {@link Message#replies}.hasComments
+ */
+export declare function commentMedia(client: ITelegramClient, message: Message, ...params: ParametersSkip2<typeof sendMedia>): ReturnType<typeof sendMedia>;
+/**
+ * Send a text comment to a given message.
+ *
+ * If this is a normal message (not a channel post),
+ * a simple reply will be sent.
+ *
+ * @throws MtArgumentError
+ *     If this is a channel post which does not have comments section.
+ *     To check if a post has comments, use {@link Message#replies}.hasComments
+ */
+export declare function commentMediaGroup(client: ITelegramClient, message: Message, ...params: ParametersSkip2<typeof sendMediaGroup>): ReturnType<typeof sendMediaGroup>;

package/highlevel/methods/messages/send-common.d.ts

@@ -0,0 +1,116 @@
+import { tl } from '@mtcute/tl';
+import { ITelegramClient } from '../../client.types.js';
+import { Message } from '../../types/messages/message.js';
+import { TextWithEntities } from '../../types/misc/entities.js';
+import { InputPeerLike } from '../../types/peers/index.js';
+export interface CommonSendParams {
+    /**
+     * Message to reply to. Either a message object or message ID.
+     *
+     * For forums - can also be an ID of the topic (i.e. its top message ID)
+     *
+     * Can also be a message from another chat, in which case a quote will be sent.
+     */
+    replyTo?: number | Message;
+    /**
+     * Whether to throw an error if {@link replyTo}
+     * message does not exist.
+     *
+     * If that message was not found, `NotFoundError` is thrown,
+     * with `text` set to `MESSAGE_NOT_FOUND`.
+     *
+     * Incurs an additional request, so only use when really needed.
+     *
+     * @default  `false`
+     */
+    mustReply?: boolean;
+    /**
+     * Message to comment to. Either a message object or message ID.
+     *
+     * This overwrites `replyTo` if it was passed
+     */
+    commentTo?: number | Message;
+    /**
+     * Story to reply to.
+     *
+     * Must be the story sent by the peer you are sending the message to.
+     *
+     * Can't be used together with {@link replyTo} or {@link commentTo}.
+     */
+    replyToStory?: number;
+    /**
+     * Quoted text. Must be exactly contained in the message
+     * being quoted to be accepted by the server (as well as entities)
+     */
+    quote?: TextWithEntities;
+    /**
+     * Offset of the start of the quote in the message.
+     */
+    quoteOffset?: number;
+    /**
+     * Whether to send this message silently.
+     */
+    silent?: boolean;
+    /**
+     * If set, the message will be scheduled to this date.
+     * When passing a number, a UNIX time in ms is expected.
+     *
+     * You can also pass `online` - this will send the message
+     * once the peer is online. Note that this requires that
+     * peer's online status to be visible to you.
+     */
+    schedule?: Date | number | 'online';
+    /**
+     * Whether to clear draft after sending this message.
+     *
+     * @default  `false`
+     */
+    clearDraft?: boolean;
+    /**
+     * Whether to disallow further forwards of this message.
+     *
+     * Only for bots, works even if the target chat does not
+     * have content protection.
+     */
+    forbidForwards?: boolean;
+    /**
+     * Peer to use when sending the message.
+     */
+    sendAs?: InputPeerLike;
+    /**
+     * If passed, instead of sending the message, it will be saved into the
+     * given quick reply shortcut (either its ID or its shortcut string).
+     */
+    quickReply?: number | string;
+    /**
+     * Whether to dispatch the returned message to the client's update handler.
+     * Doesn't follow `disableNoDispatch`
+     */
+    shouldDispatch?: true;
+    /**
+     * Unique identifier of the business connection on behalf of which
+     * the message will be sent
+     */
+    businessConnectionId?: string;
+    /**
+     * ID of a message effect to use when sending the message
+     * (see {@link TelegramClient.getAvailableMessageEffects})
+     */
+    effect?: tl.Long;
+}
+/**
+ * @internal
+ * @noemit
+ */
+export declare function _normalizeQuickReplyShortcut(shortcut: number | string | undefined): tl.TypeInputQuickReplyShortcut | undefined;
+/**
+ * @internal
+ * @noemit
+ */
+export declare function _processCommonSendParameters(client: ITelegramClient, chatId: InputPeerLike, params: CommonSendParams): Promise<{
+    peer: tl.TypeInputPeer;
+    replyTo: tl.TypeInputReplyTo | undefined;
+    scheduleDate: number | undefined;
+    quickReplyShortcut: tl.TypeInputQuickReplyShortcut | undefined;
+    chainId: string;
+}>;

package/highlevel/methods/messages/send-copy-group.d.ts

@@ -0,0 +1,21 @@
+import { ITelegramClient } from '../../client.types.js';
+import { Message } from '../../types/messages/message.js';
+import { InputPeerLike } from '../../types/peers/index.js';
+import { CommonSendParams } from './send-common.js';
+export interface SendCopyGroupParams extends CommonSendParams {
+    /** Destination chat ID */
+    toChatId: InputPeerLike;
+}
+/**
+ * Copy a message group (i.e. send the same message group, but do not forward it).
+ *
+ * Note that all the provided messages must be in the same message group
+ */
+export declare function sendCopyGroup(client: ITelegramClient, params: SendCopyGroupParams & ({
+    /** Source chat ID */
+    fromChatId: InputPeerLike;
+    /** Message IDs to forward */
+    messages: number[];
+} | {
+    messages: Message[];
+})): Promise<Message[]>;

package/highlevel/methods/messages/send-copy.d.ts

@@ -0,0 +1,32 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, InputText, Message, ReplyMarkup } from '../../types/index.js';
+import { CommonSendParams } from './send-common.js';
+export interface SendCopyParams extends CommonSendParams {
+    /** Target chat ID */
+    toChatId: InputPeerLike;
+    /**
+     * New message caption (only used for media)
+     */
+    caption?: InputText;
+    /**
+     * For bots: inline or reply markup or an instruction
+     * to hide a reply keyboard or to force a reply.
+     */
+    replyMarkup?: ReplyMarkup;
+}
+/**
+ * Copy a message (i.e. send the same message, but do not forward it).
+ *
+ * Note that if the message contains a webpage,
+ * it will be copied simply as a text message,
+ * and if the message contains an invoice,
+ * it can't be copied.
+ */
+export declare function sendCopy(client: ITelegramClient, params: SendCopyParams & ({
+    /** Source chat ID */
+    fromChatId: InputPeerLike;
+    /** Message ID to forward */
+    message: number;
+} | {
+    message: Message;
+})): Promise<Message>;

package/highlevel/methods/messages/send-media-group.d.ts

@@ -0,0 +1,35 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputMediaLike } from '../../types/media/input-media/types.js';
+import { Message } from '../../types/messages/message.js';
+import { InputPeerLike } from '../../types/peers/index.js';
+import { CommonSendParams } from './send-common.js';
+/**
+ * Send a group of media.
+ *
+ * To add a caption to the group, add caption to the first
+ * media in the group and don't add caption for any other.
+ *
+ * @param chatId  ID of the chat, its username, phone or `"me"` or `"self"`
+ * @param medias  Medias contained in the message.
+ * @param params  Additional sending parameters
+ * @link InputMedia
+ */
+export declare function sendMediaGroup(client: ITelegramClient, chatId: InputPeerLike, medias: (InputMediaLike | string)[], params?: CommonSendParams & {
+    /**
+     * Whether to invert media position.
+     *
+     * Currently only supported for web previews and makes the
+     * client render the preview above the caption and not below.
+     */
+    invertMedia?: boolean;
+    /**
+     * Function that will be called after some part has been uploaded.
+     * Only used when a file that requires uploading is passed,
+     * and not used when uploading a thumbnail.
+     *
+     * @param index  Index of the media in the original array
+     * @param uploaded  Number of bytes already uploaded
+     * @param total  Total file size
+     */
+    progressCallback?: (index: number, uploaded: number, total: number) => void;
+}): Promise<Message[]>;

package/highlevel/methods/messages/send-media.d.ts

@@ -0,0 +1,48 @@
+import { ITelegramClient } from '../../client.types.js';
+import { ReplyMarkup } from '../../types/bots/keyboards/index.js';
+import { InputMediaLike } from '../../types/media/input-media/types.js';
+import { Message } from '../../types/messages/message.js';
+import { InputText } from '../../types/misc/entities.js';
+import { InputPeerLike } from '../../types/peers/index.js';
+import { CommonSendParams } from './send-common.js';
+/**
+ * Send a single media (a photo or a document-based media)
+ *
+ * @param chatId  ID of the chat, its username, phone or `"me"` or `"self"`
+ * @param media
+ *     Media contained in the message. You can also pass TDLib
+ *     and Bot API compatible File ID, which will be wrapped
+ *     in {@link InputMedia.auto}
+ * @param params  Additional sending parameters
+ * @link InputMedia
+ */
+export declare function sendMedia(client: ITelegramClient, chatId: InputPeerLike, media: InputMediaLike | string, params?: CommonSendParams & {
+    /**
+     * For bots: inline or reply markup or an instruction
+     * to hide a reply keyboard or to force a reply.
+     */
+    replyMarkup?: ReplyMarkup;
+    /**
+     * Whether to invert media position.
+     *
+     * Currently only supported for web previews and makes the
+     * client render the preview above the caption and not below.
+     */
+    invert?: boolean;
+    /**
+     * Override caption for `media`.
+     *
+     * Can be used, for example. when using File IDs
+     * or when using existing InputMedia objects.
+     */
+    caption?: InputText;
+    /**
+     * Function that will be called after some part has been uploaded.
+     * Only used when a file that requires uploading is passed,
+     * and not used when uploading a thumbnail.
+     *
+     * @param uploaded  Number of bytes already uploaded
+     * @param total  Total file size
+     */
+    progressCallback?: (uploaded: number, total: number) => void;
+}): Promise<Message>;

package/highlevel/methods/messages/send-paid-reaction.d.ts

@@ -0,0 +1,24 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputMessageId, MessageReactions } from '../../types/index.js';
+/**
+ * Send a paid reaction using Telegram Stars.
+ *
+ * @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.
+ */
+export declare function sendPaidReaction(client: ITelegramClient, 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>;

package/highlevel/methods/messages/send-quote.d.ts

@@ -0,0 +1,33 @@
+import { ITelegramClient } from '../../client.types.js';
+import { Message } from '../../types/messages/message.js';
+import { InputPeerLike } from '../../types/peers/peer.js';
+import { sendMedia } from './send-media.js';
+import { sendMediaGroup } from './send-media-group.js';
+import { sendText } from './send-text.js';
+export type QuoteParamsFrom<T> = Omit<NonNullable<T>, 'quoteText' | 'quoteEntities'> & {
+    /**
+     * Destination chat ID, username, phone, `"me"` or `"self"`
+     *
+     * @default  `message.chat`
+     */
+    toChatId?: InputPeerLike;
+    /** Index of the first character to quote (inclusive) */
+    start: number;
+    /** Index of the last character to quote (exclusive) */
+    end: number;
+};
+/** Send a text in reply to a given quote */
+export declare function quoteWithText(client: ITelegramClient, message: Message, params: QuoteParamsFrom<Parameters<typeof sendText>[3]> & {
+    /** Text to send */
+    text: Parameters<typeof sendText>[2];
+}): ReturnType<typeof sendText>;
+/** Send a media in reply to a given quote */
+export declare function quoteWithMedia(client: ITelegramClient, message: Message, params: QuoteParamsFrom<Parameters<typeof sendMedia>[3]> & {
+    /** Media to send */
+    media: Parameters<typeof sendMedia>[2];
+}): ReturnType<typeof sendMedia>;
+/** Send a media group in reply to a given quote */
+export declare function quoteWithMediaGroup(client: ITelegramClient, message: Message, params: QuoteParamsFrom<Parameters<typeof sendMediaGroup>[3]> & {
+    /** Media group to send */
+    medias: Parameters<typeof sendMediaGroup>[2];
+}): ReturnType<typeof sendMediaGroup>;

package/highlevel/methods/messages/send-reaction.d.ts

@@ -0,0 +1,21 @@
+import { MaybeArray } from '../../../types/utils.js';
+import { ITelegramClient } from '../../client.types.js';
+import { InputMessageId, InputReaction, Message } from '../../types/index.js';
+/**
+ * Send or remove a reaction.
+ *
+ * @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.
+ */
+export declare function sendReaction(client: ITelegramClient, params: InputMessageId & {
+    /** Reaction emoji (or `null` to remove reaction) */
+    emoji?: MaybeArray<InputReaction> | null;
+    /** Whether to use a big reaction */
+    big?: boolean;
+    /**
+     * Whether to dispatch the returned edit message event
+     * to the client's update handler.
+     */
+    shouldDispatch?: true;
+}): Promise<Message | null>;