View Source Tentacat.Users (Tentacat v2.5.0)
Summary
Functions
Get a single user
.
Get all users.
Get all users since since
id.
Get the authenticated user passing a client
with necessary credentials.
Update the authenticated user.
Functions
@spec find(Tentacat.Client.t(), binary()) :: Tentacat.response()
Get a single user
.
Example
Tentacat.Users.find client, "edgurgel"
Tentacat.Users.find client, "iurifq"
More info at: http://developer.github.com/v3/users/#get-a-single-user
@spec list(Tentacat.Client.t(), any()) :: Tentacat.response()
Get all users.
Example
Tentacat.Users.list
Tentacat.Users.list client
More info at: http://developer.github.com/v3/users/#get-all-users
@spec list_since(Tentacat.Client.t(), integer(), any()) :: Tentacat.response()
Get all users since since
id.
Example
Tentacat.Users.list_since 348
Tentacat.Users.list_since 348, client
More info at: http://developer.github.com/v3/users/#get-all-users
@spec me(Tentacat.Client.t()) :: Tentacat.response()
Get the authenticated user passing a client
with necessary credentials.
Example
Tentacat.Users.me(client)
More info at: http://developer.github.com/v3/users/#get-the-authenticated-user
@spec update(Tentacat.Client.t(), Keyword.t()) :: Tentacat.response()
Update the authenticated user.
Possible values for options
:
- [name: "name"]
- [email: "email"]
- [blog: "blog.com"]
- [company: "My Company"]
- [location: "Internet"]
- [hireable: true]
- [bio: "Hireable developer"]
Example
Tentacat.Users.update [email: "eduardo@gurgel.me", hireable: false], client
More info at: http://developer.github.com/v3/users/#update-the-authenticated-user