Class StarGift

constructor

• new StarGift(raw: RawStarGift): StarGift

• Parameters

  • raw: RawStarGift

  Returns StarGift

ReadonlyisUnique

Readonlyraw

availability

• get availability(): null | { remains: number; resale: Long; total: number }

• For limited availability gifts, the number of remaining and total gifts available

  Returns null | { remains: number; resale: Long; total: number }

  • null
  • { remains: number; resale: Long; total: number }

    • remains: number

    • resale: Long

      Number of gifts available on the secondary market

    • total: number

convertStars

• get convertStars(): Long

• Amount of stars the gift can be converted to by the recipient

  Returns Long

id

• get id(): Long

• ID of the gift

  Returns Long

isLimited

• get isLimited(): boolean

• Whether this gift has limited availability

  Returns boolean

isSoldOut

• get isSoldOut(): boolean

• Whether this gift sold out and cannot be bought anymore

  Returns boolean

purchaseStars

• get purchaseStars(): Long

• Amount of stars the gift was purchased for

  Returns Long

resaleFloorPrice

• get resaleFloorPrice(): null | Long

• Floor price for the gift on the secondary market

  Returns null | Long

soldOutInfo

• get soldOutInfo(): null | { firstSale: Date; lastSale: Date }

• Additional information for sold-out gifts

  Returns null | { firstSale: Date; lastSale: Date }

  • null
  • { firstSale: Date; lastSale: Date }

    • firstSale: Date

      Date when the first gift was bought

    • lastSale: Date

      Date when the last gift was bought

sticker

• get sticker(): Sticker

• Sticker associated with the gift

  Returns Sticker

title

• get title(): null | string

• Title of the gift

  Returns null | string

upgradeStars

• get upgradeStars(): null | Long

• Amount of stars the gift can be upgraded for

  Returns null | Long