ex_uptimerobot v0.4.0 ExUptimerobot.AlertContact

Interact with Alert Contact -related API methods.

Summary

Functions

Delete an existing alert contact by the ID of alert contact

Edit an existing alert contact with given parameters

Get all alert contacts, or a set of contacts as specified by params. Full documentation for all parameters can be found from https://uptimerobot.com/api

new_alert_contact(params \\ [])

Add new alert contact with given parameters

Functions

delete_alert_contact(id)

delete_alert_contact(integer) :: tuple

delete_alert_contact(String.t) :: tuple

Delete an existing alert contact by the ID of alert contact

Example

iex> ExUptimerobot.AlertContact.delete_alert_contact(1337)
{:ok, response}

edit_alert_contact(params \\ [])

edit_alert_contact([tuple]) :: tuple

Edit an existing alert contact with given parameters

Required: id Optional: friendly_name, value

Example

iex> ExUptimerobot.AlertContact.edit_alert_contact([id: 1337, friendly_name: "Edited contact"])
{:ok, response}

get_alert_contacts(params \\ [])

get_alert_contacts([tuple]) :: tuple

Get all alert contacts, or a set of contacts as specified by params. Full documentation for all parameters can be found from https://uptimerobot.com/api.

Example

iex> ExUptimerobot.AlertContact.get_alert_contacts()
{:ok, results}

new_alert_contact(params \\ [])

new_alert_contact([tuple]) :: tuple

Add new alert contact with given parameters.

Two parameters are required: type and value. One is optional: friendly_name

Example

iex> ExUptimerobot.AlertContact.new_alert_contact([friendly_name: "Main email", value: "your-email@example.com", type: 2])
{:ok, response}