Description Public fields Methods Examples
chimpr client
chimpr client
dc
(character) a data center
key
(character) an API key
new()
Create a new ChmpClient
object
ChmpClient$new(dc = "us7", key = NULL)
dc
(character) a data center. default: us7. required.
key
(character) API key. Can either pass in here,
or set with Sys.setenv()
or pass in to each function call.
optional if already set as an environment variable
print()
print method for ChmpClient
objects
ChmpClient$print(x, ...)
x
self
...
ignored
ping()
A health check endpoint for the Mailchimp API
ChmpClient$ping(...)
...
Curl options passed to crul::verb-GET
root()
The API root resource links to all other resources available in the API. Calling the root directory also returns details about the Mailchimp user account.
ChmpClient$root(fields = NULL, exclude_fields = NULL, parse = TRUE, ...)
fields
(list/vector) A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fields
(list/vector) A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
parse
(logical) Whether to parse to list (FALSE
) or
data.frame (TRUE
). Default: TRUE
...
Curl options passed to crul::verb-GET
clone()
The objects of this class are cloneable with this method.
ChmpClient$clone(deep = FALSE)
deep
Whether to make a deep clone.
1 2 3 4 5 6 7 8 9 | ## Not run:
(x <- ChmpClient$new(dc = "us7", key = "<your key>"))
(x <- ChmpClient$new())
x$dc
x$key
x$ping()
x$root()
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.