Tentacat v1.2.0 Tentacat.Users

Summary

Functions

Get the authenticated user passing a client with necessary credentials

Update the authenticated user

Functions

find(client \\ %Client{}, user)

Specs

Get a single user

Example

Tentacat.Users.find "edgurgel", client
Tentacat.Users.find "iurifq", client

More info at: http://developer.github.com/v3/users/#get-a-single-user

list(client \\ %Client{}, options \\ [])

Specs

Get all users

Example

Tentacat.Users.list
Tentacat.Users.list client

More info at: http://developer.github.com/v3/users/#get-all-users

list_since(client \\ %Client{}, since, options \\ [])

Specs

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

me(client)

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

update(client, options)

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