https://github.com/nealrichardson/zendo

An R client for the Zendesk API
https://github.com/nealrichardson/zendo

Last synced: 13 days ago
JSON representation

An R client for the Zendesk API

• Host: GitHub
• URL: https://github.com/nealrichardson/zendo
• Owner: nealrichardson
• License: other
• Created: 2018-10-22T21:28:03.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2019-03-22T20:46:54.000Z (over 5 years ago)
• Last Synced: 2024-10-04T15:22:05.270Z (about 1 month ago)
• Language: R
• Size: 14.6 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: NEWS.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# zendo: An R client for the [Zendesk](https://zendesk.com/) [API](https://developer.zendesk.com/rest_api/docs/core/introduction)

[![Build Status](https://travis-ci.org/nealrichardson/zendo.png?branch=master)](https://travis-ci.org/nealrichardson/zendo) [![Build status](https://ci.appveyor.com/api/projects/status/tnkfvuqyucxypfeg/branch/master?svg=true)](https://ci.appveyor.com/project/nealrichardson/zendo/branch/master)

 [![codecov](https://codecov.io/gh/nealrichardson/zendo/branch/master/graph/badge.svg)](https://codecov.io/gh/nealrichardson/zendo)

[![cran](https://www.r-pkg.org/badges/version-last-release/zendo)](https://cran.r-project.org/package=zendo)

## Installing

The pre-release version of the package can be pulled from GitHub using the [remotes](https://github.com/r-lib/remotes) package:

```r

# install.packages("remotes")

remotes::install_github("nealrichardson/zendo")

```

## Getting started

1. Set credentials:

```r

options(

    zendesk.email,

    zendesk.token, # Or, zendesk.password

    zendesk.url

)

```

2. Query

* `get_all_tickets(start_time)` downloads all tickets since a given time (if omitted, returns all)

* `search_tickets(query)` searches for tickets

* `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](http://testthat.r-lib.org/) 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](https://github.com/klutometis/roxygen) package.

## See also

[zendeskR](https://github.com/tcash21/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.