R/rt_interactions_find_type.R

In Rekyt/rtaxref: An R client for TaxRef the French Taxonomical Database

#' Retrieve the status of all Taxa according to a Status Type
#'
#' @param interaction_id {`character(1)` \[**required**\]}\cr{}
#'                  The identifier of status (see [rt_interactions_type()] for
#'                  the list of status types)
#' @inheritParams rt_status_opgroup
#'
#' @examples
#' \dontrun{rt_interactions_find_type(interaction_id = "GALLES")}
#'
#' @seealso the list of status types [`rt_interactions_type()`]
#' @export
rt_interactions_find_type = function(interaction_id = NULL, page = 1,
                                     size = 2000) {
  check_required_arg(interaction_id, paste0("retrieve all interactions using ",
                                            "with a given interaction ID"))

  stopifnot(
    "'interaction_id' must be a character" = is.character(interaction_id)
  )

  stopifnot(
    "'page' must be a numeric" = is.numeric(page)
  )

  stopifnot(
    "'size' must be a numeric" = is.numeric(size)
  )


  api_query = rt_GET("interactions/findByType/", interaction_id,
                     query = list(page = page,
                                  size = size))

  parse_taxa(api_query, FALSE)
}