GhEx.Users (gh_ex v0.3.1)

Convenience functions for the GitHub Users REST API.

Thin wrappers over GhEx.REST that return the same {:ok, body, meta} / {:error, reason} shape; opts pass through to Req.

Summary

Gets a user by username.

Gets the authenticated user.

Lists email addresses for the authenticated user.

Lists followers of a user.

Lists users followed by a user.

@spec get(GhEx.Client.t(), String.t(), keyword()) :: GhEx.REST.result()

Gets a user by username.

@spec get_authenticated(
  GhEx.Client.t(),
  keyword()
) :: GhEx.REST.result()

Gets the authenticated user.

@spec list_emails(
  GhEx.Client.t(),
  keyword()
) :: GhEx.REST.result()

Lists email addresses for the authenticated user.

@spec list_followers(GhEx.Client.t(), String.t(), keyword()) :: GhEx.REST.result()

Lists followers of a user.

@spec list_following(GhEx.Client.t(), String.t(), keyword()) :: GhEx.REST.result()

Lists users followed by a user.