Available types

OwnedGiftRegular

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

fields

fieldtyperequireddescription
typestringrequiredType of the gift, always “regular”
giftGiftrequiredInformation about the regular gift
owned_gift_idstringoptionalOptional. Unique identifier of the gift for the bot; for gifts received on behalf of business accounts only
sender_userUseroptionalOptional. Sender of the gift if it is a known user
send_datenumberrequiredDate the gift was sent in Unix time
textstringoptionalOptional. Text of the message that was added to the gift
entitiesMessageEntity[]optionalOptional. Special entities that appear in the text
is_privatebooleanoptionalOptional. True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them
is_savedbooleanoptionalOptional. True, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only
can_be_upgradedbooleanoptionalOptional. True, if the gift can be upgraded to a unique gift; for gifts received on behalf of business accounts only
was_refundedbooleanoptionalOptional. True, if the gift was refunded and isn't available anymore
convert_star_countnumberoptionalOptional. 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
prepaid_upgrade_star_countnumberoptionalOptional. Number of Telegram Stars that were paid for the ability to upgrade the gift
is_upgrade_separatebooleanoptionalOptional. True, if the gift's upgrade was purchased after the gift was sent; for gifts received on behalf of business accounts only
unique_gift_numbernumberoptionalOptional. Unique number reserved for this gift when upgraded. See the number field in UniqueGift.

import

types.ts
import type { OwnedGiftRegular } from "@yaebal/types";

used by

types