commonMain.entity.DiscordUser.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!
@file:Generate(
    INT_KORD_ENUM, name = "UserPremium",
    kDoc = "Premium types denote the level of premium a user has.",
    docUrl = "https://discord.com/developers/docs/resources/user#user-object-premium-types",
    entries = [
        Entry("None", intValue = 0),
        Entry("NitroClassic", intValue = 1),
        Entry("Nitro", intValue = 2),
        Entry("NitroBasic", intValue = 3)
    ],
)

@file:Generate(
    INT_FLAGS, name = "UserFlag", valueName = "code",
    collectionHadCopy0 = true,
    docUrl = "https://discord.com/developers/docs/resources/user#user-object-user-flags",
    entries = [
        Entry("DiscordEmployee", shift = 0, kDoc = "Discord Employee"),
        Entry("DiscordPartner", shift = 1, kDoc = "Partnered Server Owner"),
        Entry("HypeSquad", shift = 2, kDoc = "HypeSquad Events Member"),
        Entry("BugHunterLevel1", shift = 3, kDoc = "Bug Hunter Level 1"),
        Entry("HouseBravery", shift = 6, kDoc = "House Bravery Member"),
        Entry("HouseBrilliance", shift = 7, kDoc = "House Brilliance Member"),
        Entry("HouseBalance", shift = 8, kDoc = "House Balance Member"),
        Entry("EarlySupporter", shift = 9, kDoc = "Early Nitro Supporter"),
        Entry("TeamUser", shift = 10, kDoc = "User is a team"),
        Entry("BugHunterLevel2", shift = 14, kDoc = "Bug Hunter Level 2"),
        Entry("VerifiedBot", shift = 16, kDoc = "Verified Bot"),
        Entry("VerifiedBotDeveloper", shift = 17, kDoc = "Early Verified Bot Developer"),
        Entry("DiscordCertifiedModerator", shift = 18, kDoc = "Moderator Programs Alumni"),
        Entry(
            "BotHttpInteractions", shift = 19,
            kDoc = "Bot uses only HTTP interactions and is shown in the online member list."
        ),
        Entry(
            "ActiveDeveloper", shift = 22,
            kDoc = "User is an [Active·Developer](https://support-dev.discord.com/hc/articles/10113997751447).",
        ),
    ],
)

package dev.kord.common.entity

import dev.kord.common.entity.optional.Optional
import dev.kord.common.entity.optional.OptionalBoolean
import dev.kord.ksp.Generate
import dev.kord.ksp.Generate.EntityType.INT_FLAGS
import dev.kord.ksp.Generate.EntityType.INT_KORD_ENUM
import dev.kord.ksp.Generate.Entry
import kotlinx.serialization.ExperimentalSerializationApi
import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable
import kotlinx.serialization.json.JsonNames

/**
 * A representation of the [Discord User structure](https://discord.com/developers/docs/resources/user).
 *
 * @param id The user's id.
 * @param username the user's username, not unique across the platform.
 * @param discriminator the 4-digit discord-tag.
 * @param avatar the user's avatar hash.
 * @param bot Whether the user belongs to an OAuth2 application.
 * @param system whether the user is an Official Discord System user (part of the urgent message system).
 * @param mfaEnabled Whether the user has two factor enabled on their account.
 * @param locale The user's chosen language option.
 * @param verified Whether the email on this account has been verified. Requires the `email` OAuth2 scope.
 * @param email The user's email. Requires the `email` OAuth2 scope.
 * @param flags The flags on a user's account. Unlike [publicFlags], these **are not** visible to other users.
 * @param premiumType The type of Nitro subscription on a user's account.
 * @param publicFlags The public flags on a user's account. Unlike [flags], these **are** visible ot other users.
 * @param banner The user's banner hash.
 * @param accentColor The user's banner color encoded as an integer representation of hexadecimal color code
 * @param avatarDecoration The user's avatar decoration hash.
 */
@Serializable
public data class DiscordUser(
    val id: Snowflake,
    val username: String,
    val discriminator: Optional = Optional.Missing(),
    @SerialName("global_name")
    val globalName: Optional = Optional.Missing(),
    val avatar: String?,
    val bot: OptionalBoolean = OptionalBoolean.Missing,
    val system: OptionalBoolean = OptionalBoolean.Missing,
    @SerialName("mfa_enabled")
    val mfaEnabled: OptionalBoolean = OptionalBoolean.Missing,
    val locale: Optional = Optional.Missing(),
    val verified: OptionalBoolean = OptionalBoolean.Missing,
    val email: Optional = Optional.Missing(),
    val flags: Optional = Optional.Missing(),
    @SerialName("premium_type")
    val premiumType: Optional = Optional.Missing(),
    @SerialName("public_flags")
    val publicFlags: Optional = Optional.Missing(),
    val banner: String? = null,
    @SerialName("accent_color")
    val accentColor: Int? = null,
    @SerialName("avatar_decoration")
    val avatarDecoration: Optional = Optional.Missing(),
)

/**
 * A representation of the [Discord User structure](https://discord.com/developers/docs/resources/user).
 * This instance also contains a [member].
 *
 * @param id The user's id.
 * @param username the user's username, not unique across the platform.
 * @param discriminator the 4-digit discord-tag.
 * @param avatar the user's avatar hash.
 * @param bot Whether the user belongs to an OAuth2 application.
 * @param system whether the user is an Official Discord System user (part of the urgent message system).
 * @param mfaEnabled Whether the user has two factor enabled on their account.
 * @param locale The user's chosen language option.
 * @param verified Whether the email on this account has been verified. Requires the `email` OAuth2 scope.
 * @param email The user's email. Requires the `email` OAuth2 scope.
 * @param flags The flags on a user's account. Unlike [publicFlags], these **are not** visible to other users.
 * @param premiumType The type of Nitro subscription on a user's account.
 * @param publicFlags The public flags on a user's account. Unlike [flags], these **are** visible ot other users.
 */
@Serializable
public data class DiscordOptionallyMemberUser(
    val id: Snowflake,
    val username: String,
    val discriminator: Optional = Optional.Missing(),
    @SerialName("global_name")
    val globalName: Optional = Optional.Missing(),
    val avatar: String?,
    val bot: OptionalBoolean = OptionalBoolean.Missing,
    val system: OptionalBoolean = OptionalBoolean.Missing,
    @SerialName("mfa_enabled")
    val mfaEnabled: OptionalBoolean = OptionalBoolean.Missing,
    val locale: Optional = Optional.Missing(),
    val verified: OptionalBoolean = OptionalBoolean.Missing,
    val email: Optional = Optional.Missing(),
    val flags: Optional = Optional.Missing(),
    @SerialName("premium_type")
    val premiumType: Optional = Optional.Missing(),
    @SerialName("public_flags")
    val publicFlags: Optional = Optional.Missing(),
    @OptIn(ExperimentalSerializationApi::class)
    @JsonNames("member", "guild_member")
    val member: Optional = Optional.Missing(),
)