Tentacat.Users
Summary
| find(user, client \\ %Tentacat.Client{}) | Get a single |
| list(client \\ %Tentacat.Client{}) | Get all users |
| list_since(since, client \\ %Tentacat.Client{}) | Get all users since |
| me(client) | Get the authenticated user passing a |
| update(options, client) | Update the authenticated user |
Functions
Specs:
- find(binary, Tentacat.Client.t) :: Tentacat.response
Get a single user
Example
Tentacat.Users.find "edgurgel", client
Tentacat.Users.find "iurifq", clientMore info at: http:\developer.github.com/v3/users/#get-a-single-user
Specs:
- list(Tentacat.Client.t) :: Tentacat.response
Get all users
Example
Tentacat.Users.list
Tentacat.Users.list clientMore info at: http:\developer.github.com/v3/users/#get-all-users
Specs:
- list_since(integer, Tentacat.Client.t) :: Tentacat.response
Get all users since since id
Example
Tentacat.Users.list_since 348
Tentacat.Users.list_since 348, clientMore info at: http:\developer.github.com/v3/users/#get-all-users
Specs:
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
Specs:
- update(Keyword.t, Tentacat.Client.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], clientMore info at: http:\developer.github.com/v3/users/#update-the-authenticated-user