@grammyjs/types 3.20.0 → 3.21.0

package/checklist.d.ts

@@ -0,0 +1,70 @@
+import type { User } from "./manage.js";
+import type { Message, MessageEntity, ParseMode } from "./message.js";
+/** Describes a task in a checklist. */
+export interface ChecklistTask {
+    /** Unique identifier of the task */
+    id: number;
+    /** Text of the task */
+    text: string;
+    /** Special entities that appear in the task text */
+    text_entities?: MessageEntity[];
+    /** User that completed the task; omitted if the task wasn't completed */
+    completed_by_user?: User;
+    /** Point in time (Unix timestamp) when the task was completed; 0 if the task wasn't completed */
+    completion_date?: number;
+}
+/** Describes a checklist. */
+export interface Checklist {
+    /** Title of the checklist */
+    title: string;
+    /** Special entities that appear in the checklist title */
+    title_entities?: MessageEntity[];
+    /** List of tasks in the checklist */
+    tasks: ChecklistTask[];
+    /** True, if users other than the creator of the list can add tasks to the list */
+    others_can_add_tasks?: true;
+    /** True, if users other than the creator of the list can mark tasks as done or not done */
+    others_can_mark_tasks_as_done?: true;
+}
+/** Describes a task to add to a checklist. */
+export interface InputChecklistTask {
+    /** Unique identifier of the task; must be positive and unique among all task identifiers currently present in the checklist */
+    id: number;
+    /** Text of the task; 1-100 characters after entities parsing */
+    text: string;
+    /** Mode for parsing entities in the text. See formatting options for more details. */
+    parse_mode?: string;
+    /** List of special entities that appear in the text, which can be specified instead of parse_mode. Currently, only bold, italic, underline, strikethrough, spoiler, and custom_emoji entities are allowed. */
+    text_entities?: MessageEntity[];
+}
+/** Describes a checklist to create. */
+export interface InputChecklist {
+    /** Title of the checklist; 1-255 characters after entities parsing */
+    title: string;
+    /** Mode for parsing entities in the title. See formatting options for more details. */
+    parse_mode?: ParseMode;
+    /** List of special entities that appear in the title, which can be specified instead of parse_mode. Currently, only bold, italic, underline, strikethrough, spoiler, and custom_emoji entities are allowed. */
+    title_entities?: MessageEntity[];
+    /** List of 1-30 tasks in the checklist */
+    tasks: InputChecklistTask[];
+    /** Pass True if other users can add tasks to the checklist */
+    others_can_add_tasks?: boolean;
+    /** Pass True if other users can mark tasks as done or not done in the checklist */
+    others_can_mark_tasks_as_done?: true;
+}
+/** Describes a service message about checklist tasks marked as done or not done. */
+export interface ChecklistTasksDone {
+    /** Message containing the checklist whose tasks were marked as done or not done. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply. */
+    checklist_message?: Message;
+    /** Identifiers of the tasks that were marked as done */
+    marked_as_done_task_ids?: number[];
+    /** Identifiers of the tasks that were marked as not done */
+    marked_as_not_done_task_ids?: number[];
+}
+/** Describes a service message about tasks added to a checklist. */
+export interface ChecklistTasksAdded {
+    /** Message containing the checklist to which the tasks were added. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply. */
+    checklist_message?: Message;
+    /** List of tasks added to the checklist */
+    tasks: ChecklistTask[];
+}

package/manage.d.ts

@@ -563,7 +563,7 @@ export interface ChatInviteLink {
 export interface ChatAdministratorRights {
     /** True, if the user's presence in the chat is hidden */
     is_anonymous: boolean;
-    /** True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege. */
+    /** True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege. */
     can_manage_chat: boolean;
     /** True, if the administrator can delete messages of other users */
     can_delete_messages: boolean;
@@ -583,7 +583,7 @@ export interface ChatAdministratorRights {
     can_edit_stories: boolean;
     /** True, if the administrator can delete stories posted by other users */
     can_delete_stories: boolean;
-    /** True, if the administrator can post messages in the channel, or access channel statistics; for channels only */
+    /** True, if the administrator can post messages in the channel, approve suggested posts, 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;
@@ -640,7 +640,7 @@ export interface ChatMemberAdministrator {
     can_be_edited: boolean;
     /** True, if the user's presence in the chat is hidden */
     is_anonymous: boolean;
-    /** True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege. */
+    /** True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege. */
     can_manage_chat: boolean;
     /** True, if the administrator can delete messages of other users */
     can_delete_messages: boolean;
@@ -660,7 +660,7 @@ export interface ChatMemberAdministrator {
     can_edit_stories: boolean;
     /** True, if the administrator can delete stories posted by other users */
     can_delete_stories: boolean;
-    /** True, if the administrator can post messages in the channel, or access channel statistics; for channels only */
+    /** True, if the administrator can post messages in the channel, approve suggested posts, 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;
@@ -702,7 +702,7 @@ export interface ChatMemberRestricted {
     can_send_video_notes: boolean;
     /** True, if the user is allowed to send voice notes */
     can_send_voice_notes: boolean;
-    /** True, if the user is allowed to send polls */
+    /** True, if the user is allowed to send polls and checklists */
     can_send_polls: boolean;
     /** True, if the user is allowed to send animations, games, stickers and use inline bots */
     can_send_other_messages: boolean;
@@ -766,7 +766,7 @@ export interface ChatPermissions {
     can_send_video_notes?: boolean;
     /** True, if the user is allowed to send voice notes */
     can_send_voice_notes?: boolean;
-    /** True, if the user is allowed to send polls */
+    /** True, if the user is allowed to send polls and checklists */
     can_send_polls?: boolean;
     /** True, if the user is allowed to send animations, games, stickers and use inline bots */
     can_send_other_messages?: boolean;

package/message.d.ts

@@ -1,3 +1,4 @@
+import type { Checklist, ChecklistTasksAdded, ChecklistTasksDone } from "./checklist.js";
 import type { Chat, User } from "./manage.js";
 import type { InlineKeyboardMarkup } from "./markup.js";
 import type { PassportData } from "./passport.js";
@@ -89,6 +90,10 @@ export declare namespace Message {
     type VenueMessage = LocationMessage & MsgWith<"venue">;
     type LocationMessage = CommonMessage & MsgWith<"location">;
     type PaidMediaMessage = CommonMessage & MsgWith<"paid_media">;
+    type DirectMessagePriceChangedMessage = ServiceMessage & MsgWith<"direct_message_price_changed">;
+    type ChecklistMessage = CommonMessage & MsgWith<"checklist">;
+    type ChecklistTasksDoneMessage = ServiceMessage & MsgWith<"checklist_tasks_done">;
+    type ChecklistTasksAddedMessage = ServiceMessage & MsgWith<"checklist_tasks_added">;
     type NewChatMembersMessage = ServiceMessage & MsgWith<"new_chat_members">;
     type LeftChatMemberMessage = ServiceMessage & MsgWith<"left_chat_member">;
     type NewChatTitleMessage = ServiceMessage & MsgWith<"new_chat_title">;
@@ -172,6 +177,12 @@ export interface Message extends Message.MediaMessage {
     location?: Location;
     /** Message contains paid media; information about the paid media */
     paid_media?: PaidMediaInfo;
+    /** Message is a checklist */
+    checklist?: Checklist;
+    /** Service message: some tasks in a checklist were marked as done or not done */
+    checklist_tasks_done?: ChecklistTasksDone;
+    /** Service message: tasks were added to a checklist */
+    checklist_tasks_added?: ChecklistTasksAdded;
     /** New members that were added to the group or supergroup and information about them (the bot itself may be one of these members) */
     new_chat_members?: User[];
     /** A member was removed from the group, information about them (this member may be the bot itself) */
@@ -243,6 +254,8 @@ export interface Message extends Message.MediaMessage {
     unique_gift?: UniqueGiftInfo;
     /** Service message: the price for paid messages has changed in the chat */
     paid_message_price_changed?: PaidMessagePriceChanged;
+    /** Service message: the price for paid messages in the corresponding direct messages chat of a channel has changed */
+    direct_message_price_changed?: DirectMessagePriceChanged;
     /** Service message: video chat scheduled */
     video_chat_scheduled?: VideoChatScheduled;
     /** Service message: video chat started */
@@ -484,6 +497,8 @@ export interface ExternalReplyInfo {
     paid_media?: PaidMediaInfo;
     /** Message is a native poll, information about the poll */
     poll?: Poll;
+    /** Message is a checklist */
+    checklist?: Checklist;
     /** Message is a venue, information about the venue */
     venue?: Venue;
 }
@@ -1017,6 +1032,13 @@ export interface WriteAccessAllowed {
     /** True, if the access was granted when the bot was added to the attachment or side menu */
     from_attachment_menu?: boolean;
 }
+/** Describes a service message about a change in the price of direct messages sent to a channel chat. */
+export interface DirectMessagePriceChanged {
+    /** True, if direct messages are enabled for the channel chat; false otherwise */
+    are_direct_messages_enabled: boolean;
+    /** The new number of Telegram Stars that must be paid by users for each direct message sent to the channel. Defaults to 0. */
+    direct_message_star_count?: number;
+}
 /** This object represents a service message about a video chat scheduled in the chat. */
 export interface VideoChatScheduled {
     /** Point in time (Unix timestamp) when the video chat is supposed to be started by a chat administrator */

package/methods.d.ts

@@ -1,3 +1,4 @@
+import type { InputChecklist } from "./checklist.js";
 import type { InlineQueryResult, InlineQueryResultsButton } from "./inline.js";
 import type { LanguageCode } from "./langs.js";
 import type { AcceptedGiftTypes, BotCommand, BusinessConnection, ChatAdministratorRights, ChatFullInfo, ChatInviteLink, ChatMember, ChatMemberAdministrator, ChatMemberOwner, ChatPermissions, ForumTopic, UserChatBoosts, UserFromGetMe, UserProfilePhotos, WebhookInfo } from "./manage.js";
@@ -666,7 +667,7 @@ export type ApiMethods<F> = {
         question_parse_mode?: ParseMode;
         /** A list of special entities that appear in the poll question. It can be specified instead of question_parse_mode */
         question_entities?: MessageEntity[];
-        /** A list of 2-10 answer options */
+        /** A list of 2-12 answer options */
         options: InputPollOption[];
         /** True, if the poll needs to be anonymous, defaults to True */
         is_anonymous?: boolean;
@@ -703,6 +704,38 @@ export type ApiMethods<F> = {
         /** @deprecated Use `reply_parameters` instead. */
         reply_to_message_id?: number;
     }): Message.PollMessage;
+    /** Use this method to send a checklist on behalf of a connected business account. On success, the sent Message is returned. */
+    sendChecklist(args: {
+        /** Unique identifier of the business connection on behalf of which the message will be sent */
+        business_connection_id: string;
+        /** Unique identifier for the target chat */
+        chat_id: number;
+        /** An object for the checklist to send */
+        checklist: InputChecklist;
+        /** Sends the message silently. Users will receive a notification with no sound. */
+        disable_notification?: boolean;
+        /** Protects the contents of the sent message from forwarding and saving */
+        protect_content?: boolean;
+        /** Unique identifier of the message effect to be added to the message */
+        message_effect_id?: string;
+        /** An object for description of the message to reply to */
+        reply_parameters?: ReplyParameters;
+        /** An object for an inline keyboard */
+        reply_markup?: InlineKeyboardMarkup;
+    }): Message.ChecklistMessage;
+    /** Use this method to edit a checklist on behalf of a connected business account. On success, the edited Message is returned. */
+    editMessageChecklist(args: {
+        /** Unique identifier of the business connection on behalf of which the message will be sent */
+        business_connection_id: string;
+        /** Unique identifier for the target chat */
+        chat_id: number;
+        /** Unique identifier for the target message */
+        message_id: number;
+        /** An object for the new checklist */
+        checklist: InputChecklist;
+        /** An object for the new inline keyboard for the message */
+        reply_markup?: InlineKeyboardMarkup;
+    }): Message.ChecklistMessage;
     /** Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned. */
     sendDice(args: {
         /** Unique identifier of the business connection on behalf of which the message will be sent */
@@ -823,7 +856,7 @@ export type ApiMethods<F> = {
         user_id: number;
         /** Pass True if the administrator's presence in the chat is hidden */
         is_anonymous?: boolean;
-        /** Pass True if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege. */
+        /** Pass True if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege. */
         can_manage_chat?: boolean;
         /** Pass True if the administrator can delete messages of other users */
         can_delete_messages?: boolean;
@@ -843,7 +876,7 @@ export type ApiMethods<F> = {
         can_edit_stories?: boolean;
         /** True if the administrator can delete stories posted by other users */
         can_delete_stories?: boolean;
-        /** True if the administrator can post messages in the channel, or access channel statistics; for channels only */
+        /** Pass True if the administrator can post messages in the channel, approve suggested posts, 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;
@@ -1249,6 +1282,8 @@ export type ApiMethods<F> = {
         /** Pass True to get default administrator rights of the bot in channels. Otherwise, default administrator rights of the bot for groups and supergroups will be returned. */
         for_channels?: boolean;
     }): ChatAdministratorRights;
+    /** A method to get the current Telegram Stars balance of the bot. Requires no parameters. On success, returns a StarAmount object. */
+    getMyStarBalance(): StarAmount;
     /** Use this method to edit text and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent. */
     editMessageText(args: {
         /** Unique identifier of the business connection on behalf of which the message to be edited was sent */

package/mod.d.ts

@@ -1,4 +1,5 @@
 export * from "./api.js";
+export * from "./checklist.js";
 export * from "./inline.js";
 export * from "./manage.js";
 export * from "./markup.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grammyjs/types",
-  "version": "3.20.0",
+  "version": "3.21.0",
   "description": "Telegram Bot API type declarations for grammY",
   "main": "mod.js",
   "repository": {

package/payment.d.ts

@@ -355,12 +355,16 @@ export interface GiftInfo {
 export interface UniqueGiftInfo {
     /** Information about the gift */
     gift: UniqueGift;
-    /** Origin of the gift. Currently, either “upgrade” or “transfer” */
-    origin: "upgrade" | "transfer";
+    /** Origin of the gift. Currently, either “upgrade” for gifts upgraded from regular gifts, “transfer” for gifts transferred from other users or channels, or “resale” for gifts bought from other users */
+    origin: "upgrade" | "transfer" | "resale";
     /** Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts */
     owned_gift_id?: string;
     /** Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer the gift */
     transfer_star_count?: number;
+    /** For gifts bought from other users, the price paid for the gift */
+    last_resale_star_count?: number;
+    /** Point in time (Unix timestamp) when the gift can be transferred. If it is in the past, then the gift can be transferred now */
+    next_transfer_date?: string;
 }
 /** Describes a service message about a change in the price of paid messages within a chat. */
 export interface PaidMessagePriceChanged {
@@ -426,6 +430,8 @@ export interface OwnedGiftUnique {
     can_be_transferred?: true;
     /** Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer the gift */
     transfer_star_count?: number;
+    /** Point in time (Unix timestamp) when the gift can be transferred. If it is in the past, then the gift can be transferred now */
+    next_transfer_date?: string;
 }
 /** Contains the list of gifts received and owned by a user or a chat. */
 export interface OwnedGifts {