R/Blog.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/>.
#

########### Blog functions ########### 
#' @templateVar name Blog
#' @templateVar urlSlug online_store/blog
#' @template api
NULL

## GET /admin/api/#{api_version}/blogs.json
## Receive a list of all Blogs
#' @rdname Blog
getBlogs <- function(...) {
    private$.request("blogs", ...)$blogs
}

## GET /admin/api/#{api_version}/blogs/count.json
## Receive a count of all Blogs
#' @rdname Blog
getBlogsCount <- function(...) {
    private$.request(private$.url("blogs","count"), ...)$count
}

## GET /admin/api/#{api_version}/blogs/#{id}.json
## Receive a single Blog
#' @rdname Blog
getBlog <- function(blogId, ...) {
    private$.request(private$.url("blogs",blogId), ...)$blog
}

## POST /admin/api/#{api_version}/blogs.json
## Create a new Blog
#' @rdname Blog
createBlog <- function(blog, ...) {
    blog <- private$.wrap(blog, "blog", check=FALSE)
    private$.request("blogs", reqType="POST", data=blog, ...)$blog
}

## PUT /admin/api/#{api_version}/blogs/#{id}.json
## Modify an existing Blog
#' @rdname Blog
modifyBlog <- function(blog, ...) {
    blog <- private$.wrap(blog, "blog")
    private$.request(private$.url("blogs",blog$blog$id), reqType="PUT", data=blog, ...)$blog
}

## DELETE /admin/api/#{api_version}/blogs/#{id}.json
## Remove a Blog from the database
#' @rdname Blog
deleteBlog <- function(blogId, ...) {
    private$.request(private$.url("blogs",blogId), reqType="DELETE", ...)
}