telebot-ts API Documentation - v1.0.0
    Preparing search index...

    Interface Gift

    Telegram Bot API: Gift

    interface Gift {
        background?: GiftBackground;
        has_colors?: boolean;
        id: string;
        is_premium?: boolean;
        personal_remaining_count?: number;
        personal_total_count?: number;
        publisher_chat?: Chat;
        remaining_count?: number;
        star_count: number;
        sticker: Sticker;
        total_count?: number;
        unique_gift_variant_count?: number;
        upgrade_star_count?: number;
    }
    Index
    background? has_colors? id is_premium? personal_remaining_count? personal_total_count? publisher_chat? remaining_count? star_count sticker total_count? unique_gift_variant_count? upgrade_star_count?
    background?: GiftBackground

    Background of the gift.

    has_colors?: boolean

    True, if the gift can be used (after being upgraded) to customize a user's appearance.

    id: string

    Unique identifier of the gift.

    is_premium?: boolean

    True, if the gift can only be purchased by Telegram Premium subscribers.

    personal_remaining_count?: number

    The number of remaining gifts of this type that can be sent by the bot; for limited gifts only.

    personal_total_count?: number

    The total number of gifts of this type that can be sent by the bot; for limited gifts only.

    publisher_chat?: Chat

    Information about the chat that published the gift.

    remaining_count?: number

    The number of remaining gifts of this type that can be sent; for limited gifts only.

    star_count: number

    Number of Telegram Stars that must be paid to send the sticker.

    sticker: Sticker

    The sticker representing the gift.

    total_count?: number

    The total number of the gifts of this type that can be sent; for limited gifts only.

    unique_gift_variant_count?: number

    The total number of different unique gifts that can be obtained by upgrading the gift.

    upgrade_star_count?: number

    Number of Telegram Stars that must be paid to upgrade the gift to a unique one.

    Settings
    Member Visibility

    On This Page
    Properties