R/custom_fields.R

In datacamp/asana: Access the Asana API

# DO NOT EDIT MANUALLY - This file is autogenerated from Asana API Specs
#' CustomFields
#'
#'
#'  Custom Fields store the metadata that is used in order to add user-specified
#'  information to tasks in Asana. Be sure to reference the [Custom
#'  Fields](/developers/documentation/getting-started/custom-fields) developer
#'  documentation for more information about how custom fields relate to various
#'  resources in Asana.
#' @name asn_custom_fields
#' @rdname asn_custom_fields
#' @family custom_fields
#' @seealso \link{https://asana.com/developers/api-reference/custom_fields}
NULL

#' Creates a new custom field in a workspace. Every custom field is required to be created in a specific workspace, and this workspace cannot be changed once set.
#' 
#' A custom field's `name` must be unique within a workspace and not conflict with names of existing task properties such as 'Due Date' or 'Assignee'. A custom field's `type` must be one of  'text', 'enum', or 'number'.
#' 
#' Returns the full record of the newly created custom field.
#'
#' @param ...  {Object} Data for the request
#'    workspace : {Id} The workspace to create a custom field in.
#'    type : {String} The type of the custom field.
#'    name : {String} The name of the custom field.
#'    [description] : {String} The description of the custom field.
#'    [precision] : {Integer} The number of decimal places for the numerical values. Required if the custom field is of type 'number'.
#'    [enum_options] : {String} The discrete values the custom field can assume. Required if the custom field is of type 'enum'.
#' @export
#' @family custom_fields
asn_custom_fields_create = function(..., options = list()){
  path =  "/custom_fields"
  asn_post(endpoint = path, ..., options = options)
}


#' Returns the complete definition of a custom field's metadata.
#'
#' @param custom_field  {Id} Globally unique identifier for the custom field.#'
#' @param ...  {Object} Parameters for the request
#' @export
#' @family custom_fields
asn_custom_fields_find_by_id = function(custom_field, ..., options = list()){
  path = sprintf("/custom_fields/%s", custom_field)
  asn_get(endpoint = path, ..., options = options)
}


#' Returns a list of the compact representation of all of the custom fields in a workspace.
#'
#' @param workspace  {Id} The workspace or organization to find custom field definitions in.#'
#' @param ...  {Object} Parameters for the request
#' @export
#' @family custom_fields
asn_custom_fields_find_by_workspace = function(workspace, ..., options = list()){
  path = sprintf("/workspaces/%s/custom_fields", workspace)
  asn_get(endpoint = path, ..., options = options)
}


#' A specific, existing custom field can be updated by making a PUT request on the URL for that custom field. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged
#' 
#' When using this method, it is best to specify only those fields you wish to change, or else you may overwrite changes made by another user since you last retrieved the custom field.
#' 
#' A custom field's `type` cannot be updated.
#' 
#' An enum custom field's `enum_options` cannot be updated with this endpoint. Instead see "Work With Enum Options" for information on how to update `enum_options`.
#' 
#' Returns the complete updated custom field record.
#'
#' @param custom_field  {Id} Globally unique identifier for the custom field.#'
#' @param ...  {Object} Data for the request
#' @export
#' @family custom_fields
asn_custom_fields_update = function(custom_field, ..., options = list()){
  path = sprintf("/custom_fields/%s", custom_field)
  asn_put(endpoint = path, ..., options = options)
}


#' A specific, existing custom field can be deleted by making a DELETE request on the URL for that custom field.
#' 
#' Returns an empty data record.
#'
#' @param custom_field  {Id} Globally unique identifier for the custom field.
#' @export
#' @family custom_fields
asn_custom_fields_delete = function(custom_field, ..., options = list()){
  path = sprintf("/custom_fields/%s", custom_field)
  asn_delete(endpoint = path, ..., options = options)
}


#' Creates an enum option and adds it to this custom field's list of enum options. A custom field can have at most 50 enum options (including disabled options). By default new enum options are inserted at the end of a custom field's list.
#' 
#' Returns the full record of the newly created enum option.
#'
#' @param custom_field  {Id} Globally unique identifier for the custom field.#'
#' @param ...  {Object} Data for the request
#'    name : {String} The name of the enum option.
#'    [color] : {String} The color of the enum option. Defaults to 'none'.
#'    [insert_before] : {Id} An existing enum option within this custom field before which the new enum option should be inserted. Cannot be provided together with after_enum_option.
#'    [insert_after] : {Id} An existing enum option within this custom field after which the new enum option should be inserted. Cannot be provided together with before_enum_option.
#' @export
#' @family custom_fields
asn_custom_fields_add_enum_option = function(custom_field, ..., options = list()){
  path = sprintf("/custom_fields/%s/enum_options", custom_field)
  asn_post(endpoint = path, ..., options = options)
}


#' Updates an existing enum option. Enum custom fields require at least one enabled enum option.
#' 
#' Returns the full record of the updated enum option.
#'
#' @param enum_option  {Id} Globally unique identifier for the enum option.#'
#' @param ...  {Object} Data for the request
#'    name : {String} The name of the enum option.
#'    [color] : {String} The color of the enum option. Defaults to 'none'.
#'    [enabled] : {Boolean} Whether or not the enum option is a selectable value for the custom field.
#' @export
#' @family custom_fields
asn_custom_fields_update_enum_option = function(enum_option, ..., options = list()){
  path = sprintf("/enum_options/%s", enum_option)
  asn_put(endpoint = path, ..., options = options)
}


#' Moves a particular enum option to be either before or after another specified enum option in the custom field.
#'
#' @param custom_field  {Id} Globally unique identifier for the custom field.#'
#' @param ...  {Object} Data for the request
#'    enum_option : {Id} The ID of the enum option to relocate.
#'    name : {String} The name of the enum option.
#'    [color] : {String} The color of the enum option. Defaults to 'none'.
#'    [before_enum_option] : {Id} An existing enum option within this custom field before which the new enum option should be inserted. Cannot be provided together with after_enum_option.
#'    [after_enum_option] : {Id} An existing enum option within this custom field after which the new enum option should be inserted. Cannot be provided together with before_enum_option.
#' @export
#' @family custom_fields
asn_custom_fields_reorder_enum_option = function(custom_field, ..., options = list()){
  path = sprintf("/custom_fields/%s/enum_options/insert", custom_field)
  asn_post(endpoint = path, ..., options = options)
}