NodePing Elixir v1.7.1

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

Manage notification profiles for a NodePing account

https://nodeping.com/docs-api-notificationprofiles.html

Link to this section Summary

Functions

create(token, name, notifications)

Create a notification profile for the account

create(token, name, notifications, customerid)

Create a notification profile for the account

create!(token, name, notifications)

Create a notification profile for the account

create!(token, name, notifications, customerid)

Create a notification profile for the account

delete(token, id)

Delete a notification profile from the account

delete(token, id, customerid)

Delete a notification profile from the account

delete!(token, id)

Delete a notification profile from the account

delete!(token, id, customerid)

Delete a notification profile from the account

get(token)

Get a list of notification profiles for the account

get(token, customerid)

Get a list of notification profiles for the account

get!(token)

Get a list of notification profiles for the subaccount

get!(token, customerid)

Get a list of notification profiles for the subaccount

get_id(token, id)

Get information for the notification profile for an account

get_id(token, id, customerid)

Get information for the notification profile for a subaccount

get_id!(token, id)

Get information for the notification profile for an account

get_id!(token, id, customerid)

Get information for the notification profile for a subaccount

update(token, id, name, notifications)

Create a notification profile for the account

update(token, id, name, notifications, customerid)

Create a notification profile for the account

update!(token, id, name, notifications)

Create a notification profile for the account

update!(token, id, name, notifications, customerid)

Create a notification profile for the account

Link to this section Functions

Link to this function

create(token, name, notifications)

View Source

Specs

create(token :: bitstring(), name :: bitstring(), notifications :: list()) ::
  tuple()

Create a notification profile for the account

Parameters

  • token - NodePing API token that is provided with account
  • name - Name for the notification profile
  • notifications - list of maps containing the contact or group id, delay, and scheduling for notifications

Examples 

iex> token = System.fetch_env!("TOKEN")
iex> notifications = [
   >   %{"contactkey1" => %{"delay" => 0, "schedule" => "schedule1"}},
   >   %{"contactkey2" => %{"delay" => 0, "schedule" => "schedule1"}},
   > ]
iex> {:ok, result} = NodePing.Notificationprofiles.create(token, "profilename", notifications)
Link to this function

create(token, name, notifications, customerid)

View Source

Specs

create(
  token :: bitstring(),
  name :: bitstring(),
  notifications :: list(),
  customerid :: bitstring()
) :: tuple()

Create a notification profile for the account

Parameters

  • token - NodePing API token that is provided with account
  • name - Name for the notification profile
  • notifications - list of maps containing the contact or group id, delay, and scheduling for notifications
  • customerid - optional ID to access a subaccount

Examples 

iex> token = System.fetch_env!("TOKEN")
iex> customerid = System.fetch_env!("CUSTOMERID")
iex> notifications = [
   >   %{"contactkey1" => %{"delay" => 0, "schedule" => "schedule1"}},
   >   %{"contactkey2" => %{"delay" => 0, "schedule" => "schedule1"}},
   > ]
iex> {:ok, result} = NodePing.Notificationprofiles.create(token, "profilename", notifications, customerid)
Link to this function

create!(token, name, notifications)

View Source

Specs

create!(
  token :: bitstring(),
  name :: bitstring(),
  notifications :: list()
) :: map()

Create a notification profile for the account

Parameters

  • token - NodePing API token that is provided with account
  • name - Name for the notification profile
  • notifications - list of maps containing the contact or group id, delay, and scheduling for notifications

Examples 

iex> token = System.fetch_env!("TOKEN")
iex> notifications = [
   >   %{"contactkey1" => %{"delay" => 0, "schedule" => "schedule1"}},
   >   %{"contactkey2" => %{"delay" => 0, "schedule" => "schedule1"}},
   > ]
iex> result = NodePing.Notificationprofiles.create!(token, "profilename", notifications)
Link to this function

create!(token, name, notifications, customerid)

View Source

Specs

create!(
  token :: bitstring(),
  name :: bitstring(),
  notifications :: list(),
  customerid :: bitstring()
) :: map()

Create a notification profile for the account

Parameters

  • token - NodePing API token that is provided with account
  • name - Name for the notification profile
  • notifications - list of maps containing the contact or group id, delay, and scheduling for notifications
  • customerid - optional ID to access a subaccount

Examples 

iex> token = System.fetch_env!("TOKEN")
iex> customerid = System.fetch_env!("CUSTOMERID")
iex> notifications = [
   >   %{"contactkey1" => %{"delay" => 0, "schedule" => "schedule1"}},
   >   %{"contactkey2" => %{"delay" => 0, "schedule" => "schedule1"}},
   > ]
iex> result = NodePing.Notificationprofiles.create!(token, "profilename", notifications, customerid)
Link to this function

delete(token, id)

View Source

Specs

delete(token :: bitstring(), id :: bitstring()) :: tuple()

Delete a notification profile from the account

Parameters

  • token - NodePing API token that is provided with account
  • id - the ID for the notification profile being updated

Examples 

iex> token = System.fetch_env!("TOKEN")
iex> id = "201205050153W2Q4C-P-3QJWG"
iex> {:ok, result} = NodePing.Notificationprofiles.delete(token, id)
Link to this function

delete(token, id, customerid)

View Source

Specs

delete(token :: bitstring(), id :: bitstring(), customerid :: bitstring()) ::
  tuple()

Delete a notification profile from the account

Parameters

  • token - NodePing API token that is provided with account
  • id - the ID for the notification profile being updated

Examples 

iex> token = System.fetch_env!("TOKEN")
iex> customerid = System.fetch_env!("CUSTOMERID")
iex> id = "201205050153W2Q4C-P-3QJWG"
iex> {:ok, result} = NodePing.Notificationprofiles.delete(token, id, customerid)
Link to this function

delete!(token, id)

View Source

Specs

delete!(token :: bitstring(), id :: bitstring()) :: map()

Delete a notification profile from the account

Parameters

  • token - NodePing API token that is provided with account
  • id - the ID for the notification profile being updated

Examples 

iex> token = System.fetch_env!("TOKEN")
iex> id = "201205050153W2Q4C-P-3QJWG"
iex> result = NodePing.Notificationprofiles.delete!(token, id)
Link to this function

delete!(token, id, customerid)

View Source

Specs

delete!(token :: bitstring(), id :: bitstring(), customerid :: bitstring()) ::
  map()

Delete a notification profile from the account

Parameters

  • token - NodePing API token that is provided with account
  • id - the ID for the notification profile being updated

Examples 

iex> token = System.fetch_env!("TOKEN")
iex> customerid = System.fetch_env!("CUSTOMERID")
iex> id = "201205050153W2Q4C-P-3QJWG"
iex> result = NodePing.Notificationprofiles.delete!(token, id, customerid)
Link to this function

get(token)

View Source

Specs

get(token :: bitstring()) :: tuple()

Get a list of notification profiles for the account

Parameters

  • token - NodePing API token that is provided with account

Examples 

iex> token = System.fetch_env!("TOKEN")
iex> {:ok, result} = NodePing.Notificationprofiles.get(token)
Link to this function

get(token, customerid)

View Source

Specs

get(token :: bitstring(), customerid :: bitstring()) :: tuple()

Get a list of notification profiles for the account

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> customerid = System.fetch_env!("CUSTOMERID")
iex> {:ok, result} = NodePing.Notificationprofiles.get(token, customerid)
Link to this function

get!(token)

View Source

Specs

get!(token :: bitstring()) :: map()

Get a list of notification profiles for the subaccount

Parameters

  • token - NodePing API token that is provided with account

Examples 

iex> token = System.fetch_env!("TOKEN")
iex> result = NodePing.Notificationprofiles.get(token)
Link to this function

get!(token, customerid)

View Source

Specs

get!(token :: bitstring(), customerid :: bitstring()) :: map()

Get a list of notification profiles for the 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> customerid = System.fetch_env!("CUSTOMERID")
iex> result = NodePing.Notificationprofiles.get(token, customerid)
Link to this function

get_id(token, id)

View Source

Specs

get_id(token :: bitstring(), id :: bitstring()) :: tuple()

Get information for the notification profile for an account

Parameters

  • token - NodePing API token that is provided with account
  • id - the ID for the notification profile

Examples 

iex> token = System.fetch_env!("TOKEN")
iex> id = "201205050153W2Q4C-P-3QJWG"
iex> {:ok, result} = NodePing.Notificationprofiles.get_id(token, id)
Link to this function

get_id(token, id, customerid)

View Source

Specs

get_id(token :: bitstring(), id :: bitstring(), customerid :: bitstring()) ::
  tuple()

Get information for the notification profile for a subaccount

Parameters

  • token - NodePing API token that is provided with account
  • id - the ID for the notification profile
  • customerid - optional ID to access a subaccount

Examples 

iex> token = System.fetch_env!("TOKEN")
iex> customerid = System.fetch_env!("CUSTOMERID")
iex> id = "201205050153W2Q4C-P-3QJWG"
iex> {:ok, result} = NodePing.Notificationprofiles.get_id(token, id, customerid)
Link to this function

get_id!(token, id)

View Source

Specs

get_id!(token :: bitstring(), id :: bitstring()) :: map()

Get information for the notification profile for an account

Parameters

  • token - NodePing API token that is provided with account
  • id - the ID for the notification profile

Examples 

iex> token = System.fetch_env!("TOKEN")
iex> id = "201205050153W2Q4C-P-3QJWG"
iex> result = NodePing.Notificationprofiles.get_id!(token, id)
Link to this function

get_id!(token, id, customerid)

View Source

Specs

get_id!(token :: bitstring(), id :: bitstring(), customerid :: bitstring()) ::
  map()

Get information for the notification profile for a subaccount

Parameters

  • token - NodePing API token that is provided with account
  • id - the ID for the notification profile
  • customerid - optional ID to access a subaccount

Examples 

iex> token = System.fetch_env!("TOKEN")
iex> customerid = System.fetch_env!("CUSTOMERID")
iex> id = "201205050153W2Q4C-P-3QJWG"
iex> result = NodePing.Notificationprofiles.get_id(token, id, customerid)
Link to this function

update(token, id, name, notifications)

View Source

Specs

update(
  token :: bitstring(),
  id :: bitstring(),
  name :: bitstring(),
  notifcations :: list()
) :: tuple()

Create a notification profile for the account

Parameters

  • token - NodePing API token that is provided with account
  • id - the ID for the notification profile being updated
  • name - Name for the notification profile
  • notifications - list of maps containing the contact or group id, delay, and scheduling for notifications

Examples 

iex> token = System.fetch_env!("TOKEN")
iex> customerid = System.fetch_env!("CUSTOMERID")
iex> id = "201205050153W2Q4C-P-3QJWG"
iex> notifications = [
   >   %{"contactkey1" => %{"delay" => 0, "schedule" => "schedule1"}},
   >   %{"contactkey2" => %{"delay" => 0, "schedule" => "schedule1"}},
   > ]
iex> {:ok, result} = NodePing.Notificationprofiles.update(token, id, "profilename", notifications)
Link to this function

update(token, id, name, notifications, customerid)

View Source

Specs

update(
  token :: bitstring(),
  id :: bitstring(),
  name :: bitstring(),
  notifcations :: list(),
  customerid :: bitstring()
) :: tuple()

Create a notification profile for the account

Parameters

  • token - NodePing API token that is provided with account
  • id - the ID for the notification profile being updated
  • name - Name for the notification profile
  • notifications - list of maps containing the contact or group id, delay, and scheduling for notifications
  • customerid - optional ID to access a subaccount

Examples 

iex> token = System.fetch_env!("TOKEN")
iex> customerid = System.fetch_env!("CUSTOMERID")
iex> id = "201205050153W2Q4C-P-3QJWG"
iex> notifications = [
   >   %{"contactkey1" => %{"delay" => 0, "schedule" => "schedule1"}},
   >   %{"contactkey2" => %{"delay" => 0, "schedule" => "schedule1"}},
   > ]
iex> {:ok, result} = NodePing.Notificationprofiles.update(token, id, "profilename", notifications, customerid)
Link to this function

update!(token, id, name, notifications)

View Source

Specs

update!(
  token :: bitstring(),
  id :: bitstring(),
  name :: bitstring(),
  notifcations :: list()
) :: map()

Create a notification profile for the account

Parameters

  • token - NodePing API token that is provided with account
  • id - the ID for the notification profile being updated
  • name - Name for the notification profile
  • notifications - list of maps containing the contact or group id, delay, and scheduling for notifications

Examples 

iex> token = System.fetch_env!("TOKEN")
iex> customerid = System.fetch_env!("CUSTOMERID")
iex> id = "201205050153W2Q4C-P-3QJWG"
iex> notifications = [
   >   %{"contactkey1" => %{"delay" => 0, "schedule" => "schedule1"}},
   >   %{"contactkey2" => %{"delay" => 0, "schedule" => "schedule1"}},
   > ]
iex> result = NodePing.Notificationprofiles.update!(token, id, "profilename", notifications)
Link to this function

update!(token, id, name, notifications, customerid)

View Source

Specs

update!(
  token :: bitstring(),
  id :: bitstring(),
  name :: bitstring(),
  notifcations :: list(),
  customerid :: bitstring()
) :: map()

Create a notification profile for the account

Parameters

  • token - NodePing API token that is provided with account
  • id - the ID for the notification profile being updated
  • name - Name for the notification profile
  • notifications - list of maps containing the contact or group id, delay, and scheduling for notifications
  • customerid - optional ID to access a subaccount

Examples 

iex> token = System.fetch_env!("TOKEN")
iex> customerid = System.fetch_env!("CUSTOMERID")
iex> id = "201205050153W2Q4C-P-3QJWG"
iex> notifications = [
   >   %{"contactkey1" => %{"delay" => 0, "schedule" => "schedule1"}},
   >   %{"contactkey2" => %{"delay" => 0, "schedule" => "schedule1"}},
   > ]
iex> result = NodePing.Notificationprofiles.update!(token, id, "profilename", notifications, customerid)