@mtcute/core 0.18.0-rc.5 → 0.18.0

package/highlevel/methods/forums/toggle-forum-topic-pinned.d.cts

@@ -0,0 +1,15 @@
+import { ITelegramClient } from '../../client.types.js';
+import { ForumTopic, InputPeerLike } from '../../types/index.js';
+/**
+ * Toggle whether a topic in a forum is pinned
+ *
+ * Only admins with `manageTopics` permission can do this.
+ */
+export declare function toggleForumTopicPinned(client: ITelegramClient, params: {
+    /** Chat ID or username */
+    chatId: InputPeerLike;
+    /** ID of the topic (i.e. its top message ID) */
+    topicId: number | ForumTopic;
+    /** Whether the topic should be pinned */
+    pinned: boolean;
+}): Promise<void>;

package/highlevel/methods/forums/toggle-forum.d.cts

@@ -0,0 +1,11 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike } from '../../types/index.js';
+/**
+ * Set whether a supergroup is a forum.
+ *
+ * Only owner of the supergroup can change this setting.
+ *
+ * @param chatId  Chat ID or username
+ * @param enabled  Whether the supergroup should be a forum
+ */
+export declare function toggleForum(client: ITelegramClient, chatId: InputPeerLike, enabled?: boolean): Promise<void>;

package/highlevel/methods/forums/toggle-general-topic-hidden.d.cts

@@ -0,0 +1,20 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, Message } from '../../types/index.js';
+/**
+ * Toggle whether "General" topic in a forum is hidden or not
+ *
+ * Only admins with `manageTopics` permission can do this.
+ *
+ * @returns  Service message about the modification
+ */
+export declare function toggleGeneralTopicHidden(client: ITelegramClient, params: {
+    /** Chat ID or username */
+    chatId: InputPeerLike;
+    /** Whether the topic should be hidden */
+    hidden: boolean;
+    /**
+     * Whether to dispatch the returned service message (if any)
+     * to the client's update handler.
+     */
+    shouldDispatch?: true;
+}): Promise<Message>;

package/highlevel/methods/invite-links/create-invite-link.d.cts

@@ -0,0 +1,38 @@
+import { tl } from '@mtcute/tl';
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, ChatInviteLink } from '../../types/index.js';
+/**
+ * Create an additional invite link for the chat.
+ *
+ * You must be an administrator and have appropriate rights.
+ *
+ * @param chatId  Chat ID
+ * @param params
+ */
+export declare function createInviteLink(client: ITelegramClient, chatId: InputPeerLike, params?: {
+    /**
+     * Date when this link will expire.
+     * If `number` is passed, UNIX time in ms is expected.
+     */
+    expires?: number | Date;
+    /**
+     * Maximum number of users that can be members of this chat
+     * at the same time after joining using this link.
+     *
+     * Integer in range `[1, 99999]` or `Infinity`
+     *
+     * @default  `Infinity`
+     */
+    usageLimit?: number;
+    /**
+     * Whether users to be joined via this link need to be
+     * approved by an admin
+     */
+    withApproval?: boolean;
+    /**
+     * When a pricing plan is passed, this link will become a paid subscription link
+     *
+     * Currently the only allowed `.period` is 1 month, i.e. `2592000`
+     */
+    subscriptionPricing?: tl.TypeStarsSubscriptionPricing;
+}): Promise<ChatInviteLink>;

package/highlevel/methods/invite-links/edit-invite-link.d.cts

@@ -0,0 +1,36 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, ChatInviteLink } from '../../types/index.js';
+/**
+ * Edit an invite link. You can only edit non-primary
+ * invite links.
+ *
+ * Only pass the fields that you want to modify.
+ *
+ * @param chatId  Chat ID
+ * @param link  Invite link to edit
+ * @param params
+ * @returns  Modified invite link
+ */
+export declare function editInviteLink(client: ITelegramClient, params: {
+    /** Chat ID */
+    chatId: InputPeerLike;
+    /** Invite link to edit */
+    link: string | ChatInviteLink;
+    /**
+     * Date when this link will expire.
+     * If `number` is passed, UNIX time in ms is expected.
+     */
+    expires?: number | Date;
+    /**
+     * Maximum number of users that can be members of this chat
+     * at the same time after joining using this link.
+     *
+     * Integer in range `[1, 99999]` or `Infinity`,
+     */
+    usageLimit?: number;
+    /**
+     * Whether users to be joined via this link need to be
+     * approved by an admin
+     */
+    withApproval?: boolean;
+}): Promise<ChatInviteLink>;

package/highlevel/methods/invite-links/export-invite-link.d.cts

@@ -0,0 +1,12 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, ChatInviteLink } from '../../types/index.js';
+/**
+ * Generate a new primary invite link for a chat,
+ * old primary link is revoked.
+ *
+ * > **Note**: each administrator has their own primary invite link,
+ * > and bots by default don't have one.
+ *
+ * @param chatId  Chat IDs
+ */
+export declare function exportInviteLink(client: ITelegramClient, chatId: InputPeerLike): Promise<ChatInviteLink>;

package/highlevel/methods/invite-links/get-invite-link-members.d.cts

@@ -0,0 +1,45 @@
+import { tl } from '@mtcute/tl';
+import { ITelegramClient } from '../../client.types.js';
+import { ArrayPaginated, ChatInviteLink, InputPeerLike, ChatInviteLinkMember } from '../../types/index.js';
+/**
+ * Iterate over users who have joined
+ * the chat with the given invite link.
+ *
+ * @param chatId  Chat ID
+ * @param params  Additional params
+ */
+export declare function getInviteLinkMembers(client: ITelegramClient, chatId: InputPeerLike, params?: {
+    /**
+     * Invite link for which to get members
+     */
+    link?: string | ChatInviteLink;
+    /**
+     * Maximum number of users to return
+     *
+     * @default  100
+     */
+    limit?: number;
+    /**
+     * Offset request/join date used as an anchor for pagination.
+     */
+    offsetDate?: Date | number;
+    /**
+     * Offset user used as an anchor for pagination
+     */
+    offsetUser?: tl.TypeInputUser;
+    /**
+     * Whether to get users who have requested to join
+     * the chat but weren't accepted yet
+     */
+    requested?: boolean;
+    /**
+     * Search for a user in the pending join requests list
+     * (if passed, {@link requested} is assumed to be true)
+     *
+     * Doesn't work when {@link link} is set (Telegram limitation)
+     */
+    requestedSearch?: string;
+}): Promise<ArrayPaginated<ChatInviteLinkMember, {
+    date: number;
+    user: tl.TypeInputUser;
+}>>;

package/highlevel/methods/invite-links/get-invite-link.d.cts

@@ -0,0 +1,9 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, ChatInviteLink } from '../../types/index.js';
+/**
+ * Get detailed information about an invite link
+ *
+ * @param chatId  Chat ID
+ * @param link  The invite link
+ */
+export declare function getInviteLink(client: ITelegramClient, chatId: InputPeerLike, link: string): Promise<ChatInviteLink>;

package/highlevel/methods/invite-links/get-invite-links.d.cts

@@ -0,0 +1,39 @@
+import { ITelegramClient } from '../../client.types.js';
+import { ArrayPaginated, InputPeerLike, ChatInviteLink } from '../../types/index.js';
+export interface GetInviteLinksOffset {
+    date: number;
+    link: string;
+}
+/**
+ * Get invite links created by some administrator in the chat.
+ *
+ * As an administrator you can only get your own links
+ * (i.e. `adminId = "self"`), as a creator you can get
+ * any other admin's links.
+ *
+ * @param chatId  Chat ID
+ * @param adminId  Admin who created the links
+ * @param params
+ */
+export declare function getInviteLinks(client: ITelegramClient, chatId: InputPeerLike, params?: {
+    /**
+     * Only return this admin's links.
+     *
+     * @default `"self"`
+     */
+    admin?: InputPeerLike;
+    /**
+     * Whether to fetch revoked invite links
+     */
+    revoked?: boolean;
+    /**
+     * Limit the number of invite links to be fetched.
+     *
+     * @default  100
+     */
+    limit?: number;
+    /**
+     * Offset for pagination.
+     */
+    offset?: GetInviteLinksOffset;
+}): Promise<ArrayPaginated<ChatInviteLink, GetInviteLinksOffset>>;

package/highlevel/methods/invite-links/get-primary-invite-link.d.cts

@@ -0,0 +1,8 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, ChatInviteLink } from '../../types/index.js';
+/**
+ * Get primary invite link of a chat
+ *
+ * @param chatId  Chat ID
+ */
+export declare function getPrimaryInviteLink(client: ITelegramClient, chatId: InputPeerLike): Promise<ChatInviteLink>;

package/highlevel/methods/invite-links/hide-all-join-requests.d.cts

@@ -0,0 +1,13 @@
+import { ITelegramClient } from '../../client.types.js';
+import { ChatInviteLink, InputPeerLike } from '../../types/index.js';
+/**
+ * Approve or decline multiple join requests to a chat.
+ */
+export declare function hideAllJoinRequests(client: ITelegramClient, params: {
+    /** Chat/channel ID */
+    chatId: InputPeerLike;
+    /** Whether to approve or decline the join requests */
+    action: 'approve' | 'decline';
+    /** Invite link to target */
+    link?: string | ChatInviteLink;
+}): Promise<void>;

package/highlevel/methods/invite-links/hide-join-request.d.cts

@@ -0,0 +1,13 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike } from '../../types/index.js';
+/**
+ * Approve or decline join request to a chat.
+ */
+export declare function hideJoinRequest(client: ITelegramClient, params: {
+    /** Chat/channel ID */
+    chatId: InputPeerLike;
+    /** User ID */
+    user: InputPeerLike;
+    /** Whether to approve or decline the join request */
+    action: 'approve' | 'decline';
+}): Promise<void>;

package/highlevel/methods/invite-links/iter-invite-link-members.d.cts

@@ -0,0 +1,25 @@
+import { ITelegramClient } from '../../client.types.js';
+import { ChatInviteLinkMember, InputPeerLike } from '../../types/index.js';
+import { getInviteLinkMembers } from './get-invite-link-members.js';
+/**
+ * Iterate over users who have joined
+ * the chat with the given invite link.
+ *
+ * @param chatId  Chat ID
+ * @param params  Additional params
+ */
+export declare function iterInviteLinkMembers(client: ITelegramClient, chatId: InputPeerLike, params?: Parameters<typeof getInviteLinkMembers>[2] & {
+    /**
+     * Maximum number of users to return
+     *
+     * @default  `Infinity`, i.e. all users are fetched
+     */
+    limit?: number;
+    /**
+     * Chunk size which will be passed to `messages.getChatInviteImporters`.
+     * You shouldn't usually care about this.
+     *
+     * @default  100.
+     */
+    chunkSize?: number;
+}): AsyncIterableIterator<ChatInviteLinkMember>;

package/highlevel/methods/invite-links/iter-invite-links.d.cts

@@ -0,0 +1,27 @@
+import { ITelegramClient } from '../../client.types.js';
+import { ChatInviteLink, InputPeerLike } from '../../types/index.js';
+import { getInviteLinks } from './get-invite-links.js';
+/**
+ * Iterate over invite links created by some administrator in the chat.
+ *
+ * As an administrator you can only get your own links
+ * (i.e. `adminId = "self"`), as a creator you can get
+ * any other admin's links.
+ *
+ * @param chatId  Chat ID
+ * @param adminId  Admin who created the links
+ * @param params
+ */
+export declare function iterInviteLinks(client: ITelegramClient, chatId: InputPeerLike, params?: Parameters<typeof getInviteLinks>[2] & {
+    /**
+     * Limit the number of invite links to be fetched.
+     * By default, all links are fetched.
+     */
+    limit?: number;
+    /**
+     * Size of chunks which are fetched. Usually not needed.
+     *
+     * @default  `100`
+     */
+    chunkSize?: number;
+}): AsyncIterableIterator<ChatInviteLink>;

package/highlevel/methods/invite-links/revoke-invite-link.d.cts

@@ -0,0 +1,13 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, ChatInviteLink } from '../../types/index.js';
+/**
+ * Revoke an invite link.
+ *
+ * If `link` is a primary invite link, a new invite link will be
+ * generated automatically by Telegram
+ *
+ * @param chatId  Chat ID
+ * @param link  Invite link to revoke
+ * @returns  If `link` is a primary invite, newly generated invite link, otherwise the revoked link
+ */
+export declare function revokeInviteLink(client: ITelegramClient, chatId: InputPeerLike, link: string | ChatInviteLink): Promise<ChatInviteLink>;

package/highlevel/methods/messages/_business-connection.d.cts

@@ -0,0 +1,8 @@
+import { tl } from '@mtcute/tl';
+import { RpcCallOptions } from '../../../network/network-manager.js';
+import { MustEqual } from '../../../types/utils.js';
+import { ITelegramClient } from '../../client.types.js';
+/**
+ * @internal
+ */
+export declare function _maybeInvokeWithBusinessConnection<T extends tl.RpcMethod>(client: ITelegramClient, businessConnectionId: string | undefined, request: MustEqual<T, tl.RpcMethod>, params?: RpcCallOptions): Promise<tl.RpcCallReturn[T['_']]>;

package/highlevel/methods/messages/close-poll.d.cts

@@ -0,0 +1,15 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputMessageId, Poll } from '../../types/index.js';
+/**
+ * Close a poll sent by you.
+ *
+ * Once closed, poll can't be re-opened, and nobody
+ * will be able to vote in it
+ */
+export declare function closePoll(client: ITelegramClient, params: InputMessageId & {
+    /**
+     * Whether to dispatch the edit message event
+     * to the client's update handler.
+     */
+    shouldDispatch?: true;
+}): Promise<Poll>;

package/highlevel/methods/messages/delete-messages.d.cts

@@ -0,0 +1,29 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, Message } from '../../types/index.js';
+export interface DeleteMessagesParams {
+    /**
+     * Whether to "revoke" (i.e. delete for both sides).
+     * Only used for chats and private chats.
+     *
+     * @default  true
+     */
+    revoke?: boolean;
+    /**
+     * Whether to dispatch updates that will be generated by this call.
+     * Doesn't follow `disableNoDispatch`
+     */
+    shouldDispatch?: true;
+}
+/**
+ * Delete messages by their IDs
+ *
+ * @param chatId  Chat's marked ID, its username, phone or `"me"` or `"self"`.
+ * @param ids  Message(s) ID(s) to delete.
+ */
+export declare function deleteMessagesById(client: ITelegramClient, chatId: InputPeerLike, ids: number[], params?: DeleteMessagesParams): Promise<void>;
+/**
+ * Delete one or more {@link Message}
+ *
+ * @param messages  Message(s) to delete
+ */
+export declare function deleteMessages(client: ITelegramClient, messages: Message[], params?: DeleteMessagesParams): Promise<void>;

package/highlevel/methods/messages/delete-scheduled-messages.d.cts

@@ -0,0 +1,9 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike } from '../../types/index.js';
+/**
+ * Delete scheduled messages by their IDs.
+ *
+ * @param chatId  Chat's marked ID, its username, phone or `"me"` or `"self"`.
+ * @param ids  Message(s) ID(s) to delete.
+ */
+export declare function deleteScheduledMessages(client: ITelegramClient, chatId: InputPeerLike, ids: number[]): Promise<void>;

package/highlevel/methods/messages/edit-inline-message.d.cts

@@ -0,0 +1,51 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputMediaLike, InputText, ReplyMarkup } from '../../types/index.js';
+import { tl } from '@mtcute/tl';
+/**
+ * Edit sent inline message text, media and reply markup.
+ *
+ * @param messageId
+ *     Inline message ID, either as a TL object, or as a
+ *     TDLib and Bot API compatible string
+ * @param params
+ */
+export declare function editInlineMessage(client: ITelegramClient, params: {
+    /**
+     * Inline message ID, either as a TL object, or as a
+     * TDLib and Bot API compatible string
+     */
+    messageId: tl.TypeInputBotInlineMessageID | string;
+    /**
+     * New message text
+     *
+     * When `media` is passed, `media.caption` is used instead
+     */
+    text?: InputText;
+    /**
+     * New message media
+     */
+    media?: InputMediaLike;
+    /**
+     * Whether to disable links preview in this message
+     */
+    disableWebPreview?: boolean;
+    /**
+     * 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;
+    /**
+     * For bots: new reply markup.
+     * If omitted, existing markup will be removed.
+     */
+    replyMarkup?: ReplyMarkup;
+    /**
+     * For media, upload progress callback.
+     *
+     * @param uploaded  Number of bytes uploaded
+     * @param total  Total file size in bytes
+     */
+    progressCallback?: (uploaded: number, total: number) => void;
+}): Promise<void>;

package/highlevel/methods/messages/edit-message.d.cts

@@ -0,0 +1,55 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputMediaLike, InputMessageId, InputText, Message, ReplyMarkup } from '../../types/index.js';
+/**
+ * Edit message text, media, reply markup and schedule date.
+ *
+ * @param chatId  ID of the chat, its username, phone or `"me"` or `"self"`
+ * @param message  Message or its ID
+ * @param params
+ */
+export declare function editMessage(client: ITelegramClient, params: InputMessageId & {
+    /**
+     * New message text
+     *
+     * When `media` is passed, `media.caption` is used instead
+     */
+    text?: InputText;
+    /**
+     * New message media
+     */
+    media?: InputMediaLike;
+    /**
+     * Whether to disable links preview in this message
+     */
+    disableWebPreview?: boolean;
+    /**
+     * For bots: new reply markup.
+     * If omitted, existing markup will be removed.
+     */
+    replyMarkup?: ReplyMarkup;
+    /**
+     * To re-schedule a message: new schedule date.
+     * When passing a number, a UNIX time in ms is expected.
+     */
+    scheduleDate?: Date | number;
+    /**
+     * For media, upload progress callback.
+     *
+     * @param uploaded  Number of bytes uploaded
+     * @param total  Total file size in bytes
+     */
+    progressCallback?: (uploaded: number, total: number) => void;
+    /**
+     * Whether to dispatch the edit message event
+     * to the client's update handler.
+     */
+    shouldDispatch?: true;
+    /**
+     * 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;
+    businessConnectionId?: string;
+}): Promise<Message>;

package/highlevel/methods/messages/find-in-update.d.cts

@@ -0,0 +1,13 @@
+import { tl } from '@mtcute/tl';
+import { ITelegramClient } from '../../client.types.js';
+import { Message } from '../../types/messages/index.js';
+/**
+ * @internal
+ * @noemit
+ */
+export declare function _findMessageInUpdate(client: ITelegramClient, res: tl.TypeUpdates, isEdit?: boolean, noDispatch?: boolean, allowNull?: false, randomId?: tl.Long): Message;
+/**
+ * @internal
+ * @noemit
+ */
+export declare function _findMessageInUpdate(client: ITelegramClient, res: tl.TypeUpdates, isEdit?: boolean, noDispatch?: boolean, allowNull?: true, randomId?: tl.Long): Message | null;

package/highlevel/methods/messages/forward-messages.d.cts

@@ -0,0 +1,84 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, Message } from '../../types/index.js';
+export interface ForwardMessageOptions {
+    /** Destination chat ID, username, phone, `"me"` or `"self"` */
+    toChatId: InputPeerLike;
+    /**
+     * Whether to forward silently (also applies to caption message).
+     */
+    silent?: boolean;
+    /**
+     * If set, the forwarding will be scheduled to this date
+     * (also applies to caption message).
+     * When passing a number, a UNIX time in ms is expected.
+     *
+     * You can also pass `0x7FFFFFFE`, this will send the message
+     * once the peer is online
+     */
+    schedule?: Date | number;
+    /**
+     * Whether to clear draft after sending this message (only used for caption)
+     *
+     * @default  `false`
+     */
+    clearDraft?: boolean;
+    /**
+     * Whether to forward without author
+     */
+    noAuthor?: boolean;
+    /**
+     * Whether to forward without caption (implies {@link noAuthor})
+     */
+    noCaption?: 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 forwarded messages
+     * to the client's update handler.
+     */
+    shouldDispatch?: true;
+    /**
+     * Bots only: if set, allows sending up to 1000 messages per second,
+     * ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message.
+     * The Stars will be withdrawn from the bot's balance.
+     */
+    allowPaidFloodskip?: boolean;
+}
+/**
+ * Forward one or more messages by their IDs.
+ * You can forward no more than 100 messages at once.
+ *
+ * @param toChatId  Destination chat ID, username, phone, `"me"` or `"self"`
+ * @param fromChatId  Source chat ID, username, phone, `"me"` or `"self"`
+ * @param messages  Message IDs
+ * @param params  Additional sending parameters
+ * @returns  Newly sent, forwarded messages in the destination chat.
+ */
+export declare function forwardMessagesById(client: ITelegramClient, params: ForwardMessageOptions & {
+    /** Source chat ID, username, phone, `"me"` or `"self"` */
+    fromChatId: InputPeerLike;
+    /** Message IDs to forward */
+    messages: number[];
+}): Promise<Message[]>;
+/**
+ * Forward one or more {@link Message}s to another chat.
+ *
+ * > **Note**: all messages must be from the same chat.
+ */
+export declare function forwardMessages(client: ITelegramClient, params: ForwardMessageOptions & {
+    messages: Message[];
+}): Promise<Message[]>;

package/highlevel/methods/messages/get-all-scheduled-messages.d.cts

@@ -0,0 +1,8 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, Message } from '../../types/index.js';
+/**
+ * Get all scheduled messages in chat
+ *
+ * @param chatId  Chat's marked ID, its username, phone or `"me"` or `"self"`
+ */
+export declare function getAllScheduledMessages(client: ITelegramClient, chatId: InputPeerLike): Promise<Message[]>;

package/highlevel/methods/messages/get-available-effects.d.cts

@@ -0,0 +1,6 @@
+import { ITelegramClient } from '../../client.types.js';
+import { MessageEffect } from '../../types/index.js';
+/**
+ * Get a list of available message effects
+ */
+export declare function getAvailableMessageEffects(client: ITelegramClient): Promise<MessageEffect[]>;

package/highlevel/methods/messages/get-callback-query-message.d.cts

@@ -0,0 +1,14 @@
+import { tl } from '@mtcute/tl';
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike } from '../../types/peers/index.js';
+import { CallbackQuery } from '../../types/updates/callback-query.js';
+import { Message } from '../../types/messages/message.js';
+/**
+ * Get the message containing the button being clicked
+ * in the given callback query.
+ */
+export declare function getCallbackQueryMessage(client: ITelegramClient, id: CallbackQuery | tl.RawUpdateBotCallbackQuery | {
+    messageId: number;
+    queryId: tl.Long;
+    peer: InputPeerLike;
+}): Promise<Message | null>;