R/get_board.R

In jchrom/trellor: Access the Trello API

#' Get Board
#'
#' Returns a flat data frame with board-related data.
#'
#' @param id Board ID
#' @param ... Additional arguments passed to [get_resource()]
#' @seealso [get_resource()]
#' @name get_board
#' @examples
#' \dontrun{
#' #Get cards with custom fields
#' cards = get_board_cards(board_id, query = list(customFieldItems = "true"))
#' }
NULL

#' @export
#' @rdname get_board
get_board_actions = function(id, ...) {
  dat = get_resource(parent = "board", child = "actions", id = id, ...)
  dat
}

#' @export
#' @rdname get_board
get_board_cards = function(id, ...) {
  dat = get_resource(parent = "board", child = "cards", id = id, ...)
  dat
}

#' @export
#' @rdname get_board
get_board_checklists = function(id, ...) {
  dat = get_resource(parent = "board", child = "checklists", id = id, ...)
  dat
}

#' @export
#' @rdname get_board
get_board_comments = function(id, ...) {
  dat = get_resource(parent = "board", child = "actions", id = id,
                  filter = "commentCard", ...)
  dat
}

#' @export
#' @rdname get_board
get_board_labels = function(id, ...) {
  dat = get_resource(parent = "board", child = "labels", id = id, ...)
  dat
}

#' @export
#' @rdname get_board
get_board_lists = function(id, ...) {
  dat = get_resource(parent = "board", child = "lists", id = id, ...)
  dat
}

#' @export
#' @rdname get_board
get_board_members = function(id, ...) {
  dat = get_resource(parent = "board", child = "members", id = id, ...)
  dat
}

#' @export
#' @rdname get_board
get_board_fields = function(id, ...) {
  dat = get_resource(parent = "board", child = "customFields", id = id, ...)
  dat
}

#' @export
#' @rdname get_board
get_board_prefs = function(id, ...) {

  dat  = get_resource(parent = "board", id = id, ...)

  pref = dat[["prefs"]][[1]]
  misc = dat[setdiff(names(diff), "prefs")]

  result = structure(wrap_list(c(pref, misc)), row.names = c(NA, -1L),
                     class = "data.frame")

  require_tibble(result)

}