ExDoppler.ActivityLogs (ExDoppler v1.0.1)

View Source

Module for interacting with ExDoppler.ActivityLog

๐Ÿ“– Resources

Summary

Functions

Same as get_activity_log/1 but won't wrap a successful response in {:ok, response}

Same as list_activity_logs/1 but won't wrap a successful response in {:ok, response}

Functions

get_activity_log(id)

Retrieves an ExDoppler.ActivityLog

๐Ÿท๏ธ Params

  • id: Unique identifier for the log object. (e.g "dmwk7ra70oem3xa")

โคต๏ธ Returns

โœ… On Success

  {:ok, %ExDoppler.ActivityLog{...}}

โŒ On Failure

  {:error, err}

๐Ÿ’ป Examples

iex> alias ExDoppler.ActivityLogs
iex> alias ExDoppler.ActivityLog
iex> [%ActivityLog{id: id} | _ ] = ActivityLogs.list_activity_logs!(page: 1, per_page: 20)
iex> {:ok, _log = %ActivityLog{}} = ActivityLogs.get_activity_log(id)

๐Ÿ“– Resources

get_activity_log!(id)

Same as get_activity_log/1 but won't wrap a successful response in {:ok, response}

list_activity_logs(opts \\ [])

Lists ExDoppler.ActivityLog using pagination.

๐Ÿท๏ธ Params

  • opts: Optional modifications to the list call
    • page - which page to list (starts at 1) (e.g page: 2). Default: 1
    • per_page - the number of ExDoppler.ActivityLog to return for this page (e.g per_page: 50). Default: 20

โคต๏ธ Returns

โœ… On Success

  {:ok, [%ExDoppler.ActivityLog{...} ...]}

โŒ On Failure

  {:error, err}

๐Ÿ’ป Examples

iex> alias ExDoppler.ActivityLogs
iex> {:ok, _logs} = ActivityLogs.list_activity_logs(page: 1, per_page: 20)

๐Ÿ“– Resources

list_activity_logs!(opts \\ [])

Same as list_activity_logs/1 but won't wrap a successful response in {:ok, response}