#' Folders
#'
#' Working with folders in ClickUp tasks (<https://clickup.com/api>).
#' @param space_id Space ID.
#' @param name Name of the folder.
#' @param folder_id Folder ID.
#' @param archived Logical, to return archived (`TRUE`) folders.
#' @param cu_token ClickUp personal access token or an access token from the OAuth flow.
#' The `CU_PAT` environment variable is used when `NULL`.
#'
#' @return
#'
#' A cu object.
#'
#' @seealso [cu-class] for the cu object class.
#'
#' @name api-folders
NULL
#' @export
#' @rdname api-folders
## Folders / Create Folder
## POST https://api.clickup.com/api/v2/space/space_id/folder
##
## space_id
## Example: 789.
## Number
##
## Body
##
## {
## "name": "New Folder Name"
## }
cu_create_folder <- function(space_id, name, cu_token = NULL) {
.cu_post("space", space_id, "folder",
body=list(name=name), cu_token = cu_token)
}
#' @export
#' @rdname api-folders
## Folders / Update Folder
## PUT https://api.clickup.com/api/v2/folder/folder_id
##
## folder_id
## Example: 457.
## Number
##
## Body
##
## {
## "name": "Updated Folder Name"
## }
cu_update_folder <- function(folder_id, name, cu_token = NULL) {
.cu_put("folder", folder_id,
body=list(name=name), cu_token = cu_token)
}
#' @export
#' @rdname api-folders
## Folders / Delete Folder
## DELETE https://api.clickup.com/api/v2/folder/folder_id
##
## folder_id
## Example: 457.
## Number
cu_delete_folder <- function(folder_id, name, cu_token = NULL) {
.cu_delete("folder", folder_id, cu_token = cu_token)
}
#' @export
#' @rdname api-folders
## Folders / Get Folders
## GET https://api.clickup.com/api/v2/space/space_id/folder?archived=false
##
## space_id
## Example: 789.
## Number
##
## archived
## Example: false.
## Boolean
cu_get_folders <- function(space_id, archived=FALSE, cu_token = NULL) {
.cu_get("space", space_id, "folder",
query = list("archived" = tolower(archived)),
cu_token = cu_token)
}
#' @export
#' @rdname api-folders
## Folders / Get Folder
## GET https://api.clickup.com/api/v2/folder/folder_id
##
## folder_id
## Example: 457.
## Number
cu_get_folder <- function(folder_id, cu_token = NULL) {
.cu_get("folder", folder_id, cu_token = cu_token)
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.