commonMain.com.bselzer.gw2.v2.model.guild.Guild.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of v2-model Show documentation

Guild Wars 2 API models for v2-client.

The newest version!

package com.bselzer.gw2.v2.model.guild

import com.bselzer.gw2.v2.model.guild.emblem.GuildEmblem
import com.bselzer.gw2.v2.scope.core.Permission
import com.bselzer.gw2.v2.scope.core.Requirement
import com.bselzer.gw2.v2.scope.core.Scope
import com.bselzer.ktx.value.identifier.Identifiable
import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable

@Scope(Requirement.OPTIONAL, Permission.GUILDS)
@Serializable
data class Guild(
    /**
     * The id in the form of a UUID.
     */
    @SerialName("id")
    override val id: GuildId = GuildId(),

    @Scope(Requirement.REQUIRED, Permission.GUILDS)
    @SerialName("level")
    val level: GuildLevel = GuildLevel(),

    /**
     * The message of the day for guild members.
     */
    @Scope(Requirement.REQUIRED, Permission.GUILDS)
    @SerialName("motd")
    val messageOfTheDay: String = "",

    /**
     * The current amount of influence.
     */
    @Scope(Requirement.REQUIRED, Permission.GUILDS)
    @SerialName("influence")
    val influence: Int = 0,

    /**
     * The current aetherium level.
     */
    @Scope(Requirement.REQUIRED, Permission.GUILDS)
    @SerialName("aetherium")
    val aetherium: Int = 0,

    /**
     * The current favor level.
     */
    @Scope(Requirement.REQUIRED, Permission.GUILDS)
    @SerialName("favor")
    val favor: Int = 0,

    /**
     * The current number of members in the guild.
     */
    @Scope(Requirement.REQUIRED, Permission.GUILDS)
    @SerialName("member_count")
    val memberCount: Int = 0,

    /**
     * The maximum number of members allowed in the guild.
     */
    @Scope(Requirement.REQUIRED, Permission.GUILDS)
    @SerialName("member_capacity")
    val memberCapacity: Int = 0,

    @SerialName("name")
    val name: String = "",

    /**
     * The 2 to 4 letter tag representing the guild.
     */
    @SerialName("tag")
    val tag: String = "",

    @SerialName("emblem")
    val emblem: GuildEmblem? = null
) : Identifiable