R/events.R

In RStripe: A Convenience Interface for the Stripe Payment API

# --------------------------------------------------
# Events
# --------------------------------------------------

#' Retrieve an event.
#'
#' Retrieve the information about a specific event.
#'
#' @param api_key Your Stripe API Key
#'
#' @param event_id The identifier of the event to be retrieved
#'
#' @return Returns an event data frame if valid.
#'
#' @export
#'
stripe_retrieve_event <- function(api_key, event_id) {
    link <- paste0("https://api.stripe.com/v1/events/", event_id)
    .get(api_key, link)
}


#' List all events.
#'
#' list all the events that have happened.
#'
#' @param api_key Your Stripe API Key
#'
#' @param args an optional list that can include:
#' \describe{
#'    \item{ending_before}{\emph{optional:} An object id which will show objects before}
#'    \item{limit}{\emph{optional:} A number 1 to 100 to limit the items.  Default is 10}
#'    \item{starting_after}{\emph{optional:} An object id which will show objects starting here}
#'    \item{type}{\emph{optional} Can contain specific event name or group with '*' wildcard.}
#' }
#'
#' @return Returns an event data frame containing
#' all the eventsif valid.
#' @export
#'
stripe_list_events <- function(api_key, args=NULL) {
    args <- .convert_to_url(args)
    link <- paste0("https://api.stripe.com/v1/events", args)
    .get(api_key, link)
}