OwnedGiftRegular

interface

Describes a regular gift owned by a user or a chat.

Declaration

interface OwnedGiftRegular

Properties

can_be_upgradedproperty#

can_be_upgraded?: boolean;

Optional. True, if the gift can be upgraded to a unique gift; for gifts received on behalf of business accounts only

convert_star_countproperty#

convert_star_count?: number;

Optional. 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; for gifts received on behalf of business accounts only

entitiesproperty#

entities?: MessageEntity[];

Optional. Special entities that appear in the text

giftproperty#

gift: Gift;

Information about the regular gift

is_privateproperty#

is_private?: boolean;

Optional. True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them

is_savedproperty#

is_saved?: boolean;

Optional. True, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only

is_upgrade_separateproperty#

is_upgrade_separate?: boolean;

Optional. True, if the gift's upgrade was purchased after the gift was sent; for gifts received on behalf of business accounts only

owned_gift_idproperty#

owned_gift_id?: string;

Optional. Unique identifier of the gift for the bot; for gifts received on behalf of business accounts only

prepaid_upgrade_star_countproperty#

prepaid_upgrade_star_count?: number;

Optional. Number of Telegram Stars that were paid for the ability to upgrade the gift

send_dateproperty#

send_date: number;

Date the gift was sent in Unix time

sender_userproperty#

sender_user?: User;

Optional. Sender of the gift if it is a known user

textproperty#

text?: string;

Optional. Text of the message that was added to the gift

typeproperty#

type: 'regular';

Type of the gift, always "regular"

unique_gift_numberproperty#

unique_gift_number?: number;

Optional. Unique number reserved for this gift when upgraded. See the number field in UniqueGift.

was_refundedproperty#

was_refunded?: boolean;

Optional. True, if the gift was refunded and isn't available anymore