Breezex.Account (breezex v0.1.0) View Source

Module implementing the Breeze account API.

Link to this section Summary

Functions

Query audit log using a map containing filters.

Get information about your account

Link to this section Functions

Link to this function

audit_log(config, filter)

View Source

Specs

audit_log(map(), map()) :: Breezex.Client.client_response()

Query audit log using a map containing filters.

Valid keys:

  • action -- see https://app.breezechms.com/api#list_account_log for valid values
  • start_date -- Date or DateTime
  • end_date -- Date or DateTime
  • user_id -- ID of user who did the action
  • details -- Boolean. Should details be included?
  • limit -- number of log entries to return. Max is 3000. Default is 500.
Link to this function

audit_log!(config, filter)

View Source

Specs

audit_log!(map(), map()) :: {map(), list()} | no_return()

Specs

Get information about your account

Specs

summary!(map()) :: {map(), list()} | no_return()