README.md

In nealrichardson/zendo: Informative Title for Your Package

zendo: An R client for the Zendesk API

Installing

The pre-release version of the package can be pulled from GitHub using the remotes package:

# install.packages("remotes")
remotes::install_github("nealrichardson/zendo")

Getting started

1. Set credentials:

options(
    zendesk.email,
    zendesk.token, # Or, zendesk.password
    zendesk.url
)

1. Query

2. get_all_tickets(start_time) downloads all tickets since a given time (if omitted, returns all)

3. search_tickets(query) searches for tickets
4. get_users()

For developers

The repository includes a Makefile to facilitate some common tasks, if you're into that kind of thing.

Running tests

$ make test. Requires the testthat package. You can also specify a specific test file or files to run by adding a "file=" argument, like $ make test file=api. testthat::test_package() will do a regular-expression pattern match within the file names (ignoring the test- prefix and the .R file extension).

Updating documentation

$ make doc. Requires the roxygen2 package.

See also

zendeskR is another Zendesk API client in R. It's not clear that it is actively supported anymore, and it's last CRAN update was in 2014. There is some overlap between what is implemented here and there. zendo offers support for the incremental export and search APIs, as well as token authentication.

nealrichardson/zendo documentation built on May 9, 2019, 3 p.m.