R/get_subscription_info.R

In briandconnelly/numerous: Interact with the Numerous API

#' Get information about a user's subscription to 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.
#'
#' @return A list containing information about the user's subscription to that
#' metric
#' @importFrom assertthat assert_that is.string
#' @importFrom httr content
#' @export
#'
#' @examples
#' \dontrun{
#' library(numerous)
#' get_subscription_info(metric_id = "4475989761572721263",
#'                       user_id = "321654987654321")
#' }
get_subscription_info <- function(metric_id, user_id=get_numerous_user())
{
    assert_that(is.string(metric_id))
    assert_that(is.string(user_id))
    
    response <- numerous_GET(path=paste("metrics", metric_id, "subscriptions",
                                        user_id, sep='/'))
    
    rval <- content(response)
    class(rval) <- c("NumerousSubscription", "list")
    rval
}