io.github.ydwk.yde.rest.methods.UserRestAPIMethods.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.methods

import io.github.ydwk.yde.entities.User
import io.github.ydwk.yde.entities.channel.DmChannel
import io.github.ydwk.yde.rest.RestResult

interface UserRestAPIMethods {
    /**
     * Creates a direct message channel with this user.
     *
     * @param id the id of the user.
     * @return A [RestResult] that will contain the created [DmChannel].
     */
    suspend fun createDm(id: Long): RestResult

    /**
     * Request a user by its id.
     *
     * @param id the id of the user.
     * @return A [RestResult] that will contain the requested [User].
     */
    suspend fun requestUser(id: Long): RestResult

    /**
     * Request to get a list of all the users that are visible to the bot.
     *
     * @return A [RestResult] that will contain a list of [User]s.
     */
    suspend fun requestUsers(): RestResult>
}