Tentacat

v0.7.2

Tentacat v0.7.2 Tentacat.Users

Summary

Functions

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

Get a single user

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

Get all users

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

Get all users since since id

me(client)

Get the authenticated user passing a client with necessary credentials

update(options, client)

Update the authenticated user

Functions

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

Specs

find(binary, Tentacat.Client.t) :: Tentacat.response

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 \\ %Tentacat.Client{}, options \\ [])

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(since, client \\ %Tentacat.Client{}, options \\ [])

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)

Specs

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

update(options, client)

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], client

More info at: http://developer.github.com/v3/users/#update-the-authenticated-user