| Title: | Interface to the 'Briq' API |
| Version: | 0.1.0 |
| Maintainer: | David Rubinger <david.rubinger@gmail.com> |
| Description: | An interface to the 'Briq' API https://briq.github.io. 'Briq' is a tool that aims to promote employee engagement by helping employees recognize and reward each other. Employees can praise and thank one another (for achieving a company goal, for example) by giving virtual credits (known as 'briqs' or 'bqs') that can be redeemed for various rewards. The 'Briq' API lets you create, read, update and delete users, user groups, transactions and messages. This package provides functions that simplify getting the users, user groups and transactions of your organization into R. |
| License: | MIT + file LICENSE |
| Encoding: | UTF-8 |
| LazyData: | true |
| RoxygenNote: | 6.1.1 |
| Depends: | R (≥ 3.6.0) |
| Imports: | magrittr (≥ 1.5), dplyr (≥ 0.8.0.1), httr (≥ 1.4.0), jsonlite (≥ 1.6), tibble (≥ 2.1.1) |
| Suggests: | httptest (≥ 3.2.2), testthat (≥ 2.1.1) |
| NeedsCompilation: | no |
| Packaged: | 2019-05-14 16:55:26 UTC; david.rubinger |
| Author: | David Rubinger [aut, cre] |
| Repository: | CRAN |
| Date/Publication: | 2019-05-16 12:30:03 UTC |
Briq user groups
Description
List all the 'Briq' user groups of your organization
Usage
bq_groups(organization = Sys.getenv("organization_name"),
api_token = Sys.getenv("briq_api_token"))
Arguments
organization |
Name of your Briq organization |
api_token |
Briq API token |
Value
Returns a tibble of Briq user groups of your organization
Examples
## Not run:
# Read organization and api_token from .Renviron file
bq_groups()
# Manually enter in organization and api_token
bq_groups(organization = "My Org", api_token = "xYz123")
## End(Not run)
Briq transactions
Description
List all the 'Briq' transactions of your organization
Usage
bq_transactions(max_results_per_page = 100, pause_between_pages = 0,
organization = Sys.getenv("organization_name"),
api_token = Sys.getenv("briq_api_token"))
Arguments
max_results_per_page |
Maximum number of results per page |
pause_between_pages |
Number of seconds to wait between page requests |
organization |
Name of your Briq organization |
api_token |
Briq API token |
Value
Returns a tibble of Briq transactions of your organization
Examples
## Not run:
# Read organization and api_token from .Renviron file
bq_transactions()
# Manually enter in organization and api_token
bq_transactions(organization = "My Org", api_token = "xYz123")
## End(Not run)
Briq users
Description
List all the 'Briq' users of your organization
Usage
bq_users(organization = Sys.getenv("organization_name"),
api_token = Sys.getenv("briq_api_token"))
Arguments
organization |
Name of your Briq organization |
api_token |
Briq API token |
Value
Returns a tibble of Briq users of your organization
Examples
## Not run:
# Read organization and api_token from .Renviron file
bq_users()
# Manually enter in organization and api_token
bq_users(organization = "My Org", api_token = "xYz123")
## End(Not run)