| Title: | Interface to the 'Briq' API |
|---|---|
| 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. |
| Authors: | David Rubinger [aut, cre] |
| Maintainer: | David Rubinger <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 0.1.0.9000 |
| Built: | 2025-02-21 03:29:14 UTC |
| Source: | https://github.com/davidrubinger/briqr |
List all the 'Briq' user groups of your organization
bq_groups(organization = Sys.getenv("organization_name"), api_token = Sys.getenv("briq_api_token"))bq_groups(organization = Sys.getenv("organization_name"), api_token = Sys.getenv("briq_api_token"))
organization |
Name of your Briq organization |
api_token |
Briq API token |
Returns a tibble of Briq user groups of your organization
## 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)## 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)
Revert a 'Briq' transaction
bq_revert_transaction(transaction_id, organization = Sys.getenv("organization_name"), api_token = Sys.getenv("briq_api_token"))bq_revert_transaction(transaction_id, organization = Sys.getenv("organization_name"), api_token = Sys.getenv("briq_api_token"))
transaction_id |
ID of transaction to revert |
organization |
Name of your Briq organization |
api_token |
Briq API token |
## Not run: # Read organization and api_token from .Renviron file bq_revert_transaction(transaction_id = "a1b-2c3") # Manually enter in organization and api_token bq_revert_transaction( transaction_id = "a1b-2c3", organization = "My Org", api_token = "xYz123" ) ## End(Not run)## Not run: # Read organization and api_token from .Renviron file bq_revert_transaction(transaction_id = "a1b-2c3") # Manually enter in organization and api_token bq_revert_transaction( transaction_id = "a1b-2c3", organization = "My Org", api_token = "xYz123" ) ## End(Not run)
List all the 'Briq' transactions of your organization
bq_transactions(max_results_per_page = 100, pause_between_pages = 0, organization = Sys.getenv("organization_name"), api_token = Sys.getenv("briq_api_token"))bq_transactions(max_results_per_page = 100, pause_between_pages = 0, organization = Sys.getenv("organization_name"), api_token = Sys.getenv("briq_api_token"))
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 |
Returns a tibble of Briq transactions of your organization
## 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)## 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)
List all the 'Briq' users of your organization
bq_users(organization = Sys.getenv("organization_name"), api_token = Sys.getenv("briq_api_token"))bq_users(organization = Sys.getenv("organization_name"), api_token = Sys.getenv("briq_api_token"))
organization |
Name of your Briq organization |
api_token |
Briq API token |
Returns a tibble of Briq users of your organization
## 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)## 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)