commonMain.entity.DiscordApplication.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_FLAGS, name = "ApplicationFlag", valueName = "code",
    docUrl = "https://discord.com/developers/docs/resources/application#application-object-application-flags",
    entries = [
        Entry(
            "ApplicationAutoModerationRuleCreateBadge", shift = 6,
            kDoc = "Indicates if an app uses the Auto Moderation API.",
        ),
        Entry(
            "GatewayPresence", shift = 12,
            kDoc = "Intent required for bots in **100 or more servers** to receive `PresenceUpdate` events.",
        ),
        Entry(
            "GatewayPresenceLimited", shift = 13,
            kDoc = "Intent required for bots in under 100 servers to receive `PresenceUpdate` events, found on the " +
                "**Bot** page in your app's settings.",
        ),
        Entry(
            "GatewayGuildMembers", shift = 14,
            kDoc = "Intent required for bots in **100 or more servers** to receive member-related events like " +
                "`GuildMemberAdd`.\n\nSee the list of member-related events " +
                "[under·`GUILD_MEMBERS`](https://discord.com/developers/docs/topics/gateway#list-of-intents).",
        ),
        Entry(
            "GatewayGuildMembersLimited", shift = 15,
            kDoc = "Intent required for bots in under 100 servers to receive member-related events like " +
                "`GuildMemberAdd`, found on the **Bot** page in your app's settings.\n\nSee the list of " +
                "member-related events " +
                "[under·`GUILD_MEMBERS`](https://discord.com/developers/docs/topics/gateway#list-of-intents).",
        ),
        Entry(
            "VerificationPendingGuildLimit", shift = 16,
            kDoc = "Indicates unusual growth of an app that prevents verification.",
        ),
        Entry(
            "Embedded", shift = 17,
            kDoc = "Indicates if an app is embedded within the Discord client (currently unavailable publicly).",
        ),
        Entry(
            "GatewayMessageContent", shift = 18,
            kDoc = "Intent required for bots in **100 or more servers** to receive " +
                "[message·content](https://support-dev.discord.com/hc/en-us/articles/4404772028055).",
        ),
        Entry(
            "GatewayMessageContentLimited", shift = 19,
            kDoc = "Intent required for bots in under 100 servers to receive " +
                "[message·content](https://support-dev.discord.com/hc/en-us/articles/4404772028055), found on the " +
                "**Bot** page in your app's settings.",
        ),
        Entry(
            "ApplicationCommandBadge", shift = 23,
            kDoc = "Indicates if an app has registered global application commands.",
        ),
    ],
)

package dev.kord.common.entity

import dev.kord.common.entity.optional.Optional
import dev.kord.common.entity.optional.OptionalSnowflake
import dev.kord.ksp.Generate
import dev.kord.ksp.Generate.EntityType.INT_FLAGS
import dev.kord.ksp.Generate.Entry
import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable

public sealed interface BaseDiscordApplication {
    public val id: Snowflake
    public val name: String
    public val icon: String?
    public val description: String
    public val rpcOrigins: Optional>
    public val termsOfServiceUrl: Optional
    public val privacyPolicyUrl: Optional
    public val owner: Optional
    public val verifyKey: String
    public val guildId: OptionalSnowflake
    public val primarySkuId: OptionalSnowflake
    public val slug: Optional
    public val coverImage: Optional
    public val flags: Optional
    public val tags: Optional>
    public val installParams: Optional
    public val customInstallUrl: Optional
    public val roleConnectionsVerificationUrl: Optional
}

/**
 * A representation of the
 * [Application Structure](https://discord.com/developers/docs/resources/application#application-object-application-structure).
 */
@Serializable
public data class DiscordApplication(
    override val id: Snowflake,
    override val name: String,
    override val icon: String?,
    override val description: String,
    @SerialName("rpc_origins")
    override val rpcOrigins: Optional> = Optional.Missing(),
    @SerialName("bot_public")
    val botPublic: Boolean,
    @SerialName("bot_require_code_grant")
    val botRequireCodeGrant: Boolean,
    @SerialName("terms_of_service_url")
    override val termsOfServiceUrl: Optional = Optional.Missing(),
    @SerialName("privacy_policy_url")
    override val privacyPolicyUrl: Optional = Optional.Missing(),
    override val owner: Optional = Optional.Missing(),
    @SerialName("verify_key")
    override val verifyKey: String,
    val team: DiscordTeam?,
    @SerialName("guild_id")
    override val guildId: OptionalSnowflake = OptionalSnowflake.Missing,
    @SerialName("primary_sku_id")
    override val primarySkuId: OptionalSnowflake = OptionalSnowflake.Missing,
    override val slug: Optional = Optional.Missing(),
    @SerialName("cover_image")
    override val coverImage: Optional = Optional.Missing(),
    override val flags: Optional = Optional.Missing(),
    override val tags: Optional> = Optional.Missing(),
    @SerialName("install_params")
    override val installParams: Optional = Optional.Missing(),
    @SerialName("custom_install_url")
    override val customInstallUrl: Optional = Optional.Missing(),
    @SerialName("role_connections_verification_url")
    override val roleConnectionsVerificationUrl: Optional = Optional.Missing(),
) : BaseDiscordApplication

/**
 * A representation of the partial
 * [Application Structure](https://discord.com/developers/docs/resources/application#application-object-application-structure)
 * sent in [invite create events](https://discord.com/developers/docs/topics/gateway-events#invite-create).
 */
@Serializable
public data class DiscordPartialApplication(
    override val id: Snowflake,
    override val name: String,
    override val icon: String?,
    override val description: String,
    @SerialName("rpc_origins")
    override val rpcOrigins: Optional> = Optional.Missing(),
    @SerialName("terms_of_service_url")
    override val termsOfServiceUrl: Optional = Optional.Missing(),
    @SerialName("privacy_policy_url")
    override val privacyPolicyUrl: Optional = Optional.Missing(),
    override val owner: Optional = Optional.Missing(),
    @SerialName("verify_key")
    override val verifyKey: String,
    @SerialName("guild_id")
    override val guildId: OptionalSnowflake = OptionalSnowflake.Missing,
    @SerialName("primary_sku_id")
    override val primarySkuId: OptionalSnowflake = OptionalSnowflake.Missing,
    override val slug: Optional = Optional.Missing(),
    @SerialName("cover_image")
    override val coverImage: Optional = Optional.Missing(),
    override val flags: Optional = Optional.Missing(),
    override val tags: Optional> = Optional.Missing(),
    @SerialName("install_params")
    override val installParams: Optional = Optional.Missing(),
    @SerialName("custom_install_url")
    override val customInstallUrl: Optional = Optional.Missing(),
    @SerialName("role_connections_verification_url")
    override val roleConnectionsVerificationUrl: Optional = Optional.Missing(),
) : BaseDiscordApplication

@Serializable
public data class InstallParams(
    /** The scopes to add the application to the server with. */
    val scopes: List,
    /** The permissions to request for the bot role. */
    val permissions: Permissions,
)