R/uptimerobot.fields.R

In uptimeRobot: Access the UptimeRobot Ping API

#' Get a list of the available fields for various endpoints
#'
#' \code{uptimerobots.fields} returns a list of vectors of available fields for commodity uses.
#' Use it to avoid manually typing long list of fields in vectors or comma-delimited strings when used in various endpoints.
#' 
#' @details
#' Use the \code{type} parameter to choose which set of fields to return in a list of vectors. These endpoints are currently supported:
#' \code{monitor} and \code{contact}.
#'
#' @return
#' The function returns a list of 3 elements which in turn contains a vector of available fields for a given \code{set} each.
#' The returned elements are:
#' \enumerate{
#'   \item \code{typical} returns a typical set of fields, used in most situations;
#'   \item \code{full} returns the full set of available fields, including passwords and other potentially confidential data;
#'   \item \code{compact} return a minimal set of fields.
#' }

#' @author Gabriele Baldassarre
#' @seealso \code{\link{uptimerobot.monitors}}, \code{\link{uptimerobot.contacts}}
#'
#' @param type string with the type of fields to be reported. Only \code{monitor} and \code{contact} are currently supported.
#' 
#' @export
uptimerobot.fields <- function(type){
  
  if(type == "monitor"){
    return(
      list("typical" = c("id", "friendlyname", "url", "type", "interval", "status"),
           "full" = c("id", "friendlyname", "url", "type", "subtype", "keywordtype", "keywordvalue", "httpusername", "httppassword", "port", "interval", "status"),
           "compact" = c("id", "friendlyname", "status"))
      )
  }
  
  if(type == "contact"){
    return(
      list("typical" = c("id", "type", "value", "friendlyname", "status"),
           "full" = c("id", "type", "value", "friendlyname", "status"),
           "compact" = c("id", "type", "value", "friendlyname"))
    )
  }
  stop("unsupported endpoint.")
}