commonMain.entity.DiscordInvite.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 = "InviteTargetType",
    docUrl = "https://discord.com/developers/docs/resources/invite#invite-object-invite-target-types",
    entries = [
        Entry("Stream", intValue = 1),
        Entry("EmbeddedApplication", intValue = 2),
    ],
)

package dev.kord.common.entity

import dev.kord.common.entity.optional.Optional
import dev.kord.common.entity.optional.OptionalInt
import dev.kord.common.serialization.DurationInSeconds
import dev.kord.ksp.Generate
import dev.kord.ksp.Generate.EntityType.INT_KORD_ENUM
import dev.kord.ksp.Generate.Entry
import kotlinx.datetime.Instant
import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable

public sealed interface BaseDiscordInvite {
    public val code: String
    public val guild: Optional
    public val channel: DiscordChannel?
    public val inviter: Optional
    public val targetType: Optional
    public val targetUser: Optional
    public val targetApplication: Optional
    public val approximatePresenceCount: OptionalInt
    public val approximateMemberCount: OptionalInt
    public val expiresAt: Optional
    public val guildScheduledEvent: Optional
}

@Serializable
public data class DiscordInvite(
    override val code: String,
    override val guild: Optional = Optional.Missing(),
    override val channel: DiscordChannel?,
    override val inviter: Optional = Optional.Missing(),
    @SerialName("target_type")
    override val targetType: Optional = Optional.Missing(),
    @SerialName("target_user")
    override val targetUser: Optional = Optional.Missing(),
    @SerialName("target_application")
    override val targetApplication: Optional = Optional.Missing(),
    @SerialName("approximate_presence_count")
    override val approximatePresenceCount: OptionalInt = OptionalInt.Missing,
    @SerialName("approximate_member_count")
    override val approximateMemberCount: OptionalInt = OptionalInt.Missing,
    @SerialName("expires_at")
    override val expiresAt: Optional = Optional.Missing(),
    @SerialName("stage_instance")
    @Deprecated("Stages are no longer discoverable")
    val stageInstance: Optional = Optional.Missing(),
    @SerialName("guild_scheduled_event")
    override val guildScheduledEvent: Optional = Optional.Missing(),
) : BaseDiscordInvite

@Serializable
public data class DiscordInviteWithMetadata(
    override val code: String,
    override val guild: Optional = Optional.Missing(),
    override val channel: DiscordChannel?,
    override val inviter: Optional = Optional.Missing(),
    @SerialName("target_type")
    override val targetType: Optional = Optional.Missing(),
    @SerialName("target_user")
    override val targetUser: Optional = Optional.Missing(),
    @SerialName("target_application")
    override val targetApplication: Optional = Optional.Missing(),
    @SerialName("approximate_presence_count")
    override val approximatePresenceCount: OptionalInt = OptionalInt.Missing,
    @SerialName("approximate_member_count")
    override val approximateMemberCount: OptionalInt = OptionalInt.Missing,
    @SerialName("expires_at")
    override val expiresAt: Optional = Optional.Missing(),
    @SerialName("guild_scheduled_event")
    override val guildScheduledEvent: Optional = Optional.Missing(),
    val uses: Int,
    @SerialName("max_uses")
    val maxUses: Int,
    @SerialName("max_age")
    val maxAge: DurationInSeconds,
    val temporary: Boolean,
    @SerialName("created_at")
    val createdAt: Instant,
) : BaseDiscordInvite

@Serializable
public data class DiscordPartialInvite(
    /*
    Do not trust the docs:
    2020-11-06 This is actually never null, the endpoint(Get Guild Vanity URL) returns
    a HTTP 4xx instead when the guild has no vanity url.
     */
    val code: String?,
    val uses: Int
)