commonMain.service.TemplateService.kt Maven / Gradle / Ivy

Go to download
package dev.kord.rest.service

import dev.kord.common.entity.DiscordGuild
import dev.kord.common.entity.DiscordTemplate
import dev.kord.common.entity.Snowflake
import dev.kord.rest.builder.template.GuildFromTemplateCreateBuilder
import dev.kord.rest.builder.template.GuildTemplateCreateBuilder
import dev.kord.rest.builder.template.GuildTemplateModifyBuilder
import dev.kord.rest.json.request.GuildFromTemplateCreateRequest
import dev.kord.rest.json.request.GuildTemplateCreateRequest
import dev.kord.rest.json.request.GuildTemplateModifyRequest
import dev.kord.rest.request.RequestHandler
import dev.kord.rest.route.Route
import kotlin.contracts.InvocationKind
import kotlin.contracts.contract

public class TemplateService(requestHandler: RequestHandler) : RestService(requestHandler) {

    /**
     * Returns a [DiscordTemplate] from the given code.
     */
    public suspend fun getGuildTemplate(code: String): DiscordTemplate = call(Route.TemplateGet) {
        keys[Route.TemplateCode] = code
    }

    /**
     * Create a new guild based on a template with the given [code] and configured by the [request], returns the created guild.
     */
    public suspend fun createGuildFromTemplate(code: String, request: GuildFromTemplateCreateRequest): DiscordGuild =
        call(Route.GuildFromTemplatePost) {
            keys[Route.TemplateCode] = code
            body(GuildFromTemplateCreateRequest.serializer(), request)
        }

    /**
     * Creates a template given [guildId] configured by [request]
     *
     * Returns created [DiscordTemplate].
     */
    public suspend fun createGuildTemplate(guildId: Snowflake, request: GuildTemplateCreateRequest): DiscordTemplate =
        call(Route.GuildTemplatePost) {
            keys[Route.GuildId] = guildId
            body(GuildTemplateCreateRequest.serializer(), request)
        }

    /**
     * Returns a list of  [DiscordTemplate] given [guildId].
     */
    public suspend fun getGuildTemplates(guildId: Snowflake): List = call(Route.GuildTemplatesGet) {
        keys[Route.GuildId] = guildId
    }

    /**
     * Synchronizes a template with [code] with the current state of the Guild with [guildId]
     *
     * Returns synchronized [DiscordTemplate].
     */
    public suspend fun syncGuildTemplate(guildId: Snowflake, code: String): DiscordTemplate =
        call(Route.TemplateSyncPut) {
            keys[Route.GuildId] = guildId
            keys[Route.TemplateCode] = code
        }

    /**
     * Deletes a template given [code] and [guildId].
     *
     * Returns deleted [DiscordTemplate]
     */
    public suspend fun deleteGuildTemplate(guildId: Snowflake, code: String): DiscordTemplate =
        call(Route.TemplateDelete) {
            keys[Route.GuildId] = guildId
            keys[Route.TemplateCode] = code
        }

    /**
     * Modifies existing guild template configured by [request] given [code] and [guildId].
     *
     * Returns the modified [DiscordTemplate].
     */
    public suspend fun modifyGuildTemplate(
        guildId: Snowflake,
        code: String,
        request: GuildTemplateModifyRequest,
    ): DiscordTemplate = call(Route.TemplatePatch) {
        keys[Route.GuildId] = guildId
        keys[Route.TemplateCode] = code
        body(GuildTemplateModifyRequest.serializer(), request)
    }

    /**
     * Create a new guild with a [name] based on a template with the given [code] and configured by the [builder], returns the created guild.
     */
    public suspend inline fun createGuildFromTemplate(
        code: String,
        name: String,
        builder: GuildFromTemplateCreateBuilder.() -> Unit
    ): DiscordGuild {
        contract { callsInPlace(builder, InvocationKind.EXACTLY_ONCE) }
        val request = GuildFromTemplateCreateBuilder(name).apply(builder).toRequest()
        return createGuildFromTemplate(code, request)
    }

    /**
     * Modifies existing guild template configured by [builder] given [code] and [guildId].
     *
     * Returns the modified [DiscordTemplate].
     */
    public suspend inline fun modifyGuildTemplate(
        guildId: Snowflake,
        code: String,
        builder: GuildTemplateModifyBuilder.() -> Unit
    ): DiscordTemplate {
        contract { callsInPlace(builder, InvocationKind.EXACTLY_ONCE) }
        val request = GuildTemplateModifyBuilder().apply(builder).toRequest()
        return modifyGuildTemplate(guildId, code, request)
    }

    /**
     * Creates a guild template with [name] inside the guild with [guildId] configured by [builder].
     *
     * Returns the new [DiscordTemplate].
     */
    public suspend inline fun createGuildTemplate(
        guildId: Snowflake,
        name: String,
        builder: GuildTemplateCreateBuilder.() -> Unit
    ): DiscordTemplate {
        contract { callsInPlace(builder, InvocationKind.EXACTLY_ONCE) }
        val request = GuildTemplateCreateBuilder(name).apply(builder).toRequest()
        return createGuildTemplate(guildId, request)
    }
}