Ramp.AuditLogs (ramp v1.0.0)

Copy Markdown View Source

The Audit Logs resource: read-only access to the audit event log for the business.

Summary

Types

list_opt()

Functions

list(client, opts \\ [])

Returns a lazily auto-paginating Stream of Ramp.AuditLogs.Events.

list_page(client, opts \\ [])

Fetches a single page of audit events. See Ramp.Page.

Types

list_opt()

@type list_opt() ::
  {:start, String.t()}
  | {:page_size, pos_integer()}
  | {:user_ids, [String.t()]}
  | {:from_date, DateTime.t()}
  | {:to_date, DateTime.t()}
  | {:event_actor_types, [String.t()]}
  | {:event_types, [String.t()]}
  | {:object_id, String.t()}
  | {:object_type, String.t()}

Functions

list(client, opts \\ [])

@spec list(Ramp.Client.t(), [list_opt()]) :: Enumerable.t(Ramp.AuditLogs.Event.t())

Returns a lazily auto-paginating Stream of Ramp.AuditLogs.Events.

:user_ids, :event_types, and :event_actor_types accept lists and are sent as repeated query parameters.

list_page(client, opts \\ [])

@spec list_page(Ramp.Client.t(), [list_opt()]) ::
  {:ok, Ramp.Page.t(Ramp.AuditLogs.Event.t())} | {:error, Ramp.Error.t()}

Fetches a single page of audit events. See Ramp.Page.