getMethodProperties: festotuAPIs utils

Description Usage Arguments Details Value Functions Examples

View source: R/utils.R

Description

Utils for building http requests for festotu APIs, using the package configuration.

Usage

1
2
3
4
5
6
7
getMethodProperties(methodName, api)

buildURL(api, methodProperties, params)

buildQuery(api, properties, params)

updateApiReference(api)

Arguments

methodName

Name of the API method

api

Name of the API

params

Additional parameters. Typically a named list of resources identifiers.

body

Named list representing the body of a PUT/POST request.

Details

getMethodProperties

updateApiReference creates a new API reference configuration file

Value

getMethodProperties returns a data.frame of method properties, to be used when building http requests.

buildURI returns a URL pointing to the resource described by the parameters provided.

buildQuery returns a named list containing a curl query for a GET request

Functions

Examples

1
2
3
festotuAPIs:::getMethodProperties("findAllListingActive", "etsy")
updateApiReference("etsy")
 

agpknitweardesign/festotuAPIs documentation built on Feb. 2, 2020, 12:20 p.m.