@telegram.ts/types 1.0.1

package/src/passport.d.ts

@@ -0,0 +1,163 @@
+/** Describes Telegram Passport data shared with the bot by the user. */
+export interface PassportData {
+  /** Array with information about documents and other Telegram Passport elements that was 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 don't 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 is supposed to be the same over time and for different bots. Can't 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. One of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”, “phone_number”, “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, available for “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport” and “address” types. Can be decrypted and verified using the accompanying EncryptedCredentials. */
+  data?: string;
+  /** User's verified phone number, available only for “phone_number” type */
+  phone_number?: string;
+  /** User's verified email address, available only for “email” type */
+  email?: string;
+  /** Array of encrypted files with documents provided by the user, available for “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. 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. Available for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file 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. Available for “driver_license” and “identity_card”. The file 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; available for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials. */
+  selfie?: PassportFile;
+  /** Array of encrypted files with translated versions of documents provided by the user. Available if requested for “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials. */
+  translation?: PassportFile[];
+  /** Base64-encoded element hash for using 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 unique 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 which was submitted that should be resolved by the user. It should be one of:
+- 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 that was 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 which has the error, one of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address” */
+  type: "personal_details" | "passport" | "driver_license" | "identity_card" | "internal_passport" | "address";
+  /** Name of the data field which 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 which has the issue, one of “passport”, “driver_license”, “identity_card”, “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 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 which has the issue, one of “driver_license”, “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 which has the issue, one of “passport”, “driver_license”, “identity_card”, “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 which has the issue, one of “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “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 which has the issue, one of “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “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 which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “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 change. */
+export interface PassportElementErrorTranslationFiles {
+  /** Error source, must be translation_files */
+  source: "translation_files";
+  /** Type of element of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “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 place. 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 which has the issue */
+  type: string;
+  /** Base64-encoded element hash */
+  element_hash: string;
+  /** Error message */
+  message: string;
+}

package/src/payment.d.ts

@@ -0,0 +1,103 @@
+import type {
+  User
+} from "./manage.js";
+/** This object represents a portion of the price for goods or services. */
+export interface LabeledPrice {
+  /** Portion label */
+  label: string;
+  /** Price of the product in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). */
+  amount: number;
+}
+/** This object contains basic information about an invoice. */
+export interface Invoice {
+  /** Product name */
+  title: string;
+  /** Product description */
+  description: string;
+  /** Unique bot deep-linking parameter that can be used to generate this invoice */
+  start_parameter: string;
+  /** Three-letter ISO 4217 currency code */
+  currency: string;
+  /** Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). */
+  total_amount: number;
+}
+/** This object represents a shipping address. */
+export interface ShippingAddress {
+  /** Two-letter ISO 3166-1 alpha-2 country code */
+  country_code: string;
+  /** State, if applicable */
+  state: string;
+  /** City */
+  city: string;
+  /** First line for the address */
+  street_line1: string;
+  /** Second line for the address */
+  street_line2: string;
+  /** Address post code */
+  post_code: string;
+}
+/** This object represents information about an order. */
+export interface OrderInfo {
+  /** User name */
+  name?: string;
+  /** User's phone number */
+  phone_number?: string;
+  /** User email */
+  email?: string;
+  /** User shipping address */
+  shipping_address?: ShippingAddress;
+}
+/** This object represents one shipping option. */
+export interface ShippingOption {
+  /** Shipping option identifier */
+  id: string;
+  /** Option title */
+  title: string;
+  /** List of price portions */
+  prices: LabeledPrice[];
+}
+/** This object contains basic information about a successful payment. */
+export interface SuccessfulPayment {
+  /** Three-letter ISO 4217 currency code */
+  currency: string;
+  /** Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). */
+  total_amount: number;
+  /** Bot specified invoice payload */
+  invoice_payload: string;
+  /** Identifier of the shipping option chosen by the user */
+  shipping_option_id?: string;
+  /** Order information provided by the user */
+  order_info?: OrderInfo;
+  /** Telegram payment identifier */
+  telegram_payment_charge_id: string;
+  /** Provider payment identifier */
+  provider_payment_charge_id: string;
+}
+/** This object contains information about an incoming shipping query. */
+export interface ShippingQuery {
+  /** Unique query identifier */
+  id: string;
+  /** User who sent the query */
+  from: User;
+  /** Bot specified invoice payload */
+  invoice_payload: string;
+  /** User specified shipping address */
+  shipping_address: ShippingAddress;
+}
+/** This object contains information about an incoming pre-checkout query. */
+export interface PreCheckoutQuery {
+  /** Unique query identifier */
+  id: string;
+  /** User who sent the query */
+  from: User;
+  /** Three-letter ISO 4217 currency code */
+  currency: string;
+  /** Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). */
+  total_amount: number;
+  /** Bot specified invoice payload */
+  invoice_payload: string;
+  /** Identifier of the shipping option chosen by the user */
+  shipping_option_id?: string;
+  /** Order information provided by the user */
+  order_info?: OrderInfo;
+}

package/src/settings.d.ts

@@ -0,0 +1,122 @@
+import type {
+  WebAppInfo
+} from "./markup.js";
+/** This object represents the bot's name. */
+export interface BotName {
+  /** The bot's name */
+  name: string;
+}
+/** This object represents the bot's description. */
+export interface BotDescription {
+  /** The bot's description */
+  description: string;
+}
+/** This object represents the bot's short description. */
+export interface BotShortDescription {
+  /** The bot's short description */
+  short_description: string;
+}
+/** This object describes the bot's menu button in a private chat. It should be one of
+- MenuButtonCommands
+- MenuButtonWebApp
+- MenuButtonDefault
+
+If a menu button other than MenuButtonDefault is set for a private chat, then it is applied in the chat. Otherwise the default menu button is applied. By default, the menu button opens the list of bot commands. */
+export type MenuButton = MenuButtonCommands | MenuButtonWebApp | MenuButtonDefault;
+/** Represents a menu button, which opens the bot's list of commands. */
+export interface MenuButtonCommands {
+  /** Type of the button, must be commands */
+  type: "commands";
+}
+/** Represents a menu button, which launches a Web App. */
+export interface MenuButtonWebApp {
+  /** Button type, must be web_app */
+  type: "web_app";
+  /** Text on the button */
+  text: string;
+  /** Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery. */
+  web_app: WebAppInfo;
+}
+/** Describes that no specific value for the menu button was set. */
+export interface MenuButtonDefault {
+  /** Type of the button, must be default */
+  type: "default";
+}
+/** This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported:
+- BotCommandScopeDefault
+- BotCommandScopeAllPrivateChats
+- BotCommandScopeAllGroupChats
+- BotCommandScopeAllChatAdministrators
+- BotCommandScopeChat
+- BotCommandScopeChatAdministrators
+- BotCommandScopeChatMember
+
+## Determining list of commands
+
+The following algorithm is used to determine the list of commands for a particular user viewing the bot menu. The first list of commands which is set is returned:
+
+### Commands in the chat with the bot
+- botCommandScopeChat + language_code
+- botCommandScopeChat
+- botCommandScopeAllPrivateChats + language_code
+- botCommandScopeAllPrivateChats
+- botCommandScopeDefault + language_code
+- botCommandScopeDefault
+
+### Commands in group and supergroup chats
+- botCommandScopeChatMember + language_code
+- botCommandScopeChatMember
+- botCommandScopeChatAdministrators + language_code (administrators only)
+- botCommandScopeChatAdministrators (administrators only)
+- botCommandScopeChat + language_code
+- botCommandScopeChat
+- botCommandScopeAllChatAdministrators + language_code (administrators only)
+- botCommandScopeAllChatAdministrators (administrators only)
+- botCommandScopeAllGroupChats + language_code
+- botCommandScopeAllGroupChats
+- botCommandScopeDefault + language_code
+- botCommandScopeDefault */
+export type BotCommandScope = BotCommandScopeDefault | BotCommandScopeAllPrivateChats | BotCommandScopeAllGroupChats | BotCommandScopeAllChatAdministrators | BotCommandScopeChat | BotCommandScopeChatAdministrators | BotCommandScopeChatMember;
+/** Represents the default scope of bot commands. Default commands are used if no commands with a narrower scope are specified for the user. */
+export interface BotCommandScopeDefault {
+  /** Scope type, must be default */
+  type: "default";
+}
+/** Represents the scope of bot commands, covering all private chats. */
+export interface BotCommandScopeAllPrivateChats {
+  /** Scope type, must be all_private_chats */
+  type: "all_private_chats";
+}
+/** Represents the scope of bot commands, covering all group and supergroup chats. */
+export interface BotCommandScopeAllGroupChats {
+  /** Scope type, must be all_group_chats */
+  type: "all_group_chats";
+}
+/** Represents the scope of bot commands, covering all group and supergroup chat administrators. */
+export interface BotCommandScopeAllChatAdministrators {
+  /** Scope type, must be all_chat_administrators */
+  type: "all_chat_administrators";
+}
+/** Represents the scope of bot commands, covering a specific chat. */
+export interface BotCommandScopeChat {
+  /** Scope type, must be chat */
+  type: "chat";
+  /** Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) */
+  chat_id: number | string;
+}
+/** Represents the scope of bot commands, covering all administrators of a specific group or supergroup chat. */
+export interface BotCommandScopeChatAdministrators {
+  /** Scope type, must be chat_administrators */
+  type: "chat_administrators";
+  /** Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) */
+  chat_id: number | string;
+}
+/** Represents the scope of bot commands, covering a specific member of a group or supergroup chat. */
+export interface BotCommandScopeChatMember {
+  /** Scope type, must be chat_member */
+  type: "chat_member";
+  /** Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) */
+  chat_id: number | string;
+  /** Unique identifier of the target user */
+  user_id: number;
+}

package/src/update.d.ts

@@ -0,0 +1,74 @@
+import type {
+  ChosenInlineResult,
+  InlineQuery
+} from "./inline.js";
+import type {
+  Chat,
+  ChatJoinRequest,
+  ChatMemberUpdated,
+  User
+} from "./manage.js";
+import type {
+  CallbackQuery
+} from "./markup.js";
+import type {
+  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 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, 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;
+  /** New incoming message of any kind - text, photo, sticker, etc. */
+  message?: Message & Update.NonChannel;
+  /** New version of a message that is known to the bot and was 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 that is known to the bot and was 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 see our documentation on the feedback collecting 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 only updates about stopped polls and polls, which are 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;
+}