@telegram.ts/types 1.24.0 → 1.25.0

package/src/checkListTask.d.ts

@@ -1,4 +1,4 @@
-import type { User } from "./manageTypes";
+import type { Chat, User } from "./manageTypes";
 import type { Message, MessageEntity, ParseMode } from "./messageTypes";
 
 /** Describes a task in a checklist. */
@@ -9,8 +9,10 @@ export interface ChecklistTask {
   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 */
+  /** User that completed the task; omitted if the task wasn't completed by a user */
   completed_by_user?: User;
+  /** Chat that completed the task; omitted if the task wasn't completed by a chat */
+  completed_by_chat?: Chat;
   /** Point in time (Unix timestamp) when the task was completed; 0 if the task wasn't completed */
   completion_date?: number;
 }
@@ -36,7 +38,7 @@ export interface InputChecklistTask {
   /** 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?: ParseMode;
+  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[];
 }

package/src/inlineTypes.d.ts

@@ -7,6 +7,7 @@ import type {
   ParseMode,
 } from "./messageTypes";
 import type { LabeledPrice } from "./invoiceTypes";
+
 /** This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results. */
 export interface InlineQuery {
   /** Unique identifier for this query */

package/src/invoiceTypes.d.ts

@@ -66,7 +66,7 @@ export interface ShippingOption {
   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;
@@ -184,16 +184,16 @@ export interface AffiliateInfo {
 
 - TransactionPartnerUser
 - TransactionPartnerChat
-- TransactionPartnerFragment
 - TransactionPartnerAffiliateProgram
+- TransactionPartnerFragment
 - TransactionPartnerTelegramAds
-- TransactionPartnerTelegramApi 
+- TransactionPartnerTelegramApi
 - TransactionPartnerOther */
 export type TransactionPartner =
   | TransactionPartnerUser
   | TransactionPartnerChat
-  | TransactionPartnerFragment
   | TransactionPartnerAffiliateProgram
+  | TransactionPartnerFragment
   | TransactionPartnerTelegramAds
   | TransactionPartnerTelegramApi
   | TransactionPartnerOther;
@@ -213,13 +213,13 @@ export interface TransactionPartnerUser {
   user: User;
   /** Information about the affiliate that received a commission via this transaction. Can be available only for “invoice_payment” and “paid_media_payment” transactions. */
   affiliate?: AffiliateInfo;
-  /** The duration of the paid subscription. Can be available only for “invoice_payment” transactions. */
-  subscription_period?: number;
   /** Bot-specified invoice payload. Can be available only for “invoice_payment” transactions. */
   invoice_payload?: string;
-  /** Information about the paid media bought by the user. Can be available only for “invoice_payment” transactions. */
+  /** The duration of the paid subscription. Can be available only for “invoice_payment” transactions. */
+  subscription_period?: number;
+  /** Information about the paid media bought by the user; for “paid_media_payment” transactions only */
   paid_media?: PaidMedia[];
-  /** Bot-specified paid media payload. Can be available only for “invoice_payment” transactions. */
+  /** Bot-specified paid media payload. Can be available only for “paid_media_payment” transactions. */
   paid_media_payload?: string;
   /** The gift sent to the user by the bot; for “gift_purchase” transactions only */
   gift?: Gift;
@@ -255,6 +255,12 @@ export interface TransactionPartnerFragment {
   withdrawal_state?: RevenueWithdrawalState;
 }
 
+/** 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 payment for paid broadcasting. */
 export interface TransactionPartnerTelegramApi {
   /** Type of the transaction partner, always “telegram_api” */
@@ -263,21 +269,15 @@ export interface TransactionPartnerTelegramApi {
   request_count: number;
 }
 
-/** 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 {
   /** 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 identifer of the original transaction for refund transactions. Coincides with SuccessfulPayment.telegram_payment_charge_id for successful incoming payments from users. */
+  /** 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;
   /** Integer amount of Telegram Stars transferred by the transaction */
   amount: number;
@@ -305,6 +305,16 @@ export interface PaidMediaPurchased {
   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 */
@@ -313,14 +323,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. */
@@ -333,8 +355,6 @@ export interface Gifts {
 export interface UniqueGiftModel {
   /** Name of the model */
   name: string;
-  /** Information about the chat that published the gift */
-  publisher_chat?: Chat;
   /** The sticker that represents the unique gift */
   sticker: Sticker;
   /** The number of unique gifts that receive this model for every 1000 gifts upgraded */
@@ -375,12 +395,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 */
@@ -389,6 +415,24 @@ 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;
+}
+
+/** 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. */
@@ -403,6 +447,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 */
@@ -415,14 +463,16 @@ 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?: number;
 }
@@ -442,6 +492,7 @@ export interface StarAmount {
 }
 
 /** This object describes a gift received and owned by a user or a chat. Currently, it can be one of
+
 - OwnedGiftRegular
 - OwnedGiftUnique */
 export type OwnedGift = OwnedGiftRegular | OwnedGiftUnique;
@@ -458,6 +509,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 */
@@ -468,14 +521,14 @@ 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 */
   convert_star_count?: number;
   /** Number of Telegram Stars that were paid by the sender for the ability to upgrade the gift */
   prepaid_upgrade_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 unique gift received and owned by a user or a chat. */
@@ -510,7 +563,7 @@ export interface OwnedGifts {
   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";