typegram/update.d.ts

Type declarations for the Telegram API

import type { ChosenInlineResult, InlineQuery } from "./inline.js";
import type { Chat, ChatJoinRequest, ChatMemberUpdated, User } from "./manage.js";
import type { CallbackQuery } from "./markup.js";
import type { CommonMessageBundle, Message, Poll, PollAnswer } from "./message.js";
import type { PreCheckoutQuery, ShippingQuery } from "./payment.js";
/** Internal namespace used to make some message types more accurate */
export declare namespace Update {
    /** Internal type holding properties that updates in channels share. */
    interface Channel {
        chat: Chat.ChannelChat;
        author_signature?: string;
        from?: never;
    }
    /** Internal type holding properties that updates outside of channels share. */
    interface NonChannel {
        chat: Exclude<Chat, Chat.ChannelChat>;
        author_signature?: never;
        from: User;
    }
    /** Internal type holding properties that updates about new messages share. */
    interface New {
        edit_date?: never;
    }
    /** Internal type holding properties that updates about edited messages share. */
    interface Edited {
        /** Date the message was last edited in Unix time */
        edit_date: number;
        forward_from?: never;
        forward_from_chat?: never;
        forward_from_message_id?: never;
        forward_signature?: never;
        forward_sender_name?: never;
        forward_date?: never;
    }
    interface AbstractUpdate {
        /** The update's unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you're using webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order. If there are no new updates for at least a week, then identifier of the next update will be chosen randomly instead of sequentially. */
        update_id: number;
    }
    interface MessageUpdate<M extends Message = Message> extends AbstractUpdate {
        /** New incoming message of any kind - text, photo, sticker, etc. */
        message: New & NonChannel & M;
    }
    interface EditedMessageUpdate<M extends CommonMessageBundle = CommonMessageBundle> extends AbstractUpdate {
        /** New version of a message that is known to the bot and was edited */
        edited_message: Edited & NonChannel & M;
    }
    interface ChannelPostUpdate<M extends Message = Message> extends AbstractUpdate {
        /** New incoming channel post of any kind - text, photo, sticker, etc. */
        channel_post: New & Channel & M;
    }
    interface EditedChannelPostUpdate<M extends CommonMessageBundle = CommonMessageBundle> extends AbstractUpdate {
        /** New version of a channel post that is known to the bot and was edited */
        edited_channel_post: Edited & Channel & M;
    }
    interface InlineQueryUpdate extends AbstractUpdate {
        /** New incoming inline query */
        inline_query: InlineQuery;
    }
    interface ChosenInlineResultUpdate extends AbstractUpdate {
        /** The result of an inline query that was chosen by a user and sent to their chat partner. Please see our documentation on the feedback collecting for details on how to enable these updates for your bot. */
        chosen_inline_result: ChosenInlineResult;
    }
    interface CallbackQueryUpdate<C extends CallbackQuery = CallbackQuery> extends AbstractUpdate {
        /** New incoming callback query */
        callback_query: C;
    }
    interface ShippingQueryUpdate extends AbstractUpdate {
        /** New incoming shipping query. Only for invoices with flexible price */
        shipping_query: ShippingQuery;
    }
    interface PreCheckoutQueryUpdate extends AbstractUpdate {
        /** New incoming pre-checkout query. Contains full information about checkout */
        pre_checkout_query: PreCheckoutQuery;
    }
    interface PollUpdate extends AbstractUpdate {
        /** New poll state. Bots receive only updates about stopped polls and polls, which are sent by the bot */
        poll: Poll;
    }
    interface PollAnswerUpdate extends AbstractUpdate {
        /** A user changed their answer in a non-anonymous poll. Bots receive new votes only in polls that were sent by the bot itself. */
        poll_answer: PollAnswer;
    }
    interface MyChatMemberUpdate extends AbstractUpdate {
        /** The bot's chat member status was updated in a chat. For private chats, this update is received only when the bot is blocked or unblocked by the user. */
        my_chat_member: ChatMemberUpdated;
    }
    interface ChatMemberUpdate extends AbstractUpdate {
        /** A chat member's status was updated in a chat. The bot must be an administrator in the chat and must explicitly specify “chat_member” in the list of allowed_updates to receive these updates. */
        chat_member: ChatMemberUpdated;
    }
    interface ChatJoinRequestUpdate extends AbstractUpdate {
        /** A request to join the chat has been sent. The bot must have the can_invite_users administrator right in the chat to receive these updates. */
        chat_join_request: ChatJoinRequest;
    }
}
/** This object represents an incoming update.
At most one of the optional parameters can be present in any given update. */
export type Update = Update.CallbackQueryUpdate | Update.ChannelPostUpdate | Update.ChatMemberUpdate | Update.ChosenInlineResultUpdate | Update.EditedChannelPostUpdate | Update.EditedMessageUpdate | Update.InlineQueryUpdate | Update.MessageUpdate | Update.MyChatMemberUpdate | Update.PreCheckoutQueryUpdate | Update.PollAnswerUpdate | Update.PollUpdate | Update.ShippingQueryUpdate | Update.ChatJoinRequestUpdate;