R/rt_ticket_history_comment.R

In rt: Interface to the 'Request Tracker' API

#' Comment on a ticket
#'
#' @inheritParams rt_ticket_attachment
#' @param comment_text (character) Text that to add as a comment
#' @param ... Other arguments passed to \code{\link{rt_POST}}
#'
#' @return (numeric) The ID of the ticket
#'
#' @export
#'
#' @examples
#' \dontrun{
#' rt_ticket_history_comment(1, "Your comment here...")
#' }
rt_ticket_history_comment <- function(ticket_id, comment_text, ...) {
  url <- rt_url("ticket", ticket_id, "comment")

  comment <- sprintf("id: %s\nAction: comment\nText: %s",
                     ticket_id,
                     comment_text)

  response <- rt_POST(url, body = list(content = comment), ...)
  stopforstatus(response)

  invisible(ticket_id)
}