Humaans.Me (Humaans v0.6.0)

Copy Markdown View Source

Singleton helper for the /me endpoint.

GET /api/me returns the profile of the authenticated user (the human whose access token was used to make the request). Useful for startup-time "who am I" checks before issuing scoped operations.

The response is decoded into a Humaans.Resources.Person struct.

Summary

Functions

Retrieves the authenticated user's profile.

Functions

get(client)

@spec get(client :: map()) ::
  {:ok, Humaans.Resources.Person.t()} | {:error, Humaans.Error.t()}

Retrieves the authenticated user's profile.

Examples

client = Humaans.new(access_token: "your_access_token")
{:ok, %Humaans.Resources.Person{} = me} = Humaans.Me.get(client)