commonMain.dev.kord.common.entity.PremiumTier.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kord-common-jvm Show documentation
Idiomatic Kotlin Wrapper for The Discord API
The newest version!
// THIS FILE IS AUTO-GENERATED, DO NOT EDIT!
@file:Suppress(names = arrayOf("IncorrectFormatting", "ReplaceArrayOfWithLiteral",
                "SpellCheckingInspection", "GrazieInspection"))

package dev.kord.common.entity

import kotlin.LazyThreadSafetyMode.PUBLICATION
import kotlinx.serialization.KSerializer
import kotlinx.serialization.Serializable
import kotlinx.serialization.descriptors.PrimitiveKind
import kotlinx.serialization.descriptors.PrimitiveSerialDescriptor
import kotlinx.serialization.descriptors.SerialDescriptor
import kotlinx.serialization.encoding.Decoder
import kotlinx.serialization.encoding.Encoder

/**
 * See [PremiumTier]s in the
 * [Discord Developer Documentation](https://discord.com/developers/docs/resources/guild#guild-object-premium-tier).
 */
@Serializable(with = PremiumTier.Serializer::class)
public sealed class PremiumTier(
    /**
     * The raw value used by Discord.
     */
    public val `value`: Int,
) {
    final override fun equals(other: Any?): Boolean = this === other ||
            (other is PremiumTier && this.value == other.value)

    final override fun hashCode(): Int = value.hashCode()

    final override fun toString(): String = if (this is Unknown) "PremiumTier.Unknown(value=$value)"
            else "PremiumTier.${this::class.simpleName}"

    /**
     * An unknown [PremiumTier].
     *
     * This is used as a fallback for [PremiumTier]s that haven't been added to Kord yet.
     */
    public class Unknown internal constructor(
        `value`: Int,
    ) : PremiumTier(value)

    /**
     * Guild has not unlocked any Server Boost perks.
     */
    public object None : PremiumTier(0)

    /**
     * Guild has unlocked Server Boost level 1 perks.
     */
    public object One : PremiumTier(1)

    /**
     * Guild has unlocked Server Boost level 2 perks.
     */
    public object Two : PremiumTier(2)

    /**
     * Guild has unlocked Server Boost level 3 perks.
     */
    public object Three : PremiumTier(3)

    internal object Serializer : KSerializer {
        override val descriptor: SerialDescriptor =
                PrimitiveSerialDescriptor("dev.kord.common.entity.PremiumTier", PrimitiveKind.INT)

        override fun serialize(encoder: Encoder, `value`: PremiumTier) {
            encoder.encodeInt(value.value)
        }

        override fun deserialize(decoder: Decoder): PremiumTier = from(decoder.decodeInt())
    }

    public companion object {
        /**
         * A [List] of all known [PremiumTier]s.
         */
        public val entries: List by lazy(mode = PUBLICATION) {
            listOf(
                None,
                One,
                Two,
                Three,
            )
        }

        /**
         * Returns an instance of [PremiumTier] with [PremiumTier.value] equal to the specified
         * [value].
         */
        public fun from(`value`: Int): PremiumTier = when (value) {
            0 -> None
            1 -> One
            2 -> Two
            3 -> Three
            else -> Unknown(value)
        }
    }
}