@tgify/types 9.2.0

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@tgify/types",
+  "private": false,
+  "version": "9.2.0",
+  "description": "Type declarations for the Telegram API",
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tgify/types.git"
+  },
+  "keywords": [
+    "telegram",
+    "tgify",
+    "bot",
+    "api",
+    "types",
+    "typings"
+  ],
+  "scripts": {
+    "prepare": "deno task backport"
+  },
+  "author": "IATNAOD",
+  "types": "index.d.ts",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/tgify/types/issues"
+  },
+  "homepage": "https://github.com/tgify/types#readme",
+  "files": [
+    "*.d.ts",
+    "index.js"
+  ],
+  "devDependencies": {
+    "deno-bin": "^2.1.6"
+  }
+}

package/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 only 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 only 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 only 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 only 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 if requested 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/payment.d.ts

@@ -0,0 +1,281 @@
+import type { Chat, Gift, User } from "./manage.js";
+import { PaidMedia } from "./message.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, or “XTR” for payments in Telegram Stars */
+    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. Note that if the buyer initiates a chargeback with the relevant payment provider following this transaction, the funds may be debited from your balance. This is outside of Telegram's control. */
+export interface SuccessfulPayment {
+    /** Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars */
+    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;
+    /** Expiration date of the subscription, in Unix time; for recurring payments only */
+    subscription_expiration_date?: number;
+    /** True, if the payment is a recurring payment for a subscription */
+    is_recurring?: boolean;
+    /** True, if the payment is the first payment for a subscription */
+    is_first_recurring?: boolean;
+    /** 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 basic information about a refunded payment. */
+export interface RefundedPayment {
+    /** Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars. Currently, always “XTR” */
+    currency: "XTR";
+    /** Total refunded price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45, total_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;
+    /** 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, or “XTR” for payments in Telegram Stars */
+    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;
+}
+/** This object contains information about a paid media purchase. */
+export interface PaidMediaPurchased {
+    /** User who purchased the media */
+    from: User;
+    /** Bot-specified paid media payload */
+    paid_media_payload: string;
+}
+/** This object describes the state of a revenue withdrawal operation. Currently, it can be one of
+
+- RevenueWithdrawalStatePending
+- RevenueWithdrawalStateSucceeded
+- RevenueWithdrawalStateFailed */
+export type RevenueWithdrawalState = RevenueWithdrawalStatePending | RevenueWithdrawalStateSucceeded | RevenueWithdrawalStateFailed;
+/** The withdrawal is in progress. */
+export interface RevenueWithdrawalStatePending {
+    /** Type of the state, always “pending” */
+    type: "pending";
+}
+/** The withdrawal succeeded. */
+export interface RevenueWithdrawalStateSucceeded {
+    /** Type of the state, always “succeeded” */
+    type: "succeeded";
+    /** Date the withdrawal was completed in Unix time */
+    date: number;
+    /** An HTTPS URL that can be used to see transaction details */
+    url: string;
+}
+/** The withdrawal failed and the transaction was refunded. */
+export interface RevenueWithdrawalStateFailed {
+    /** Type of the state, always “failed” */
+    type: "failed";
+}
+/** Contains information about the affiliate that received a commission via this transaction. */
+export interface AffiliateInfo {
+    /** The bot or the user that received an affiliate commission if it was received by a bot or a user */
+    affiliate_user?: User;
+    /** The chat that received an affiliate commission if it was received by a chat */
+    affiliate_chat?: Chat;
+    /** The number of Telegram Stars received by the affiliate for each 1000 Telegram Stars received by the bot from referred users */
+    commission_per_mille: number;
+    /** Integer amount of Telegram Stars received by the affiliate from the transaction, rounded to 0; can be negative for refunds */
+    amount: number;
+    /** The number of 1/1000000000 shares of Telegram Stars received by the affiliate; from -999999999 to 999999999; can be negative for refunds */
+    nanostar_amount?: number;
+}
+/** This object describes the source of a transaction, or its recipient for outgoing transactions. Currently, it can be one of
+
+- TransactionPartnerUser
+- TransactionPartnerChat
+- TransactionPartnerAffiliateProgram
+- TransactionPartnerFragment
+- TransactionPartnerTelegramAds
+- TransactionPartnerTelegramApi
+- TransactionPartnerOther */
+export type TransactionPartner = TransactionPartnerUser | TransactionPartnerChat | TransactionPartnerAffiliateProgram | TransactionPartnerFragment | TransactionPartnerTelegramAds | TransactionPartnerTelegramApi | TransactionPartnerOther;
+export declare namespace TransactionPartnerUser {
+    interface Abstract {
+        /** Type of the transaction partner, always “user” */
+        type: "user";
+        /** Type of the transaction, currently one of “invoice_payment” for payments via invoices, “paid_media_payment” for payments for paid media, “gift_purchase” for gifts sent by the bot, “premium_purchase” for Telegram Premium subscriptions gifted by the bot, “business_account_transfer” for direct transfers from managed business accounts */
+        transaction_type: "invoice_payment" | "paid_media_payment" | "gift_purchase" | "premium_purchase" | "business_account_transfer";
+        /** Information about the user */
+        user: User;
+    }
+    interface InvoicePayment extends Abstract {
+        transaction_type: "invoice_payment";
+        /** Information about the affiliate that received a commission via this transaction. Can be available only for “invoice_payment” and “paid_media_payment” transactions. */
+        affiliate?: AffiliateInfo;
+        /** Bot-specified invoice payload. Can be available only for “invoice_payment” transactions. */
+        invoice_payload?: string;
+        /** The duration of the paid subscription. Can be available only for “invoice_payment” transactions. */
+        subscription_period?: number;
+    }
+    interface PaidMediaPayment extends Abstract {
+        transaction_type: "paid_media_payment";
+        /** Information about the affiliate that received a commission via this transaction. Can be available only for “invoice_payment” and “paid_media_payment” transactions. */
+        affiliate?: AffiliateInfo;
+        /** Information about the paid media bought by the user; for “paid_media_payment” transactions only */
+        paid_media?: PaidMedia[];
+        /** Bot-specified paid media payload. Can be available only for “paid_media_payment” transactions. */
+        paid_media_payload?: string;
+    }
+    interface GiftPurchase extends Abstract {
+        transaction_type: "gift_purchase";
+        /** The gift sent to the user by the bot; for “gift_purchase” transactions only */
+        gift?: Gift;
+    }
+    interface PremiumPurchase extends Abstract {
+        transaction_type: "premium_purchase";
+        /** Number of months the gifted Telegram Premium subscription will be active for; for “premium_purchase” transactions only */
+        premium_subscription_duration?: number;
+    }
+    interface BusinessAccountTransfer extends Abstract {
+        transaction_type: "business_account_transfer";
+    }
+}
+/** Describes a transaction with a user. */
+export type TransactionPartnerUser = TransactionPartnerUser.InvoicePayment | TransactionPartnerUser.PaidMediaPayment | TransactionPartnerUser.GiftPurchase | TransactionPartnerUser.PremiumPurchase | TransactionPartnerUser.BusinessAccountTransfer;
+/** Describes a transaction with a chat. */
+export interface TransactionPartnerChat {
+    /** Type of the transaction partner, always “chat” */
+    type: "chat";
+    /** Information about the chat */
+    chat: Chat;
+    /** The gift sent to the chat by the bot */
+    gift?: Gift;
+}
+/** Describes the affiliate program that issued the affiliate commission received via this transaction. */
+export interface TransactionPartnerAffiliateProgram {
+    /** Type of the transaction partner, always “affiliate_program” */
+    type: "affiliate_program";
+    /** Information about the bot that sponsored the affiliate program */
+    sponsor_user?: User;
+    /** The number of Telegram Stars received by the bot for each 1000 Telegram Stars received by the affiliate program sponsor from referred users */
+    commission_per_mille: number;
+}
+/** Describes a withdrawal transaction with Fragment. */
+export interface TransactionPartnerFragment {
+    /** Type of the transaction partner, always “fragment” */
+    type: "fragment";
+    /** State of the transaction if the transaction is outgoing */
+    withdrawal_state?: RevenueWithdrawalState;
+}
+/** Describes a withdrawal transaction to the Telegram Ads platform. */
+export interface TransactionPartnerTelegramAds {
+    /** Type of the transaction partner, always “telegram_ads” */
+    type: "telegram_ads";
+}
+/** Describes a transaction with payment for paid broadcasting. */
+export interface TransactionPartnerTelegramApi {
+    /** Type of the transaction partner, always “telegram_api” */
+    type: "telegram_api";
+    /** The number of successful requests that exceeded regular limits and were therefore billed */
+    request_count: number;
+}
+/** Describes a transaction with an unknown source or recipient. */
+export interface TransactionPartnerOther {
+    /** Type of the transaction partner, always “other” */
+    type: "other";
+}
+/** Describes a Telegram Star transaction. Note that if the buyer initiates a chargeback with the payment provider from whom they acquired Stars (e.g., Apple, Google) following this transaction, the refunded Stars will be deducted from the bot's balance. This is outside of Telegram's control. */
+export interface StarTransaction {
+    /** Unique identifier of the transaction. Coincides with the identifier of the original transaction for refund transactions. Coincides with SuccessfulPayment.telegram_payment_charge_id for successful incoming payments from users. */
+    id: string;
+    /** Integer amount of Telegram Stars transferred by the transaction */
+    amount: number;
+    /** The number of 1/1000000000 shares of Telegram Stars transferred by the transaction; from 0 to 999999999 */
+    nanostar_amount?: number;
+    /** Date the transaction was created in Unix time */
+    date: number;
+    /** Source of an incoming transaction (e.g., a user purchasing goods or services, Fragment refunding a failed withdrawal). Only for incoming transactions */
+    source?: TransactionPartner;
+    /** Receiver of an outgoing transaction (e.g., a user for a purchase refund, Fragment for a withdrawal). Only for outgoing transactions */
+    receiver?: TransactionPartner;
+}
+/** Contains a list of Telegram Star transactions. */
+export interface StarTransactions {
+    /** The list of transactions */
+    transactions: StarTransaction[];
+}

package/settings.d.ts

@@ -0,0 +1,120 @@
+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. Alternatively, a t.me link to a Web App of the bot can be specified in the object instead of the Web App's URL, in which case the Web App will be opened as if the user pressed the link. */
+    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`). Channel direct messages chats and channel chats aren't supported. */
+    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`). Channel direct messages chats and channel chats aren't supported. */
+    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`). Channel direct messages chats and channel chats aren't supported. */
+    chat_id: number | string;
+    /** Unique identifier of the target user */
+    user_id: number;
+}