SavedStarGift

class pyrogram.raw.types.SavedStarGift

Represents a gift owned by a peer.

Constructor of SavedStarGift.

Details:

  • Layer: 223

  • ID: 41DF43FC

Parameters:

  • date (int 32-bit) – Reception date of the gift.

  • gift (StarGift) – The collectible gift.

  • name_hidden (bool, optional) – If set, the gift sender in from_id and the message are set only for the receiver of the gift.

  • unsaved (bool, optional) – If set, the gift is not pinned on the user’s profile.

  • refunded (bool, optional) – This gift was upgraded to a collectible gift » and then re-downgraded to a regular gift because a request to refund the payment related to the upgrade was made, and the money was returned.

  • can_upgrade (bool, optional) – Only set for non-collectible gifts, if they can be upgraded to a collectible gift ».

  • pinned_to_top (bool, optional) – Whether this gift is pinned on top of the user’s profile page.

  • upgrade_separate (bool, optional) – If set, someone already separately pre-paid for the upgrade of this gift.

  • from_id (Peer, optional) – Sender of the gift (unset for anonymous gifts).

  • message (TextWithEntities, optional) – Message attached to the gift.

  • msg_id (int 32-bit, optional) – For gifts received by users, ID to use in inputSavedStarGiftUser constructors.

  • saved_id (int 64-bit, optional) – For gifts received by channels, ID to use in inputSavedStarGiftChat constructors.

  • convert_stars (int 64-bit, optional) – For non-collectible gifts, the receiver of this gift may convert it to this many Telegram Stars, instead of displaying it on their profile page.

  • upgrade_stars (int 64-bit, optional) – Only for pre-paid non-collectible gifts, the number of Telegram Stars the sender has already paid to convert the gift into a collectible gift » (this is different from the meaning of the flag in messageActionStarGift, where it signals the upgrade price for not yet upgraded gifts).

  • can_export_at (int 32-bit, optional) – If set, indicates that the current gift can’t be exported to the TON blockchain » yet: the owner will be able to export it at the specified unixtime.

  • transfer_stars (int 64-bit, optional) – If set, indicates that the gift can be transferred » to another user by paying the specified amount of stars.

  • can_transfer_at (int 32-bit, optional) – If set, indicates that the current gift can’t be transferred » yet: the owner will be able to transfer it at the specified unixtime.

  • can_resell_at (int 32-bit, optional) – If set, indicates that the current gift can’t be resold » yet: the owner will be able to put it up for sale at the specified unixtime.

  • collection_id (List of int 32-bit, optional) – IDs of the collections » that this gift is a part of.

  • prepaid_upgrade_hash (str, optional) – Hash to prepay for a gift upgrade separately ».

  • drop_original_details_stars (int 64-bit, optional)

  • gift_num (int 32-bit, optional)

  • can_craft_at (int 32-bit, optional)

TL Schema

savedStarGift#41df43fc
flags:#
name_hidden:flags.0?true
unsaved:flags.5?true
refunded:flags.9?true
can_upgrade:flags.10?true
pinned_to_top:flags.12?true
upgrade_separate:flags.17?true
from_id:flags.1?Peer
date:int
gift:StarGift
message:flags.2?TextWithEntities
msg_id:flags.3?int
saved_id:flags.11?long
convert_stars:flags.4?long
upgrade_stars:flags.6?long
can_export_at:flags.7?int
transfer_stars:flags.8?long
can_transfer_at:flags.13?int
can_resell_at:flags.14?int
collection_id:flags.15?Vector<int>
prepaid_upgrade_hash:flags.16?string
drop_original_details_stars:flags.18?long
gift_num:flags.19?int
can_craft_at:flags.20?int

= SavedStarGift

Parameter Tree

SavedStarGift
├── name_hidden → true (optional)
├── unsaved → true (optional)
├── refunded → true (optional)
├── can_upgrade → true (optional)
├── pinned_to_top → true (optional)
├── upgrade_separate → true (optional)
├── from_id → Peer (optional)
│ ├── PeerUser
│ │ └── user_id → long
│ ├── PeerChat
│ │ └── chat_id → long
│ └── PeerChannel
│ └── channel_id → long
├── date → int
├── gift → StarGift
│ ├── StarGift
│ │ ├── limited → true (optional)
│ │ ├── sold_out → true (optional)
│ │ ├── birthday → true (optional)
│ │ ├── require_premium → true (optional)
│ │ ├── limited_per_user → true (optional)
│ │ ├── peer_color_available → true (optional)
│ │ ├── auction → true (optional)
│ │ ├── id → long
│ │ ├── sticker → Document
│ │ │ ├── DocumentEmpty
│ │ │ │ └── id → long
│ │ │ └── Document
│ │ │ ├── id → long
│ │ │ ├── access_hash → long
│ │ │ ├── file_reference → bytes
│ │ │ ├── date → int
│ │ │ ├── mime_type → string
│ │ │ ├── size → long
│ │ │ ├── thumbs → Vector < PhotoSize > (optional)
│ │ │ │ ├── PhotoSizeEmpty
│ │ │ │ ├── PhotoSize
│ │ │ │ ├── PhotoCachedSize
│ │ │ │ ├── PhotoStrippedSize
│ │ │ │ ├── PhotoSizeProgressive
│ │ │ │ └── PhotoPathSize
│ │ │ ├── video_thumbs → Vector < VideoSize > (optional)
│ │ │ │ ├── VideoSize
│ │ │ │ ├── VideoSizeEmojiMarkup
│ │ │ │ └── VideoSizeStickerMarkup
│ │ │ ├── dc_id → int
│ │ │ └── attributes → Vector < DocumentAttribute >
│ │ │ ├── DocumentAttributeImageSize
│ │ │ ├── DocumentAttributeAnimated
│ │ │ ├── DocumentAttributeSticker
│ │ │ ├── DocumentAttributeVideo
│ │ │ ├── DocumentAttributeAudio
│ │ │ ├── DocumentAttributeFilename
│ │ │ ├── DocumentAttributeHasStickers
│ │ │ └── DocumentAttributeCustomEmoji
│ │ ├── stars → long
│ │ ├── availability_remains → int (optional)
│ │ ├── availability_total → int (optional)
│ │ ├── availability_resale → long (optional)
│ │ ├── convert_stars → long
│ │ ├── first_sale_date → int (optional)
│ │ ├── last_sale_date → int (optional)
│ │ ├── upgrade_stars → long (optional)
│ │ ├── resell_min_stars → long (optional)
│ │ ├── title → string (optional)
│ │ ├── released_by → Peer (optional)
│ │ │ ├── PeerUser
│ │ │ │ └── user_id → long
│ │ │ ├── PeerChat
│ │ │ │ └── chat_id → long
│ │ │ └── PeerChannel
│ │ │ └── channel_id → long
│ │ ├── per_user_total → int (optional)
│ │ ├── per_user_remains → int (optional)
│ │ ├── locked_until_date → int (optional)
│ │ ├── auction_slug → string (optional)
│ │ ├── gifts_per_round → int (optional)
│ │ ├── auction_start_date → int (optional)
│ │ ├── upgrade_variants → int (optional)
│ │ └── background → StarGiftBackground (optional)
│ │ └── StarGiftBackground
│ │ ├── center_color → int
│ │ ├── edge_color → int
│ │ └── text_color → int
│ └── StarGiftUnique
│ ├── require_premium → true (optional)
│ ├── resale_ton_only → true (optional)
│ ├── theme_available → true (optional)
│ ├── burned → true (optional)
│ ├── crafted → true (optional)
│ ├── id → long
│ ├── gift_id → long
│ ├── title → string
│ ├── slug → string
│ ├── num → int
│ ├── owner_id → Peer (optional)
│ │ ├── PeerUser
│ │ │ └── user_id → long
│ │ ├── PeerChat
│ │ │ └── chat_id → long
│ │ └── PeerChannel
│ │ └── channel_id → long
│ ├── owner_name → string (optional)
│ ├── owner_address → string (optional)
│ ├── attributes → Vector < StarGiftAttribute >
│ │ ├── StarGiftAttributeModel
│ │ │ ├── crafted → true (optional)
│ │ │ ├── name → string
│ │ │ ├── document → Document
│ │ │ │ ├── DocumentEmpty
│ │ │ │ └── Document
│ │ │ └── rarity → StarGiftAttributeRarity
│ │ │ ├── StarGiftAttributeRarity
│ │ │ ├── StarGiftAttributeRarityUncommon
│ │ │ ├── StarGiftAttributeRarityRare
│ │ │ ├── StarGiftAttributeRarityEpic
│ │ │ └── StarGiftAttributeRarityLegendary
│ │ ├── StarGiftAttributePattern
│ │ │ ├── name → string
│ │ │ ├── document → Document
│ │ │ │ ├── DocumentEmpty
│ │ │ │ └── Document
│ │ │ └── rarity → StarGiftAttributeRarity
│ │ │ ├── StarGiftAttributeRarity
│ │ │ ├── StarGiftAttributeRarityUncommon
│ │ │ ├── StarGiftAttributeRarityRare
│ │ │ ├── StarGiftAttributeRarityEpic
│ │ │ └── StarGiftAttributeRarityLegendary
│ │ ├── StarGiftAttributeBackdrop
│ │ │ ├── name → string
│ │ │ ├── backdrop_id → int
│ │ │ ├── center_color → int
│ │ │ ├── edge_color → int
│ │ │ ├── pattern_color → int
│ │ │ ├── text_color → int
│ │ │ └── rarity → StarGiftAttributeRarity
│ │ │ ├── StarGiftAttributeRarity
│ │ │ ├── StarGiftAttributeRarityUncommon
│ │ │ ├── StarGiftAttributeRarityRare
│ │ │ ├── StarGiftAttributeRarityEpic
│ │ │ └── StarGiftAttributeRarityLegendary
│ │ └── StarGiftAttributeOriginalDetails
│ │ ├── sender_id → Peer (optional)
│ │ │ ├── PeerUser
│ │ │ ├── PeerChat
│ │ │ └── PeerChannel
│ │ ├── recipient_id → Peer
│ │ │ ├── PeerUser
│ │ │ ├── PeerChat
│ │ │ └── PeerChannel
│ │ ├── date → int
│ │ └── message → TextWithEntities (optional)
│ │ └── TextWithEntities
│ ├── availability_issued → int
│ ├── availability_total → int
│ ├── gift_address → string (optional)
│ ├── resell_amount → Vector < StarsAmount > (optional)
│ │ ├── StarsAmount
│ │ │ ├── amount → long
│ │ │ └── nanos → int
│ │ └── StarsTonAmount
│ │ └── amount → long
│ ├── released_by → Peer (optional)
│ │ ├── PeerUser
│ │ │ └── user_id → long
│ │ ├── PeerChat
│ │ │ └── chat_id → long
│ │ └── PeerChannel
│ │ └── channel_id → long
│ ├── value_amount → long (optional)
│ ├── value_currency → string (optional)
│ ├── value_usd_amount → long (optional)
│ ├── theme_peer → Peer (optional)
│ │ ├── PeerUser
│ │ │ └── user_id → long
│ │ ├── PeerChat
│ │ │ └── chat_id → long
│ │ └── PeerChannel
│ │ └── channel_id → long
│ ├── peer_color → PeerColor (optional)
│ │ ├── PeerColor
│ │ │ ├── color → int (optional)
│ │ │ └── background_emoji_id → long (optional)
│ │ ├── PeerColorCollectible
│ │ │ ├── collectible_id → long
│ │ │ ├── gift_emoji_id → long
│ │ │ ├── background_emoji_id → long
│ │ │ ├── accent_color → int
│ │ │ ├── colors → Vector < int >
│ │ │ ├── dark_accent_color → int (optional)
│ │ │ └── dark_colors → Vector < int > (optional)
│ │ └── InputPeerColorCollectible
│ │ └── collectible_id → long
│ ├── host_id → Peer (optional)
│ │ ├── PeerUser
│ │ │ └── user_id → long
│ │ ├── PeerChat
│ │ │ └── chat_id → long
│ │ └── PeerChannel
│ │ └── channel_id → long
│ ├── offer_min_stars → int (optional)
│ └── craft_chance_permille → int (optional)
├── message → TextWithEntities (optional)
│ └── TextWithEntities
│ ├── text → string
│ └── entities → Vector < MessageEntity >
│ ├── MessageEntityUnknown
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityMention
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityHashtag
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityBotCommand
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityUrl
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityEmail
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityBold
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityItalic
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityCode
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityPre
│ │ ├── offset → int
│ │ ├── length → int
│ │ └── language → string
│ ├── MessageEntityTextUrl
│ │ ├── offset → int
│ │ ├── length → int
│ │ └── url → string
│ ├── MessageEntityMentionName
│ │ ├── offset → int
│ │ ├── length → int
│ │ └── user_id → long
│ ├── InputMessageEntityMentionName
│ │ ├── offset → int
│ │ ├── length → int
│ │ └── user_id → InputUser
│ │ ├── InputUserEmpty
│ │ ├── InputUserSelf
│ │ ├── InputUser
│ │ └── InputUserFromMessage
│ ├── MessageEntityPhone
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityCashtag
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityUnderline
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityStrike
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityBankCard
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntitySpoiler
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityCustomEmoji
│ │ ├── offset → int
│ │ ├── length → int
│ │ └── document_id → long
│ ├── MessageEntityBlockquote
│ │ ├── collapsed → true (optional)
│ │ ├── offset → int
│ │ └── length → int
│ └── MessageEntityFormattedDate
│ ├── relative → true (optional)
│ ├── short_time → true (optional)
│ ├── long_time → true (optional)
│ ├── short_date → true (optional)
│ ├── long_date → true (optional)
│ ├── day_of_week → true (optional)
│ ├── offset → int
│ ├── length → int
│ └── date → int
├── msg_id → int (optional)
├── saved_id → long (optional)
├── convert_stars → long (optional)
├── upgrade_stars → long (optional)
├── can_export_at → int (optional)
├── transfer_stars → long (optional)
├── can_transfer_at → int (optional)
├── can_resell_at → int (optional)
├── collection_id → Vector < int > (optional)
├── prepaid_upgrade_hash → string (optional)
├── drop_original_details_stars → long (optional)
├── gift_num → int (optional)
└── can_craft_at → int (optional)

Example

SavedStarGift(
    date=0,
    gift=StarGift(
        id=0,
        sticker=DocumentEmpty(id=0),
        stars=0,
        convert_stars=0
    ),
)