@grammyjs/types 3.8.1 → 3.9.0

package/markup.d.ts

@@ -15,7 +15,7 @@ export declare namespace InlineKeyboardButton {
         url: string;
     }
     interface CallbackButton extends AbstractInlineKeyboardButton {
-        /** Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes. Not supported for messages sent on behalf of a Telegram Business account. */
+        /** Data to be sent in a callback query to the bot when the button is pressed, 1-64 bytes */
         callback_data: string;
     }
     interface WebAppButton extends AbstractInlineKeyboardButton {

package/methods.d.ts

@@ -4,7 +4,7 @@ import type { ChatFullInfo } from "./manage.js";
 import type { ForceReply, InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove } from "./markup.js";
 import type { File, GameHighScore, InputPollOption, LinkPreviewOptions, MaskPosition, Message, MessageEntity, MessageId, ParseMode, Poll, ReactionType, ReplyParameters, SentWebAppMessage, Sticker, StickerSet } from "./message.js";
 import type { PassportElementError } from "./passport.js";
-import type { LabeledPrice, ShippingOption } from "./payment.js";
+import type { LabeledPrice, ShippingOption, StarTransactions } from "./payment.js";
 import type { BotCommandScope, BotDescription, BotName, BotShortDescription, MenuButton } from "./settings.js";
 import type { Update } from "./update.js";
 import type { LanguageCode } from "./langs.js";
@@ -94,7 +94,7 @@ export type ApiMethods<F> = {
         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 */
+        /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
@@ -203,7 +203,7 @@ export type ApiMethods<F> = {
         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 */
+        /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
@@ -242,7 +242,7 @@ export type ApiMethods<F> = {
         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 */
+        /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
@@ -275,7 +275,7 @@ export type ApiMethods<F> = {
         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 */
+        /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
@@ -318,7 +318,7 @@ export type ApiMethods<F> = {
         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 */
+        /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
@@ -359,7 +359,7 @@ export type ApiMethods<F> = {
         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 */
+        /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
@@ -390,7 +390,7 @@ export type ApiMethods<F> = {
         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 */
+        /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
@@ -420,7 +420,7 @@ export type ApiMethods<F> = {
         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 */
+        /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
@@ -443,7 +443,7 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent messages from forwarding and saving */
         protect_content?: boolean;
-        /** Unique identifier of the message effect to be added to the message */
+        /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
@@ -474,7 +474,7 @@ export type ApiMethods<F> = {
         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 */
+        /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
@@ -485,6 +485,8 @@ export type ApiMethods<F> = {
     }): Message.LocationMessage;
     /** Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. */
     editMessageLiveLocation(args: {
+        /** Unique identifier of the business connection on behalf of which the message to be edited was sent */
+        business_connection_id?: string;
         /** Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
         chat_id?: number | string;
         /** Required if inline_message_id is not specified. Identifier of the message to edit */
@@ -508,6 +510,8 @@ export type ApiMethods<F> = {
     }): (Update.Edited & Message.LocationMessage) | true;
     /** Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned. */
     stopMessageLiveLocation(args: {
+        /** Unique identifier of the business connection on behalf of which the message to be edited was sent */
+        business_connection_id?: string;
         /** Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
         chat_id?: number | string;
         /** Required if inline_message_id is not specified. Identifier of the message with live location to stop */
@@ -545,7 +549,7 @@ export type ApiMethods<F> = {
         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 */
+        /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
@@ -574,7 +578,7 @@ export type ApiMethods<F> = {
         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 */
+        /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
@@ -623,7 +627,7 @@ export type ApiMethods<F> = {
         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 */
+        /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
@@ -646,7 +650,7 @@ export type ApiMethods<F> = {
         disable_notification?: boolean;
         /** Protects the contents of the sent message from forwarding */
         protect_content?: boolean;
-        /** Unique identifier of the message effect to be added to the message */
+        /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
@@ -1143,8 +1147,10 @@ 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;
-    /** 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. */
+    /** 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 */
+        business_connection_id?: string;
         /** Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
         chat_id?: number | string;
         /** Required if inline_message_id is not specified. Identifier of the message to edit */
@@ -1162,8 +1168,10 @@ export type ApiMethods<F> = {
         /** An object for an inline keyboard. */
         reply_markup?: InlineKeyboardMarkup;
     }): (Update.Edited & Message.TextMessage) | true;
-    /** Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. */
+    /** Use this method to edit captions of 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. */
     editMessageCaption(args: {
+        /** Unique identifier of the business connection on behalf of which the message to be edited was sent */
+        business_connection_id?: string;
         /** Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
         chat_id?: number | string;
         /** Required if inline_message_id is not specified. Identifier of the message to edit */
@@ -1181,8 +1189,10 @@ export type ApiMethods<F> = {
         /** An object for an inline keyboard. */
         reply_markup?: InlineKeyboardMarkup;
     }): (Update.Edited & Message.CaptionableMessage) | true;
-    /** Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. */
+    /** Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. 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. */
     editMessageMedia(args: {
+        /** Unique identifier of the business connection on behalf of which the message to be edited was sent */
+        business_connection_id?: string;
         /** Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
         chat_id?: number | string;
         /** Required if inline_message_id is not specified. Identifier of the message to edit */
@@ -1194,8 +1204,10 @@ export type ApiMethods<F> = {
         /** An object for a new inline keyboard. */
         reply_markup?: InlineKeyboardMarkup;
     }): (Update.Edited & Message) | true;
-    /** Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. */
+    /** Use this method to edit only the reply markup of 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. */
     editMessageReplyMarkup(args: {
+        /** Unique identifier of the business connection on behalf of which the message to be edited was sent */
+        business_connection_id?: string;
         /** Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
         chat_id?: number | string;
         /** Required if inline_message_id is not specified. Identifier of the message to edit */
@@ -1207,6 +1219,8 @@ export type ApiMethods<F> = {
     }): (Update.Edited & Message) | true;
     /** Use this method to stop a poll which was sent by the bot. On success, the stopped Poll is returned. */
     stopPoll(args: {
+        /** Unique identifier of the business connection on behalf of which the message to be edited was sent */
+        business_connection_id?: string;
         /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
         chat_id: number | string;
         /** Identifier of the original message with the poll */
@@ -1253,7 +1267,7 @@ export type ApiMethods<F> = {
         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 */
+        /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
@@ -1456,7 +1470,7 @@ export type ApiMethods<F> = {
         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 */
+        /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;
@@ -1528,6 +1542,13 @@ export type ApiMethods<F> = {
         /** Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!"). Telegram will display this message to the user. */
         error_message?: string;
     }): true;
+    /** Returns the bot's Telegram Star transactions in chronological order. On success, returns a StarTransactions object. */
+    getStarTransactions(args: {
+        /** Number of transactions to skip in the response */
+        offset?: number;
+        /** The maximum number of transactions to be retrieved. Values between 1-100 are accepted. Defaults to 100. */
+        limit?: number;
+    }): StarTransactions;
     /** Refunds a successful payment in Telegram Stars. Returns True on success. */
     refundStarPayment(args: {
         /** Identifier of the user whose payment will be refunded */
@@ -1558,7 +1579,7 @@ export type ApiMethods<F> = {
         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 */
+        /** Unique identifier of the message effect to be added to the message; for private chats only */
         message_effect_id?: string;
         /** Description of the message to reply to */
         reply_parameters?: ReplyParameters;

package/package.json

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

package/payment.d.ts

@@ -99,3 +99,71 @@ export interface PreCheckoutQuery {
     /** Order information provided by the user */
     order_info?: OrderInfo;
 }
+/** 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";
+}
+/** This object describes the source of a transaction, or its recipient for outgoing transactions. Currently, it can be one of
+
+- TransactionPartnerFragment
+- TransactionPartnerUser
+- TransactionPartnerOther */
+export type TransactionPartner = TransactionPartnerFragment | TransactionPartnerUser | TransactionPartnerOther;
+/** 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 transaction with a user. */
+export interface TransactionPartnerUser {
+    /** Type of the transaction partner, always “user” */
+    type: "user";
+    /** Information about the user */
+    user: User;
+}
+/** 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. */
+export interface StarTransaction {
+    /** Unique identifier of the transaction. Coincides with the identifer of the original transaction for refund transactions. Coincides with SuccessfulPayment.telegram_payment_charge_id for successful incoming payments from users. */
+    id: string;
+    /** Number of Telegram Stars transferred by the transaction */
+    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[];
+}