R/unsubscribe.R

In briandconnelly/numerous: Interact with the Numerous API

#' Unsubscribe a user from a metric
#'
#' @param metric_id The ID of the metric
#' @param user_id The ID of the user. If one is not provided, the current user's ID is used.
#'
#' @importFrom assertthat assert_that is.string
#' @export
#'
#' @examples
#' \dontrun{
#' library(numerous)
#' 
#' unsubscribe(metric_id = "4754875937013463485",
#'             user_id = "2586911214569254875")
#' }
unsubscribe <- function(metric_id, user_id=get_numerous_user())
{
    assert_that(is.string(metric_id))
    assert_that(is.string(user_id))
    
    result <- numerous_DELETE(path=paste("metrics", metric_id, "subscriptions",
                                         user_id, sep='/'))
}