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

########### GraphQL functions ########### 
#' Query the GraphQL Admin API
#' 
#' @param query a literal GraphQL query string
#' @param ... additional request parameters
#' @param includeExtensions should the extensions portion of the graphql query results be included in the return object. Default is \code{FALSE}
#' @return The query results 
#' @name GraphQL
NULL

## GET admin/api/{ version }/graphql.json
## Makes a graphql request
#' @rdname GraphQL
graphQlQuery <- function(query, ..., includeExtensions = FALSE) {
    result <- private$.graphQlRequest(query, ...)
    
    if (!isTRUE(includeExtensions) && is.list(result) && !is.null(result$data))
        return(result$data)
    
    return(result)
}