@grammyjs/types 3.18.0 → 3.19.0

package/manage.d.ts

@@ -192,6 +192,10 @@ export declare namespace ChatFullInfo {
         pinned_message?: Message;
         /** Default chat member permissions, for groups and supergroups */
         permissions?: undefined;
+        /** True, if gifts can be sent to the chat */
+        can_send_gift?: true;
+        /** 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;
         /** For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds */
         slow_mode_delay?: undefined;
         /** For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions */
@@ -216,8 +220,6 @@ 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 {
@@ -283,6 +285,10 @@ export declare namespace ChatFullInfo {
         pinned_message?: Message;
         /** Default chat member permissions, for groups and supergroups */
         permissions?: ChatPermissions;
+        /** True, if gifts can be sent to the chat */
+        can_send_gift?: true;
+        /** 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;
         /** For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds */
         slow_mode_delay?: undefined;
         /** For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions */
@@ -307,8 +313,6 @@ 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 {
@@ -374,6 +378,10 @@ export declare namespace ChatFullInfo {
         pinned_message?: Message;
         /** Default chat member permissions, for groups and supergroups */
         permissions?: ChatPermissions;
+        /** True, if gifts can be sent to the chat */
+        can_send_gift?: true;
+        /** 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;
         /** For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds */
         slow_mode_delay?: number;
         /** For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions */
@@ -398,8 +406,6 @@ 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 {
@@ -465,6 +471,10 @@ export declare namespace ChatFullInfo {
         pinned_message?: Message;
         /** Default chat member permissions, for groups and supergroups */
         permissions?: undefined;
+        /** True, if gifts can be sent to the chat */
+        can_send_gift?: true;
+        /** 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;
         /** For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds */
         slow_mode_delay?: undefined;
         /** For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions */
@@ -489,8 +499,6 @@ 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

@@ -487,7 +487,7 @@ export interface ReplyParameters {
     /** 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;
     /** Mode for parsing entities in the quote. See formatting options for more details. */
-    quote_parse_mode?: string;
+    quote_parse_mode?: ParseMode;
     /** A JSON-serialized list of special entities that appear in the quote. It can be specified instead of quote_parse_mode. */
     quote_entities?: MessageEntity[];
     /** Position of the quote in the original message in UTF-16 code units */
@@ -633,6 +633,10 @@ export interface Video {
     duration: number;
     /** Video thumbnail */
     thumbnail?: PhotoSize;
+    /** Available sizes of the cover of the video in the message */
+    cover?: PhotoSize[];
+    /** Timestamp in seconds from which the video will play in the message */
+    start_timestamp?: number;
     /** Original filename as defined by sender */
     file_name?: string;
     /** MIME type of the file as defined by sender */
@@ -702,7 +706,7 @@ export interface InputPollOption {
     /** Option text, 1-100 characters */
     text: string;
     /** Mode for parsing entities in the text. See formatting options for more details. Currently, only custom emoji entities are allowed */
-    text_parse_mode?: string;
+    text_parse_mode?: ParseMode;
     /** A list of special entities that appear in the poll option text. It can be specified instead of text_parse_mode */
     text_entities?: MessageEntity[];
 }

package/methods.d.ts

@@ -112,6 +112,8 @@ export type ApiMethods<F> = {
         message_thread_id?: number;
         /** Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername) */
         from_chat_id: number | string;
+        /** New start timestamp for the copied video in the message */
+        video_start_timestamp?: number;
         /** Sends the message silently. Users will receive a notification with no sound. */
         disable_notification?: boolean;
         /** Protects the contents of the forwarded message from forwarding and saving */
@@ -144,10 +146,12 @@ export type ApiMethods<F> = {
         from_chat_id: number | string;
         /** Message identifier in the chat specified in from_chat_id */
         message_id: number;
+        /** New start timestamp for the copied video in the message */
+        video_start_timestamp?: number;
         /** New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept */
         caption?: string;
         /** Mode for parsing entities in the new caption. See formatting options for more details. */
-        parse_mode?: string;
+        parse_mode?: ParseMode;
         /** A list of special entities that appear in the new caption, which can be specified instead of parse_mode */
         caption_entities?: MessageEntity[];
         /** Pass True, if the caption must be shown above the message media. Ignored if a new caption isn't specified. */
@@ -311,6 +315,10 @@ export type ApiMethods<F> = {
         height?: number;
         /** 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>. */
         thumbnail?: F;
+        /** Cover for the video in the message. 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. */
+        cover?: F | string;
+        /** Start timestamp for the video in the message */
+        start_timestamp?: number;
         /** Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing */
         caption?: string;
         /** Mode for parsing entities in the video caption. See formatting options for more details. */
@@ -557,7 +565,7 @@ export type ApiMethods<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;
+        parse_mode?: ParseMode;
         /** 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 */
@@ -654,7 +662,7 @@ export type ApiMethods<F> = {
         /** Poll question, 1-300 characters */
         question: string;
         /** Mode for parsing entities in the question. See formatting options for more details. Currently, only custom emoji entities are allowed */
-        question_parse_mode?: string;
+        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 */
@@ -734,7 +742,7 @@ export type ApiMethods<F> = {
         /** Unique identifier for the target message thread; for supergroups only */
         message_thread_id?: number;
     }): true;
-    /** Use this method to change the chosen reactions on a message. Service messages can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Bots can't use paid reactions. Returns True on success. */
+    /** Use this method to change the chosen reactions on a message. Service messages of some types can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Bots can't use paid reactions. Returns True on success. */
     setMessageReaction(args: {
         /** Unique identifier for the target chat or username of the target channel (in the format @channelusername) */
         chat_id: number | string;
@@ -1488,12 +1496,14 @@ export type ApiMethods<F> = {
         /** Custom emoji identifier of a sticker from the sticker set; pass an empty string to drop the thumbnail and use the first sticker as the thumbnail. */
         custom_emoji_id?: string;
     }): true;
-    /** Returns the list of gifts that can be sent by the bot to users. Requires no parameters. Returns a Gifts object. */
+    /** Returns the list of gifts that can be sent by the bot to users and channel chats. Requires no parameters. Returns a Gifts object. */
     getAvailableGifts(): Gifts;
-    /** Sends a gift to the given user. The gift can't be converted to Telegram Stars by the user. Returns True on success. */
+    /** Sends a gift to the given user or channel chat. The gift can't be converted to Telegram Stars by the receiver. Returns True on success. */
     sendGift(args: {
-        /** Unique identifier of the target user that will receive the gift */
-        user_id: number;
+        /** Required if chat_id is not specified. Unique identifier of the target user who will receive the gift. */
+        user_id?: number;
+        /** Required if user_id is not specified. Unique identifier for the chat or username of the channel (in the format @channelusername) that will receive the gift. */
+        chat_id?: number | string;
         /** Identifier of the gift */
         gift_id: string;
         /** Pass True to pay for the gift upgrade from the bot's balance, thereby making the upgrade free for the receiver */
@@ -1663,7 +1673,7 @@ export type ApiMethods<F> = {
         ok: boolean;
         /** Required if ok is True. An array of available shipping options. */
         shipping_options?: readonly ShippingOption[];
-        /** Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. "Sorry, delivery to your desired address is unavailable'). Telegram will display this message to the user. */
+        /** Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. “Sorry, delivery to your desired address is unavailable”). Telegram will display this message to the user. */
         error_message?: string;
     }): true;
     /** Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent. */
@@ -1832,6 +1842,10 @@ export interface InputMediaVideo<F> {
     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>. */
     thumbnail?: F;
+    /** Cover for the video in the message. 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. */
+    cover?: F | string;
+    /** Start timestamp for the video in the message */
+    start_timestamp?: number;
     /** Caption of the video to be sent, 0-1024 characters after entities parsing */
     caption?: string;
     /** Pass True, if the caption must be shown above the message media */
@@ -1934,6 +1948,10 @@ export interface InputPaidMediaVideo<F> {
     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;
+    /** Cover for the video in the message. 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. */
+    cover?: F | string;
+    /** Start timestamp for the video in the message */
+    start_timestamp?: number;
     /** Video width */
     width?: number;
     /** Video height */

package/package.json

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

package/payment.d.ts

@@ -55,7 +55,7 @@ export interface ShippingOption {
     /** List of price portions */
     prices: LabeledPrice[];
 }
-/** This object contains basic information about a successful payment. */
+/** 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;
@@ -160,12 +160,13 @@ export interface AffiliateInfo {
 /** 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 | TransactionPartnerAffiliateProgram | TransactionPartnerFragment | TransactionPartnerTelegramAds | TransactionPartnerTelegramApi | TransactionPartnerOther;
+export type TransactionPartner = TransactionPartnerUser | TransactionPartnerChat | TransactionPartnerAffiliateProgram | TransactionPartnerFragment | TransactionPartnerTelegramAds | TransactionPartnerTelegramApi | TransactionPartnerOther;
 /** Describes a transaction with a user. */
 export interface TransactionPartnerUser {
     /** Type of the transaction partner, always “user” */
@@ -183,7 +184,16 @@ export interface TransactionPartnerUser {
     /** Bot-specified paid media payload */
     paid_media_payload?: string;
     /** The gift sent to the user by the bot */
-    gift?: string;
+    gift?: Gift;
+}
+/** 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 {
@@ -218,7 +228,7 @@ export interface TransactionPartnerOther {
     /** Type of the transaction partner, always “other” */
     type: "other";
 }
-/** Describes a Telegram Star transaction. */
+/** 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;