@grammyjs/types 3.22.2 → 3.24.0

package/package.json

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

package/payment.d.ts

@@ -259,6 +259,15 @@ export interface PaidMediaPurchased {
     /** Bot-specified paid media payload */
     paid_media_payload: string;
 }
+/** This object describes the background of a gift. */
+export interface GiftBackground {
+    /** Center color of the background in RGB format */
+    center_color: number;
+    /** Edge color of the background in RGB format */
+    edge_color: number;
+    /** Text color of the background in RGB format */
+    text_color: number;
+}
 /** This object represents a gift that can be sent by the bot. */
 export interface Gift {
     /** Unique identifier of the gift */
@@ -267,14 +276,26 @@ export interface Gift {
     publisher_chat?: Chat;
     /** The sticker that represents the gift */
     sticker: Sticker;
+    /** Background of the gift */
+    background?: GiftBackground;
+    /** True, if the gift can only be purchased by Telegram Premium subscribers */
+    is_premium?: true;
+    /** True, if the gift can be used (after being upgraded) to customize a user's appearance */
+    has_colors?: true;
     /** The number of Telegram Stars that must be paid to send the sticker */
     star_count: number;
     /** The number of Telegram Stars that must be paid to upgrade the gift to a unique one */
     upgrade_star_count?: number;
-    /** The total number of the gifts of this type that can be sent; for limited gifts only */
+    /** The total number of different unique gifts that can be obtained by upgrading the gift */
+    unique_gift_variant_count?: number;
+    /** The total number of gifts of this type that can be sent by all users; for limited gifts only */
     total_count?: number;
-    /** The number of remaining gifts of this type that can be sent; for limited gifts only */
+    /** The number of remaining gifts of this type that can be sent by all users; for limited gifts only */
     remaining_count?: number;
+    /** The total number of gifts of this type that can be sent by the bot; for limited gifts only */
+    personal_total_count?: number;
+    /** The number of remaining gifts of this type that can be sent by the bot; for limited gifts only */
+    personal_remaining_count?: number;
 }
 /** This object represent a list of gifts. */
 export interface Gifts {
@@ -287,8 +308,10 @@ export interface UniqueGiftModel {
     name: string;
     /** The sticker that represents the unique gift */
     sticker: Sticker;
-    /** The number of unique gifts that receive this model for every 1000 gifts upgraded */
+    /** The number of unique gifts that receive this model for every 1000 gift upgrades. Always 0 for crafted gifts. */
     rarity_per_mille: number;
+    /** Rarity of the model if it is a crafted model. Currently, can be “uncommon”, “rare”, “epic”, or “legendary”. */
+    rarity?: "uncommon" | "rare" | "epic" | "legendary";
 }
 /** This object describes the symbol shown on the pattern of a unique gift. */
 export interface UniqueGiftSymbol {
@@ -321,12 +344,18 @@ export interface UniqueGiftBackdrop {
 }
 /** This object describes a unique gift that was upgraded from a regular gift. */
 export interface UniqueGift {
+    /** Identifier of the regular gift from which the gift was upgraded */
+    gift_id: string;
     /** Human-readable name of the regular gift from which this unique gift was upgraded */
     base_name: string;
     /** Unique name of the gift. This name can be used in https://t.me/nft/... links and story areas */
     name: string;
     /** Information about the chat that published the gift */
     publisher_chat?: Chat;
+    /** True, if the original regular gift was exclusively purchaseable by Telegram Premium subscribers */
+    is_premium?: true;
+    /** True, if the gift is assigned from the TON blockchain and can't be resold or transferred in Telegram */
+    is_from_blockchain?: true;
     /** Unique number of the upgraded gift among gifts upgraded from the same regular gift */
     number: number;
     /** Model of the gift */
@@ -335,6 +364,25 @@ export interface UniqueGift {
     symbol: UniqueGiftSymbol;
     /** Backdrop of the gift */
     backdrop: UniqueGiftBackdrop;
+    /** The color scheme that can be used by the gift's owner for the chat's name, replies to messages and link previews */
+    colors?: UniqueGiftColors;
+    /** True, if the gift was used to craft another gift and isn't available anymore */
+    is_burned?: true;
+}
+/** This object contains information about the color scheme for a user's name, message replies and link previews based on a unique gift. */
+export interface UniqueGiftColors {
+    /** Custom emoji identifier of the unique gift's model */
+    model_custom_emoji_id: string;
+    /** Custom emoji identifier of the unique gift's symbol */
+    symbol_custom_emoji_id: string;
+    /** Main color used in light themes; RGB format */
+    light_theme_main_color: number;
+    /** List of 1-3 additional colors used in light themes; RGB format */
+    light_theme_other_colors: number[];
+    /** Main color used in dark themes; RGB format */
+    dark_theme_main_color: number;
+    /** List of 1-3 additional colors used in dark themes; RGB format */
+    dark_theme_other_colors: number[];
 }
 /** Describes a service message about a regular gift that was sent or received. */
 export interface GiftInfo {
@@ -348,6 +396,10 @@ export interface GiftInfo {
     prepaid_upgrade_star_count?: number;
     /** True, if the gift can be upgraded to a unique gift */
     can_be_upgraded?: true;
+    /** True, if the gift's upgrade was purchased after the gift was sent */
+    is_upgrade_separate?: true;
+    /** Unique number reserved for this gift when upgraded. See the number field in UniqueGift */
+    unique_gift_number?: number;
     /** Text of the message that was added to the gift */
     text?: string;
     /** Special entities that appear in the text */
@@ -359,16 +411,18 @@ export interface GiftInfo {
 export interface UniqueGiftInfo {
     /** Information about the gift */
     gift: UniqueGift;
-    /** 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";
+    /** Origin of the gift. Currently, either “upgrade” for gifts upgraded from regular gifts, “transfer” for gifts transferred from other users or channels, “resale” for gifts bought from other users, “gifted_upgrade” for upgrades purchased after the gift was sent, or “offer” for gifts bought or sold through gift purchase offers */
+    origin: "upgrade" | "transfer" | "resale" | "gifted_upgrade" | "offer";
     /** 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;
+    /** For gifts bought from other users, the currency in which the payment for the gift was done. Currently, one of “XTR” for Telegram Stars or “TON” for toncoins. */
+    last_resale_currency?: "XTR" | "TON";
+    /** For gifts bought from other users, the price paid for the gift in either Telegram Stars or nanotoncoins */
+    last_resale_amount?: 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;
+    next_transfer_date?: number;
 }
 /** Describes a service message about a change in the price of paid messages within a chat. */
 export interface PaidMessagePriceChanged {
@@ -399,6 +453,8 @@ export interface OwnedGiftRegular {
     sender_user?: User;
     /** Date the gift was sent in Unix time */
     send_date: number;
+    /** Unique number reserved for this gift when upgraded. See the number field in UniqueGift */
+    unique_gift_number?: number;
     /** Text of the message that was added to the gift */
     text?: string;
     /** Special entities that appear in the text */
@@ -409,6 +465,8 @@ export interface OwnedGiftRegular {
     is_saved?: true;
     /** True, if the gift can be upgraded to a unique gift; for gifts received on behalf of business accounts only */
     can_be_upgraded?: true;
+    /** True, if the gift's upgrade was purchased after the gift was sent */
+    is_upgrade_separate?: true;
     /** True, if the gift was refunded and isn't available anymore */
     was_refunded?: true;
     /** Number of Telegram Stars that can be claimed by the receiver instead of the gift; omitted if the gift cannot be converted to Telegram Stars */
@@ -435,7 +493,7 @@ export interface OwnedGiftUnique {
     /** 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;
+    next_transfer_date?: number;
 }
 /** Contains the list of gifts received and owned by a user or a chat. */
 export interface OwnedGifts {
@@ -446,7 +504,7 @@ export interface OwnedGifts {
     /** Offset for the next request. If empty, then there are no more results */
     next_offset?: string;
 }
-/** Desribes price of a suggested post. */
+/** Describes the price of a suggested post. */
 export interface SuggestedPostPrice {
     /** Currency in which the post will be paid. Currently, must be one of “XTR” for Telegram Stars or “TON” for toncoins */
     currency: "XTR" | "TON";

package/settings.d.ts

@@ -99,21 +99,21 @@ export interface BotCommandScopeAllChatAdministrators {
 export interface BotCommandScopeChat {
     /** Scope type, must be chat */
     type: "chat";
-    /** Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername). Channel direct messages chats and channel chats aren't supported. */
+    /** Unique identifier for the target chat or username of the target supergroup (in the format `@supergroupusername`). Channel direct messages chats and channel chats aren't supported. */
     chat_id: number | string;
 }
 /** Represents the scope of bot commands, covering all administrators of a specific group or supergroup chat. */
 export interface BotCommandScopeChatAdministrators {
     /** Scope type, must be chat_administrators */
     type: "chat_administrators";
-    /** Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername). Channel direct messages chats and channel chats aren't supported. */
+    /** Unique identifier for the target chat or username of the target supergroup (in the format `@supergroupusername`). Channel direct messages chats and channel chats aren't supported. */
     chat_id: number | string;
 }
 /** Represents the scope of bot commands, covering a specific member of a group or supergroup chat. */
 export interface BotCommandScopeChatMember {
     /** Scope type, must be chat_member */
     type: "chat_member";
-    /** Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername). Channel direct messages chats and channel chats aren't supported. */
+    /** Unique identifier for the target chat or username of the target supergroup (in the format `@supergroupusername`). Channel direct messages chats and channel chats aren't supported. */
     chat_id: number | string;
     /** Unique identifier of the target user */
     user_id: number;