github4s.algebras.Users.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of github4s_2.12 Show documentation
Github API wrapper written in Scala
The newest version!
/*
 * Copyright 2016-2024 47 Degrees Open Source 
 *
 * 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
 *
 *     http://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 github4s.algebras

import github4s.GHResponse
import github4s.domain._

trait Users[F[_]] {

  /**
   * Get information for a particular user
   *
   * @param username of the user to retrieve
   * @param headers optional user headers to include in the request
   * @return GHResponse[User] User details
   */
  def get(username: String, headers: Map[String, String] = Map()): F[GHResponse[User]]

  /**
   * Get information of the authenticated user
   * @param headers optional user headers to include in the request
   * @return GHResponse[User] User details
   */
  def getAuth(headers: Map[String, String] = Map()): F[GHResponse[User]]

  /**
   * Get users
   *
   * @param since The integer ID of the last User that you've seen.
   * @param pagination Limit and Offset for pagination
   * @param headers optional user headers to include in the request
   * @return GHResponse[List[User]] List of user's details
   */
  def getUsers(
      since: Int,
      pagination: Option[Pagination] = None,
      headers: Map[String, String] = Map()
  ): F[GHResponse[List[User]]]

  /**
   * Get information for a particular user's list of users they follow
   *
   * @param username of the user to retrieve
   * @param pagination Limit and Offset for pagination
   * @param headers optional user headers to include in the request
   * @return GHResponse[User] User details
   */
  def getFollowing(
      username: String,
      pagination: Option[Pagination] = None,
      headers: Map[String, String] = Map()
  ): F[GHResponse[List[User]]]

  /**
   * Get information for an authenticated user's associated email addresses
   *
   * @param pagination Limit and Offset for pagination
   * @param headers optional user headers to include in the request
   * @return GHResponse[Email] Email details
   */
  def getEmails(
      pagination: Option[Pagination] = None,
      headers: Map[String, String] = Map()
  ): F[GHResponse[List[Email]]]
}