NodePing.ContactGroups (NodePing Elixir v1.7.1) View Source

iex> token = System.fetch_env!("TOKEN")
iex> members = ["9GJ7EHJX", "GFRWVKD9"]
iex> opts = %{:name => "contactgroup name", :members => members}
iex> {:ok, result} = NodePing.ContactGroups.create(token, opts)

create!(token, opts, customerid \\ nil)

Create a contact group from your NodePing account or subaccount.

Parameters

token - NodePing API token that is provided with account
opts - Optional Map of parameters for new contact group
customerid - optional ID to access a subaccount

Opts

name - A label for the group
members - A list of contact ids

Examples

iex> token = System.fetch_env!("TOKEN")
iex> members = ["9GJ7EHJX", "GFRWVKD9"]
iex> opts = %{:name => "contactgroup name", :members => members}
iex> result = NodePing.ContactGroups.create!(token, opts)

delete(token, id, customerid \\ nil)

Delete a contact group from your NodePing account or subaccount.

Parameters

token - NodePing API token that is provided with account
id - the ID for your contact group
customerid - optional ID to access a subaccount

Examples

iex> token = System.fetch_env!("TOKEN")
iex> id = "201205050153W2Q4C-G-3QJWG"
iex> {:ok, result} = NodePing.ContactGroups.delete(token, id)

delete!(token, id, customerid \\ nil)

Delete a contact group from your NodePing account or subaccount.

Parameters

token - NodePing API token that is provided with account
id - the ID for your contact group
customerid - optional ID to access a subaccount

Examples

iex> token = System.fetch_env!("TOKEN")
iex> id = "201205050153W2Q4C-G-3QJWG"
iex> result = NodePing.ContactGroups.delete!(token, id)

get_all(token, customerid \\ nil)

Get contact groups for your NodePing account or subaccount.

Parameters

token - NodePing API token that is provided with account
customerid - optional ID to access a subaccount

Examples

iex> token = System.fetch_env!("TOKEN")
iex> {:ok, result} = NodePing.ContactGroups.get_all(token)

get_all!(token, customerid \\ nil)

Get contact groups for your NodePing account or subaccount.

Parameters

token - NodePing API token that is provided with account
customerid - optional ID to access a subaccount

Examples

iex> token = System.fetch_env!("TOKEN")
iex> result = NodePing.ContactGroups.get_all!(token)

get_by_id(token, id, customerid \\ nil)

Get a contact group from your NodePing account or subaccount.

Parameters

token - NodePing API token that is provided with account
id - the ID for your contact group
customerid - optional ID to access a subaccount

Examples

iex> token = System.fetch_env!("TOKEN")
iex> id = "201205050153W2Q4C-G-3QJWG"
iex> {:ok, result} = NodePing.ContactGroups.get_by_id(token, id)

get_by_id!(token, id, customerid \\ nil)

Get a contact group from your NodePing account or subaccount.

Parameters

token - NodePing API token that is provided with account
id - the ID for your contact group
customerid - optional ID to access a subaccount

Examples

iex> token = System.fetch_env!("TOKEN")
iex> id = "201205050153W2Q4C-G-3QJWG"
iex> result = NodePing.ContactGroups.get_by_id!(token, id)

update(token, id, opts, customerid \\ nil)

Update an existing contact group on your NodePing account or subaccount.

Parameters

token - NodePing API token that is provided with account
id - the ID for your contact group
opts - Optional Map of parameters for new contact group
customerid - optional ID to access a subaccount

Opts

name - A label for the group
members - A list of contact ids

Examples

iex> token = System.fetch_env!("TOKEN")
iex> id = "201205050153W2Q4C-G-3QJWG"
iex> members = ["9GJ7EHJX", "GFRWVKD9"]
iex> opts = %{:name => "contactgroup name", :members => members}
iex> {:ok, result} = NodePing.ContactGroups.update(token, id, opts)

update!(token, id, opts, customerid \\ nil)

Update an existing contact group on your NodePing account or subaccount.

Parameters

token - NodePing API token that is provided with account
id - the ID for your contact group
opts - Optional Map of parameters for new contact group
customerid - optional ID to access a subaccount

Opts

name - A label for the group
members - A list of contact ids

Examples

iex> token = System.fetch_env!("TOKEN")
iex> id = "201205050153W2Q4C-G-3QJWG"
iex> members = ["9GJ7EHJX", "GFRWVKD9"]
iex> opts = %{:name => "contactgroup name", :members => members}
iex> result = NodePing.ContactGroups.update!(token, id, opts)