Mercury.Events (mercury_client v1.0.0)

The Mercury Events API — an audit log of account and org changes.

Summary

Returns a single event by ID. GET /events/{id}

Returns one page of events. GET /events

A lazy, auto-paginating stream of every event.

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

Returns a single event by ID. GET /events/{id}

@spec get!(client :: Mercury.Client.t(), event_id :: String.t()) :: Mercury.Event.t()

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

Returns one page of events. GET /events

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

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

A lazy, auto-paginating stream of every event.