peyk.platforms.telegram.types.owned_gift_regular

Classes

OwnedGiftRegular(gift, send_date[, type, ...])

Describes a regular gift owned by a user or a chat.
class peyk.platforms.telegram.types.owned_gift_regular.OwnedGiftRegular(gift: Gift, send_date: int, type: str = 'regular', owned_gift_id: str | None = None, sender_user: User | None = None, text: str | None = None, entities: List[MessageEntity] | None = None, is_private: bool | None = None, is_saved: bool | None = None, can_be_upgraded: bool | None = None, was_refunded: bool | None = None, convert_star_count: int | None = None, prepaid_upgrade_star_count: int | None = None, is_upgrade_separate: bool | None = None, unique_gift_number: int | None = None)[source]

Bases: object

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

Variables:

  • type (str) – Type of the gift, always ‘regular’

  • gift (peyk.platforms.telegram.types.gift.Gift) – Information about the regular gift

  • send_date (int) – Date the gift was sent in Unix time

  • owned_gift_id (str | None) – Unique identifier of the gift for the bot; for gifts received on behalf of business accounts only

  • sender_user (peyk.platforms.telegram.types.user.User | None) – Sender of the gift if it is a known user

  • text (str | None) – Text of the message that was added to the gift

  • entities (List[peyk.platforms.telegram.types.message_entity.MessageEntity] | None) – Special entities that appear in the text

  • is_private (bool | None) – True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them

  • is_saved (bool | None) – True, if the gift is displayed on the account’s profile page; for gifts received on behalf of business accounts only

  • can_be_upgraded (bool | None) – True, if the gift can be upgraded to a unique gift; for gifts received on behalf of business accounts only

  • was_refunded (bool | None) – True, if the gift was refunded and isn’t available anymore

  • convert_star_count (int | None) – 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_count (int | None) – Number of Telegram Stars that were paid for the ability to upgrade the gift

  • is_upgrade_separate (bool | None) – True, if the gift’s upgrade was purchased after the gift was sent; for gifts received on behalf of business accounts only

  • unique_gift_number (int | None) – Unique number reserved for this gift when upgraded. See the number field in UniqueGift.

gift: Gift
send_date: int
type: str = 'regular'
owned_gift_id: str | None = None
sender_user: User | None = None
text: str | None = None
entities: List[MessageEntity] | None = None
is_private: bool | None = None
is_saved: bool | None = None
can_be_upgraded: bool | None = None
was_refunded: bool | None = None
convert_star_count: int | None = None
prepaid_upgrade_star_count: int | None = None
is_upgrade_separate: bool | None = None
unique_gift_number: int | None = None
classmethod from_dict(data)
date = None