typegram/methods.d.ts

Type declarations for the Telegram API

import type { InlineQueryResult, InlineQueryResultsButton } from "./inline.js";
import type { ForceReply, InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove } from "./markup.js";
import type { BotCommand, ChatAdministratorRights, ChatFromGetChat, ChatInviteLink, ChatMember, ChatMemberAdministrator, ChatMemberOwner, ChatPermissions, File, ForumTopic, UserFromGetMe, UserProfilePhotos, WebhookInfo } from "./manage.js";
import type { GameHighScore, MaskPosition, Message, MessageEntity, MessageId, ParseMode, Poll, SentWebAppMessage, Sticker, StickerSet } from "./message.js";
import type { PassportElementError } from "./passport.js";
import type { LabeledPrice, ShippingOption } from "./payment.js";
import type { BotCommandScope, BotDescription, BotName, BotShortDescription, MenuButton } from "./settings.js";
import type { Update } from "./update.js";
/** Extracts the parameters of a given method name */
type Params<F, M extends keyof ApiMethods<F>> = Parameters<ApiMethods<F>[M]>;
/** Utility type providing the argument type for the given method name or `{}` if the method does not take any parameters */
export type Opts<F> = {
    [M in keyof ApiMethods<F>]: Params<F, M>[0] extends undefined ? {} : NonNullable<Params<F, M>[0]>;
};
export type Ret<F> = {
    [M in keyof ApiMethods<F>]: ReturnType<ApiMethods<F>[M]>;
};
type UnionKeys<T> = T extends T ? keyof T : never;
/** Wrapper type to bundle all methods of the Telegram Bot API */
export type ApiMethods<F> = {
    /** Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.
  
    Notes
    1. This method will not work if an outgoing webhook is set up.
    2. In order to avoid getting duplicate updates, recalculate offset after each server response. */
    getUpdates(args?: {
        /** Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will be forgotten. */
        offset?: number;
        /** Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100. */
        limit?: number;
        /** Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only. */
        timeout?: number;
        /** A list of the update types you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member (default). If not specified, the previous setting will be used.
    
        Please note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time. */
        allowed_updates?: ReadonlyArray<Exclude<UnionKeys<Update>, "update_id">>;
    }): Update[];
    /** Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success.
  
    If you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header “X-Telegram-Bot-Api-Secret-Token” with the secret token as content.
  
    Notes
    1. You will not be able to receive updates using getUpdates for as long as an outgoing webhook is set up.
    2. To use a self-signed certificate, you need to upload your public key certificate using certificate parameter. Please upload as InputFile, sending a String will not work.
    3. Ports currently supported for Webhooks: 443, 80, 88, 8443.
  
    If you're having any trouble setting up webhooks, please check out this amazing guide to webhooks. */
    setWebhook(args: {
        /** HTTPS URL to send updates to. Use an empty string to remove webhook integration */
        url: string;
        /** Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details. */
        certificate?: F;
        /** The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS */
        ip_address?: string;
        /** The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput. */
        max_connections?: number;
        /** A list of the update types you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member (default). If not specified, the previous setting will be used.
    
        Please note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time. */
        allowed_updates?: ReadonlyArray<Exclude<UnionKeys<Update>, "update_id">>;
        /** Pass True to drop all pending updates */
        drop_pending_updates?: boolean;
        /** A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you. */
        secret_token?: string;
    }): true;
    /** Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success. */
    deleteWebhook(args?: {
        /** Pass True to drop all pending updates */
        drop_pending_updates?: boolean;
    }): true;
    /** Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty. */
    getWebhookInfo(): WebhookInfo;
    /** A simple method for testing your bot's authentication token. Requires no parameters. Returns basic information about the bot in form of a User object. */
    getMe(): UserFromGetMe;
    /** Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters. */
    logOut(): true;
    /** Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters. */
    close(): true;
    /** Use this method to send text messages. On success, the sent Message is returned. */
    sendMessage(args: {
        /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
        chat_id: number | string;
        /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
        message_thread_id?: number;
        /** Text of the message to be sent, 1-4096 characters after entities parsing */
        text: string;
        /** Mode for parsing entities in the message text. See formatting options for more details. */
        parse_mode?: ParseMode;
        /** A list of special entities that appear in message text, which can be specified instead of parse_mode */
        entities?: MessageEntity[];
        /** Boolean Disables link previews for links in this message */
        disable_web_page_preview?: boolean;
        /** Sends the message silently. Users will receive a notification with no sound. */
        disable_notification?: boolean;
        /** Protects the contents of the sent message from forwarding and saving */
        protect_content?: boolean;
        /** If the message is a reply, ID of the original message */
        reply_to_message_id?: number;
        /** Pass True if the message should be sent even if the specified replied-to message is not found */
        allow_sending_without_reply?: boolean;
        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. */
        reply_markup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
    }): Message.TextMessage;
    /** Use this method to forward messages of any kind. Service messages can't be forwarded. On success, the sent Message is returned. */
    forwardMessage(args: {
        /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
        chat_id: number | string;
        /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
        message_thread_id?: number;
        /** Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername) */
        from_chat_id: number | string;
        /** Sends the message silently. Users will receive a notification with no sound. */
        disable_notification?: boolean;
        /** Protects the contents of the forwarded message from forwarding and saving */
        protect_content?: boolean;
        /** Message identifier in the chat specified in from_chat_id */
        message_id: number;
    }): Message;
    /** Use this method to copy messages of any kind. Service messages and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success. */
    copyMessage(args: {
        /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
        chat_id: number | string;
        /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
        message_thread_id?: number;
        /** Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername) */
        from_chat_id: number | string;
        /** Message identifier in the chat specified in from_chat_id */
        message_id: number;
        /** New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept */
        caption?: string;
        /** Mode for parsing entities in the new caption. See formatting options for more details. */
        parse_mode?: string;
        /** A list of special entities that appear in the new caption, which can be specified instead of parse_mode */
        caption_entities?: MessageEntity[];
        /** Sends the message silently. Users will receive a notification with no sound. */
        disable_notification?: boolean;
        /** Protects the contents of the sent message from forwarding and saving */
        protect_content?: boolean;
        /** If the message is a reply, ID of the original message */
        reply_to_message_id?: number;
        /** Pass True if the message should be sent even if the specified replied-to message is not found */
        allow_sending_without_reply?: boolean;
        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. */
        reply_markup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
    }): MessageId;
    /** Use this method to send photos. On success, the sent Message is returned. */
    sendPhoto(args: {
        /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
        chat_id: number | string;
        /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
        message_thread_id?: number;
        /** Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. */
        photo: F | string;
        /** Photo caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsing */
        caption?: string;
        /** Mode for parsing entities in the photo caption. See formatting options for more details. */
        parse_mode?: ParseMode;
        /** A list of special entities that appear in the caption, which can be specified instead of parse_mode */
        caption_entities?: MessageEntity[];
        /** Pass True if the photo needs to be covered with a spoiler animation */
        has_spoiler?: boolean;
        /** Sends the message silently. Users will receive a notification with no sound. */
        disable_notification?: boolean;
        /** Protects the contents of the sent message from forwarding and saving */
        protect_content?: boolean;
        /** If the message is a reply, ID of the original message */
        reply_to_message_id?: number;
        /** Pass True if the message should be sent even if the specified replied-to message is not found */
        allow_sending_without_reply?: boolean;
        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. */
        reply_markup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
    }): Message.PhotoMessage;
    /** Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.
  
    For sending voice messages, use the sendVoice method instead. */
    sendAudio(args: {
        /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
        chat_id: number | string;
        /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
        message_thread_id?: number;
        /** Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. */
        audio: F | string;
        /** Audio caption, 0-1024 characters after entities parsing */
        caption?: string;
        /** Mode for parsing entities in the audio caption. See formatting options for more details. */
        parse_mode?: ParseMode;
        /** A list of special entities that appear in the caption, which can be specified instead of parse_mode */
        caption_entities?: MessageEntity[];
        /** Duration of the audio in seconds */
        duration?: number;
        /** Performer */
        performer?: string;
        /** Track name */
        title?: string;
        /** Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. */
        thumbnail?: F;
        /** Sends the message silently. Users will receive a notification with no sound. */
        disable_notification?: boolean;
        /** Protects the contents of the sent message from forwarding and saving */
        protect_content?: boolean;
        /** If the message is a reply, ID of the original message */
        reply_to_message_id?: number;
        /** Pass True if the message should be sent even if the specified replied-to message is not found */
        allow_sending_without_reply?: boolean;
        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. */
        reply_markup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
    }): Message.AudioMessage;
    /** Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future. */
    sendDocument(args: {
        /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
        chat_id: number | string;
        /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
        message_thread_id?: number;
        /** File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. */
        document: F | string;
        /** Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. */
        thumbnail?: F;
        /** Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing */
        caption?: string;
        /** Mode for parsing entities in the document caption. See formatting options for more details. */
        parse_mode?: ParseMode;
        /** A list of special entities that appear in the caption, which can be specified instead of parse_mode */
        caption_entities?: MessageEntity[];
        /** Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always true, if the document is sent as part of an album. */
        disable_content_type_detection?: boolean;
        /** Sends the message silently. Users will receive a notification with no sound. */
        disable_notification?: boolean;
        /** Protects the contents of the sent message from forwarding and saving */
        protect_content?: boolean;
        /** If the message is a reply, ID of the original message */
        reply_to_message_id?: number;
        /** Pass True if the message should be sent even if the specified replied-to message is not found */
        allow_sending_without_reply?: boolean;
        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. */
        reply_markup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
    }): Message.DocumentMessage;
    /** Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future. */
    sendVideo(args: {
        /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
        chat_id: number | string;
        /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
        message_thread_id?: number;
        /** Video to send. Pass a file_id as String to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data. */
        video: F | string;
        /** Duration of sent video in seconds */
        duration?: number;
        /** Video width */
        width?: number;
        /** Video height */
        height?: number;
        /** Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. */
        thumbnail?: F;
        /** Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing */
        caption?: string;
        /** Mode for parsing entities in the video caption. See formatting options for more details. */
        parse_mode?: ParseMode;
        /** A list of special entities that appear in the caption, which can be specified instead of parse_mode */
        caption_entities?: MessageEntity[];
        /** Pass True if the video needs to be covered with a spoiler animation */
        has_spoiler?: boolean;
        /** Pass True if the uploaded video is suitable for streaming */
        supports_streaming?: boolean;
        /** Sends the message silently. Users will receive a notification with no sound. */
        disable_notification?: boolean;
        /** Protects the contents of the sent message from forwarding and saving */
        protect_content?: boolean;
        /** If the message is a reply, ID of the original message */
        reply_to_message_id?: number;
        /** Pass True if the message should be sent even if the specified replied-to message is not found */
        allow_sending_without_reply?: boolean;
        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. */
        reply_markup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
    }): Message.VideoMessage;
    /** Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future. */
    sendAnimation(args: {
        /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
        chat_id: number | string;
        /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
        message_thread_id?: number;
        /** Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. */
        animation: F | string;
        /** Duration of sent animation in seconds */
        duration?: number;
        /** Animation width */
        width?: number;
        /** Animation height */
        height?: number;
        /** Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. */
        thumbnail?: F;
        /** Animation caption (may also be used when resending animation by file_id), 0-1024 characters after entities parsing */
        caption?: string;
        /** Mode for parsing entities in the animation caption. See formatting options for more details. */
        parse_mode?: ParseMode;
        /** A list of special entities that appear in the caption, which can be specified instead of parse_mode */
        caption_entities?: MessageEntity[];
        /** Pass True if the animation needs to be covered with a spoiler animation */
        has_spoiler?: boolean;
        /** Sends the message silently. Users will receive a notification with no sound. */
        disable_notification?: boolean;
        /** Protects the contents of the sent message from forwarding and saving */
        protect_content?: boolean;
        /** If the message is a reply, ID of the original message */
        reply_to_message_id?: number;
        /** Pass True if the message should be sent even if the specified replied-to message is not found */
        allow_sending_without_reply?: boolean;
        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. */
        reply_markup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
    }): Message.AnimationMessage;
    /** Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future. */
    sendVoice(args: {
        /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
        chat_id: number | string;
        /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
        message_thread_id?: number;
        /** Audio file to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. */
        voice: F | string;
        /** Voice message caption, 0-1024 characters after entities parsing */
        caption?: string;
        /** Mode for parsing entities in the voice message caption. See formatting options for more details. */
        parse_mode?: ParseMode;
        /** A list of special entities that appear in the caption, which can be specified instead of parse_mode */
        caption_entities?: MessageEntity[];
        /** Duration of the voice message in seconds */
        duration?: number;
        /** Sends the message silently. Users will receive a notification with no sound. */
        disable_notification?: boolean;
        /** Protects the contents of the sent message from forwarding and saving */
        protect_content?: boolean;
        /** If the message is a reply, ID of the original message */
        reply_to_message_id?: number;
        /** Pass True if the message should be sent even if the specified replied-to message is not found */
        allow_sending_without_reply?: boolean;
        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. */
        reply_markup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
    }): Message.VoiceMessage;
    /** Use this method to send video messages. On success, the sent Message is returned.
    As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. */
    sendVideoNote(args: {
        /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
        chat_id: number | string;
        /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
        message_thread_id?: number;
        /** Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data.. Sending video notes by a URL is currently unsupported */
        video_note: F | string;
        /** Duration of sent video in seconds */
        duration?: number;
        /** Video width and height, i.e. diameter of the video message */
        length?: number;
        /** Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. */
        thumbnail?: F;
        /** Sends the message silently. Users will receive a notification with no sound. */
        disable_notification?: boolean;
        /** Protects the contents of the sent message from forwarding and saving */
        protect_content?: boolean;
        /** If the message is a reply, ID of the original message */
        reply_to_message_id?: number;
        /** Pass True if the message should be sent even if the specified replied-to message is not found */
        allow_sending_without_reply?: boolean;
        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. */
        reply_markup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
    }): Message.VideoNoteMessage;
    /** Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Messages that were sent is returned. */
    sendMediaGroup(args: {
        /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
        chat_id: number | string;
        /** An array describing messages to be sent, must include 2-10 items */
        /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
        message_thread_id?: number;
        media: ReadonlyArray<InputMediaAudio<F> | InputMediaDocument<F> | InputMediaPhoto<F> | InputMediaVideo<F>>;
        /** Sends the messages silently. Users will receive a notification with no sound. */
        disable_notification?: boolean;
        /** Protects the contents of the sent messages from forwarding and saving */
        protect_content?: boolean;
        /** If messages are a reply, ID of the original message */
        reply_to_message_id?: number;
        /** Pass True if the message should be sent even if the specified replied-to message is not found */
        allow_sending_without_reply?: boolean;
    }): Array<Message.AudioMessage | Message.DocumentMessage | Message.PhotoMessage | Message.VideoMessage>;
    /** Use this method to send point on the map. On success, the sent Message is returned. */
    sendLocation(args: {
        /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
        chat_id: number | string;
        /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
        message_thread_id?: number;
        /** Latitude of the location */
        latitude: number;
        /** Longitude of the location */
        longitude: number;
        /** The radius of uncertainty for the location, measured in meters; 0-1500 */
        horizontal_accuracy?: number;
        /** Period in seconds for which the location will be updated (see Live Locations, should be between 60 and 86400. */
        live_period?: number;
        /** The direction in which user is moving, in degrees; 1-360. For active live locations only. */
        heading?: number;
        /** The maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only. */
        proximity_alert_radius?: number;
        /** Sends the message silently. Users will receive a notification with no sound. */
        disable_notification?: boolean;
        /** Protects the contents of the sent message from forwarding and saving */
        protect_content?: boolean;
        /** If the message is a reply, ID of the original message */
        reply_to_message_id?: number;
        /** Pass True if the message should be sent even if the specified replied-to message is not found */
        allow_sending_without_reply?: boolean;
        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. */
        reply_markup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
    }): Message.LocationMessage;
    /** Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. */
    editMessageLiveLocation(args: {
        /** Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
        chat_id?: number | string;
        /** Required if inline_message_id is not specified. Identifier of the message to edit */
        message_id?: number;
        /** Required if chat_id and message_id are not specified. Identifier of the inline message */
        inline_message_id?: string;
        /** Latitude of new location */
        latitude: number;
        /** Longitude of new location */
        longitude: number;
        /** The radius of uncertainty for the location, measured in meters; 0-1500 */
        horizontal_accuracy?: number;
        /** The direction in which user is moving, in degrees; 1-360. For active live locations only. */
        heading?: number;
        /** The maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only. */
        proximity_alert_radius?: number;
        /** An object for a new inline keyboard. */
        reply_markup?: InlineKeyboardMarkup;
    }): (Update.Edited & Message.LocationMessage) | true;
    /** Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned. */
    stopMessageLiveLocation(args: {
        /** Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
        chat_id?: number | string;
        /** Required if inline_message_id is not specified. Identifier of the message with live location to stop */
        message_id?: number;
        /** Required if chat_id and message_id are not specified. Identifier of the inline message */
        inline_message_id?: string;
        /** An object for a new inline keyboard. */
        reply_markup?: InlineKeyboardMarkup;
    }): (Update.Edited & Message.LocationMessage) | true;
    /** Use this method to send information about a venue. On success, the sent Message is returned. */
    sendVenue(args: {
        /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
        chat_id: number | string;
        /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
        message_thread_id?: number;
        /** Latitude of the venue */
        latitude: number;
        /** Longitude of the venue */
        longitude: number;
        /** Name of the venue */
        title: string;
        /** Address of the venue */
        address: string;
        /** Foursquare identifier of the venue */
        foursquare_id?: string;
        /** Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.) */
        foursquare_type?: string;
        /** Google Places identifier of the venue */
        google_place_id?: string;
        /** Google Places type of the venue. (See supported types.) */
        google_place_type?: string;
        /** Sends the message silently. Users will receive a notification with no sound. */
        disable_notification?: boolean;
        /** Protects the contents of the sent message from forwarding and saving */
        protect_content?: boolean;
        /** If the message is a reply, ID of the original message */
        reply_to_message_id?: number;
        /** Pass True if the message should be sent even if the specified replied-to message is not found */
        allow_sending_without_reply?: boolean;
        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. */
        reply_markup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
    }): Message.VenueMessage;
    /** Use this method to send phone contacts. On success, the sent Message is returned. */
    sendContact(args: {
        /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
        chat_id: number | string;
        /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
        message_thread_id?: number;
        /** Contact's phone number */
        phone_number: string;
        /** Contact's first name */
        first_name: string;
        /** Contact's last name */
        last_name?: string;
        /** Additional data about the contact in the form of a vCard, 0-2048 bytes */
        vcard?: string;
        /** Sends the message silently. Users will receive a notification with no sound. */
        disable_notification?: boolean;
        /** Protects the contents of the sent message from forwarding and saving */
        protect_content?: boolean;
        /** If the message is a reply, ID of the original message */
        reply_to_message_id?: number;
        /** Pass True if the message should be sent even if the specified replied-to message is not found */
        allow_sending_without_reply?: boolean;
        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove keyboard or to force a reply from the user. */
        reply_markup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
    }): Message.ContactMessage;
    /** Use this method to send a native poll. On success, the sent Message is returned. */
    sendPoll(args: {
        /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
        chat_id: number | string;
        /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
        message_thread_id?: number;
        /** Poll question, 1-300 characters */
        question: string;
        /** A list of answer options, 2-10 strings 1-100 characters each */
        options: readonly string[];
        /** True, if the poll needs to be anonymous, defaults to True */
        is_anonymous?: boolean;
        /** Poll type, “quiz” or “regular”, defaults to “regular” */
        type?: "quiz" | "regular";
        /** True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False */
        allows_multiple_answers?: boolean;
        /** 0-based identifier of the correct answer option, required for polls in quiz mode */
        correct_option_id?: number;
        /** Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after entities parsing */
        explanation?: string;
        /** Mode for parsing entities in the explanation. See formatting options for more details. */
        explanation_parse_mode?: ParseMode;
        /** A list of special entities that appear in the poll explanation, which can be specified instead of parse_mode */
        explanation_entities?: MessageEntity[];
        /** Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close_date. */
        open_period?: number;
        /** Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can't be used together with open_period. */
        close_date?: number;
        /** Pass True if the poll needs to be immediately closed. This can be useful for poll preview. */
        is_closed?: boolean;
        /** Sends the message silently. Users will receive a notification with no sound. */
        disable_notification?: boolean;
        /** Protects the contents of the sent message from forwarding and saving */
        protect_content?: boolean;
        /** If the message is a reply, ID of the original message */
        reply_to_message_id?: number;
        /** Pass True if the message should be sent even if the specified replied-to message is not found */
        allow_sending_without_reply?: boolean;
        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. */
        reply_markup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
    }): Message.PollMessage;
    /** Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned. */
    sendDice(args: {
        /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
        chat_id: number | string;
        /** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
        message_thread_id?: number;
        /** Emoji on which the dice throw animation is based. Currently, must be one of "🎲", "🎯", "🏀", "⚽", "🎳", or "🎰". Dice can have values 1-6 for "🎲", "🎯" and "🎳", values 1-5 for "🏀" and "⚽", and values 1-64 for "🎰". Defaults to "🎲" */
        emoji?: string;
        /** Sends the message silently. Users will receive a notification with no sound. */
        disable_notification?: boolean;
        /** Protects the contents of the sent message from forwarding */
        protect_content?: boolean;
        /** If the message is a reply, ID of the original message */
        reply_to_message_id?: number;
        /** Pass True if the message should be sent even if the specified replied-to message is not found */
        allow_sending_without_reply?: boolean;
        /** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. */
        reply_markup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
    }): Message.DiceMessage;
    /** Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success.
  
    Example: The ImageBot needs some time to process a request and upload the image. Instead of sending a text message along the lines of "Retrieving image, please wait...", the bot may use sendChatAction with action = upload_photo. The user will see a "sending photo" status for the bot.
  
    We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive. */
    sendChatAction(args: {
        /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
        chat_id: number | string;
        /** Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_voice or upload_voice for voice notes, upload_document for general files, choose_sticker for stickers, find_location for location data, record_video_note or upload_video_note for video notes. */
        action: "typing" | "upload_photo" | "record_video" | "upload_video" | "record_voice" | "upload_voice" | "upload_document" | "choose_sticker" | "find_location" | "record_video_note" | "upload_video_note";
        /** Unique identifier for the target message thread; supergroups only */
        message_thread_id?: number;
    }): true;
    /** Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object. */
    getUserProfilePhotos(args: {
        /** Unique identifier of the target user */
        user_id: number;
        /** Sequential number of the first photo to be returned. By default, all photos are returned. */
        offset?: number;
        /** Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100. */
        limit?: number;
    }): UserProfilePhotos;
    /** Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>, where <file_path> is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile again.
  
    Note: This function may not preserve the original file name and MIME type. You should save the file's MIME type and name (if available) when the File object is received. */
    getFile(args: {
        /** File identifier to get information about */
        file_id: string;
    }): File;
    /** Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
     * @deprecated Use `banChatMember` instead. */
    kickChatMember: ApiMethods<F>["banChatMember"];
    /** Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success. */
    banChatMember(args: {
        /** Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername) */
        chat_id: number | string;
        /** Unique identifier of the target user */
        user_id: number;
        /** Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only. */
        until_date?: number;
        /** Pass True to delete all messages from the chat for the user that is being removed. If False, the user will be able to see messages in the group that were sent before the user was removed. Always True for supergroups and channels. */
        revoke_messages?: boolean;
    }): true;
    /** Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will