Mercury.Users (mercury_client v1.0.0)

The Mercury Users API — platform users on the organization.

Summary

Returns a single user by ID. GET /users/{id}

Returns one page of users. GET /users

A lazy, auto-paginating stream of every user.

@spec get(client :: Mercury.Client.t(), user_id :: String.t()) ::
  {:ok, Mercury.User.t()} | {:error, Exception.t()}

Returns a single user by ID. GET /users/{id}

@spec get!(client :: Mercury.Client.t(), user_id :: String.t()) :: Mercury.User.t()

@spec list(client :: Mercury.Client.t(), opts :: keyword()) ::
  {:ok, Mercury.Page.t(Mercury.User.t())} | {:error, Exception.t()}

Returns one page of users. GET /users

@spec list!(client :: Mercury.Client.t(), opts :: keyword()) ::
  Mercury.Page.t(Mercury.User.t())

@spec stream(client :: Mercury.Client.t(), opts :: keyword()) :: Enumerable.t()

A lazy, auto-paginating stream of every user.