@telegram.ts/types 1.0.1 → 1.3.1

package/src/{message.d.ts → messageTypes.d.ts}

@@ -1,19 +1,8 @@
-import type {
-  Chat,
-  File,
-  User
-} from "./manage.js";
-import type {
-  InlineKeyboardMarkup
-} from "./markup.js";
-import type {
-  PassportData
-} from "./passport.js";
-import type {
-  Invoice,
-  SuccessfulPayment
-} from "./payment.js";
-type MsgWith < P extends keyof Message > = Record < P, NonNullable < Message[P]>>;
+import type { Chat, File, User } from "./manageTypes.js";
+import type { InlineKeyboardMarkup } from "./markupTypes.js";
+import type { PassportData } from "./passportTypes.js";
+import type { Invoice, SuccessfulPayment } from "./invoiceTypes.js";
+type MsgWith<P extends keyof Message> = Record<P, NonNullable<Message[P]>>;
 export declare namespace Message {
   interface ServiceMessage {
     /** Unique message identifier inside this chat */
@@ -71,52 +60,75 @@ export declare namespace Message {
     /** True, if the message media is covered by a spoiler animation */
     has_media_spoiler?: true;
   }
-  export type TextMessage = CommonMessage & MsgWith < "text" >;
-  export type AudioMessage = CaptionableMessage & MsgWith < "audio" >;
-  export type DocumentMessage = CaptionableMessage & MsgWith < "document" >;
-  export type AnimationMessage = DocumentMessage & MsgWith < "animation" >;
-  export type PhotoMessage = MediaMessage & MsgWith < "photo" >;
-  export type StickerMessage = CommonMessage & MsgWith < "sticker" >;
-  export type VideoMessage = MediaMessage & MsgWith < "video" >;
-  export type VideoNoteMessage = CommonMessage & MsgWith < "video_note" >;
-  export type VoiceMessage = CaptionableMessage & MsgWith < "voice" >;
-  export type ContactMessage = CommonMessage & MsgWith < "contact" >;
-  export type DiceMessage = CommonMessage & MsgWith < "dice" >;
-  export type GameMessage = CommonMessage & MsgWith < "game" >;
-  export type PollMessage = CommonMessage & MsgWith < "poll" >;
-  export type LocationMessage = CommonMessage & MsgWith < "location" >;
-  export type VenueMessage = LocationMessage & MsgWith < "venue" >;
-  export type NewChatMembersMessage = ServiceMessage & MsgWith < "new_chat_members" >;
-  export type LeftChatMemberMessage = ServiceMessage & MsgWith < "left_chat_member" >;
-  export type NewChatTitleMessage = ServiceMessage & MsgWith < "new_chat_title" >;
-  export type NewChatPhotoMessage = ServiceMessage & MsgWith < "new_chat_photo" >;
-  export type DeleteChatPhotoMessage = ServiceMessage & MsgWith < "delete_chat_photo" >;
-  export type GroupChatCreatedMessage = ServiceMessage & MsgWith < "group_chat_created" >;
-  export type SupergroupChatCreated = ServiceMessage & MsgWith < "supergroup_chat_created" >;
-  export type ChannelChatCreatedMessage = ServiceMessage & MsgWith < "channel_chat_created" >;
-  export type MessageAutoDeleteTimerChangedMessage = ServiceMessage & MsgWith < "message_auto_delete_timer_changed" >;
-  export type MigrateToChatIdMessage = ServiceMessage & MsgWith < "migrate_to_chat_id" >;
-  export type MigrateFromChatIdMessage = ServiceMessage & MsgWith < "migrate_from_chat_id" >;
-  export type PinnedMessageMessage = ServiceMessage & MsgWith < "pinned_message" >;
-  export type InvoiceMessage = ServiceMessage & MsgWith < "invoice" >;
-  export type SuccessfulPaymentMessage = ServiceMessage & MsgWith < "successful_payment" >;
-  export type UserSharedMessage = ServiceMessage & MsgWith < "user_shared" >;
-  export type ChatSharedMessage = ServiceMessage & MsgWith < "chat_shared" >;
-  export type ConnectedWebsiteMessage = ServiceMessage & MsgWith < "connected_website" >;
-  export type WriteAccessAllowedMessage = ServiceMessage & MsgWith < "write_access_allowed" >;
-  export type PassportDataMessage = ServiceMessage & MsgWith < "passport_data" >;
-  export type ProximityAlertTriggeredMessage = ServiceMessage & MsgWith < "proximity_alert_triggered" >;
-  export type ForumTopicCreatedMessage = ServiceMessage & MsgWith < "forum_topic_created" >;
-  export type ForumTopicEditedMessage = ServiceMessage & MsgWith < "forum_topic_edited" >;
-  export type ForumTopicClosedMessage = ServiceMessage & MsgWith < "forum_topic_closed" >;
-  export type ForumTopicReopenedMessage = ServiceMessage & MsgWith < "forum_topic_reopened" >;
-  export type GeneralForumTopicHiddenMessage = ServiceMessage & MsgWith < "general_forum_topic_hidden" >;
-  export type GeneralForumTopicUnhiddenMessage = ServiceMessage & MsgWith < "general_forum_topic_unhidden" >;
-  export type VideoChatScheduledMessage = ServiceMessage & MsgWith < "video_chat_scheduled" >;
-  export type VideoChatStartedMessage = ServiceMessage & MsgWith < "video_chat_started" >;
-  export type VideoChatEndedMessage = ServiceMessage & MsgWith < "video_chat_ended" >;
-  export type VideoChatParticipantsInvitedMessage = ServiceMessage & MsgWith < "video_chat_participants_invited" >;
-  export type WebAppDataMessage = ServiceMessage & MsgWith < "web_app_data" >;
+  export type TextMessage = CommonMessage & MsgWith<"text">;
+  export type AudioMessage = CaptionableMessage & MsgWith<"audio">;
+  export type DocumentMessage = CaptionableMessage & MsgWith<"document">;
+  export type AnimationMessage = DocumentMessage & MsgWith<"animation">;
+  export type PhotoMessage = MediaMessage & MsgWith<"photo">;
+  export type StickerMessage = CommonMessage & MsgWith<"sticker">;
+  export type VideoMessage = MediaMessage & MsgWith<"video">;
+  export type VideoNoteMessage = CommonMessage & MsgWith<"video_note">;
+  export type VoiceMessage = CaptionableMessage & MsgWith<"voice">;
+  export type ContactMessage = CommonMessage & MsgWith<"contact">;
+  export type DiceMessage = CommonMessage & MsgWith<"dice">;
+  export type GameMessage = CommonMessage & MsgWith<"game">;
+  export type PollMessage = CommonMessage & MsgWith<"poll">;
+  export type LocationMessage = CommonMessage & MsgWith<"location">;
+  export type VenueMessage = LocationMessage & MsgWith<"venue">;
+  export type NewChatMembersMessage = ServiceMessage &
+    MsgWith<"new_chat_members">;
+  export type LeftChatMemberMessage = ServiceMessage &
+    MsgWith<"left_chat_member">;
+  export type NewChatTitleMessage = ServiceMessage & MsgWith<"new_chat_title">;
+  export type NewChatPhotoMessage = ServiceMessage & MsgWith<"new_chat_photo">;
+  export type DeleteChatPhotoMessage = ServiceMessage &
+    MsgWith<"delete_chat_photo">;
+  export type GroupChatCreatedMessage = ServiceMessage &
+    MsgWith<"group_chat_created">;
+  export type SupergroupChatCreated = ServiceMessage &
+    MsgWith<"supergroup_chat_created">;
+  export type ChannelChatCreatedMessage = ServiceMessage &
+    MsgWith<"channel_chat_created">;
+  export type MessageAutoDeleteTimerChangedMessage = ServiceMessage &
+    MsgWith<"message_auto_delete_timer_changed">;
+  export type MigrateToChatIdMessage = ServiceMessage &
+    MsgWith<"migrate_to_chat_id">;
+  export type MigrateFromChatIdMessage = ServiceMessage &
+    MsgWith<"migrate_from_chat_id">;
+  export type PinnedMessageMessage = ServiceMessage & MsgWith<"pinned_message">;
+  export type InvoiceMessage = ServiceMessage & MsgWith<"invoice">;
+  export type SuccessfulPaymentMessage = ServiceMessage &
+    MsgWith<"successful_payment">;
+  export type UserSharedMessage = ServiceMessage & MsgWith<"user_shared">;
+  export type ChatSharedMessage = ServiceMessage & MsgWith<"chat_shared">;
+  export type ConnectedWebsiteMessage = ServiceMessage &
+    MsgWith<"connected_website">;
+  export type WriteAccessAllowedMessage = ServiceMessage &
+    MsgWith<"write_access_allowed">;
+  export type PassportDataMessage = ServiceMessage & MsgWith<"passport_data">;
+  export type ProximityAlertTriggeredMessage = ServiceMessage &
+    MsgWith<"proximity_alert_triggered">;
+  export type ForumTopicCreatedMessage = ServiceMessage &
+    MsgWith<"forum_topic_created">;
+  export type ForumTopicEditedMessage = ServiceMessage &
+    MsgWith<"forum_topic_edited">;
+  export type ForumTopicClosedMessage = ServiceMessage &
+    MsgWith<"forum_topic_closed">;
+  export type ForumTopicReopenedMessage = ServiceMessage &
+    MsgWith<"forum_topic_reopened">;
+  export type GeneralForumTopicHiddenMessage = ServiceMessage &
+    MsgWith<"general_forum_topic_hidden">;
+  export type GeneralForumTopicUnhiddenMessage = ServiceMessage &
+    MsgWith<"general_forum_topic_unhidden">;
+  export type VideoChatScheduledMessage = ServiceMessage &
+    MsgWith<"video_chat_scheduled">;
+  export type VideoChatStartedMessage = ServiceMessage &
+    MsgWith<"video_chat_started">;
+  export type VideoChatEndedMessage = ServiceMessage &
+    MsgWith<"video_chat_ended">;
+  export type VideoChatParticipantsInvitedMessage = ServiceMessage &
+    MsgWith<"video_chat_participants_invited">;
+  export type WebAppDataMessage = ServiceMessage & MsgWith<"web_app_data">;
   export {};
 }
 type ReplyMessage = Message & {
@@ -256,12 +268,12 @@ __underline__
 [inline mention of a user](tg://user?id=123456789)
 ![👍](tg://emoji?id=5368324170671202286)
 `inline fixed-width code`
-`​`​`
+```
 pre-formatted fixed-width code block
-`​`​`
-`​`​`python
+```
+```python
 pre-formatted fixed-width code block written in the Python programming language
-`​`​`
+```
 ```
 Please note:
 
@@ -334,7 +346,20 @@ export declare namespace MessageEntity {
     length: number;
   }
   export interface CommonMessageEntity extends AbstractMessageEntity {
-    type: "mention" | "hashtag" | "cashtag" | "bot_command" | "url" | "email" | "phone_number" | "bold" | "italic" | "underline" | "strikethrough" | "spoiler" | "code";
+    type:
+      | "mention"
+      | "hashtag"
+      | "cashtag"
+      | "bot_command"
+      | "url"
+      | "email"
+      | "phone_number"
+      | "bold"
+      | "italic"
+      | "underline"
+      | "strikethrough"
+      | "spoiler"
+      | "code";
   }
   export interface PreMessageEntity extends AbstractMessageEntity {
     type: "pre";
@@ -359,7 +384,12 @@ export declare namespace MessageEntity {
   export {};
 }
 /** This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc. */
-export type MessageEntity = MessageEntity.CommonMessageEntity | MessageEntity.CustomEmojiMessageEntity | MessageEntity.PreMessageEntity | MessageEntity.TextLinkMessageEntity | MessageEntity.TextMentionMessageEntity;
+export type MessageEntity =
+  | MessageEntity.CommonMessageEntity
+  | MessageEntity.CustomEmojiMessageEntity
+  | MessageEntity.PreMessageEntity
+  | MessageEntity.TextLinkMessageEntity
+  | MessageEntity.TextMentionMessageEntity;
 /** This object represents one size of a photo or a file / sticker thumbnail. */
 export interface PhotoSize {
   /** Identifier for this file, which can be used to download or reuse the file */
@@ -740,4 +770,4 @@ export interface GameHighScore {
   /** Score */
   score: number;
 }
-export {};
+export {};

package/src/passportTypes.d.ts

@@ -0,0 +1,257 @@
+/** Describes the user's Telegram Passport data shared with the bot. */
+export interface PassportData {
+  /** Array containing information about documents and other Telegram Passport elements shared with the bot. */
+  data: EncryptedPassportElement[];
+  /** Encrypted credentials required to decrypt the data. */
+  credentials: EncryptedCredentials;
+}
+
+/** This object represents a file uploaded to Telegram Passport. Currently, all Telegram Passport files are in JPEG format when decrypted and do not exceed 10MB. */
+export interface PassportFile {
+  /** Identifier for this file, which can be used to download or reuse the file. */
+  file_id: string;
+  /** Unique identifier for this file, which remains the same over time and for different bots. This identifier cannot be used to download or reuse the file. */
+  file_unique_id: string;
+  /** File size in bytes. */
+  file_size: number;
+  /** Unix time when the file was uploaded. */
+  file_date: number;
+}
+
+/** Describes documents or other Telegram Passport elements shared with the bot by the user. */
+export interface EncryptedPassportElement {
+  /** Element type. Possible values are "personal_details", "passport", "driver_license", "identity_card", "internal_passport", "address", "utility_bill", "bank_statement", "rental_agreement", "passport_registration", "temporary_registration", "phone_number", and "email". */
+  type:
+    | "personal_details"
+    | "passport"
+    | "driver_license"
+    | "identity_card"
+    | "internal_passport"
+    | "address"
+    | "utility_bill"
+    | "bank_statement"
+    | "rental_agreement"
+    | "passport_registration"
+    | "temporary_registration"
+    | "phone_number"
+    | "email";
+  /** Base64-encoded encrypted Telegram Passport element data provided by the user. This data is available for types "personal_details", "passport", "driver_license", "identity_card", "internal_passport", and "address". It can be decrypted and verified using the accompanying EncryptedCredentials. */
+  data?: string;
+  /** User's verified phone number, available only for type "phone_number". */
+  phone_number?: string;
+  /** User's verified email address, available only for type "email". */
+  email?: string;
+  /** Array of encrypted files with documents provided by the user. This array is available for types "utility_bill", "bank_statement", "rental_agreement", "passport_registration", and "temporary_registration". The files can be decrypted and verified using the accompanying EncryptedCredentials. */
+  files?: PassportFile[];
+  /** Encrypted file with the front side of the document, provided by the user. This file is available for types "passport", "driver_license", "identity_card", and "internal_passport". It can be decrypted and verified using the accompanying EncryptedCredentials. */
+  front_side?: PassportFile;
+  /** Encrypted file with the reverse side of the document, provided by the user. This file is available for types "driver_license" and "identity_card". It can be decrypted and verified using the accompanying EncryptedCredentials. */
+  reverse_side?: PassportFile;
+  /** Encrypted file with the selfie of the user holding a document, provided by the user. This file is available for types "passport", "driver_license", "identity_card", and "internal_passport". It can be decrypted and verified using the accompanying EncryptedCredentials. */
+  selfie?: PassportFile;
+  /** Array of encrypted files with translated versions of documents provided by the user. This array is available for types "passport", "driver_license", "identity_card", "internal_passport", "utility_bill", "bank_statement", "rental_agreement", "passport_registration", and "temporary_registration". The
+
+  files can be decrypted and verified using the accompanying EncryptedCredentials. */
+  translation?: PassportFile[];
+  /** Base64-encoded element hash for use in PassportElementErrorUnspecified. */
+  hash: string;
+}
+
+/** Describes data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes. */
+export interface EncryptedCredentials {
+  /** Base64-encoded encrypted JSON-serialized data with the user's payload, data hashes, and secrets required for EncryptedPassportElement decryption and authentication. */
+  data: string;
+  /** Base64-encoded data hash for data authentication. */
+  hash: string;
+  /** Base64-encoded secret encrypted with the bot's public RSA key, required for data decryption. */
+  secret: string;
+}
+
+/** This object represents an error in the Telegram Passport element that was submitted and should be resolved by the user. It can be one of the following:
+- PassportElementErrorDataField
+- PassportElementErrorFrontSide
+- PassportElementErrorReverseSide
+- PassportElementErrorSelfie
+- PassportElementErrorFile
+- PassportElementErrorFiles
+- PassportElementErrorTranslationFile
+- PassportElementErrorTranslationFiles
+- PassportElementErrorUnspecified
+*/
+export type PassportElementError =
+  | PassportElementErrorDataField
+  | PassportElementErrorFrontSide
+  | PassportElementErrorReverseSide
+  | PassportElementErrorSelfie
+  | PassportElementErrorFile
+  | PassportElementErrorFiles
+  | PassportElementErrorTranslationFile
+  | PassportElementErrorTranslationFiles
+  | PassportElementErrorUnspecified;
+
+/** Represents an issue in one of the data fields provided by the user. The error is considered resolved when the field's value changes. */
+export interface PassportElementErrorDataField {
+  /** Error source, must be "data". */
+  source: "data";
+  /** The section of the user's Telegram Passport that has the error. Possible values are "personal_details", "passport", "driver_license", "identity_card", "internal_passport", and "address". */
+  type:
+    | "personal_details"
+    | "passport"
+    | "driver_license"
+    | "identity_card"
+    | "internal_passport"
+    | "address";
+  /** Name of the data field that has the error. */
+  field_name: string;
+  /** Base64-encoded data hash. */
+  data_hash: string;
+  /** Error message. */
+  message: string;
+}
+
+/** Represents an issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes. */
+export interface PassportElementErrorFrontSide {
+  /** Error source, must be "front_side". */
+  source: "front_side";
+  /** The section of the user's Telegram Passport that has the issue. Possible values are "passport", "driver_license", "identity_card", and "internal_passport". */
+  type: "passport" | "driver_license" | "identity_card" | "internal_passport";
+  /** Base64-encoded hash of the file with the front side of the document. */
+  file_hash: string;
+  /** Error message. */
+  message: string;
+}
+
+/** Represents an issue with the reverse side of a document. The error is considered resolved when the file with the reverse side of the document changes. */
+export interface PassportElementErrorReverseSide {
+  /** Error source, must be "reverse_side". */
+  source: "reverse_side";
+  /** The section of the user's Telegram Passport that has the issue. Possible values are "driver_license" and "identity_card". */
+  type: "driver_license" | "identity_card";
+  /** Base64-encoded hash of the file with the reverse side
+
+  of the document. */
+  file_hash: string;
+  /** Error message. */
+  message: string;
+}
+
+/** Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes. */
+export interface PassportElementErrorSelfie {
+  /** Error source, must be "selfie". */
+  source: "selfie";
+  /** The section of the user's Telegram Passport that has the issue. Possible values are "passport", "driver_license", "identity_card", and "internal_passport". */
+  type: "passport" | "driver_license" | "identity_card" | "internal_passport";
+  /** Base64-encoded hash of the file with the selfie. */
+  file_hash: string;
+  /** Error message. */
+  message: string;
+}
+
+/** Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes. */
+export interface PassportElementErrorFile {
+  /** Error source, must be "file". */
+  source: "file";
+  /** The section of the user's Telegram Passport that has the issue. Possible values are "utility_bill", "bank_statement", "rental_agreement", "passport_registration", and "temporary_registration". */
+  type:
+    | "utility_bill"
+    | "bank_statement"
+    | "rental_agreement"
+    | "passport_registration"
+    | "temporary_registration";
+  /** Base64-encoded file hash. */
+  file_hash: string;
+  /** Error message. */
+  message: string;
+}
+
+/** Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes. */
+export interface PassportElementErrorFiles {
+  /** Error source, must be "files". */
+  source: "files";
+  /** The section of the user's Telegram Passport that has the issue. Possible values are "utility_bill", "bank_statement", "rental_agreement", "passport_registration", and "temporary_registration". */
+  type:
+    | "utility_bill"
+    | "bank_statement"
+    | "rental_agreement"
+    | "passport_registration"
+    | "temporary_registration";
+  /** List of base64-encoded file hashes. */
+  file_hashes: string[];
+  /** Error message. */
+  message: string;
+}
+
+/** Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes. */
+export interface PassportElementErrorTranslationFile {
+  /** Error source, must be "translation_file". */
+  source: "translation_file";
+  /** Type of element of the user's Telegram Passport that has the issue. Possible values are "passport", "driver_license", "identity_card", "internal_passport", "utility_bill", "bank_statement", "rental_agreement", "passport_registration", and "temporary_registration". */
+  type:
+    | "passport"
+    | "driver_license"
+    | "identity_card"
+    | "internal_passport"
+    | "utility_bill"
+    | "bank_statement"
+    | "rental_agreement"
+    | "passport_registration"
+    | "temporary_registration";
+  /** Base64-encoded file hash. */
+  file_hash: string;
+  /** Error message. */
+  message: string;
+}
+
+/** Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation changes. */
+export interface PassportElementErrorTranslationFiles {
+  /** Error source, must be "translation_files". */
+  source: "translation_files";
+  /** Type of element of the user's Telegram Passport that has the issue. Possible values are "passport", "driver_license", "identity_card", "internal_passport", "utility_bill", "bank_statement", "rental_agreement", "passport_registration", and "temporary_registration". */
+  type:
+    | "passport"
+    | "driver_license"
+    | "identity_card"
+    | "internal_passport"
+    | "utility_bill"
+    | "bank_statement"
+    | "rental_agreement"
+    | "passport_registration"
+    | "temporary_registration";
+  /** List of base64-encoded file hashes. */
+  file_hashes: string[];
+  /** Error message. */
+  message: string;
+}
+
+/** Represents an issue in an unspecified element of the Telegram Passport. The error is considered resolved when new data is added. */
+export interface PassportElementErrorUnspecified {
+  /** Error source, must be "unspecified". */
+  source: "unspecified";
+  /** Type of element of the user's Telegram Passport that has the issue. Possible values are "personal_details", "passport", "driver_license", "identity_card", "internal_passport", "address", "utility_bill", "bank_statement", "rental_agreement", "passport_registration", "temporary_registration", "phone_number", and "email". */
+  type:
+    | "personal_details"
+    | "passport"
+    | "driver_license"
+    | "identity_card"
+    | "internal_passport"
+    | "address"
+    | "utility_bill"
+    | "bank_statement"
+    | "rental_agreement"
+    | "passport_registration"
+    | "temporary_registration"
+    | "phone_number"
+    | "email";
+  /** Base64-encoded element hash. */
+  element_hash: string;
+  /** Error message. */
+  message: string;
+}
+
+/** This object represents a user's Telegram Passport data. */
+export interface Passport {
+  /** Array with information about documents and other Telegram Passport elements that are shared with the bot. */
+  data: EncryptedPassportElement[];
+  /** Encrypted credentials required to decrypt and authenticate the data. */
+  credentials: EncryptedCredentials;
+}

package/src/telegramTypes.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Represents the response from the API, which can be either a success or an error.
+ * If 'ok' is true, the request was successful, and the result of the query can be found in the 'result' field.
+ * In case of an unsuccessful request, 'ok' is false, and the error is explained in the 'description' field.
+ * An optional 'error_code' field of type number may be returned, but its contents are subject to change in the future.
+ * Some errors may also have an additional 'parameters' field of type ResponseParameters,
+ * which can provide information to automatically handle the error.
+ */
+export type ApiResponse<T> = ApiError | ApiSuccess<T>;
+
+/**
+ * Represents an API error response.
+ */
+export interface ApiError {
+  ok: false;
+  error_code: number;
+  description: string;
+  parameters?: ResponseParameters;
+}
+
+/**
+ * Represents a successful API response.
+ * 'ok' is true, and the result of the query can be found in the 'result' field.
+ */
+export interface ApiSuccess<T> {
+  ok: true;
+  result: T;
+}
+
+/**
+ * Describes additional parameters provided in an API error response.
+ */
+export interface ResponseParameters {
+  /**
+   * The group has been migrated to a supergroup with the specified identifier.
+   * This number may have more than 32 significant bits, and some programming languages may have difficulty/silent defects in interpreting it.
+   * However, it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type is safe for storing this identifier.
+   */
+  migrate_to_chat_id?: number;
+  /**
+   * In case of exceeding flood control, the number of seconds left to wait before the request can be repeated.
+   */
+  retry_after?: number;
+}
+
+/**
+ * All methods in the Bot API are case-insensitive.
+ * All queries must be made using UTF-8.
+ */

package/src/updateTypes.d.ts

@@ -0,0 +1,128 @@
+import type { ChosenInlineResult, InlineQuery } from "./inlineTypes.js";
+import type {
+  Chat,
+  ChatJoinRequest,
+  ChatMemberUpdated,
+  User,
+} from "./manageTypes.js";
+import type { CallbackQuery } from "./markupTypes.js";
+import type { Message, Poll, PollAnswer } from "./messageTypes.js";
+import type { PreCheckoutQuery, ShippingQuery } from "./invoiceTypes.js";
+
+/**
+ * Namespace used internally to define more accurate message update types.
+ */
+export declare namespace Update {
+  /**
+   * Internal type holding properties that message updates in channels share.
+   */
+  interface Channel {
+    chat: Chat.ChannelChat;
+  }
+
+  /**
+   * Internal type holding properties that message updates outside of channels share.
+   */
+  interface NonChannel {
+    chat: Exclude<Chat, Chat.ChannelChat>;
+    from: User;
+  }
+
+  /**
+   * Internal type holding properties that updates about edited messages share.
+   */
+  interface Edited {
+    /**
+     * Date the message was last edited in Unix time.
+     */
+    edit_date: number;
+  }
+}
+
+/**
+ * This object represents an incoming update.
+ * At most one of the optional parameters can be present in any given update.
+ */
+export interface Update {
+  /**
+   * 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, as it allows you to ignore repeated updates or restore the correct update sequence if they get out of order.
+   * If there are no new updates for at least a week, the identifier of the next update will be chosen randomly instead of sequentially.
+   */
+  update_id: number;
+
+  /**
+   * New incoming message of any kind - text, photo, sticker, etc.
+   */
+  message?: Message & Update.NonChannel;
+
+  /**
+   * New version of a message known to the bot that has been edited.
+   */
+  edited_message?: Message & Update.Edited & Update.NonChannel;
+
+  /**
+   * New incoming channel post of any kind - text, photo, sticker, etc.
+   */
+  channel_post?: Message & Update.Channel;
+
+  /**
+   * New version of a channel post known to the bot that has been edited.
+   */
+  edited_channel_post?: Message & Update.Edited & Update.Channel;
+
+  /**
+   * New incoming inline query.
+   */
+  inline_query?: InlineQuery;
+
+  /**
+   * The result of an inline query that was chosen by a user and sent to their chat partner.
+   * Please refer to our documentation on collecting feedback for details on how to enable these updates for your bot.
+   */
+  chosen_inline_result?: ChosenInlineResult;
+
+  /**
+   * New incoming callback query.
+   */
+  callback_query?: CallbackQuery;
+
+  /**
+   * New incoming shipping query. Only for invoices with flexible price.
+   */
+  shipping_query?: ShippingQuery;
+
+  /**
+   * New incoming pre-checkout query. Contains full information about checkout.
+   */
+  pre_checkout_query?: PreCheckoutQuery;
+
+  /**
+   * New poll state. Bots receive updates only about stopped polls and polls sent by the bot.
+   */
+  poll?: Poll;
+
+  /**
+   * 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;
+
+  /**
+   * 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;
+
+  /**
+   * 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;
+
+  /**
+   * 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;
+}