R/Event.R

In charliebone/shopifyr: An R Interface to the Shopify API

#
#   shopifyr: An R Interface to the Shopify API
#
#   Copyright (C) 2015 Charlie Friedemann cfriedem @ gmail.com
#   Shopify API (c) 2006-2015 Shopify Inc.
#
#   This program is free software: you can redistribute it and/or modify
#   it under the terms of the GNU General Public License as published by
#   the Free Software Foundation, either version 3 of the License, or
#   (at your option) any later version.
#
#   This program is distributed in the hope that it will be useful,
#   but WITHOUT ANY WARRANTY; without even the implied warranty of
#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#   GNU General Public License for more details.
#
#   You should have received a copy of the GNU General Public License
#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
#

########### Event functions ########### 
#' @param eventId a Event id number
#' @templateVar name Event
#' @templateVar urlSlug events/event
#' @templateVar default.params FALSE
#' @template api
NULL

## GET /admin/api/#{api_version}/events.json
## Receive a list of all Events
#' @rdname Event
getEvents <- function(...) {
    private$.fetchAll("events", ...)
}

## GET /admin/api/#{api_version}/events/#{id}.json
## Receive a single Event
#' @rdname Event
getEvent <- function(eventId, ...) {
    private$.request(private$.url("events",eventId), ...)$event
}

## GET /admin/api/#{api_version}/events/count.json
## Receive a count of all Events
#' @rdname Event
getEventsCount <- function(...) {
    private$.request(private$.url("events","count"), ...)$count
}