R/FulfillmentService.R

Defines functions getFulfillmentServices createFulfillmentService getFulfillmentService modifyFulfillmentService deleteFulfillmentService

Documented in createFulfillmentService deleteFulfillmentService getFulfillmentService getFulfillmentServices modifyFulfillmentService

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

########### FulfillmentService functions ########### 
#' @templateVar name FulfillmentService
#' @templateVar urlSlug shipping_and_fulfillment/fulfillmentservice
#' @template api
NULL

## GET /admin/api/#{api_version}/fulfillment_services.json
## Receive a list of all FulfillmentServices
#' @rdname FulfillmentService
getFulfillmentServices <- function(...) {
    private$.request("fulfillment_services", ...)$fulfillment_services
}

## POST /admin/api/#{api_version}/fulfillment_services.json
## Create a new FulfillmentService
#' @rdname FulfillmentService
createFulfillmentService <- function(fulfillmentService, ...) {
    fulfillmentService <- private$.wrap(fulfillmentService, "fulfillment_service", check=FALSE)
    private$.request("fulfillment_services", reqType="POST", data=fulfillmentService, ...)$fulfillment_service
}

## GET /admin/api/#{api_version}/fulfillment_services/#{id}.json
## Receive a single FulfillmentService
#' @rdname FulfillmentService
getFulfillmentService <- function(fulfillmentServiceId, ...) {
    private$.request(private$.url("fulfillment_services",fulfillmentServiceId), ...)$fulfillment_service
}

## PUT /admin/api/#{api_version}/fulfillment_services/#{id}.json
## Modify an existing FulfillmentService
#' @rdname FulfillmentService
modifyFulfillmentService <- function(fulfillmentService, ...) {
    fulfillmentService <- private$.wrap(fulfillmentService, "fulfillment_service")
    private$.request(private$.url("fulfillment_services",fulfillmentService$fulfillment_service$id), reqType="PUT", data=fulfillmentService, ...)$fulfillment_service
}

## DELETE /admin/api/#{api_version}/fulfillment_services/#{id}.json
## Remove a FulfillmentService from the database
#' @rdname FulfillmentService
deleteFulfillmentService <- function(fulfillmentServiceId, ...) {
    private$.request(private$.url("fulfillment_services",fulfillmentServiceId), reqType="DELETE", ...)
}
charliebone/shopifyr documentation built on Aug. 12, 2019, 7:35 p.m.