R/saved_query.R

In solvebio: The Official SolveBio API Client

#' SavedQuery.all
#'
#' Retrieves the all saved queries on SolveBio.
#'
#' @param env (optional) Custom client environment.
#' @param ... (optional) Additional query parameters (e.g. page).
#'
#' @examples \dontrun{
#' SavedQuery.all()
#' }
#'
#' @references
#' \url{https://docs.solvebio.com/}
#'
#' @export
SavedQuery.all <- function(env = solvebio:::.solveEnv, ...) {
    .request('GET', "v2/saved_queries", query=list(...), env=env)
}


#' SavedQuery.retrieve
#'
#' Retrieves a specific saved query on SolveBio by ID.
#'
#' @param id String The ID of a SolveBio saved query.
#' @param env (optional) Custom client environment.
#'
#' @examples \dontrun{
#' SavedQuery.retrieve(<ID>)
#' }
#'
#' @references
#' \url{https://docs.solvebio.com/}
#'
#' @export
SavedQuery.retrieve <- function(id, env = solvebio:::.solveEnv) {
    if (missing(id)) {
        stop("A saved query ID is required.")
    }

    path <- paste("v2/saved_queries", paste(id), sep="/")
    .request('GET', path=path, env=env)
}


#' SavedQuery.delete
#'
#' Deletes a specific saved query on SolveBio.
#'
#' @param id String The ID of the SolveBio saved query.
#' @param env (optional) Custom client environment.
#'
#' @examples \dontrun{
#' SavedQuery.delete(<ID>)
#' }
#'
#' @references
#' \url{https://docs.solvebio.com/}
#'
#' @export
SavedQuery.delete <- function(id, env = solvebio:::.solveEnv) {
    if (missing(id)) {
        stop("A saved query ID is required.")
    }

    path <- paste("v2/saved_queries", paste(id), sep="/")
    .request('DELETE', path=path, env=env)
}


#' SavedQuery.create
#'
#' Create a SolveBio saved query.
#' @param env (optional) Custom client environment.
#' @param ... (optional) Saved query attributes.
#'
#' @examples \dontrun{
#' SavedQuery.create(name="My Dataset Template")
#' }
#'
#' @references
#' \url{https://docs.solvebio.com/}
#'
#' @export
SavedQuery.create <- function(env = solvebio:::.solveEnv, ...) {
    .request('POST', path='v2/saved_queries', query=NULL, body=list(...), env=env)
}


#' SavedQuery.update
#'
#' Updates the attributes of an existing saved query.
#'
#' @param id The ID of the saved query to update.
#' @param env (optional) Custom client environment.
#' @param ... Saved query attributes to change.
#'
#' @examples \dontrun{
#' SavedQuery.update(
#'                id="1234",
#'                name="New query Name",
#'               )
#' }
#'
#' @references
#' \url{https://docs.solvebio.com/}
#'
#' @export
SavedQuery.update <- function(id, env = solvebio:::.solveEnv, ...) {
    if (missing(id)) {
        stop("A saved query ID is required.")
    }

    path <- paste("v2/saved_queries", paste(id), sep="/")
    .request('PATCH', path=path, query=NULL, body=list(...), env=env)
}