@mtkruto/node 0.1.151 → 0.1.153

package/esm/client/4_client.d.ts

@@ -2,11 +2,12 @@ import { MaybePromise } from "../1_utilities.js";
 import { functions, types } from "../2_tl.js";
 import { Storage } from "../3_storage.js";
 import { DC } from "../3_transport.js";
-import { BotCommand, Chat, ChatAction, ChatMember, ChatP, Document, FileSource, ID, InlineQueryResult, Message, MessageAnimation, MessageAudio, MessageContact, MessageDice, MessageDocument, MessageLocation, MessagePhoto, MessagePoll, MessageText, MessageVenue, MessageVideo, MessageVideoNote, MessageVoice, NetworkStatistics, ParseMode, Reaction, Update, UpdateIntersection, User } from "../3_types.js";
+import { InactiveChat } from "../3_types.js";
+import { BotCommand, Chat, ChatAction, ChatMember, ChatP, Document, FileSource, ID, InlineQueryResult, InputStoryContent, Message, MessageAnimation, MessageAudio, MessageContact, MessageDice, MessageDocument, MessageLocation, MessagePhoto, MessagePoll, MessageText, MessageVenue, MessageVideo, MessageVideoNote, MessageVoice, NetworkStatistics, ParseMode, Reaction, Story, Update, UpdateIntersection, User } from "../3_types.js";
 import { Migrate } from "../4_errors.js";
 import { ClientAbstract } from "./0_client_abstract.js";
 import { FilterQuery, WithFilter } from "./0_filters.js";
-import { AddReactionParams, AnswerCallbackQueryParams, AnswerInlineQueryParams, AuthorizeUserParams, BanChatMemberParams, DeleteMessageParams, DeleteMessagesParams, DownloadParams, EditMessageParams, EditMessageReplyMarkupParams, ForwardMessagesParams, GetChatsParams, GetHistoryParams, GetMyCommandsParams, PinMessageParams, ReplyParams, SendAnimationParams, SendAudioParams, SendContactParams, SendDiceParams, SendDocumentParams, SendLocationParams, SendMessageParams, SendPhotoParams, SendPollParams, SendVenueParams, SendVideoNoteParams, SendVideoParams, SendVoiceParams, SetChatMemberRightsParams, SetChatPhotoParams, SetMyCommandsParams, SetReactionsParams, UploadParams } from "./0_params.js";
+import { AddReactionParams, AnswerCallbackQueryParams, AnswerInlineQueryParams, AuthorizeUserParams, BanChatMemberParams, CreateStoryParams, DeleteMessageParams, DeleteMessagesParams, DownloadParams, EditMessageParams, EditMessageReplyMarkupParams, ForwardMessagesParams, GetChatsParams, GetHistoryParams, GetMyCommandsParams, PinMessageParams, ReplyParams, SearchMessagesParams, SendAnimationParams, SendAudioParams, SendContactParams, SendDiceParams, SendDocumentParams, SendLocationParams, SendMessageParams, SendPhotoParams, SendPollParams, SendVenueParams, SendVideoNoteParams, SendVideoParams, SendVoiceParams, SetChatMemberRightsParams, SetChatPhotoParams, SetMyCommandsParams, SetReactionsParams, UploadParams } from "./0_params.js";
 import { Api } from "./0_types.js";
 import { Composer, Middleware } from "./1_composer.js";
 import { ClientPlainParams } from "./2_client_plain.js";
@@ -241,7 +242,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
      * Alias for `invoke` with its second parameter being `true`.
      */
     send<T extends (functions.Function<unknown> | types.Type) = functions.Function<unknown>>(function_: T): Promise<void>;
-    getInputPeer(id: ID): Promise<import("../tl/2_types.js").InputPeerChat_ | import("../tl/2_types.js").InputPeerUser_ | import("../tl/2_types.js").InputPeerChannel_>;
+    getInputPeer(id: ID): Promise<import("../tl/2_types.js").InputPeerSelf_ | import("../tl/2_types.js").InputPeerChat_ | import("../tl/2_types.js").InputPeerUser_ | import("../tl/2_types.js").InputPeerChannel_>;
     getInputChannel(id: ID): Promise<import("../tl/2_types.js").InputChannel_>;
     getInputUser(id: ID): Promise<import("../tl/2_types.js").InputUser_>;
     private [getEntity];
@@ -260,7 +261,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Send a text message.
      *
-     * @method
+     * @method ms
      * @param chatId The chat to send the message to.
      * @param text The message's text.
      * @returns The sent text message.
@@ -269,7 +270,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Edit a message's text.
      *
-     * @method
+     * @method ms
      * @param chatId The identifier of the chat that contains the messages.
      * @param messageId The message's identifier.
      * @param text The new text of the message.
@@ -279,7 +280,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Edit an inline message's text.
      *
-     * @method
+     * @method ms
      * @param inlineMessageId The inline message's identifier.
      * @param text The new text of the message.
      */
@@ -287,7 +288,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Edit a message's reply markup.
      *
-     * @method
+     * @method ms
      * @param chatId The identifier of the chat that contains the messages.
      * @param messageId The message's identifier.
      * @returns The edited message.
@@ -296,14 +297,14 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Edit an inline message's reply markup.
      *
-     * @method
+     * @method ms
      * @param inlineMessageId The inline message's identifier.
      */
     editInlineMessageReplyMarkup(inlineMessageId: string, params?: EditMessageReplyMarkupParams): Promise<void>;
     /**
      * Retrieve multiple messages.
      *
-     * @method
+     * @method ms
      * @param chatId The identifier of the chat to retrieve the messages from.
      * @param messageIds The identifiers of the messages to retrieve.
      * @example ```ts
@@ -315,7 +316,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Retrieve a single message.
      *
-     * @method
+     * @method ms
      * @param chatId The identifier of the chat to retrieve the message from.
      * @param messageId The identifier of the message to retrieve.
      * @example ```ts
@@ -327,7 +328,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Download a file.
      *
-     * @method
+     * @method fs
      * @param fileId The identifier of the file to download.
      * @example ```ts
      * for await (const chunk of client.download(fileId, { chunkSize: 256 * 1024 })) {
@@ -340,7 +341,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Forward multiple messages.
      *
-     * @method
+     * @method ms
      * @param from The identifier of the chat to forward the messages from.
      * @param to The identifier of the chat to forward the messages to.
      * @param messageIds The identifiers of the messages to forward.
@@ -350,7 +351,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Forward a single message.
      *
-     * @method
+     * @method ms
      * @param from The identifier of the chat to forward the message from.
      * @param to The identifier of the chat to forward the message to.
      * @param messageId The identifier of the message to forward.
@@ -360,20 +361,20 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Get information on the currently authorized user.
      *
-     * @method
+     * @method ac
      */
     getMe(): Promise<User>;
     /**
      * Answer a callback query. Bot-only.
      *
-     * @method
+     * @method cq
      * @param id ID of the callback query to answer.
      */
     answerCallbackQuery(id: string, params?: AnswerCallbackQueryParams): Promise<void>;
     /**
      * Send a poll.
      *
-     * @method
+     * @method ms
      * @param chatId The chat to send the poll to.
      * @param question The poll's question.
      * @param options The poll's options.
@@ -383,7 +384,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Send a chat action.
      *
-     * @method
+     * @method ms
      * @param chatId The chat to send the chat action to.
      * @param action The chat action.
      * @param messageThreadId The thread to send the chat action to.
@@ -394,25 +395,27 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Upload a file.
      *
-     * @method
+     * @method fs
      * @param contents The contents of the file.
      */
     upload(contents: Uint8Array, params?: UploadParams): Promise<import("../tl/2_types.js").InputFile_ | import("../tl/2_types.js").InputFileBig_>;
     /**
      * Set the bot's commands in the given scope and/or language. Bot-only.
      *
-     * @method
+     * @method bs
      * @param commands The commands to set.
      */
     setMyCommands(commands: BotCommand[], params?: SetMyCommandsParams): Promise<void>;
     /**
      * Get the bot's commands in the given scope and/or language. Bot-only.
+     *
+     * @method bs
      */
     getMyCommands(params?: GetMyCommandsParams): Promise<BotCommand[]>;
     /**
      * Answer an inline query. Bot-only.
      *
-     * @method
+     * @method iq
      * @param id The ID of the inline query to answer.
      * @param results The results to answer with.
      */
@@ -420,7 +423,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Set the bot's description in the given language. Bot-only.
      *
-     * @method
+     * @method bs
      */
     setMyDescription(params?: {
         description?: string;
@@ -429,7 +432,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Set the bot's name in the given language. Bot-only.
      *
-     * @method
+     * @method bs
      */
     setMyName(params?: {
         name?: string;
@@ -438,7 +441,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Set the bot's short description in the given language. Bot-only.
      *
-     * @method
+     * @method bs
      */
     setMyShortDescription(params?: {
         shortDescription?: string;
@@ -447,7 +450,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Get the bot's description in the given language. Bot-only.
      *
-     * @method
+     * @method bs
      */
     getMyDescription(params?: {
         languageCode?: string;
@@ -455,7 +458,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Set the bot's name in the given language. Bot-only.
      *
-     * @method
+     * @method bs
      */
     getMyName(params?: {
         languageCode?: string;
@@ -463,7 +466,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Get the bot's short description in the given language. Bot-only.
      *
-     * @method
+     * @method bs
      */
     getMyShortDescription(params?: {
         languageCode?: string;
@@ -471,15 +474,15 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Delete multiple messages.
      *
-     * @method
+     * @method ms
      * @param chatId The identifier of the chat that contains the messages.
-     * @param messageIds The identifier of the messages to delete.
+     * @param messageIds The identifiers of the messages to delete.
      */
     deleteMessages(chatId: ID, messageIds: number[], params?: DeleteMessagesParams): Promise<void>;
     /**
      * Delete a single message.
      *
-     * @method
+     * @method ms
      * @param chatId The identifier of the chat that contains the message.
      * @param messageId The identifier of the message to delete.
      */
@@ -487,7 +490,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Send a photo.
      *
-     * @method
+     * @method ms
      * @param chatId The chat to send the photo to.
      * @param photo The photo to send.
      */
@@ -495,7 +498,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Send a document.
      *
-     * @method
+     * @method ms
      * @param chatId The chat to send the document to.
      * @param document The document to send.
      */
@@ -503,7 +506,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Send a video.
      *
-     * @method
+     * @method ms
      * @param chatId The chat to send the video to.
      * @param video The video to send.
      */
@@ -511,7 +514,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Send an animation.
      *
-     * @method
+     * @method ms
      * @param chatId The chat to send the animation to.
      * @param animation The animation to send.
      */
@@ -519,7 +522,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Send a voice message.
      *
-     * @method
+     * @method ms
      * @param chatId The chat to send the voice message to.
      * @param voice The voice to send.
      */
@@ -527,7 +530,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Send an audio file.
      *
-     * @method
+     * @method ms
      * @param chatId The chat to send the audio file to.
      * @param audio The audio to send.
      */
@@ -535,7 +538,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Send a video note.
      *
-     * @method
+     * @method ms
      * @param chatId The chat to send the video note to.
      * @param videoNote The video note to send.
      */
@@ -543,7 +546,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Send a location.
      *
-     * @method
+     * @method ms
      * @param chatId The chat to send the location to.
      * @param latitude The location's latitude.
      * @param longitude The location's longitude.
@@ -552,7 +555,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Send a contact.
      *
-     * @method
+     * @method ms
      * @param chatId The chat to send the contact to.
      * @param firstName The contact's first name.
      * @param number The contact's phone number.
@@ -561,14 +564,14 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Send a dice.
      *
-     * @method
+     * @method ms
      * @param chatId The chat to send the dice to.
      */
     sendDice(chatId: ID, params?: SendDiceParams): Promise<MessageDice>;
     /**
      * Send a venue.
      *
-     * @method
+     * @method ms
      * @param chatId The chat to send the venue to.
      * @param latitude The latitude of the venue.
      * @param longitude The longitude of the venue.
@@ -579,39 +582,39 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Get network statistics. This might not always be available.
      *
-     * @method
+     * @method mc
      */
     getNetworkStatistics(): Promise<NetworkStatistics>;
     /**
      * Get chats from a chat list. User-only.
      *
-     * @method
+     * @method ch
      */
     getChats(params?: GetChatsParams): Promise<Chat[]>;
     /**
      * Get a chat.
      *
-     * @method
+     * @method ch
      */
     getChat(chatId: ID): Promise<Chat>;
     /**
      * Get chat history. User-only.
      *
-     * @method
+     * @method ch
      * @param chatId The identifier of the chat to get its history.
      */
     getHistory(chatId: ID, params?: GetHistoryParams): Promise<Message[]>;
     /**
      * Get custom emoji documents for download.
      *
-     * @method
+     * @method fs
      * @param id Identifier of one or more of custom emojis.
      */
     getCustomEmojiDocuments(id: string | string[]): Promise<Document[]>;
     /**
      * Set a chat's available reactions.
      *
-     * @method
+     * @method ch
      * @param chatId The identifier of the chat.
      * @param availableReactions The new available reactions.
      */
@@ -619,7 +622,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Change reactions made to a message.
      *
-     * @method
+     * @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.
@@ -628,7 +631,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Make a reaction to a message.
      *
-     * @method
+     * @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.
@@ -637,7 +640,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Undo a reaction made to a message.
      *
-     * @method
+     * @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.
@@ -646,7 +649,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Set a chat's photo.
      *
-     * @method
+     * @method ch
      * @param chatId The identifier of the chat.
      * @param photo A photo to set as the chat's photo.
      */
@@ -654,14 +657,14 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Delete a chat's photo.
      *
-     * @method
+     * @method ch
      * @param chatId The identifier of the chat.
      */
     deleteChatPhoto(chatId: number): Promise<void>;
     /**
      * Delete all messages sent by a specific member of a chat.
      *
-     * @method
+     * @method ms
      * @param chatId The identifier of the chat. Must be a supergroup.
      * @param memberId The identifier of the member.
      */
@@ -669,7 +672,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Pin a message in a chat.
      *
-     * @method
+     * @method ms
      * @param chatId The identifier of the chat that contains the message.
      * @param messageId The message's identifier.
      */
@@ -677,7 +680,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Unpin a pinned message.
      *
-     * @method
+     * @method ms
      * @param chatId The identifier of the chat that contains the message.
      * @param messageId The message's identifier.
      */
@@ -685,14 +688,14 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Unpin all pinned messages.
      *
-     * @method
+     * @method ms
      * @param chatId The identifier of the chat.
      */
     unpinMessages(chatId: ID): Promise<void>;
     /**
      * Ban a member from a chat.
      *
-     * @method
+     * @method ch
      * @param chatId The identifier of the chat.
      * @param memberId The identifier of the member.
      */
@@ -700,7 +703,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Unban a member from a chat.
      *
-     * @method
+     * @method ch
      * @param chatId The identifier of the chat. Must be a supergroup.
      * @param memberId The identifier of the member.
      */
@@ -708,7 +711,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Kick a member from a chat. Same as a banChatMember call followed by unbanChatMember.
      *
-     * @method
+     * @method ch
      * @param chatId The identifier of the chat. Must be a supergroup.
      * @param memberId The identifier of the member.
      */
@@ -716,7 +719,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Set the rights of a chat member.
      *
-     * @method
+     * @method ch
      * @param chatId The identifier of the chat. Must be a supergroup.
      * @param memberId The identifier of a member.
      */
@@ -724,9 +727,140 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Get the administrators of a chat.
      *
-     * @method
+     * @method ch
      * @param chatId The identifier of the chat.
      */
     getChatAdministrators(chatId: ID): Promise<ChatMember[]>;
+    /**
+     * Create a story. User-only.
+     *
+     * @method st
+     * @param content The content of the story.
+     * @returns The created story.
+     */
+    createStory(chatId: ID, content: InputStoryContent, params?: CreateStoryParams): Promise<Story>;
+    /**
+     * Retrieve multiple stories. User-only.
+     *
+     * @method st
+     * @param chatId The identifier of the chat to retrieve the stories from.
+     * @param storyIds The identifiers of the stories to retrieve.
+     */
+    getStories(chatId: ID, storyIds: number[]): Promise<Story[]>;
+    /**
+     * Retrieve a single story. User-only.
+     *
+     * @method st
+     * @param chatId The identifier of the chat to retrieve the story from.
+     * @param storyId The identifier of the story to retrieve.
+     */
+    getStory(chatId: ID, storyId: number): Promise<Story | null>;
+    /**
+     * Delete multiple stories. User-only.
+     *
+     * @method st
+     * @param chatId The identifier of the chat to delete the stories from.
+     * @param storyIds The identifiers of the stories to delete.
+     */
+    deleteStories(chatId: ID, storyIds: number[]): Promise<void>;
+    /**
+     * Delete a single story. User-only.
+     *
+     * @method st
+     * @param chatId The identifier of the chat to delete the story from.
+     * @param storyId The identifier of the story to delete.
+     */
+    deleteStory(chatId: ID, storyId: number): Promise<void>;
+    /**
+     * Add multiple stories to highlights. User-only.
+     *
+     * @method st
+     * @param chatId The identifier of the chat that has the stories.
+     * @param storyIds The identifiers of the stories to add to highlights.
+     */
+    addStoriesToHighlights(chatId: ID, storyIds: number[]): Promise<void>;
+    /**
+     * Add a single story to highlights. User-only.
+     *
+     * @method st
+     * @param chatId The identifier of the chat that has the story.
+     * @param storyId The identifier of the story to add to highlights.
+     */
+    addStoryToHighlights(chatId: ID, storyId: number): Promise<void>;
+    /**
+     * Remove multiple stories from highlights. User-only.
+     *
+     * @method st
+     * @param chatId The identifier of the chat that has the stories.
+     * @param storyIds The identifiers of the stories to remove from highlights.
+     */
+    removeStoriesFromHighlights(chatId: ID, storyIds: number[]): Promise<void>;
+    /**
+     * Remove a single story from highlights. User-only.
+     *
+     * @method st
+     * @param chatId The identifier of the chat that has the story.
+     * @param storyId The identifier of the story to remove from highlights.
+     */
+    removeStoryFromHighlights(chatId: ID, storyId: number): Promise<void>;
+    /**
+     * Enable join requests in a chat. User-only.
+     *
+     * @method ch
+     * @param chatId The identifier of the chat. Must be a channel or a supergroup.
+     */
+    enableJoinRequests(chatId: ID): Promise<void>;
+    /**
+     * Disable join requests in a chat. User-only.
+     *
+     * @method ch
+     * @param chatId The identifier of the chat. Must be a channel or a supergroup.
+     */
+    disableJoinRequests(chatId: ID): Promise<void>;
+    /**
+     * Show a username in the current account, a bot account, sa upergroup, 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.
+     */
+    showUsername(id: ID, username: string): Promise<void>;
+    /**
+     * 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.
+     */
+    hideUsername(id: ID, username: string): Promise<void>;
+    /**
+     * 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.
+     */
+    reorderUsernames(id: ID, order: string[]): Promise<boolean>;
+    /**
+     * Hide all usernames from the a supergroup or a channel's profile. User-only.
+     *
+     * @method ac
+     * @param id A supergroup ID or a channel ID.
+     */
+    hideUsernames(id: ID): Promise<boolean>;
+    /**
+     * Get inactive chats. User-only.
+     *
+     * @method ch
+     */
+    getInactiveChats(): Promise<InactiveChat[]>;
+    /**
+     * Search the messages of a chat.
+     *
+     * @method ms
+     * @param chatId The identifier of the chat to search the messages in.
+     * @param query The message search query.
+     */
+    searchMessages(chatId: ID, query: string, params?: SearchMessagesParams): Promise<Message[]>;
 }
 export {};