@grammyjs/types 3.9.0 → 3.11.0

package/manage.d.ts

@@ -214,6 +214,8 @@ export declare namespace ChatFullInfo {
         linked_chat_id?: undefined;
         /** For supergroups, the location to which the supergroup is connected */
         location?: undefined;
+        /** True, if paid media messages can be sent or forwarded to the channel chat. The field is available only for channel chats. */
+        can_send_paid_media?: undefined;
     }
     /** Internal type for group chats */
     interface GroupChat {
@@ -303,6 +305,8 @@ export declare namespace ChatFullInfo {
         linked_chat_id?: undefined;
         /** For supergroups, the location to which the supergroup is connected */
         location?: undefined;
+        /** True, if paid media messages can be sent or forwarded to the channel chat. The field is available only for channel chats. */
+        can_send_paid_media?: undefined;
     }
     /** Internal type for supergroup chats */
     interface SupergroupChat {
@@ -392,6 +396,8 @@ export declare namespace ChatFullInfo {
         linked_chat_id?: number;
         /** For supergroups, the location to which the supergroup is connected */
         location?: ChatLocation;
+        /** True, if paid media messages can be sent or forwarded to the channel chat. The field is available only for channel chats. */
+        can_send_paid_media?: undefined;
     }
     /** Internal type for channel chats */
     interface ChannelChat {
@@ -481,6 +487,8 @@ export declare namespace ChatFullInfo {
         linked_chat_id?: number;
         /** For supergroups, the location to which the supergroup is connected */
         location?: undefined;
+        /** True, if paid media messages can be sent or forwarded to the channel chat. The field is available only for channel chats. */
+        can_send_paid_media?: true;
     }
 }
 /** This object contains full information about a chat. */

package/message.d.ts

@@ -1,7 +1,7 @@
 import type { Chat, User } from "./manage.js";
 import type { InlineKeyboardMarkup } from "./markup.js";
 import type { PassportData } from "./passport.js";
-import type { Invoice, SuccessfulPayment } from "./payment.js";
+import type { Invoice, RefundedPayment, SuccessfulPayment } from "./payment.js";
 type MsgWith<P extends keyof Message> = Record<P, NonNullable<Message[P]>>;
 export declare namespace Message {
     interface ServiceMessage {
@@ -84,8 +84,9 @@ export declare namespace Message {
     type DiceMessage = CommonMessage & MsgWith<"dice">;
     type GameMessage = CommonMessage & MsgWith<"game">;
     type PollMessage = CommonMessage & MsgWith<"poll">;
-    type LocationMessage = CommonMessage & MsgWith<"location">;
     type VenueMessage = LocationMessage & MsgWith<"venue">;
+    type LocationMessage = CommonMessage & MsgWith<"location">;
+    type PaidMediaMessage = CommonMessage & MsgWith<"paid_media">;
     type NewChatMembersMessage = ServiceMessage & MsgWith<"new_chat_members">;
     type LeftChatMemberMessage = ServiceMessage & MsgWith<"left_chat_member">;
     type NewChatTitleMessage = ServiceMessage & MsgWith<"new_chat_title">;
@@ -100,6 +101,7 @@ export declare namespace Message {
     type PinnedMessageMessage = ServiceMessage & MsgWith<"pinned_message">;
     type InvoiceMessage = ServiceMessage & MsgWith<"invoice">;
     type SuccessfulPaymentMessage = ServiceMessage & MsgWith<"successful_payment">;
+    type RefundedPaymentMessage = ServiceMessage & MsgWith<"refunded_payment">;
     type UsersSharedMessage = ServiceMessage & MsgWith<"users_shared">;
     type ChatSharedMessage = ServiceMessage & MsgWith<"chat_shared">;
     type ConnectedWebsiteMessage = ServiceMessage & MsgWith<"connected_website">;
@@ -162,6 +164,8 @@ export interface Message extends Message.MediaMessage {
     venue?: Venue;
     /** Message is a shared location, information about the location */
     location?: Location;
+    /** Message contains paid media; information about the paid media */
+    paid_media?: PaidMediaInfo;
     /** 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) */
@@ -190,6 +194,8 @@ export interface Message extends Message.MediaMessage {
     invoice?: Invoice;
     /** Message is a service message about a successful payment, information about the payment. More about payments » */
     successful_payment?: SuccessfulPayment;
+    /** Message is a service message about a refunded payment, information about the payment. More about payments » */
+    refunded_payment?: RefundedPayment;
     /** Service message: users were shared with the bot */
     users_shared?: UsersShared;
     /** Service message: a chat was shared with the bot */
@@ -462,6 +468,8 @@ export interface ExternalReplyInfo {
     invoice?: Invoice;
     /** Message is a shared location, information about the location */
     location?: Location;
+    /** Message contains paid media; information about the paid media */
+    paid_media?: PaidMediaInfo;
     /** Message is a native poll, information about the poll */
     poll?: Poll;
     /** Message is a venue, information about the venue */
@@ -754,6 +762,44 @@ export interface Location {
     /** The maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only. */
     proximity_alert_radius?: number;
 }
+/** Describes the paid media added to a message. */
+export interface PaidMediaInfo {
+    /** The number of Telegram Stars that must be paid to buy access to the media */
+    star_count: number;
+    /** Information about the paid media */
+    paid_media: PaidMedia[];
+}
+/** This object describes paid media. Currently, it can be one of
+
+- PaidMediaPreview
+- PaidMediaPhoto
+- PaidMediaVideo */
+export type PaidMedia = PaidMediaPreview | PaidMediaPhoto | PaidMediaVideo;
+/** The paid media isn't available before the payment. */
+export interface PaidMediaPreview {
+    /** Type of the paid media, always “preview” */
+    type: "preview";
+    /** Media width as defined by the sender */
+    width?: number;
+    /** Media height as defined by the sender */
+    height?: number;
+    /** Duration of the media in seconds as defined by the sender */
+    duration?: number;
+}
+/** The paid media is a photo. */
+export interface PaidMediaPhoto {
+    /** Type of the paid media, always “photo” */
+    type: "photo";
+    /** The photo */
+    photo: PhotoSize[];
+}
+/** The paid media is a video. */
+export interface PaidMediaVideo {
+    /** Type of the paid media, always “video” */
+    type: "video";
+    /** The video */
+    video: Video;
+}
 /** This object represents a venue. */
 export interface Venue {
     /** Venue location. Can't be a live location */

package/methods.d.ts

@@ -133,7 +133,7 @@ export type ApiMethods<F> = {
         /** Protects the contents of the forwarded messages from forwarding and saving */
         protect_content?: boolean;
     }): MessageId[];
-    /** Use this method to copy messages of any kind. Service messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success. */
+    /** Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success. */
     copyMessage(args: {
         /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
         chat_id: number | string;
@@ -162,7 +162,7 @@ export type ApiMethods<F> = {
         /** @deprecated Use `reply_parameters` instead. */
         reply_to_message_id?: number;
     }): MessageId;
-    /** Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageId of the sent messages is returned. */
+    /** Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageId of the sent messages is returned. */
     copyMessages(args: {
         /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
         chat_id: number | string;
@@ -521,6 +521,31 @@ export type ApiMethods<F> = {
         /** An object for a new inline keyboard. */
         reply_markup?: InlineKeyboardMarkup;
     }): (Update.Edited & Message.LocationMessage) | true;
+    /** Use this method to send paid media to channel chats. On success, the sent Message is returned. */
+    sendPaidMedia(args: {
+        /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
+        chat_id: number | string;
+        /** The number of Telegram Stars that must be paid to buy access to the media */
+        star_count: number;
+        /** An array describing the media to be sent; up to 10 items */
+        media: InputPaidMedia<F>[];
+        /** Media caption, 0-1024 characters after entities parsing */
+        caption?: string;
+        /** Mode for parsing entities in the media caption. See formatting options for more details. */
+        parse_mode?: string;
+        /** A list of special entities that appear in the caption, which can be specified instead of parse_mode */
+        caption_entities?: MessageEntity[];
+        /** Pass True, if the caption must be shown above the message media */
+        show_caption_above_media?: boolean;
+        /** 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;
+        /** Description of the message to reply to */
+        reply_parameters?: ReplyParameters;
+        /** Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user */
+        reply_markup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
+    }): Message.PaidMediaMessage;
     /** Use this method to send information about a venue. On success, the sent Message is returned. */
     sendVenue(args: {
         /** Unique identifier of the business connection on behalf of which the message will be sent */
@@ -1746,4 +1771,33 @@ export interface InputMediaDocument<F> {
     /** Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always true, if the document is sent as part of an album. */
     disable_content_type_detection?: boolean;
 }
+/** This object describes the paid media to be sent. Currently, it can be one of
+
+- InputPaidMediaPhoto
+- InputPaidMediaVideo */
+export type InputPaidMedia<F> = InputMediaPhoto<F> | InputPaidMediaVideo<F>;
+/** The paid media to send is a photo. */
+export interface InputPaidMediaPhoto<F> {
+    /** Type of the media, must be photo */
+    type: "photo";
+    /** File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files » */
+    media: F | string;
+}
+/** The paid media to send is a video. */
+export interface InputPaidMediaVideo<F> {
+    /** Type of the media, must be video */
+    type: "video";
+    /** File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files » */
+    media: F | string;
+    /** Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » */
+    thumbnail?: F | string;
+    /** Video width */
+    width?: number;
+    /** Video height */
+    height?: number;
+    /** Video duration in seconds */
+    duration?: number;
+    /** Pass True if the uploaded video is suitable for streaming */
+    supports_streaming?: boolean;
+}
 export {};

package/package.json

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

package/payment.d.ts

@@ -71,6 +71,19 @@ export interface SuccessfulPayment {
     /** 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: string;
+    /** 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 */
@@ -126,10 +139,20 @@ export interface RevenueWithdrawalStateFailed {
 }
 /** This object describes the source of a transaction, or its recipient for outgoing transactions. Currently, it can be one of
 
-- TransactionPartnerFragment
 - TransactionPartnerUser
+- TransactionPartnerFragment
+- TransactionPartnerTelegramAds
 - TransactionPartnerOther */
-export type TransactionPartner = TransactionPartnerFragment | TransactionPartnerUser | TransactionPartnerOther;
+export type TransactionPartner = TransactionPartnerUser | TransactionPartnerFragment | TransactionPartnerTelegramAds | TransactionPartnerOther;
+/** Describes a transaction with a user. */
+export interface TransactionPartnerUser {
+    /** Type of the transaction partner, always “user” */
+    type: "user";
+    /** Information about the user */
+    user: User;
+    /** Bot-specified invoice payload */
+    invoice_payload?: string;
+}
 /** Describes a withdrawal transaction with Fragment. */
 export interface TransactionPartnerFragment {
     /** Type of the transaction partner, always “fragment” */
@@ -137,12 +160,10 @@ export interface TransactionPartnerFragment {
     /** 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 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 an unknown source or recipient. */
 export interface TransactionPartnerOther {

package/settings.d.ts

@@ -32,7 +32,7 @@ export interface MenuButtonWebApp {
     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. */
+    /** 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 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. */