@telegram.ts/types 1.6.0 → 1.8.0

package/src/manageTypes.d.ts

@@ -3,6 +3,7 @@ import type {
   Message,
   PhotoSize,
   ReactionType,
+  Sticker,
 } from "./messageTypes";
 import type { Update } from "./updateTypes";
 
@@ -58,6 +59,8 @@ export interface UserFromGetMe extends User {
   can_read_all_group_messages: boolean;
   /** True, if the bot supports inline queries. Returned only in getMe. */
   supports_inline_queries: boolean;
+  /** True, if the bot can be connected to a Telegram Business account to receive its messages. Returned only in getMe. */
+  can_connect_to_business?: boolean;
 }
 
 export declare namespace Chat {
@@ -164,6 +167,16 @@ export declare namespace Chat {
       GetChat,
       NonGroupGetChat,
       NonMultiUserGetChat {
+    /** For private chats, the date of birth of the user. Returned only in getChat. */
+    birthdate?: Birthdate;
+    /** For private chats with business accounts, the intro of the business. Returned only in getChat. */
+    business_intro?: BusinessIntro;
+    /** For private chats with business accounts, the location of the business. Returned only in getChat. */
+    business_location?: BusinessLocation;
+    /** For private chats with business accounts, the opening hours of the business. Returned only in getChat. */
+    business_opening_hours?: BusinessOpeningHours;
+    /** For private chats, the personal channel of the user. Returned only in getChat. */
+    personal_chat?: Chat.ChannelChat;
     /** Bio of the other party in a private chat. Returned only in getChat. */
     bio?: string;
     /** True, if privacy settings of the other party in the private chat allows to use tg://user?id=<user_id> links only in chats with the user. Returned only in getChat. */
@@ -295,19 +308,19 @@ export interface ChatAdministratorRights {
   can_change_info: boolean;
   /** True, if the user is allowed to invite new users to the chat */
   can_invite_users: boolean;
-  /** True, if the administrator can post messages in the channel, or access channel statistics; channels only */
-  can_post_messages?: boolean;
-  /** True, if the administrator can edit messages of other users and can pin messages; channels only */
-  can_edit_messages?: boolean;
-  /** True, if the user is allowed to pin messages; groups and supergroups only */
-  can_pin_messages?: boolean;
   /** True, if the administrator can post stories to the chat */
-  can_post_stories?: boolean;
+  can_post_stories: boolean;
   /** True, if the administrator can edit stories posted by other users */
-  can_edit_stories?: boolean;
+  can_edit_stories: boolean;
   /** True, if the administrator can delete stories posted by other users; channels only */
-  can_delete_stories?: boolean;
-  /** True, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only */
+  can_delete_stories: boolean;
+  /** True, if the administrator can post messages in the channel, or access channel statistics; for channels only */
+  can_post_messages?: boolean;
+  /** True, if the administrator can edit messages of other users and can pin messages; for channels only */
+  can_edit_messages?: boolean;
+  /** True, if the user is allowed to pin messages; for groups and supergroups only */
+  can_pin_messages?: boolean;
+  /** True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only */
   can_manage_topics?: boolean;
 }
 
@@ -380,19 +393,19 @@ export interface ChatMemberAdministrator {
   can_change_info: boolean;
   /** True, if the user is allowed to invite new users to the chat */
   can_invite_users: boolean;
-  /** True, if the administrator can post messages in the channel, or access channel statistics; channels only */
-  can_post_messages?: boolean;
-  /** True, if the administrator can edit messages of other users and can pin messages; channels only */
-  can_edit_messages?: boolean;
-  /** True, if the user is allowed to pin messages; groups and supergroups only */
-  can_pin_messages?: boolean;
   /** True, if the administrator can post stories to the chat */
-  can_post_stories?: boolean;
+  can_post_stories: boolean;
   /** True, if the administrator can edit stories posted by other users */
-  can_edit_stories?: boolean;
+  can_edit_stories: boolean;
   /** True, if the administrator can delete stories posted by other users */
-  can_delete_stories?: boolean;
-  /** True, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only */
+  can_delete_stories: boolean;
+  /** True, if the administrator can post messages in the channel, or access channel statistics; for channels only */
+  can_post_messages?: boolean;
+  /** True, if the administrator can edit messages of other users and can pin messages; for channels only */
+  can_edit_messages?: boolean;
+  /** True, if the user is allowed to pin messages; for groups and supergroups only */
+  can_pin_messages?: boolean;
+  /** True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only */
   can_manage_topics?: boolean;
   /** Custom title for this user */
   custom_title?: string;
@@ -512,6 +525,45 @@ export interface ChatPermissions {
   can_manage_topics?: boolean;
 }
 
+export interface Birthdate {
+  /** Day of the user's birth; 1-31 */
+  day: number;
+  /** Month of the user's birth; 1-12 */
+  month: number;
+  /** Year of the user's birth */
+  year?: number;
+}
+
+export interface BusinessIntro {
+  /** Title text of the business intro */
+  title?: string;
+  /** Message text of the business intro */
+  message?: string;
+  /** Sticker of the business intro */
+  sticker?: Sticker;
+}
+
+export interface BusinessLocation {
+  /** Address of the business */
+  address: string;
+  /** Location of the business */
+  location?: Location;
+}
+
+export interface BusinessOpeningHoursInterval {
+  /** The minute's sequence number in a week, starting on Monday, marking the start of the time interval during which the business is open; 0 - 7 24 60 */
+  opening_minute: number;
+  /** The minute's sequence number in a week, starting on Monday, marking the end of the time interval during which the business is open; 0 - 8 24 60 */
+  closing_minute: number;
+}
+
+export interface BusinessOpeningHours {
+  /** Unique name of the time zone for which the opening hours are defined */
+  time_zone_name: string;
+  /** List of time intervals describing business opening hours */
+  opening_hours: BusinessOpeningHoursInterval[];
+}
+
 /** Represents a location to which a chat is connected. */
 export interface ChatLocation {
   /** The location to which the supergroup is connected. Can't be a live location. */
@@ -611,3 +663,29 @@ export interface UserChatBoosts {
   /** The list of boosts added to the chat by the user */
   boosts: ChatBoost[];
 }
+
+/** Describes the connection of the bot with a business account. */
+export interface BusinessConnection {
+  /** Unique identifier of the business connection */
+  id: string;
+  /** Business account user that created the business connection */
+  user: User;
+  /** Identifier of a private chat with the user who created the business connection. */
+  user_chat_id: number;
+  /** Date the connection was established in Unix time */
+  date: number;
+  /** True, if the bot can act on behalf of the business account in chats that were active in the last 24 hours */
+  can_reply: boolean;
+  /** True, if the connection is active */
+  is_enabled: boolean;
+}
+
+/** This object is received when messages are deleted from a connected business account. */
+export interface BusinessMessagesDeleted {
+  /** Unique identifier of the business connection */
+  business_connection_id: string;
+  /** Information about a chat in the business account. The bot may not have access to the chat or the corresponding user. */
+  chat: Chat.PrivateChat;
+  /** A JSON-serialized list of identifiers of deleted messages in the chat of the business account */
+  message_ids: number[];
+}

package/src/markupTypes.d.ts

@@ -222,7 +222,7 @@ export interface WebAppInfo {
   url: string;
 }
 
-/** This object defines the criteria used to request suitable users. The identifiers of the selected users will be shared with the bot when the corresponding button is pressed. */
+/** This object defines the criteria used to request suitable users. Information about the selected users will be shared with the bot when the corresponding button is pressed. */
 export interface KeyboardButtonRequestUsers {
   /** Signed 32-bit identifier of the request that will be received back in the UsersShared object. Must be unique within the message */
   request_id: number;
@@ -232,9 +232,15 @@ export interface KeyboardButtonRequestUsers {
   user_is_premium?: boolean;
   /** The maximum number of users to be selected; 1-10. Defaults to 1. */
   max_quantity?: boolean;
+  /** Pass True to request the users' first and last name */
+  request_name?: boolean;
+  /** Pass True to request the users' username */
+  request_username?: boolean;
+  /** Pass True to request the users' photo */
+  request_photo?: boolean;
 }
 
-/** This object defines the criteria used to request a suitable chat. The identifier of the selected chat will be shared with the bot when the corresponding button is pressed. */
+/** This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the chat if appropriate */
 export interface KeyboardButtonRequestChat {
   /** Signed 32-bit identifier of the request, which will be received back in the ChatShared object. Must be unique within the message */
   request_id: number;
@@ -252,4 +258,10 @@ export interface KeyboardButtonRequestChat {
   bot_administrator_rights?: ChatAdministratorRights;
   /** Pass True to request a chat with the bot as a member. Otherwise, no additional restrictions are applied. */
   bot_is_member?: boolean;
+  /** Pass True to request the chat's title */
+  request_title?: boolean;
+  /** Pass True to request the chat's username */
+  request_username?: boolean;
+  /** Pass True to request the chat's photo */
+  request_photo?: boolean;
 }

package/src/messageTypes.d.ts

@@ -17,6 +17,8 @@ export declare namespace Message {
     sender_chat?: Chat;
     /** Date the message was sent in Unix time. It is always a positive number, representing a valid date. */
     date: number;
+    /** Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier. */
+    business_connection_id?: string;
     /** Chat the message belongs to */
     chat: Chat;
     /** True, if the message is sent to a forum topic */
@@ -25,6 +27,8 @@ export declare namespace Message {
   export interface CommonMessage extends ServiceMessage {
     /** If the sender of the message boosted the chat, the number of boosts added by the user */
     sender_boost_count?: number;
+    /** The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account. */
+    sender_business_bot?: User;
     /** Information about the original message for forwarded messages */
     forward_origin?: MessageOrigin;
     /** True, if the message is a channel post that was automatically forwarded to the connected discussion group */
@@ -43,6 +47,8 @@ export declare namespace Message {
     edit_date?: number;
     /** True, if the message can't be forwarded */
     has_protected_content?: true;
+    /** True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message */
+    is_from_offline?: true;
     /** Signature of the post author for messages in channels, or the custom title of an anonymous group administrator */
     author_signature?: string;
     /** Options used for link preview generation for the message, if it is a text message and link preview options were changed */
@@ -518,9 +524,9 @@ export interface ExternalReplyInfo {
 export interface ReplyParameters {
   /** Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified */
   message_id: number;
-  /** If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername) */
+  /** If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername). Not supported for messages sent on behalf of a business account. */
   chat_id?: number | string;
-  /** Pass True if the message should be sent even if the specified message to be replied to is not found; can be used only for replies in the same chat and forum topic. */
+  /** Pass True if the message should be sent even if the specified message to be replied to is not found; can be used only for replies in the same chat and forum topic. Always True for messages sent on behalf of a business account. */
   allow_sending_without_reply?: boolean;
   /** Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be an exact substring of the message to be replied to, including bold, italic, underline, strikethrough, spoiler, and custom_emoji entities. The message will fail to send if the quote isn't found in the original message. */
   quote?: string;
@@ -789,10 +795,10 @@ export interface Poll {
 
 /** This object represents a point on the map. */
 export interface Location {
-  /** Longitude as defined by sender */
-  longitude: number;
   /** Latitude as defined by sender */
   latitude: number;
+  /** Longitude as defined by sender */
+  longitude: number;
   /** The radius of uncertainty for the location, measured in meters; 0-1500 */
   horizontal_accuracy?: number;
   /** Time relative to the message sending date, during which the location can be updated; in seconds. For active live locations only. */
@@ -885,16 +891,22 @@ export interface ChatBoostAdded {
 export interface UsersShared {
   /** Identifier of the request */
   request_id: number;
-  /** Identifiers of the shared users. The bot may not have access to the users and could be unable to use these identifiers, unless the users are already known to the bot by some other means. */
-  user_ids: number[];
+  /** Information about users shared with the bot. */
+  users: SharedUser[];
 }
 
-/** This object contains information about the chat whose identifier was shared with the bot using a KeyboardButtonRequestChat button. */
+/** This object contains information about a chat that was shared with the bot using a KeyboardButtonRequestChat button. */
 export interface ChatShared {
   /** Identifier of the request */
   request_id: number;
   /** Identifier of the shared chat. The bot may not have access to the chat and could be unable to use this identifier, unless the chat is already known to the bot by some other means. */
   chat_id: number;
+  /** Title of the chat, if the title was requested by the bot. */
+  title?: string;
+  /** Username of the chat, if the username was requested by the bot and available. */
+  username?: string;
+  /** Available sizes of the chat photo, if the photo was requested by the bot */
+  photo?: PhotoSize[];
 }
 
 /** This object represents a service message about a user allowing a bot to write messages after adding it to the attachment menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method requestWriteAccess. */
@@ -928,6 +940,20 @@ export interface VideoChatParticipantsInvited {
   users: User[];
 }
 
+/** This object contains information about a user that was shared with the bot using a KeyboardButtonRequestUser button. */
+export interface SharedUser {
+  /** Identifier of the shared user. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so 64-bit integers or double-precision float types are safe for storing these identifiers. The bot may not have access to the user and could be unable to use this identifier, unless the user is already known to the bot by some other means. */
+  user_id: number;
+  /** First name of the user, if the name was requested by the bot */
+  first_name?: string;
+  /** Last name of the user, if the name was requested by the bot */
+  last_name?: string;
+  /** Username of the user, if the username was requested by the bot */
+  username?: string;
+  /** Available sizes of the chat photo, if the photo was requested by the bot */
+  photo?: PhotoSize[];
+}
+
 /** This object represents a service message about the creation of a scheduled giveaway. Currently holds no information. */
 export interface GiveawayCreated {}
 
@@ -1049,10 +1075,6 @@ export interface StickerSet {
   title: string;
   /** Type of stickers in the set, currently one of “regular”, “mask”, “custom_emoji” */
   sticker_type: "regular" | "mask" | "custom_emoji";
-  /** True, if the sticker set contains animated stickers */
-  is_animated: boolean;
-  /** True, if the sticker set contains video stickers */
-  is_video: boolean;
   /** List of all set stickers */
   stickers: Sticker[];
   /** Sticker set thumbnail in the .WEBP, .TGS, or .WEBM format */

package/src/passportTypes.d.ts

@@ -35,21 +35,21 @@ export interface EncryptedPassportElement {
     | "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. */
+  /** 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 type "phone_number". */
+  /** User's verified phone number; available only for type "phone_number". */
   phone_number?: string;
-  /** User's verified email address, available only for type "email". */
+  /** 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. */
+  /** Array of encrypted files with documents provided by the user; This array is available only 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. */
+  /** Encrypted file with the front side of the document, provided by the user; This file is available only 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. */
+  /** Encrypted file with the reverse side of the document, provided by the user; This file is available only 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. */
+  /** Encrypted file with the selfie of the user holding a document, provided by the user. This file is available if requested 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
+  /** Array of encrypted files with translated versions of documents provided by the user; This array is available only 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[];

package/src/updateTypes.d.ts

@@ -1,11 +1,13 @@
 import type { ChosenInlineResult, InlineQuery } from "./inlineTypes";
 import type {
+  User,
   Chat,
   ChatJoinRequest,
   ChatMemberUpdated,
   ChatBoostRemoved,
   ChatBoostUpdated,
-  User,
+  BusinessConnection,
+  BusinessMessagesDeleted,
 } from "./manageTypes";
 import type { CallbackQuery } from "./markupTypes";
 import type {
@@ -21,6 +23,11 @@ import type { PreCheckoutQuery, ShippingQuery } from "./invoiceTypes";
  * Namespace used internally to define more accurate message update types.
  */
 export declare namespace Update {
+  /** Internal type holding properties that message updates in private chats share. */
+  interface Private {
+    chat: Chat.PrivateChat;
+  }
+
   /**
    * Internal type holding properties that message updates in channels share.
    */
@@ -79,6 +86,18 @@ export interface Update {
    */
   edited_channel_post?: Message & Update.Edited & Update.Channel;
 
+  /** The bot was connected to or disconnected from a business account, or a user edited an existing connection with the bot */
+  business_connection?: BusinessConnection;
+
+  /** New non-service message from a connected business account */
+  business_message?: Message & Update.Private;
+
+  /** New version of a message from a connected business account */
+  edited_business_message?: Message & Update.Edited & Update.Private;
+
+  /** Messages were deleted from a connected business account */
+  deleted_business_messages?: BusinessMessagesDeleted;
+
   /** A reaction to a message was changed by a user. The bot must be an administrator in the chat and must explicitly specify "message_reaction" in the list of allowed_updates to receive these updates. The update isn't received for reactions set by bots. */
   message_reaction?: MessageReactionUpdated;