io.github.ydwk.yde.rest.RestApiManager.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yde-api Show documentation
YDE (Yusuf's Discord Entities) API contains all the entities that are used in wrappers like YDWK.
The newest version!
/*
 * Copyright 2024 YDWK inc.
 *
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 *
 * you may not use this file except in compliance with the License.
 *
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */ 
package io.github.ydwk.yde.rest

import io.ktor.http.content.*

/** Manages the REST API */
interface RestApiManager {

    /**
     * Adds a query parameters to the request
     *
     * @param key The key of the query parameter
     * @param value The value of the query parameter
     * @return The RestApiManager
     */
    fun addQueryParameter(key: String, value: String): RestApiManager

    /**
     * Gets a certain endpoint from the API.
     *
     * @param endPoint The endpoint to get.
     * @param params The parameters to be used in the endpoint.
     * @return The [SimilarRestApi] instance.
     */
    suspend fun get(endPoint: EndPoint.IEnumEndpoint, vararg params: String): SimilarRestApi

    /**
     * Gets a certain endpoint from the API.
     *
     * @param endPoint The endpoint to get.
     * @return The [SimilarRestApi] instance.
     */
    suspend fun get(endPoint: EndPoint.IEnumEndpoint): SimilarRestApi {
        return get(endPoint, *arrayOf())
    }

    /**
     * Posts something to the API.
     *
     * @param body The body of the request.
     * @param endPoint The endpoint to post to.
     * @param params The parameters to be added to the endpoint.
     * @return The [SimilarRestApi] instance.
     */
    suspend fun post(
        body: OutgoingContent?,
        endPoint: EndPoint.IEnumEndpoint,
        vararg params: String,
    ): SimilarRestApi

    /**
     * Pots something to the API.
     *
     * @param body The body of the request.
     * @param endPoint The endpoint to post to.
     * @return The [SimilarRestApi] instance.
     */
    suspend fun post(body: OutgoingContent?, endPoint: EndPoint.IEnumEndpoint): SimilarRestApi {
        return post(body, endPoint, *arrayOf())
    }

    /**
     * Puts something to the API.
     *
     * @param body The body of the request.
     * @param endPoint The endpoint to put to.
     * @param params The parameters to put to the endpoint.
     * @return The [SimilarRestApi] instance.
     */
    suspend fun put(
        body: OutgoingContent?,
        endPoint: EndPoint.IEnumEndpoint,
        vararg params: String
    ): SimilarRestApi

    /**
     * Puts something to the API.
     *
     * @param body The body of the request.
     * @param endPoint The endpoint to put to.
     * @return The [SimilarRestApi] instance.
     */
    suspend fun put(body: OutgoingContent?, endPoint: EndPoint.IEnumEndpoint): SimilarRestApi {
        return put(body, endPoint, *arrayOf())
    }

    /**
     * Deletes something from the API.
     *
     * @param endPoint The endpoint to delete from.
     * @param params The parameters to be used in the endpoint.
     * @return The [SimilarRestApi] instance.
     */
    suspend fun delete(
        body: OutgoingContent?,
        endPoint: EndPoint.IEnumEndpoint,
        vararg params: String,
    ): SimilarRestApi

    /**
     * Deletes something from the API.
     *
     * @param body The body of the request.
     * @param endPoint The endpoint to delete from.
     * @return The [SimilarRestApi] instance.
     */
    suspend fun delete(body: OutgoingContent, endPoint: EndPoint.IEnumEndpoint): SimilarRestApi {
        return delete(body, endPoint, *arrayOf())
    }

    /**
     * Deletes something from the API.
     *
     * @param endPoint The endpoint to delete from.
     * @param params The parameters to be used in the endpoint.
     * @return The [SimilarRestApi] instance.
     */
    suspend fun delete(endPoint: EndPoint.IEnumEndpoint, vararg params: String): SimilarRestApi {
        return delete(null, endPoint, *params)
    }

    /**
     * Deletes something from the API.
     *
     * @param endPoint The endpoint to delete from.
     * @return The [SimilarRestApi] instance.
     */
    suspend fun delete(endPoint: EndPoint.IEnumEndpoint): SimilarRestApi {
        return delete(null, endPoint)
    }

    /**
     * Patches something from the API.
     *
     * @param body The body of the request.
     * @param endPoint The endpoint to patch from.
     * @param params The parameters to be used in the endpoint.
     * @return The [SimilarRestApi] instance.
     */
    suspend fun patch(
        body: OutgoingContent,
        endPoint: EndPoint.IEnumEndpoint,
        vararg params: String,
    ): SimilarRestApi

    companion object {
        var FULL_DISCORD_REST_URL = "https://discord.com/api/v10"

        fun setFullDiscordRestUrl(url: String) {
            FULL_DISCORD_REST_URL = url
        }
    }
}