github4s/github4s.algebras/Users

Users

trait Users[F[_]]
class Object
trait Matchable
class Any

Value members

Abstract methods

def get(username: String, headers: Map[String, String]): F[GHResponse[User]]

Get information for a particular user

Get information for a particular user

Value Params
headers

optional user headers to include in the request

username

of the user to retrieve

Returns

GHResponse[User] User details

def getAuth(headers: Map[String, String]): F[GHResponse[User]]

Get information of the authenticated user

Get information of the authenticated user

Value Params
headers

optional user headers to include in the request

Returns

GHResponse[User] User details

def getFollowing(username: String, pagination: Option[Pagination], headers: Map[String, String]): F[GHResponse[List[User]]]

Get information for a particular user's list of users they follow

Get information for a particular user's list of users they follow

Value Params
headers

optional user headers to include in the request

pagination

Limit and Offset for pagination

username

of the user to retrieve

Returns

GHResponse[User] User details

def getUsers(since: Int, pagination: Option[Pagination], headers: Map[String, String]): F[GHResponse[List[User]]]

Get users

Get users

Value Params
headers

optional user headers to include in the request

pagination

Limit and Offset for pagination

since

The integer ID of the last User that you've seen.

Returns

GHResponse[List[User]] List of user's details