R/ss_list_sheets.R

In smartsheetr: Access and Write 'Smartsheet' Data using the 'Smartsheet' API 2.0

#' Get a data frame describing the smartsheets available
#'
#' @details
#' Note that the environment variable SMARTSHEET_API_TOKEN should be defined in order to run this or any
#' other `smarsheetr` functions.
#'
#' @examples
#' \dontrun{
#' ss_list_sheets()
#' }
#'
#' @return A dataframe
#'
#' @export
ss_list_sheets <- function() {
  resp = ss_get(path='sheets')
  # TODO: Handle pagination
  ss_resp_data_to_dataframe(resp$content$data)
}