diff --git a/CHANGELOG.md b/CHANGELOG.md index 14fa37c3..d77df2c5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # Changelog -## [1.5.0] - Unreleased +## [1.5.0] - 2018-05-20 ### Changed - `write_civis_file` automatically retries on upload failures. diff --git a/DESCRIPTION b/DESCRIPTION index a3f12704..07b80a3a 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: civis Title: R Client for the 'Civis data science API' -Version: 1.4.0 +Version: 1.5.0 Authors@R: c( person("Patrick", "Miller", email = "pmiller@civisanalytics.com", role = c("cre", "aut")), person("Keith", "Ingersoll", email = "kingersoll@civisanalytics.com", role = "aut"), diff --git a/NAMESPACE b/NAMESPACE index ab640652..3786924d 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -88,8 +88,10 @@ export(civis_platform) export(civis_table) export(civis_to_multifile_csv) export(clusters_get_kubernetes) +export(clusters_get_kubernetes_partitions) export(clusters_get_workers) export(clusters_list_kubernetes) +export(clusters_list_kubernetes_partitions) export(clusters_list_workers) export(clusters_list_workers_active_jobs) export(clusters_list_workers_queued_jobs) @@ -138,6 +140,7 @@ export(enhancements_list_cass_ncoa_runs) export(enhancements_list_cass_ncoa_runs_logs) export(enhancements_list_cass_ncoa_runs_outputs) export(enhancements_list_cass_ncoa_shares) +export(enhancements_list_field_mapping) export(enhancements_list_person_matching_projects) export(enhancements_list_person_matching_shares) export(enhancements_list_types) diff --git a/R/generated_client.R b/R/generated_client.R index 655019eb..2366a908 100644 --- a/R/generated_client.R +++ b/R/generated_client.R @@ -90,7 +90,7 @@ apps_get <- function(slug) { #' List the instances of a Decision Application #' @param slug string required. The slug for the application. -#' @param archived string optional. The archival status of the requested object(s). +#' @param archived string optional. The archival status of the requested item(s). #' @param app_release_id integer optional. If supplied, return only instances matching this release. #' @param limit integer optional. Number of results to return. Defaults to its maximum of 50. #' @param page_num integer optional. Page number of the results to return. Defaults to the first page, 1. @@ -111,7 +111,7 @@ apps_get <- function(slug) { #' \item initials string, This user's initials. #' \item online boolean, Whether this user is online. #' }} -#' \item{projectId}{integer, The id of the project collecting all the objects that belong to this app instance.} +#' \item{projectId}{integer, The id of the project collecting all the items that belong to this app instance.} #' @export apps_list_instances <- function(slug, archived = NULL, app_release_id = NULL, limit = NULL, page_num = NULL, order = NULL, order_dir = NULL) { @@ -148,7 +148,7 @@ apps_list_instances <- function(slug, archived = NULL, app_release_id = NULL, li #' \item initials string, This user's initials. #' \item online boolean, Whether this user is online. #' }} -#' \item{projectId}{integer, The id of the project collecting all the objects that belong to this app instance.} +#' \item{projectId}{integer, The id of the project collecting all the items that belong to this app instance.} #' \item{authCodeUrl}{string, } #' \item{apiKey}{string, A Civis API key that can be used by this app instance.} #' @export @@ -171,7 +171,7 @@ apps_post_instances <- function(slug, name = NULL) { #' List the releases of a particular Decision Application #' @param slug string required. The slug for the application. -#' @param archived string optional. The archival status of the requested object(s). +#' @param archived string optional. The archival status of the requested item(s). #' @param limit integer optional. Number of results to return. Defaults to its maximum of 50. #' @param page_num integer optional. Page number of the results to return. Defaults to the first page, 1. #' @param order string optional. The field on which to order the result set. Defaults to id. Must be one of: id. @@ -245,7 +245,7 @@ apps_get_releases <- function(id, slug) { #' \item initials string, This user's initials. #' \item online boolean, Whether this user is online. #' }} -#' \item{projectId}{integer, The id of the project collecting all the objects that belong to this app instance.} +#' \item{projectId}{integer, The id of the project collecting all the items that belong to this app instance.} #' \item{authCodeUrl}{string, } #' \item{apiKey}{string, A Civis API key that can be used by this app instance.} #' @export @@ -285,7 +285,7 @@ apps_get_instances <- function(id, slug) { #' \item initials string, This user's initials. #' \item online boolean, Whether this user is online. #' }} -#' \item{projectId}{integer, The id of the project collecting all the objects that belong to this app instance.} +#' \item{projectId}{integer, The id of the project collecting all the items that belong to this app instance.} #' \item{authCodeUrl}{string, } #' \item{apiKey}{string, A Civis API key that can be used by this app instance.} #' @export @@ -501,7 +501,7 @@ apps_delete_instances_shares_groups <- function(id, group_id, slug) { #' \item initials string, This user's initials. #' \item online boolean, Whether this user is online. #' }} -#' \item{projectId}{integer, The id of the project collecting all the objects that belong to this app instance.} +#' \item{projectId}{integer, The id of the project collecting all the items that belong to this app instance.} #' \item{authCodeUrl}{string, } #' \item{apiKey}{string, A Civis API key that can be used by this app instance.} #' @export @@ -525,7 +525,7 @@ apps_put_instances_archive <- function(id, slug, status) { #' List the projects a AppInstance belongs to #' @param id integer required. The ID of the resource. #' @param slug string required. The slug for the application. -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. #' #' @return An array containing the following fields: #' \item{id}{integer, The ID for this project.} @@ -538,7 +538,7 @@ apps_put_instances_archive <- function(id, slug, status) { #' \item online boolean, Whether this user is online. #' }} #' \item{name}{string, The name of this project.} -#' \item{description}{string, A description of the project} +#' \item{description}{string, A description of the project.} #' \item{users}{array, An array containing the following fields: #' \itemize{ #' \item id integer, The ID of this user. @@ -550,7 +550,7 @@ apps_put_instances_archive <- function(id, slug, status) { #' \item{autoShare}{boolean, } #' \item{createdAt}{string, } #' \item{updatedAt}{string, } -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export apps_list_instances_projects <- function(id, slug, hidden = NULL) { @@ -570,8 +570,8 @@ apps_list_instances_projects <- function(id, slug, hidden = NULL) { #' Add a AppInstance to a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' @param slug string required. The slug for the application. #' #' @return An empty HTTP response @@ -594,8 +594,8 @@ apps_put_instances_projects <- function(id, project_id, slug) { #' Remove a AppInstance from a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' @param slug string required. The slug for the application. #' #' @return An empty HTTP response @@ -711,7 +711,7 @@ clusters_get_workers <- function(id) { #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{requiredCpu}{integer, The CPU shares required by the script.} #' \item{requiredDiskSpace}{integer, The disk space in GB required by the script.} #' \item{requiredMemory}{integer, The memory in MB required by the script.} @@ -778,7 +778,7 @@ clusters_list_workers_active_jobs <- function(id) { #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{requiredCpu}{integer, The CPU shares required by the script.} #' \item{requiredDiskSpace}{integer, The disk space in GB required by the script.} #' \item{requiredMemory}{integer, The memory in MB required by the script.} @@ -833,10 +833,19 @@ clusters_list_workers_queued_jobs <- function(id) { #' \item instanceMaxMemory integer, The amount of memory available to a single instance of that type. #' \item instanceMaxCpu integer, The number of processor shares available to a single instance of that type. #' }} -#' \item{defaultInstanceType}{string, The default EC2 instance type in this cluster.} +#' \item{defaultInstanceType}{string, Deprecated. The default EC2 instance type in this cluster.} #' \item{organizationId}{string, The id of this cluster's organization.} #' \item{organizationSlug}{string, The slug of this cluster's organization.} #' \item{securityGroupId}{string, The security group to be added to the nodes of this cluster} +#' \item{clusterPartitions}{array, An array containing the following fields: +#' \itemize{ +#' \item clusterPartitionId integer, The ID of this cluster partition. +#' \item name string, The name of the cluster partition. +#' \item labels array, Labels associated with this partition. +#' \item instanceConfigs array, The instances configured for this cluster partition. +#' \item defaultInstanceConfigId integer, The id of the InstanceConfig that is the default for this partition. +#' }} +#' \item{isNatEnabled}{boolean, Whether this cluster needs a NAT gateway or not.} #' @export clusters_list_kubernetes <- function(organization_slug = NULL, limit = NULL, page_num = NULL, order = NULL, order_dir = NULL) { @@ -868,10 +877,19 @@ clusters_list_kubernetes <- function(organization_slug = NULL, limit = NULL, pag #' \item instanceMaxMemory integer, The amount of memory available to a single instance of that type. #' \item instanceMaxCpu integer, The number of processor shares available to a single instance of that type. #' }} -#' \item{defaultInstanceType}{string, The default EC2 instance type in this cluster.} +#' \item{defaultInstanceType}{string, Deprecated. The default EC2 instance type in this cluster.} #' \item{organizationId}{string, The id of this cluster's organization.} #' \item{organizationSlug}{string, The slug of this cluster's organization.} #' \item{securityGroupId}{string, The security group to be added to the nodes of this cluster} +#' \item{clusterPartitions}{array, An array containing the following fields: +#' \itemize{ +#' \item clusterPartitionId integer, The ID of this cluster partition. +#' \item name string, The name of the cluster partition. +#' \item labels array, Labels associated with this partition. +#' \item instanceConfigs array, The instances configured for this cluster partition. +#' \item defaultInstanceConfigId integer, The id of the InstanceConfig that is the default for this partition. +#' }} +#' \item{isNatEnabled}{boolean, Whether this cluster needs a NAT gateway or not.} #' @export clusters_get_kubernetes <- function(id) { @@ -890,6 +908,77 @@ clusters_get_kubernetes <- function(id) { } +#' List Cluster Partitions for given cluster +#' @param id integer required. The ID of this cluster. +#' +#' @return An array containing the following fields: +#' \item{clusterPartitionId}{integer, The ID of this cluster partition.} +#' \item{name}{string, The name of the cluster partition.} +#' \item{labels}{array, Labels associated with this partition.} +#' \item{instanceConfigs}{array, An array containing the following fields: +#' \itemize{ +#' \item instanceConfigId integer, The ID of this InstanceConfig. +#' \item instanceType string, An EC2 instance type. Possible values include t2.large, m4.xlarge, m4.2xlarge, and p2.xlarge. +#' \item minInstances integer, The minimum number of instances of that type in this cluster. +#' \item maxInstances integer, The maximum number of instances of that type in this cluster. +#' \item instanceMaxMemory number, The amount of memory (RAM) available to a single instance of that type in megabytes. +#' \item instanceMaxCpu number, The number of processor shares available to a single instance of that type in millicores. +#' }} +#' \item{defaultInstanceConfigId}{integer, The id of the InstanceConfig that is the default for this partition.} +#' @export +clusters_list_kubernetes_partitions <- function(id) { + + args <- as.list(match.call())[-1] + path <- "/clusters/kubernetes/{id}/partitions" + path_params <- list(id = id) + query_params <- list() + body_params <- list() + path_params <- path_params[match_params(path_params, args)] + query_params <- query_params[match_params(query_params, args)] + body_params <- body_params[match_params(body_params, args)] + resp <- call_api("get", path, path_params, query_params, body_params) + + return(resp) + + } + + +#' Describe a Cluster Partition +#' @param id integer required. The ID of the cluster which this partition belongs to. +#' @param cluster_partition_id integer required. The ID of this cluster partition. +#' +#' @return A list containing the following elements: +#' \item{clusterPartitionId}{integer, The ID of this cluster partition.} +#' \item{name}{string, The name of the cluster partition.} +#' \item{labels}{array, Labels associated with this partition.} +#' \item{instanceConfigs}{array, An array containing the following fields: +#' \itemize{ +#' \item instanceConfigId integer, The ID of this InstanceConfig. +#' \item instanceType string, An EC2 instance type. Possible values include t2.large, m4.xlarge, m4.2xlarge, and p2.xlarge. +#' \item minInstances integer, The minimum number of instances of that type in this cluster. +#' \item maxInstances integer, The maximum number of instances of that type in this cluster. +#' \item instanceMaxMemory number, The amount of memory (RAM) available to a single instance of that type in megabytes. +#' \item instanceMaxCpu number, The number of processor shares available to a single instance of that type in millicores. +#' }} +#' \item{defaultInstanceConfigId}{integer, The id of the InstanceConfig that is the default for this partition.} +#' @export +clusters_get_kubernetes_partitions <- function(id, cluster_partition_id) { + + args <- as.list(match.call())[-1] + path <- "/clusters/kubernetes/{id}/partitions/{cluster_partition_id}" + path_params <- list(id = id, cluster_partition_id = cluster_partition_id) + query_params <- list() + body_params <- list() + path_params <- path_params[match_params(path_params, args)] + query_params <- query_params[match_params(query_params, args)] + body_params <- body_params[match_params(body_params, args)] + resp <- call_api("get", path, path_params, query_params, body_params) + + return(resp) + + } + + #' List codes #' @param limit integer optional. The maximum number of codes to return. #' @param type string optional. The code's type; e.g., Code::FrontEnd. @@ -1081,6 +1170,7 @@ codes_delete <- function(id) { #' \item{owner}{string, The name of the user who this credential belongs to.} #' \item{remoteHostId}{integer, The ID of the remote host associated with this credential.} #' \item{remoteHostName}{string, The name of the remote host associated with this credential.} +#' \item{state}{string, The U.S. state for the credential. Only for VAN credentials.} #' \item{createdAt}{string, The creation time for this credential.} #' \item{updatedAt}{string, The last modification time for this credential.} #' @export @@ -1108,6 +1198,7 @@ credentials_list <- function(type = NULL, default = NULL, limit = NULL, page_num #' @param name string optional. The name identifying the credential. #' @param description string optional. A long description of the credential. #' @param remote_host_id integer optional. The ID of the remote host associated with the credential. +#' @param state string optional. The U.S. state for the credential. Only for VAN credentials. #' @param system_credential boolean optional. #' #' @return A list containing the following elements: @@ -1119,16 +1210,17 @@ credentials_list <- function(type = NULL, default = NULL, limit = NULL, page_num #' \item{owner}{string, The name of the user who this credential belongs to.} #' \item{remoteHostId}{integer, The ID of the remote host associated with this credential.} #' \item{remoteHostName}{string, The name of the remote host associated with this credential.} +#' \item{state}{string, The U.S. state for the credential. Only for VAN credentials.} #' \item{createdAt}{string, The creation time for this credential.} #' \item{updatedAt}{string, The last modification time for this credential.} #' @export -credentials_post <- function(type, username, password, name = NULL, description = NULL, remote_host_id = NULL, system_credential = NULL) { +credentials_post <- function(type, username, password, name = NULL, description = NULL, remote_host_id = NULL, state = NULL, system_credential = NULL) { args <- as.list(match.call())[-1] path <- "/credentials/" path_params <- list() query_params <- list() - body_params <- list(type = type, username = username, password = password, name = name, description = description, remoteHostId = remote_host_id, systemCredential = system_credential) + body_params <- list(type = type, username = username, password = password, name = name, description = description, remoteHostId = remote_host_id, state = state, systemCredential = system_credential) path_params <- path_params[match_params(path_params, args)] query_params <- query_params[match_params(query_params, args)] body_params <- body_params[match_params(body_params, args)] @@ -1147,6 +1239,7 @@ credentials_post <- function(type, username, password, name = NULL, description #' @param name string optional. The name identifying the credential. #' @param description string optional. A long description of the credential. #' @param remote_host_id integer optional. The ID of the remote host associated with the credential. +#' @param state string optional. The U.S. state for the credential. Only for VAN credentials. #' @param system_credential boolean optional. #' #' @return A list containing the following elements: @@ -1158,16 +1251,17 @@ credentials_post <- function(type, username, password, name = NULL, description #' \item{owner}{string, The name of the user who this credential belongs to.} #' \item{remoteHostId}{integer, The ID of the remote host associated with this credential.} #' \item{remoteHostName}{string, The name of the remote host associated with this credential.} +#' \item{state}{string, The U.S. state for the credential. Only for VAN credentials.} #' \item{createdAt}{string, The creation time for this credential.} #' \item{updatedAt}{string, The last modification time for this credential.} #' @export -credentials_put <- function(id, type, username, password, name = NULL, description = NULL, remote_host_id = NULL, system_credential = NULL) { +credentials_put <- function(id, type, username, password, name = NULL, description = NULL, remote_host_id = NULL, state = NULL, system_credential = NULL) { args <- as.list(match.call())[-1] path <- "/credentials/{id}" path_params <- list(id = id) query_params <- list() - body_params <- list(type = type, username = username, password = password, name = name, description = description, remoteHostId = remote_host_id, systemCredential = system_credential) + body_params <- list(type = type, username = username, password = password, name = name, description = description, remoteHostId = remote_host_id, state = state, systemCredential = system_credential) path_params <- path_params[match_params(path_params, args)] query_params <- query_params[match_params(query_params, args)] body_params <- body_params[match_params(body_params, args)] @@ -1190,6 +1284,7 @@ credentials_put <- function(id, type, username, password, name = NULL, descripti #' \item{owner}{string, The name of the user who this credential belongs to.} #' \item{remoteHostId}{integer, The ID of the remote host associated with this credential.} #' \item{remoteHostName}{string, The name of the remote host associated with this credential.} +#' \item{state}{string, The U.S. state for the credential. Only for VAN credentials.} #' \item{createdAt}{string, The creation time for this credential.} #' \item{updatedAt}{string, The last modification time for this credential.} #' @export @@ -1212,7 +1307,7 @@ credentials_get <- function(id) { #' Authenticate against a remote host #' @param url string required. The URL to your host. -#' @param remote_host_type string required. The type of remote host. One of: RemoteHostTypes::Bitbucket, RemoteHostTypes::Ftp, RemoteHostTypes::Github, RemoteHostTypes::GoogleDoc, RemoteHostTypes::JDBC, RemoteHostTypes::Redshift, RemoteHostTypes::Salesforce, and RemoteHostTypes::Van +#' @param remote_host_type string required. The type of remote host. One of: RemoteHostTypes::Bitbucket, RemoteHostTypes::Ftp, RemoteHostTypes::Github, RemoteHostTypes::GoogleDoc, RemoteHostTypes::JDBC, RemoteHostTypes::Postgres, RemoteHostTypes::Redshift, RemoteHostTypes::Salesforce, and RemoteHostTypes::Van #' @param username string required. The username for the credential. #' @param password string required. The password for the credential. #' @@ -1225,6 +1320,7 @@ credentials_get <- function(id) { #' \item{owner}{string, The name of the user who this credential belongs to.} #' \item{remoteHostId}{integer, The ID of the remote host associated with this credential.} #' \item{remoteHostName}{string, The name of the remote host associated with this credential.} +#' \item{state}{string, The U.S. state for the credential. Only for VAN credentials.} #' \item{createdAt}{string, The creation time for this credential.} #' \item{updatedAt}{string, The last modification time for this credential.} #' @export @@ -1744,11 +1840,34 @@ enhancements_list_types <- function() { } +#' List the fields in a field mapping for Civis Data Match, Data Unification, and Table Deduplication jobs +#' +#' @return An array containing the following fields: +#' \item{field}{string, The name of the field.} +#' \item{description}{string, The description of the field.} +#' @export +enhancements_list_field_mapping <- function() { + + args <- as.list(match.call())[-1] + path <- "/enhancements/field-mapping" + path_params <- list() + query_params <- list() + body_params <- list() + path_params <- path_params[match_params(path_params, args)] + query_params <- query_params[match_params(query_params, args)] + body_params <- body_params[match_params(body_params, args)] + resp <- call_api("get", path, path_params, query_params, body_params) + + return(resp) + + } + + #' List Enhancements -#' @param type string optional. If specified, return objects of these types. -#' @param author string optional. If specified, return objects from this author. Must use user IDs. A comma separated list of IDs is also accepted to return objects from multiple authors. -#' @param status string optional. If specified, returns objects with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'. -#' @param archived string optional. The archival status of the requested object(s). +#' @param type string optional. If specified, return items of these types. +#' @param author string optional. If specified, return items from this author. Must use user IDs. A comma separated list of IDs is also accepted to return items from multiple authors. +#' @param status string optional. If specified, returns items with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'. +#' @param archived string optional. The archival status of the requested item(s). #' @param limit integer optional. Number of results to return. Defaults to 20. Maximum allowed is 50. #' @param page_num integer optional. Page number of the results to return. Defaults to the first page, 1. #' @param order string optional. The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at, last_run.updated_at. @@ -1756,7 +1875,7 @@ enhancements_list_types <- function() { #' #' @return An array containing the following fields: #' \item{id}{integer, The ID for the enhancement.} -#' \item{name}{string, The name of the enhancement.} +#' \item{name}{string, The name of the enhancement job.} #' \item{type}{string, The type of the enhancement (e.g CASS-NCOA)} #' \item{createdAt}{string, The time this enhancement was created.} #' \item{updatedAt}{string, The time the enhancement was last updated.} @@ -1769,7 +1888,7 @@ enhancements_list_types <- function() { #' \item online boolean, Whether this user is online. #' }} #' \item{state}{string, The status of the enhancement's last run} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export enhancements_list <- function(type = NULL, author = NULL, status = NULL, archived = NULL, limit = NULL, page_num = NULL, order = NULL, order_dir = NULL) { @@ -1789,18 +1908,18 @@ enhancements_list <- function(type = NULL, author = NULL, status = NULL, archive #' Create a CASS/NCOA Enhancement -#' @param name string required. The name of the enhancement. +#' @param name string required. The name of the enhancement job. #' @param source list required. A list containing the following elements: #' \itemize{ #' \item databaseTable object, #' } #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param parent_id integer optional. Parent ID that triggers this enhancement. #' @param notifications list optional. A list containing the following elements: @@ -1838,7 +1957,7 @@ enhancements_list <- function(type = NULL, author = NULL, status = NULL, archive #' #' @return A list containing the following elements: #' \item{id}{integer, The ID for the enhancement.} -#' \item{name}{string, The name of the enhancement.} +#' \item{name}{string, The name of the enhancement job.} #' \item{type}{string, The type of the enhancement (e.g CASS-NCOA)} #' \item{createdAt}{string, The time this enhancement was created.} #' \item{updatedAt}{string, The time the enhancement was last updated.} @@ -1853,11 +1972,11 @@ enhancements_list <- function(type = NULL, author = NULL, status = NULL, archive #' \item{state}{string, The status of the enhancement's last run} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{parentId}{integer, Parent ID that triggers this enhancement.} #' \item{notifications}{list, A list containing the following elements: @@ -1904,7 +2023,7 @@ enhancements_list <- function(type = NULL, author = NULL, status = NULL, archive #' \item{ncoaCredentialId}{integer, Credential to use when performing NCOA updates. Required if 'performNcoa' is true.} #' \item{outputLevel}{string, The set of fields persisted by a CASS or NCOA enhancement.For CASS enhancements, one of 'cass' or 'all.'For NCOA enhancements, one of 'cass', 'ncoa' , 'coalesced' or 'all'.By default, all fields will be returned.} #' \item{limitingSQL}{string, The limiting sql.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export enhancements_post_cass_ncoa <- function(name, source, schedule = NULL, parent_id = NULL, notifications = NULL, destination = NULL, column_mapping = NULL, use_default_column_mapping = NULL, perform_ncoa = NULL, ncoa_credential_id = NULL, output_level = NULL, limiting_sql = NULL) { @@ -1928,7 +2047,7 @@ enhancements_post_cass_ncoa <- function(name, source, schedule = NULL, parent_id #' #' @return A list containing the following elements: #' \item{id}{integer, The ID for the enhancement.} -#' \item{name}{string, The name of the enhancement.} +#' \item{name}{string, The name of the enhancement job.} #' \item{type}{string, The type of the enhancement (e.g CASS-NCOA)} #' \item{createdAt}{string, The time this enhancement was created.} #' \item{updatedAt}{string, The time the enhancement was last updated.} @@ -1943,11 +2062,11 @@ enhancements_post_cass_ncoa <- function(name, source, schedule = NULL, parent_id #' \item{state}{string, The status of the enhancement's last run} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{parentId}{integer, Parent ID that triggers this enhancement.} #' \item{notifications}{list, A list containing the following elements: @@ -1994,7 +2113,7 @@ enhancements_post_cass_ncoa <- function(name, source, schedule = NULL, parent_id #' \item{ncoaCredentialId}{integer, Credential to use when performing NCOA updates. Required if 'performNcoa' is true.} #' \item{outputLevel}{string, The set of fields persisted by a CASS or NCOA enhancement.For CASS enhancements, one of 'cass' or 'all.'For NCOA enhancements, one of 'cass', 'ncoa' , 'coalesced' or 'all'.By default, all fields will be returned.} #' \item{limitingSQL}{string, The limiting sql.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export enhancements_get_cass_ncoa <- function(id) { @@ -2015,18 +2134,18 @@ enhancements_get_cass_ncoa <- function(id) { #' Replace all attributes of this CASS/NCOA Enhancement #' @param id integer required. The ID for the enhancement. -#' @param name string required. The name of the enhancement. +#' @param name string required. The name of the enhancement job. #' @param source list required. A list containing the following elements: #' \itemize{ #' \item databaseTable object, #' } #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param parent_id integer optional. Parent ID that triggers this enhancement. #' @param notifications list optional. A list containing the following elements: @@ -2064,7 +2183,7 @@ enhancements_get_cass_ncoa <- function(id) { #' #' @return A list containing the following elements: #' \item{id}{integer, The ID for the enhancement.} -#' \item{name}{string, The name of the enhancement.} +#' \item{name}{string, The name of the enhancement job.} #' \item{type}{string, The type of the enhancement (e.g CASS-NCOA)} #' \item{createdAt}{string, The time this enhancement was created.} #' \item{updatedAt}{string, The time the enhancement was last updated.} @@ -2079,11 +2198,11 @@ enhancements_get_cass_ncoa <- function(id) { #' \item{state}{string, The status of the enhancement's last run} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{parentId}{integer, Parent ID that triggers this enhancement.} #' \item{notifications}{list, A list containing the following elements: @@ -2130,7 +2249,7 @@ enhancements_get_cass_ncoa <- function(id) { #' \item{ncoaCredentialId}{integer, Credential to use when performing NCOA updates. Required if 'performNcoa' is true.} #' \item{outputLevel}{string, The set of fields persisted by a CASS or NCOA enhancement.For CASS enhancements, one of 'cass' or 'all.'For NCOA enhancements, one of 'cass', 'ncoa' , 'coalesced' or 'all'.By default, all fields will be returned.} #' \item{limitingSQL}{string, The limiting sql.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export enhancements_put_cass_ncoa <- function(id, name, source, schedule = NULL, parent_id = NULL, notifications = NULL, destination = NULL, column_mapping = NULL, use_default_column_mapping = NULL, perform_ncoa = NULL, ncoa_credential_id = NULL, output_level = NULL, limiting_sql = NULL) { @@ -2151,14 +2270,14 @@ enhancements_put_cass_ncoa <- function(id, name, source, schedule = NULL, parent #' Update some attributes of this CASS/NCOA Enhancement #' @param id integer required. The ID for the enhancement. -#' @param name string optional. The name of the enhancement. +#' @param name string optional. The name of the enhancement job. #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param parent_id integer optional. Parent ID that triggers this enhancement. #' @param notifications list optional. A list containing the following elements: @@ -2200,7 +2319,7 @@ enhancements_put_cass_ncoa <- function(id, name, source, schedule = NULL, parent #' #' @return A list containing the following elements: #' \item{id}{integer, The ID for the enhancement.} -#' \item{name}{string, The name of the enhancement.} +#' \item{name}{string, The name of the enhancement job.} #' \item{type}{string, The type of the enhancement (e.g CASS-NCOA)} #' \item{createdAt}{string, The time this enhancement was created.} #' \item{updatedAt}{string, The time the enhancement was last updated.} @@ -2215,11 +2334,11 @@ enhancements_put_cass_ncoa <- function(id, name, source, schedule = NULL, parent #' \item{state}{string, The status of the enhancement's last run} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{parentId}{integer, Parent ID that triggers this enhancement.} #' \item{notifications}{list, A list containing the following elements: @@ -2266,7 +2385,7 @@ enhancements_put_cass_ncoa <- function(id, name, source, schedule = NULL, parent #' \item{ncoaCredentialId}{integer, Credential to use when performing NCOA updates. Required if 'performNcoa' is true.} #' \item{outputLevel}{string, The set of fields persisted by a CASS or NCOA enhancement.For CASS enhancements, one of 'cass' or 'all.'For NCOA enhancements, one of 'cass', 'ncoa' , 'coalesced' or 'all'.By default, all fields will be returned.} #' \item{limitingSQL}{string, The limiting sql.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export enhancements_patch_cass_ncoa <- function(id, name = NULL, schedule = NULL, parent_id = NULL, notifications = NULL, source = NULL, destination = NULL, column_mapping = NULL, use_default_column_mapping = NULL, perform_ncoa = NULL, ncoa_credential_id = NULL, output_level = NULL, limiting_sql = NULL) { @@ -2464,9 +2583,9 @@ enhancements_post_cass_ncoa_cancel <- function(id) { #' #' @return An array containing the following fields: #' \item{objectType}{string, The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue} -#' \item{objectId}{integer, The ID of the output object.} -#' \item{name}{string, The name of the output object.} -#' \item{link}{string, The link to retrieve the output object.} +#' \item{objectId}{integer, The ID of the output.} +#' \item{name}{string, The name of the output.} +#' \item{link}{string, The hypermedia link to the output.} #' \item{value}{string, } #' @export enhancements_list_cass_ncoa_runs_outputs <- function(id, run_id, limit = NULL, page_num = NULL, order = NULL, order_dir = NULL) { @@ -2659,7 +2778,7 @@ enhancements_delete_cass_ncoa_shares_groups <- function(id, group_id) { #' List the projects a JobTypes::CassNcoa belongs to #' @param id integer required. The ID of the resource. -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. #' #' @return An array containing the following fields: #' \item{id}{integer, The ID for this project.} @@ -2672,7 +2791,7 @@ enhancements_delete_cass_ncoa_shares_groups <- function(id, group_id) { #' \item online boolean, Whether this user is online. #' }} #' \item{name}{string, The name of this project.} -#' \item{description}{string, A description of the project} +#' \item{description}{string, A description of the project.} #' \item{users}{array, An array containing the following fields: #' \itemize{ #' \item id integer, The ID of this user. @@ -2684,7 +2803,7 @@ enhancements_delete_cass_ncoa_shares_groups <- function(id, group_id) { #' \item{autoShare}{boolean, } #' \item{createdAt}{string, } #' \item{updatedAt}{string, } -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export enhancements_list_cass_ncoa_projects <- function(id, hidden = NULL) { @@ -2704,8 +2823,8 @@ enhancements_list_cass_ncoa_projects <- function(id, hidden = NULL) { #' Add a JobTypes::CassNcoa to a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -2727,8 +2846,8 @@ enhancements_put_cass_ncoa_projects <- function(id, project_id) { #' Remove a JobTypes::CassNcoa from a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -2755,7 +2874,7 @@ enhancements_delete_cass_ncoa_projects <- function(id, project_id) { #' #' @return A list containing the following elements: #' \item{id}{integer, The ID for the enhancement.} -#' \item{name}{string, The name of the enhancement.} +#' \item{name}{string, The name of the enhancement job.} #' \item{type}{string, The type of the enhancement (e.g CASS-NCOA)} #' \item{createdAt}{string, The time this enhancement was created.} #' \item{updatedAt}{string, The time the enhancement was last updated.} @@ -2770,11 +2889,11 @@ enhancements_delete_cass_ncoa_projects <- function(id, project_id) { #' \item{state}{string, The status of the enhancement's last run} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{parentId}{integer, Parent ID that triggers this enhancement.} #' \item{notifications}{list, A list containing the following elements: @@ -2821,7 +2940,7 @@ enhancements_delete_cass_ncoa_projects <- function(id, project_id) { #' \item{ncoaCredentialId}{integer, Credential to use when performing NCOA updates. Required if 'performNcoa' is true.} #' \item{outputLevel}{string, The set of fields persisted by a CASS or NCOA enhancement.For CASS enhancements, one of 'cass' or 'all.'For NCOA enhancements, one of 'cass', 'ncoa' , 'coalesced' or 'all'.By default, all fields will be returned.} #' \item{limitingSQL}{string, The limiting sql.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export enhancements_put_cass_ncoa_archive <- function(id, status) { @@ -3013,7 +3132,7 @@ enhancements_delete_person_matching_shares_groups <- function(id, group_id) { #' List the projects a container docker belongs to #' @param id integer required. The ID of the resource. -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. #' #' @return An array containing the following fields: #' \item{id}{integer, The ID for this project.} @@ -3026,7 +3145,7 @@ enhancements_delete_person_matching_shares_groups <- function(id, group_id) { #' \item online boolean, Whether this user is online. #' }} #' \item{name}{string, The name of this project.} -#' \item{description}{string, A description of the project} +#' \item{description}{string, A description of the project.} #' \item{users}{array, An array containing the following fields: #' \itemize{ #' \item id integer, The ID of this user. @@ -3038,7 +3157,7 @@ enhancements_delete_person_matching_shares_groups <- function(id, group_id) { #' \item{autoShare}{boolean, } #' \item{createdAt}{string, } #' \item{updatedAt}{string, } -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export enhancements_list_person_matching_projects <- function(id, hidden = NULL) { @@ -3058,8 +3177,8 @@ enhancements_list_person_matching_projects <- function(id, hidden = NULL) { #' Add a container docker to a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -3081,8 +3200,8 @@ enhancements_put_person_matching_projects <- function(id, project_id) { #' Remove a container docker from a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -3109,7 +3228,7 @@ enhancements_delete_person_matching_projects <- function(id, project_id) { #' #' @return A list containing the following elements: #' \item{id}{integer, The ID for the enhancement.} -#' \item{name}{string, The name of the enhancement.} +#' \item{name}{string, The name of the enhancement job.} #' \item{type}{string, The type of the enhancement (e.g CASS-NCOA)} #' \item{createdAt}{string, The time this enhancement was created.} #' \item{updatedAt}{string, The time the enhancement was last updated.} @@ -3124,11 +3243,11 @@ enhancements_delete_person_matching_projects <- function(id, project_id) { #' \item{state}{string, The status of the enhancement's last run} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{parentId}{integer, Parent ID that triggers this enhancement.} #' \item{notifications}{list, A list containing the following elements: @@ -3199,8 +3318,8 @@ enhancements_put_person_matching_archive <- function(id, status) { #' @param type string optional. If specified, return exports of these types. It accepts a comma-separated list, possible values are 'database' and 'gdoc'. #' @param author string optional. If specified, return exports from this author. It accepts a comma-separated list of author ids. #' @param status string optional. If specified, returns export with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'. -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. -#' @param archived string optional. The archival status of the requested object(s). +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. +#' @param archived string optional. The archival status of the requested item(s). #' @param limit integer optional. Number of results to return. Defaults to 20. Maximum allowed is 50. #' @param page_num integer optional. Page number of the results to return. Defaults to the first page, 1. #' @param order string optional. The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at, last_run.updated_at. @@ -3250,7 +3369,7 @@ exports_list <- function(type = NULL, author = NULL, status = NULL, hidden = NUL #' List the projects a Data::S3File belongs to #' @param id integer required. The ID of the resource. -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. #' #' @return An array containing the following fields: #' \item{id}{integer, The ID for this project.} @@ -3263,7 +3382,7 @@ exports_list <- function(type = NULL, author = NULL, status = NULL, hidden = NUL #' \item online boolean, Whether this user is online. #' }} #' \item{name}{string, The name of this project.} -#' \item{description}{string, A description of the project} +#' \item{description}{string, A description of the project.} #' \item{users}{array, An array containing the following fields: #' \itemize{ #' \item id integer, The ID of this user. @@ -3275,7 +3394,7 @@ exports_list <- function(type = NULL, author = NULL, status = NULL, hidden = NUL #' \item{autoShare}{boolean, } #' \item{createdAt}{string, } #' \item{updatedAt}{string, } -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export files_list_projects <- function(id, hidden = NULL) { @@ -3295,8 +3414,8 @@ files_list_projects <- function(id, hidden = NULL) { #' Add a Data::S3File to a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -3318,8 +3437,8 @@ files_put_projects <- function(id, project_id) { #' Remove a Data::S3File from a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -3345,7 +3464,7 @@ files_delete_projects <- function(id, project_id) { #' @param expires_at string optional. The date and time the file will expire. If not specified, the file will expire in 30 days. To keep a file indefinitely, specify null. #' #' @return A list containing the following elements: -#' \item{id}{integer, The ID of the file object.} +#' \item{id}{integer, The ID of the file.} #' \item{name}{string, The file name.} #' \item{createdAt}{string, The date and time the file was created.} #' \item{fileSize}{integer, The file size.} @@ -3376,7 +3495,7 @@ files_post <- function(name, expires_at = NULL) { #' @param expires_at string optional. The date and time the file will expire. If not specified, the file will expire in 30 days. To keep a file indefinitely, specify null. #' #' @return A list containing the following elements: -#' \item{id}{integer, The ID of the file object.} +#' \item{id}{integer, The ID of the file.} #' \item{name}{string, The file name.} #' \item{createdAt}{string, The date and time the file was created.} #' \item{fileSize}{integer, The file size.} @@ -3401,7 +3520,7 @@ files_post_multipart <- function(name, num_parts, expires_at = NULL) { #' Complete a multipart upload -#' @param id integer required. The ID of the file object. +#' @param id integer required. The ID of the file. #' #' @return An empty HTTP response #' @export @@ -3423,12 +3542,12 @@ files_post_multipart_complete <- function(id) { #' Get details about a file -#' @param id integer required. The ID of the file object. +#' @param id integer required. The ID of the file. #' @param link_expires_at string optional. The date and time the download link will expire. Must be a time between now and 36 hours from now. Defaults to 30 minutes from now. #' @param inline boolean optional. If true, will return a url that can be displayed inline in HTML #' #' @return A list containing the following elements: -#' \item{id}{integer, The ID of the file object.} +#' \item{id}{integer, The ID of the file.} #' \item{name}{string, The file name.} #' \item{createdAt}{string, The date and time the file was created.} #' \item{fileSize}{integer, The file size.} @@ -3932,7 +4051,7 @@ imports_delete_shares_groups <- function(id, group_id) { #' List the projects a JobTypes::Import belongs to #' @param id integer required. The ID of the resource. -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. #' #' @return An array containing the following fields: #' \item{id}{integer, The ID for this project.} @@ -3945,7 +4064,7 @@ imports_delete_shares_groups <- function(id, group_id) { #' \item online boolean, Whether this user is online. #' }} #' \item{name}{string, The name of this project.} -#' \item{description}{string, A description of the project} +#' \item{description}{string, A description of the project.} #' \item{users}{array, An array containing the following fields: #' \itemize{ #' \item id integer, The ID of this user. @@ -3957,7 +4076,7 @@ imports_delete_shares_groups <- function(id, group_id) { #' \item{autoShare}{boolean, } #' \item{createdAt}{string, } #' \item{updatedAt}{string, } -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export imports_list_projects <- function(id, hidden = NULL) { @@ -3977,8 +4096,8 @@ imports_list_projects <- function(id, hidden = NULL) { #' Add a JobTypes::Import to a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -4000,8 +4119,8 @@ imports_put_projects <- function(id, project_id) { #' Remove a JobTypes::Import from a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -4045,11 +4164,11 @@ imports_delete_projects <- function(id, project_id) { #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -4105,8 +4224,8 @@ imports_delete_projects <- function(id, project_id) { #' }} #' \item{nextRunAt}{string, The time of the next scheduled run.} #' \item{timeZone}{string, The time zone of this import.} -#' \item{hidden}{boolean, The hidden status of the object.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{hidden}{boolean, The hidden status of the item.} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export imports_put_archive <- function(id, status) { @@ -4130,8 +4249,8 @@ imports_put_archive <- function(id, status) { #' @param author string optional. If specified, return imports from this author. It accepts a comma-separated list of author ids. #' @param destination string optional. If specified, returns imports with one of these destinations. It accepts a comma-separated list of remote host ids. #' @param status string optional. If specified, returns imports with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'. -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. -#' @param archived string optional. The archival status of the requested object(s). +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. +#' @param archived string optional. The archival status of the requested item(s). #' @param limit integer optional. Number of results to return. Defaults to 20. Maximum allowed is 50. #' @param page_num integer optional. Page number of the results to return. Defaults to the first page, 1. #' @param order string optional. The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at, last_run.updated_at. @@ -4156,11 +4275,11 @@ imports_put_archive <- function(id, status) { #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{id}{integer, The ID for the import.} #' \item{isOutbound}{boolean, } @@ -4186,7 +4305,7 @@ imports_put_archive <- function(id, status) { #' \item online boolean, Whether this user is online. #' }} #' \item{timeZone}{string, The time zone of this import.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export imports_list <- function(type = NULL, author = NULL, destination = NULL, status = NULL, hidden = NULL, archived = NULL, limit = NULL, page_num = NULL, order = NULL, order_dir = NULL) { @@ -4223,11 +4342,11 @@ imports_list <- function(type = NULL, author = NULL, destination = NULL, status #' } #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param notifications list optional. A list containing the following elements: #' \itemize{ @@ -4245,7 +4364,7 @@ imports_list <- function(type = NULL, author = NULL, destination = NULL, status #' @param parent_id integer optional. Parent id to trigger this import from #' @param next_run_at string optional. The time of the next scheduled run. #' @param time_zone string optional. The time zone of this import. -#' @param hidden boolean optional. The hidden status of the object. +#' @param hidden boolean optional. The hidden status of the item. #' #' @return A list containing the following elements: #' \item{name}{string, The name of the import.} @@ -4266,11 +4385,11 @@ imports_list <- function(type = NULL, author = NULL, destination = NULL, status #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -4326,8 +4445,8 @@ imports_list <- function(type = NULL, author = NULL, destination = NULL, status #' }} #' \item{nextRunAt}{string, The time of the next scheduled run.} #' \item{timeZone}{string, The time zone of this import.} -#' \item{hidden}{boolean, The hidden status of the object.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{hidden}{boolean, The hidden status of the item.} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export imports_post <- function(name, sync_type, is_outbound, source = NULL, destination = NULL, schedule = NULL, notifications = NULL, parent_id = NULL, next_run_at = NULL, time_zone = NULL, hidden = NULL) { @@ -4360,12 +4479,12 @@ imports_post <- function(name, sync_type, is_outbound, source = NULL, destinatio #' @param column_delimiter string optional. The column delimiter of the file. If column_delimiter is null or omitted, it will be auto-detected. Valid arguments are "comma", "tab", and "pipe". #' @param first_row_is_header boolean optional. A boolean value indicating whether or not the first row is a header row. If first_row_is_header is null or omitted, it will be auto-detected. #' @param multipart boolean optional. If true, the upload URI will require a `multipart/form-data` POST request. Defaults to false. -#' @param hidden boolean optional. The hidden status of the object. +#' @param hidden boolean optional. The hidden status of the item. #' #' @return A list containing the following elements: #' \item{id}{integer, The id of the import.} -#' \item{uploadUri}{string, The URI which may be used to upload a tabular file for import. You must use this URI to upload the file you wish imported and then inform the Civis API when your upload is complete using the URI given by the runUri field of this reponse.} -#' \item{runUri}{string, The URI to POST to once the file upload is complete. After uploading the file using the URI given in the uploadUri attribute of the reponse, POST to this URI to initiate the import of your uploaded file into the platform.} +#' \item{uploadUri}{string, The URI which may be used to upload a tabular file for import. You must use this URI to upload the file you wish imported and then inform the Civis API when your upload is complete using the URI given by the runUri field of this response.} +#' \item{runUri}{string, The URI to POST to once the file upload is complete. After uploading the file using the URI given in the uploadUri attribute of the response, POST to this URI to initiate the import of your uploaded file into the platform.} #' \item{uploadFields}{list, If multipart was set to true, these fields should be included in the multipart upload.} #' @export imports_post_files <- function(schema, name, remote_host_id, credential_id, max_errors = NULL, existing_table_rows = NULL, diststyle = NULL, distkey = NULL, sortkey1 = NULL, sortkey2 = NULL, column_delimiter = NULL, first_row_is_header = NULL, multipart = NULL, hidden = NULL) { @@ -4559,7 +4678,7 @@ imports_list_runs_logs <- function(id, run_id, last_id = NULL, limit = NULL) { #' List batch imports -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. #' @param limit integer optional. Number of results to return. Defaults to 20. Maximum allowed is 50. #' @param page_num integer optional. Page number of the results to return. Defaults to the first page, 1. #' @param order string optional. The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at. @@ -4601,7 +4720,7 @@ imports_list_batches <- function(hidden = NULL, limit = NULL, page_num = NULL, o #' @param column_delimiter string optional. The column delimiter for the file. Valid arguments are "comma", "tab", and "pipe". If unspecified, defaults to "comma". #' @param first_row_is_header boolean optional. A boolean value indicating whether or not the first row is a header row. If unspecified, defaults to false. #' @param compression string optional. The type of compression. Valid arguments are "gzip", "zip", and "none". If unspecified, defaults to "gzip". -#' @param hidden boolean optional. The hidden status of the object. +#' @param hidden boolean optional. The hidden status of the item. #' #' @return A list containing the following elements: #' \item{id}{integer, The ID for the import.} @@ -4612,7 +4731,7 @@ imports_list_batches <- function(hidden = NULL, limit = NULL, page_num = NULL, o #' \item{startedAt}{string, The time the last run started at.} #' \item{finishedAt}{string, The time the last run completed.} #' \item{error}{string, The error returned by the run, if any.} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' @export imports_post_batches <- function(file_ids, schema, table, remote_host_id, credential_id, column_delimiter = NULL, first_row_is_header = NULL, compression = NULL, hidden = NULL) { @@ -4643,7 +4762,7 @@ imports_post_batches <- function(file_ids, schema, table, remote_host_id, creden #' \item{startedAt}{string, The time the last run started at.} #' \item{finishedAt}{string, The time the last run completed.} #' \item{error}{string, The error returned by the run, if any.} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' @export imports_get_batches <- function(id) { @@ -4684,11 +4803,11 @@ imports_get_batches <- function(id) { #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -4744,8 +4863,8 @@ imports_get_batches <- function(id) { #' }} #' \item{nextRunAt}{string, The time of the next scheduled run.} #' \item{timeZone}{string, The time zone of this import.} -#' \item{hidden}{boolean, The hidden status of the object.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{hidden}{boolean, The hidden status of the item.} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export imports_get <- function(id) { @@ -4783,11 +4902,11 @@ imports_get <- function(id) { #' } #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param notifications list optional. A list containing the following elements: #' \itemize{ @@ -4825,11 +4944,11 @@ imports_get <- function(id) { #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -4885,8 +5004,8 @@ imports_get <- function(id) { #' }} #' \item{nextRunAt}{string, The time of the next scheduled run.} #' \item{timeZone}{string, The time zone of this import.} -#' \item{hidden}{boolean, The hidden status of the object.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{hidden}{boolean, The hidden status of the item.} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export imports_put <- function(id, name, sync_type, is_outbound, source = NULL, destination = NULL, schedule = NULL, notifications = NULL, parent_id = NULL, next_run_at = NULL, time_zone = NULL) { @@ -5307,11 +5426,11 @@ imports_put_syncs_archive <- function(id, sync_id, status = NULL) { #' List #' @param state string optional. The job's state. One or more of queued, running, succeeded, failed, and cancelled. Specify multiple values as a comma-separated list (e.g., "A,B"). #' @param type string optional. The job's type. Specify multiple values as a comma-separated list (e.g., "A,B"). -#' @param q string optional. Query string to search on the id, name, and job type +#' @param q string optional. Query string to search on the id, name, and job type. #' @param permission string optional. A permissions string, one of "read", "write", or "manage". Lists only jobs for which the current user has that permission. -#' @param scheduled boolean optional. If the object is scheduled. -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. -#' @param archived string optional. The archival status of the requested object(s). +#' @param scheduled boolean optional. If the item is scheduled. +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. +#' @param archived string optional. The archival status of the requested item(s). #' @param limit integer optional. Number of results to return. Defaults to its maximum of 50. #' @param page_num integer optional. Page number of the results to return. Defaults to the first page, 1. #' @param order string optional. The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at. @@ -5334,14 +5453,14 @@ imports_put_syncs_archive <- function(id, sync_id, status = NULL) { #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' @export jobs_list <- function(state = NULL, type = NULL, q = NULL, permission = NULL, scheduled = NULL, hidden = NULL, archived = NULL, limit = NULL, page_num = NULL, order = NULL, order_dir = NULL) { @@ -5390,15 +5509,15 @@ jobs_list <- function(state = NULL, type = NULL, q = NULL, permission = NULL, sc #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{hidden}{boolean, The hidden status of the item.} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' @export jobs_get <- function(id) { @@ -5470,15 +5589,15 @@ jobs_post_trigger_email <- function(id) { #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{hidden}{boolean, The hidden status of the item.} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' @export jobs_list_parents <- function(id) { @@ -5628,7 +5747,7 @@ jobs_delete_runs <- function(id, run_id) { #' List the workflows a job belongs to #' @param id integer required. -#' @param archived string optional. The archival status of the requested object(s). +#' @param archived string optional. The archival status of the requested item(s). #' #' @return An array containing the following fields: #' \item{id}{integer, The ID for this workflow.} @@ -5647,15 +5766,15 @@ jobs_delete_runs <- function(id, run_id) { #' \item{state}{string, The state of the workflow. State is "running" if any execution is running, otherwise reflects most recent execution state.} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{timeZone}{string, The time zone of this workflow.} #' \item{nextExecutionAt}{string, The time of the next scheduled execution.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{createdAt}{string, } #' \item{updatedAt}{string, } #' @export @@ -5849,7 +5968,7 @@ jobs_delete_shares_groups <- function(id, group_id) { #' List the projects a Job belongs to #' @param id integer required. The ID of the resource. -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. #' #' @return An array containing the following fields: #' \item{id}{integer, The ID for this project.} @@ -5862,7 +5981,7 @@ jobs_delete_shares_groups <- function(id, group_id) { #' \item online boolean, Whether this user is online. #' }} #' \item{name}{string, The name of this project.} -#' \item{description}{string, A description of the project} +#' \item{description}{string, A description of the project.} #' \item{users}{array, An array containing the following fields: #' \itemize{ #' \item id integer, The ID of this user. @@ -5874,7 +5993,7 @@ jobs_delete_shares_groups <- function(id, group_id) { #' \item{autoShare}{boolean, } #' \item{createdAt}{string, } #' \item{updatedAt}{string, } -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export jobs_list_projects <- function(id, hidden = NULL) { @@ -5894,8 +6013,8 @@ jobs_list_projects <- function(id, hidden = NULL) { #' Add a Job to a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -5917,8 +6036,8 @@ jobs_put_projects <- function(id, project_id) { #' Remove a Job from a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -6230,7 +6349,7 @@ media_delete_spot_orders_shares_groups <- function(id, group_id) { #' #' @return A list containing the following elements: #' \item{id}{integer, The ID for the spot order.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{csvS3Uri}{string, S3 URI for the spot order CSV file.} #' \item{jsonS3Uri}{string, S3 URI for the spot order JSON file.} #' \item{xmlArchiveS3Uri}{string, S3 URI for the spot order XML archive.} @@ -6445,7 +6564,7 @@ media_delete_optimizations_shares_groups <- function(id, group_id) { #' \item{state}{string, The state of the last run.} #' \item{lastRunId}{integer, The ID of the last run.} #' \item{spotOrderId}{integer, The ID for the spot order produced by the optimization.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{reportLink}{string, A link to the visual report for the optimization.} #' \item{spotOrderLink}{string, A link to the json version of the spot order.} #' \item{fileLinks}{array, Links to the csv and xml versions of the spot order.} @@ -6664,7 +6783,7 @@ media_delete_ratecards_shares_groups <- function(id, group_id) { #' \item{startOn}{string, First day to which the ratecard applies.} #' \item{endOn}{string, Last day to which the ratecard applies.} #' \item{dmaNumber}{integer, Number of the DMA associated with the ratecard.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export media_put_ratecards_archive <- function(id, status) { @@ -6684,7 +6803,7 @@ media_put_ratecards_archive <- function(id, status) { #' List all optimizations -#' @param archived string optional. The archival status of the requested object(s). +#' @param archived string optional. The archival status of the requested item(s). #' @param limit integer optional. Number of results to return. Defaults to 20. Maximum allowed is 50. #' @param page_num integer optional. Page number of the results to return. Defaults to the first page, 1. #' @param order string optional. The field on which to order the result set. Defaults to created_at. Must be one of: created_at, author, name. @@ -6707,7 +6826,7 @@ media_put_ratecards_archive <- function(id, status) { #' \item{state}{string, The state of the last run.} #' \item{lastRunId}{integer, The ID of the last run.} #' \item{spotOrderId}{integer, The ID for the spot order produced by the optimization.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export media_list_optimizations <- function(archived = NULL, limit = NULL, page_num = NULL, order = NULL, order_dir = NULL) { @@ -6762,7 +6881,7 @@ media_list_optimizations <- function(archived = NULL, limit = NULL, page_num = N #' \item{state}{string, The state of the last run.} #' \item{lastRunId}{integer, The ID of the last run.} #' \item{spotOrderId}{integer, The ID for the spot order produced by the optimization.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{reportLink}{string, A link to the visual report for the optimization.} #' \item{spotOrderLink}{string, A link to the json version of the spot order.} #' \item{fileLinks}{array, Links to the csv and xml versions of the spot order.} @@ -6820,7 +6939,7 @@ media_post_optimizations <- function(runs, name = NULL, programs = NULL, network #' \item{state}{string, The state of the last run.} #' \item{lastRunId}{integer, The ID of the last run.} #' \item{spotOrderId}{integer, The ID for the spot order produced by the optimization.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{reportLink}{string, A link to the visual report for the optimization.} #' \item{spotOrderLink}{string, A link to the json version of the spot order.} #' \item{fileLinks}{array, Links to the csv and xml versions of the spot order.} @@ -6895,7 +7014,7 @@ media_get_optimizations <- function(id) { #' \item{state}{string, The state of the last run.} #' \item{lastRunId}{integer, The ID of the last run.} #' \item{spotOrderId}{integer, The ID for the spot order produced by the optimization.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{reportLink}{string, A link to the visual report for the optimization.} #' \item{spotOrderLink}{string, A link to the json version of the spot order.} #' \item{fileLinks}{array, Links to the csv and xml versions of the spot order.} @@ -6953,7 +7072,7 @@ media_patch_optimizations <- function(id, name = NULL, runs = NULL, programs = N #' \item{state}{string, The state of the last run.} #' \item{lastRunId}{integer, The ID of the last run.} #' \item{spotOrderId}{integer, The ID for the spot order produced by the optimization.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{reportLink}{string, A link to the visual report for the optimization.} #' \item{spotOrderLink}{string, A link to the json version of the spot order.} #' \item{fileLinks}{array, Links to the csv and xml versions of the spot order.} @@ -7137,11 +7256,11 @@ media_list_optimizations_runs_logs <- function(id, run_id, last_id = NULL, limit #' List all spot orders #' @param id integer optional. The ID for the spot order. -#' @param archived string optional. The archival status of the requested object(s). +#' @param archived string optional. The archival status of the requested item(s). #' #' @return An array containing the following fields: #' \item{id}{integer, The ID for the spot order.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export media_list_spot_orders <- function(id = NULL, archived = NULL) { @@ -7165,7 +7284,7 @@ media_list_spot_orders <- function(id = NULL, archived = NULL) { #' #' @return A list containing the following elements: #' \item{id}{integer, The ID for the spot order.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{csvS3Uri}{string, S3 URI for the spot order CSV file.} #' \item{jsonS3Uri}{string, S3 URI for the spot order JSON file.} #' \item{xmlArchiveS3Uri}{string, S3 URI for the spot order XML archive.} @@ -7193,7 +7312,7 @@ media_post_spot_orders <- function(body = NULL) { #' #' @return A list containing the following elements: #' \item{id}{integer, The ID for the spot order.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{csvS3Uri}{string, S3 URI for the spot order CSV file.} #' \item{jsonS3Uri}{string, S3 URI for the spot order JSON file.} #' \item{xmlArchiveS3Uri}{string, S3 URI for the spot order XML archive.} @@ -7222,7 +7341,7 @@ media_get_spot_orders <- function(id) { #' #' @return A list containing the following elements: #' \item{id}{integer, The ID for the spot order.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{csvS3Uri}{string, S3 URI for the spot order CSV file.} #' \item{jsonS3Uri}{string, S3 URI for the spot order JSON file.} #' \item{xmlArchiveS3Uri}{string, S3 URI for the spot order XML archive.} @@ -7246,7 +7365,7 @@ media_put_spot_orders <- function(id, body = NULL) { #' List all ratecards -#' @param archived string optional. The archival status of the requested object(s). +#' @param archived string optional. The archival status of the requested item(s). #' @param filename string optional. If specified, will be used to filter the ratecards returned. Substring matching is supported with "\%" and "*" wildcards (e.g., "filename=\%ratecard\%" will return both "ratecard 1" and "my ratecard"). #' @param dma_number integer optional. If specified, will be used to filter the ratecards by DMA. #' @@ -7256,7 +7375,7 @@ media_put_spot_orders <- function(id, body = NULL) { #' \item{startOn}{string, First day to which the ratecard applies.} #' \item{endOn}{string, Last day to which the ratecard applies.} #' \item{dmaNumber}{integer, Number of the DMA associated with the ratecard.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export media_list_ratecards <- function(archived = NULL, filename = NULL, dma_number = NULL) { @@ -7287,7 +7406,7 @@ media_list_ratecards <- function(archived = NULL, filename = NULL, dma_number = #' \item{startOn}{string, First day to which the ratecard applies.} #' \item{endOn}{string, Last day to which the ratecard applies.} #' \item{dmaNumber}{integer, Number of the DMA associated with the ratecard.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export media_post_ratecards <- function(filename, start_on, end_on, dma_number) { @@ -7315,7 +7434,7 @@ media_post_ratecards <- function(filename, start_on, end_on, dma_number) { #' \item{startOn}{string, First day to which the ratecard applies.} #' \item{endOn}{string, Last day to which the ratecard applies.} #' \item{dmaNumber}{integer, Number of the DMA associated with the ratecard.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export media_get_ratecards <- function(id) { @@ -7347,7 +7466,7 @@ media_get_ratecards <- function(id) { #' \item{startOn}{string, First day to which the ratecard applies.} #' \item{endOn}{string, Last day to which the ratecard applies.} #' \item{dmaNumber}{integer, Number of the DMA associated with the ratecard.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export media_put_ratecards <- function(id, filename, start_on, end_on, dma_number) { @@ -7379,7 +7498,7 @@ media_put_ratecards <- function(id, filename, start_on, end_on, dma_number) { #' \item{startOn}{string, First day to which the ratecard applies.} #' \item{endOn}{string, Last day to which the ratecard applies.} #' \item{dmaNumber}{integer, Number of the DMA associated with the ratecard.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export media_patch_ratecards <- function(id, filename = NULL, start_on = NULL, end_on = NULL, dma_number = NULL) { @@ -7507,15 +7626,15 @@ models_list_types <- function() { #' } #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param parent_id integer optional. The ID of the parent job that will trigger this model. #' @param time_zone string optional. The time zone of this model. -#' @param hidden boolean optional. The hidden status of the object. +#' @param hidden boolean optional. The hidden status of the item. #' #' @return A list containing the following elements: #' \item{id}{integer, The ID of the model.} @@ -7550,11 +7669,11 @@ models_list_types <- function() { #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{parentId}{integer, The ID of the parent job that will trigger this model.} #' \item{runningAs}{list, A list containing the following elements: @@ -7575,7 +7694,7 @@ models_list_types <- function() { #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{user}{list, A list containing the following elements: #' \itemize{ #' \item id integer, The ID of this user. @@ -7609,7 +7728,7 @@ models_list_types <- function() { #' \item state string, The status of the prediction. One of: "succeeded", "failed", "queued", or "running,"or "idle", if no build has been attempted. #' }} #' \item{lastOutputLocation}{string, The output JSON for the last build.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export models_post <- function(table_name = NULL, database_id = NULL, credential_id = NULL, model_name = NULL, description = NULL, interaction_terms = NULL, box_cox_transformation = NULL, model_type_id = NULL, primary_key = NULL, dependent_variable = NULL, dependent_variable_order = NULL, excluded_columns = NULL, limiting_sql = NULL, active_build_id = NULL, cross_validation_parameters = NULL, number_of_folds = NULL, notifications = NULL, schedule = NULL, parent_id = NULL, time_zone = NULL, hidden = NULL) { @@ -7634,8 +7753,8 @@ models_post <- function(table_name = NULL, database_id = NULL, credential_id = N #' @param dependent_variable string optional. If specified, will be used to filter the models returned by the dependent variable column name. Substring matching is supported. (e.g., "dependentVariable=predictor" will return both "predictor" and "my predictor"). #' @param author string optional. If specified, return models from this author. It accepts a comma-separated list of author ids. #' @param status string optional. If specified, returns models with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'. -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. -#' @param archived string optional. The archival status of the requested object(s). +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. +#' @param archived string optional. The archival status of the requested item(s). #' @param limit integer optional. Number of results to return. Defaults to its maximum of 50. #' @param page_num integer optional. Page number of the results to return. Defaults to the first page, 1. #' @param order string optional. The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at, last_run.updated_at. @@ -7660,11 +7779,11 @@ models_post <- function(table_name = NULL, database_id = NULL, credential_id = N #' \item{numberOfFolds}{integer, Number of folds for cross validation. Default value is 5.} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{parentId}{integer, The ID of the parent job that will trigger this model.} #' \item{timeZone}{string, The time zone of this model.} @@ -7709,7 +7828,7 @@ models_post <- function(table_name = NULL, database_id = NULL, credential_id = N #' \item state string, The status of the prediction. One of: "succeeded", "failed", "queued", or "running,"or "idle", if no build has been attempted. #' }} #' \item{lastOutputLocation}{string, The output JSON for the last build.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export models_list <- function(model_name = NULL, training_table_name = NULL, dependent_variable = NULL, author = NULL, status = NULL, hidden = NULL, archived = NULL, limit = NULL, page_num = NULL, order = NULL, order_dir = NULL) { @@ -7761,11 +7880,11 @@ models_list <- function(model_name = NULL, training_table_name = NULL, dependent #' } #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param parent_id integer optional. The ID of the parent job that will trigger this model. #' @param time_zone string optional. The time zone of this model. @@ -7825,11 +7944,11 @@ models_patch <- function(id, table_name = NULL, database_id = NULL, credential_i #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{parentId}{integer, The ID of the parent job that will trigger this model.} #' \item{runningAs}{list, A list containing the following elements: @@ -7850,7 +7969,7 @@ models_patch <- function(id, table_name = NULL, database_id = NULL, credential_i #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{user}{list, A list containing the following elements: #' \itemize{ #' \item id integer, The ID of this user. @@ -7884,7 +8003,7 @@ models_patch <- function(id, table_name = NULL, database_id = NULL, credential_i #' \item state string, The status of the prediction. One of: "succeeded", "failed", "queued", or "running,"or "idle", if no build has been attempted. #' }} #' \item{lastOutputLocation}{string, The output JSON for the last build.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export models_get <- function(id) { @@ -8235,7 +8354,7 @@ models_delete_shares_groups <- function(id, group_id) { #' List the projects a models belongs to #' @param id integer required. The ID of the resource. -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. #' #' @return An array containing the following fields: #' \item{id}{integer, The ID for this project.} @@ -8248,7 +8367,7 @@ models_delete_shares_groups <- function(id, group_id) { #' \item online boolean, Whether this user is online. #' }} #' \item{name}{string, The name of this project.} -#' \item{description}{string, A description of the project} +#' \item{description}{string, A description of the project.} #' \item{users}{array, An array containing the following fields: #' \itemize{ #' \item id integer, The ID of this user. @@ -8260,7 +8379,7 @@ models_delete_shares_groups <- function(id, group_id) { #' \item{autoShare}{boolean, } #' \item{createdAt}{string, } #' \item{updatedAt}{string, } -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export models_list_projects <- function(id, hidden = NULL) { @@ -8280,8 +8399,8 @@ models_list_projects <- function(id, hidden = NULL) { #' Add a models to a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -8303,8 +8422,8 @@ models_put_projects <- function(id, project_id) { #' Remove a models from a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -8362,11 +8481,11 @@ models_delete_projects <- function(id, project_id) { #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{parentId}{integer, The ID of the parent job that will trigger this model.} #' \item{runningAs}{list, A list containing the following elements: @@ -8387,7 +8506,7 @@ models_delete_projects <- function(id, project_id) { #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{user}{list, A list containing the following elements: #' \itemize{ #' \item id integer, The ID of this user. @@ -8421,7 +8540,7 @@ models_delete_projects <- function(id, project_id) { #' \item state string, The status of the prediction. One of: "succeeded", "failed", "queued", or "running,"or "idle", if no build has been attempted. #' }} #' \item{lastOutputLocation}{string, The output JSON for the last build.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export models_put_archive <- function(id, status) { @@ -8448,11 +8567,11 @@ models_put_archive <- function(id, status) { #' @param output_table string optional. The qualified name of the table to be created which will contain the model's predictions. #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' #' @return A list containing the following elements: @@ -8463,11 +8582,11 @@ models_put_archive <- function(id, status) { #' \item{outputTable}{string, The qualified name of the table to be created which will contain the model's predictions.} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{state}{string, The status of the prediction. One of: "succeeded", "failed", "queued", or "running,"or "idle", if no build has been attempted.} #' @export @@ -8495,11 +8614,11 @@ models_put_predictions <- function(id, table_name, primary_key, limiting_sql = N #' \item{id}{integer, The ID of the model associated with this schedule.} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' @export models_list_schedules <- function(id) { @@ -8523,22 +8642,22 @@ models_list_schedules <- function(id) { #' @param id integer required. The ID of the model associated with this schedule. #' @param schedule list required. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' #' @return A list containing the following elements: #' \item{id}{integer, The ID of the model associated with this schedule.} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' @export models_put_schedules <- function(id, schedule) { @@ -8559,8 +8678,8 @@ models_put_schedules <- function(id, schedule) { #' List Notebooks -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. -#' @param archived string optional. The archival status of the requested object(s). +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. +#' @param archived string optional. The archival status of the requested item(s). #' @param author string optional. If specified, return imports from this author. It accepts a comma-separated list of author IDs. #' @param status string optional. If specified, returns notebooks with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'pending', 'idle'. #' @param limit integer optional. Number of results to return. Defaults to 20. Maximum allowed is 50. @@ -8601,7 +8720,7 @@ models_put_schedules <- function(id, schedule) { #' \item published boolean, #' \item notebookId integer, The ID of owning Notebook #' }} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export notebooks_list <- function(hidden = NULL, archived = NULL, author = NULL, status = NULL, limit = NULL, page_num = NULL, order = NULL, order_dir = NULL) { @@ -8638,7 +8757,7 @@ notebooks_list <- function(hidden = NULL, archived = NULL, author = NULL, status #' @param git_repo_url string optional. The url of the git repository #' @param git_ref string optional. The git reference if git repo is specified #' @param git_path string optional. The path to the .ipynb file in the git repo that will be started up on notebook launch -#' @param hidden boolean optional. The hidden status of the object. +#' @param hidden boolean optional. The hidden status of the item. #' #' @return A list containing the following elements: #' \item{id}{integer, The ID for this notebook.} @@ -8673,7 +8792,7 @@ notebooks_list <- function(hidden = NULL, archived = NULL, author = NULL, status #' \item name string, Name of the deployment. #' \item dockerImageName string, The name of the docker image to pull from DockerHub. #' \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -#' \item displayUrl string, URL that displays the deployed platform object and includes auth token. +#' \item displayUrl string, A signed URL for viewing the deployed item. #' \item instanceType string, The EC2 instance type requested for the deployment. #' \item memory integer, The memory allocated to the deployment. #' \item cpu integer, The cpu allocated to the deployment. @@ -8691,8 +8810,8 @@ notebooks_list <- function(hidden = NULL, archived = NULL, author = NULL, status #' \item{gitRepoUrl}{string, The url of the git repository} #' \item{gitRef}{string, The git reference if git repo is specified} #' \item{gitPath}{string, The path to the .ipynb file in the git repo that will be started up on notebook launch} -#' \item{archived}{string, The archival status of the requested object(s).} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{archived}{string, The archival status of the requested item(s).} +#' \item{hidden}{boolean, The hidden status of the item.} #' @export notebooks_post <- function(name = NULL, language = NULL, description = NULL, file_id = NULL, requirements_file_id = NULL, requirements = NULL, docker_image_name = NULL, docker_image_tag = NULL, instance_type = NULL, memory = NULL, cpu = NULL, credentials = NULL, environment_variables = NULL, idle_timeout = NULL, git_repo_url = NULL, git_ref = NULL, git_path = NULL, hidden = NULL) { @@ -8747,7 +8866,7 @@ notebooks_post <- function(name = NULL, language = NULL, description = NULL, fil #' \item name string, Name of the deployment. #' \item dockerImageName string, The name of the docker image to pull from DockerHub. #' \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -#' \item displayUrl string, URL that displays the deployed platform object and includes auth token. +#' \item displayUrl string, A signed URL for viewing the deployed item. #' \item instanceType string, The EC2 instance type requested for the deployment. #' \item memory integer, The memory allocated to the deployment. #' \item cpu integer, The cpu allocated to the deployment. @@ -8765,8 +8884,8 @@ notebooks_post <- function(name = NULL, language = NULL, description = NULL, fil #' \item{gitRepoUrl}{string, The url of the git repository} #' \item{gitRef}{string, The git reference if git repo is specified} #' \item{gitPath}{string, The path to the .ipynb file in the git repo that will be started up on notebook launch} -#' \item{archived}{string, The archival status of the requested object(s).} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{archived}{string, The archival status of the requested item(s).} +#' \item{hidden}{boolean, The hidden status of the item.} #' @export notebooks_get <- function(id) { @@ -8838,7 +8957,7 @@ notebooks_get <- function(id) { #' \item name string, Name of the deployment. #' \item dockerImageName string, The name of the docker image to pull from DockerHub. #' \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -#' \item displayUrl string, URL that displays the deployed platform object and includes auth token. +#' \item displayUrl string, A signed URL for viewing the deployed item. #' \item instanceType string, The EC2 instance type requested for the deployment. #' \item memory integer, The memory allocated to the deployment. #' \item cpu integer, The cpu allocated to the deployment. @@ -8856,8 +8975,8 @@ notebooks_get <- function(id) { #' \item{gitRepoUrl}{string, The url of the git repository} #' \item{gitRef}{string, The git reference if git repo is specified} #' \item{gitPath}{string, The path to the .ipynb file in the git repo that will be started up on notebook launch} -#' \item{archived}{string, The archival status of the requested object(s).} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{archived}{string, The archival status of the requested item(s).} +#' \item{hidden}{boolean, The hidden status of the item.} #' @export notebooks_put <- function(id, name = NULL, language = NULL, description = NULL, file_id = NULL, requirements_file_id = NULL, requirements = NULL, docker_image_name = NULL, docker_image_tag = NULL, instance_type = NULL, memory = NULL, cpu = NULL, credentials = NULL, environment_variables = NULL, idle_timeout = NULL, git_repo_url = NULL, git_ref = NULL, git_path = NULL) { @@ -8929,7 +9048,7 @@ notebooks_put <- function(id, name = NULL, language = NULL, description = NULL, #' \item name string, Name of the deployment. #' \item dockerImageName string, The name of the docker image to pull from DockerHub. #' \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -#' \item displayUrl string, URL that displays the deployed platform object and includes auth token. +#' \item displayUrl string, A signed URL for viewing the deployed item. #' \item instanceType string, The EC2 instance type requested for the deployment. #' \item memory integer, The memory allocated to the deployment. #' \item cpu integer, The cpu allocated to the deployment. @@ -8947,8 +9066,8 @@ notebooks_put <- function(id, name = NULL, language = NULL, description = NULL, #' \item{gitRepoUrl}{string, The url of the git repository} #' \item{gitRef}{string, The git reference if git repo is specified} #' \item{gitPath}{string, The path to the .ipynb file in the git repo that will be started up on notebook launch} -#' \item{archived}{string, The archival status of the requested object(s).} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{archived}{string, The archival status of the requested item(s).} +#' \item{hidden}{boolean, The hidden status of the item.} #' @export notebooks_patch <- function(id, name = NULL, language = NULL, description = NULL, file_id = NULL, requirements_file_id = NULL, requirements = NULL, docker_image_name = NULL, docker_image_tag = NULL, instance_type = NULL, memory = NULL, cpu = NULL, credentials = NULL, environment_variables = NULL, idle_timeout = NULL, git_repo_url = NULL, git_ref = NULL, git_path = NULL) { @@ -9049,7 +9168,7 @@ notebooks_list_update_links <- function(id) { #' \item name string, Name of the deployment. #' \item dockerImageName string, The name of the docker image to pull from DockerHub. #' \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -#' \item displayUrl string, URL that displays the deployed platform object and includes auth token. +#' \item displayUrl string, A signed URL for viewing the deployed item. #' \item instanceType string, The EC2 instance type requested for the deployment. #' \item memory integer, The memory allocated to the deployment. #' \item cpu integer, The cpu allocated to the deployment. @@ -9067,8 +9186,8 @@ notebooks_list_update_links <- function(id) { #' \item{gitRepoUrl}{string, The url of the git repository} #' \item{gitRef}{string, The git reference if git repo is specified} #' \item{gitPath}{string, The path to the .ipynb file in the git repo that will be started up on notebook launch} -#' \item{archived}{string, The archival status of the requested object(s).} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{archived}{string, The archival status of the requested item(s).} +#' \item{hidden}{boolean, The hidden status of the item.} #' @export notebooks_post_clone <- function(id) { @@ -9295,7 +9414,7 @@ notebooks_delete_shares_groups <- function(id, group_id) { #' \item name string, Name of the deployment. #' \item dockerImageName string, The name of the docker image to pull from DockerHub. #' \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -#' \item displayUrl string, URL that displays the deployed platform object and includes auth token. +#' \item displayUrl string, A signed URL for viewing the deployed item. #' \item instanceType string, The EC2 instance type requested for the deployment. #' \item memory integer, The memory allocated to the deployment. #' \item cpu integer, The cpu allocated to the deployment. @@ -9313,8 +9432,8 @@ notebooks_delete_shares_groups <- function(id, group_id) { #' \item{gitRepoUrl}{string, The url of the git repository} #' \item{gitRef}{string, The git reference if git repo is specified} #' \item{gitPath}{string, The path to the .ipynb file in the git repo that will be started up on notebook launch} -#' \item{archived}{string, The archival status of the requested object(s).} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{archived}{string, The archival status of the requested item(s).} +#' \item{hidden}{boolean, The hidden status of the item.} #' @export notebooks_put_archive <- function(id, status) { @@ -9335,7 +9454,7 @@ notebooks_put_archive <- function(id, status) { #' List the projects a Notebook belongs to #' @param id integer required. The ID of the resource. -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. #' #' @return An array containing the following fields: #' \item{id}{integer, The ID for this project.} @@ -9348,7 +9467,7 @@ notebooks_put_archive <- function(id, status) { #' \item online boolean, Whether this user is online. #' }} #' \item{name}{string, The name of this project.} -#' \item{description}{string, A description of the project} +#' \item{description}{string, A description of the project.} #' \item{users}{array, An array containing the following fields: #' \itemize{ #' \item id integer, The ID of this user. @@ -9360,7 +9479,7 @@ notebooks_put_archive <- function(id, status) { #' \item{autoShare}{boolean, } #' \item{createdAt}{string, } #' \item{updatedAt}{string, } -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export notebooks_list_projects <- function(id, hidden = NULL) { @@ -9380,8 +9499,8 @@ notebooks_list_projects <- function(id, hidden = NULL) { #' Add a Notebook to a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -9403,8 +9522,8 @@ notebooks_put_projects <- function(id, project_id) { #' Remove a Notebook from a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -9479,7 +9598,7 @@ notebooks_list_deployments <- function(notebook_id, deployment_id = NULL, limit #' \item{name}{string, Name of the deployment.} #' \item{dockerImageName}{string, The name of the docker image to pull from DockerHub.} #' \item{dockerImageTag}{string, The tag of the docker image to pull from DockerHub (default: latest).} -#' \item{displayUrl}{string, URL that displays the deployed platform object and includes auth token.} +#' \item{displayUrl}{string, A signed URL for viewing the deployed item.} #' \item{instanceType}{string, The EC2 instance type requested for the deployment.} #' \item{memory}{integer, The memory allocated to the deployment.} #' \item{cpu}{integer, The cpu allocated to the deployment.} @@ -9518,7 +9637,7 @@ notebooks_post_deployments <- function(notebook_id, deployment_id = NULL, publis #' \item{name}{string, Name of the deployment.} #' \item{dockerImageName}{string, The name of the docker image to pull from DockerHub.} #' \item{dockerImageTag}{string, The tag of the docker image to pull from DockerHub (default: latest).} -#' \item{displayUrl}{string, URL that displays the deployed platform object and includes auth token.} +#' \item{displayUrl}{string, A signed URL for viewing the deployed item.} #' \item{instanceType}{string, The EC2 instance type requested for the deployment.} #' \item{memory}{integer, The memory allocated to the deployment.} #' \item{cpu}{integer, The cpu allocated to the deployment.} @@ -9599,7 +9718,7 @@ notebooks_list_deployments_logs <- function(id, deployment_id, start_at = NULL, #' Get the git metadata attached to this Notebook -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' #' @return A list containing the following elements: #' \item{gitRef}{string, A git reference specifying an unambiguous version of the file. Can be a branch name, or the full or shortened SHA of a commit.} @@ -9631,7 +9750,7 @@ notebooks_list_git <- function(id) { #' Attach this Notebook to a git repo/file -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' @param git_ref string optional. A git reference specifying an unambiguous version of the file. Can be a branch name, or the full or shortened SHA of a commit. #' @param git_branch string optional. The git branch that the file is on. #' @param git_path string optional. The path of the file in the repository. @@ -9667,7 +9786,7 @@ notebooks_put_git <- function(id, git_ref = NULL, git_branch = NULL, git_path = #' Get the git commits for this Notebook -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' #' @return A list containing the following elements: #' \item{commitHash}{string, The SHA of the commit.} @@ -9693,7 +9812,7 @@ notebooks_list_git_commits <- function(id) { #' Commit and push a new version of the file -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' @param content string required. The contents to commit to the file. #' @param message string required. A commit message describing the changes being made. #' @param file_hash string required. The full SHA of the file being replaced. @@ -9722,7 +9841,7 @@ notebooks_post_git_commits <- function(id, content, message, file_hash) { #' Get file contents at commit_hash -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' @param commit_hash string required. The SHA (full or shortened) of the desired git commit. #' #' @return A list containing the following elements: @@ -9870,11 +9989,11 @@ predictions_list <- function(model_id = NULL) { #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{limitingSQL}{string, A SQL WHERE clause used to scope the rows to be predicted.} #' \item{primaryKey}{array, The primary key or composite keys of the table being predicted.} @@ -9931,11 +10050,11 @@ predictions_get <- function(id) { #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{limitingSQL}{string, A SQL WHERE clause used to scope the rows to be predicted.} #' \item{primaryKey}{array, The primary key or composite keys of the table being predicted.} @@ -9964,11 +10083,11 @@ predictions_patch <- function(id, output_table_name = NULL, limiting_sql = NULL, #' \item{id}{integer, ID of the prediction associated with this schedule.} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{scoreOnModelBuild}{boolean, Whether the prediction will run after a rebuild of the associated model.} #' @export @@ -9993,11 +10112,11 @@ predictions_list_schedules <- function(id) { #' @param id integer required. ID of the prediction associated with this schedule. #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param score_on_model_build boolean optional. Whether the prediction will run after a rebuild of the associated model. #' @@ -10005,11 +10124,11 @@ predictions_list_schedules <- function(id) { #' \item{id}{integer, ID of the prediction associated with this schedule.} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{scoreOnModelBuild}{boolean, Whether the prediction will run after a rebuild of the associated model.} #' @export @@ -10198,8 +10317,8 @@ predictions_list_runs_logs <- function(id, run_id, last_id = NULL, limit = NULL) #' List projects #' @param author string optional. If specified, return projects owned by this author. It accepts a comma-separated list of author ids. #' @param permission string optional. A permissions string, one of "read", "write", or "manage". Lists only projects for which the current user has that permission. -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. -#' @param archived string optional. The archival status of the requested object(s). +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. +#' @param archived string optional. The archival status of the requested item(s). #' @param limit integer optional. Number of results to return. Defaults to 20. Maximum allowed is 1000. #' @param page_num integer optional. Page number of the results to return. Defaults to the first page, 1. #' @param order string optional. The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at. @@ -10216,7 +10335,7 @@ predictions_list_runs_logs <- function(id, run_id, last_id = NULL, limit = NULL) #' \item online boolean, Whether this user is online. #' }} #' \item{name}{string, The name of this project.} -#' \item{description}{string, A description of the project} +#' \item{description}{string, A description of the project.} #' \item{users}{array, An array containing the following fields: #' \itemize{ #' \item id integer, The ID of this user. @@ -10228,7 +10347,7 @@ predictions_list_runs_logs <- function(id, run_id, last_id = NULL, limit = NULL) #' \item{autoShare}{boolean, } #' \item{createdAt}{string, } #' \item{updatedAt}{string, } -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export projects_list <- function(author = NULL, permission = NULL, hidden = NULL, archived = NULL, limit = NULL, page_num = NULL, order = NULL, order_dir = NULL) { @@ -10249,9 +10368,9 @@ projects_list <- function(author = NULL, permission = NULL, hidden = NULL, archi #' Create a project #' @param name string required. The name of this project. -#' @param description string required. A description of the project -#' @param note string optional. Notes for the project -#' @param hidden boolean optional. The hidden status of the object. +#' @param description string required. A description of the project. +#' @param note string optional. Notes for the project. +#' @param hidden boolean optional. The hidden status of the item. #' #' @return A list containing the following elements: #' \item{id}{integer, The ID for this project.} @@ -10264,7 +10383,7 @@ projects_list <- function(author = NULL, permission = NULL, hidden = NULL, archi #' \item online boolean, Whether this user is online. #' }} #' \item{name}{string, The name of this project.} -#' \item{description}{string, A description of the project} +#' \item{description}{string, A description of the project.} #' \item{users}{array, An array containing the following fields: #' \itemize{ #' \item id integer, The ID of this user. @@ -10287,13 +10406,13 @@ projects_list <- function(author = NULL, permission = NULL, hidden = NULL, archi #' }} #' \item{surveys}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' }} #' \item{scripts}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -10303,7 +10422,7 @@ projects_list <- function(author = NULL, permission = NULL, hidden = NULL, archi #' }} #' \item{imports}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -10313,7 +10432,7 @@ projects_list <- function(author = NULL, permission = NULL, hidden = NULL, archi #' }} #' \item{models}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -10321,7 +10440,7 @@ projects_list <- function(author = NULL, permission = NULL, hidden = NULL, archi #' }} #' \item{notebooks}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -10329,7 +10448,7 @@ projects_list <- function(author = NULL, permission = NULL, hidden = NULL, archi #' }} #' \item{services}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -10337,7 +10456,7 @@ projects_list <- function(author = NULL, permission = NULL, hidden = NULL, archi #' }} #' \item{workflows}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -10345,7 +10464,7 @@ projects_list <- function(author = NULL, permission = NULL, hidden = NULL, archi #' }} #' \item{reports}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -10353,14 +10472,14 @@ projects_list <- function(author = NULL, permission = NULL, hidden = NULL, archi #' }} #' \item{scriptTemplates}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, #' }} #' \item{files}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item fileName string, @@ -10369,7 +10488,7 @@ projects_list <- function(author = NULL, permission = NULL, hidden = NULL, archi #' }} #' \item{appInstances}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -10385,11 +10504,11 @@ projects_list <- function(author = NULL, permission = NULL, hidden = NULL, archi #' \item name string, #' \item icon string, #' \item author string, -#' \item archived string, The archival status of the requested object(s). +#' \item archived string, The archival status of the requested item(s). #' }} #' \item{note}{string, } -#' \item{hidden}{boolean, The hidden status of the object.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{hidden}{boolean, The hidden status of the item.} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export projects_post <- function(name, description, note = NULL, hidden = NULL) { @@ -10422,7 +10541,7 @@ projects_post <- function(name, description, note = NULL, hidden = NULL) { #' \item online boolean, Whether this user is online. #' }} #' \item{name}{string, The name of this project.} -#' \item{description}{string, A description of the project} +#' \item{description}{string, A description of the project.} #' \item{users}{array, An array containing the following fields: #' \itemize{ #' \item id integer, The ID of this user. @@ -10445,13 +10564,13 @@ projects_post <- function(name, description, note = NULL, hidden = NULL) { #' }} #' \item{surveys}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' }} #' \item{scripts}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -10461,7 +10580,7 @@ projects_post <- function(name, description, note = NULL, hidden = NULL) { #' }} #' \item{imports}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -10471,7 +10590,7 @@ projects_post <- function(name, description, note = NULL, hidden = NULL) { #' }} #' \item{models}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -10479,7 +10598,7 @@ projects_post <- function(name, description, note = NULL, hidden = NULL) { #' }} #' \item{notebooks}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -10487,7 +10606,7 @@ projects_post <- function(name, description, note = NULL, hidden = NULL) { #' }} #' \item{services}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -10495,7 +10614,7 @@ projects_post <- function(name, description, note = NULL, hidden = NULL) { #' }} #' \item{workflows}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -10503,7 +10622,7 @@ projects_post <- function(name, description, note = NULL, hidden = NULL) { #' }} #' \item{reports}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -10511,14 +10630,14 @@ projects_post <- function(name, description, note = NULL, hidden = NULL) { #' }} #' \item{scriptTemplates}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, #' }} #' \item{files}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item fileName string, @@ -10527,7 +10646,7 @@ projects_post <- function(name, description, note = NULL, hidden = NULL) { #' }} #' \item{appInstances}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -10543,11 +10662,11 @@ projects_post <- function(name, description, note = NULL, hidden = NULL) { #' \item name string, #' \item icon string, #' \item author string, -#' \item archived string, The archival status of the requested object(s). +#' \item archived string, The archival status of the requested item(s). #' }} #' \item{note}{string, } -#' \item{hidden}{boolean, The hidden status of the object.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{hidden}{boolean, The hidden status of the item.} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export projects_get <- function(project_id) { @@ -10569,8 +10688,8 @@ projects_get <- function(project_id) { #' Update a project #' @param project_id integer required. #' @param name string optional. The name of this project. -#' @param description string optional. A description of the project -#' @param note string optional. Notes for the project +#' @param description string optional. A description of the project. +#' @param note string optional. Notes for the project. #' #' @return A list containing the following elements: #' \item{id}{integer, The ID for this project.} @@ -10583,7 +10702,7 @@ projects_get <- function(project_id) { #' \item online boolean, Whether this user is online. #' }} #' \item{name}{string, The name of this project.} -#' \item{description}{string, A description of the project} +#' \item{description}{string, A description of the project.} #' \item{users}{array, An array containing the following fields: #' \itemize{ #' \item id integer, The ID of this user. @@ -10606,13 +10725,13 @@ projects_get <- function(project_id) { #' }} #' \item{surveys}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' }} #' \item{scripts}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -10622,7 +10741,7 @@ projects_get <- function(project_id) { #' }} #' \item{imports}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -10632,7 +10751,7 @@ projects_get <- function(project_id) { #' }} #' \item{models}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -10640,7 +10759,7 @@ projects_get <- function(project_id) { #' }} #' \item{notebooks}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -10648,7 +10767,7 @@ projects_get <- function(project_id) { #' }} #' \item{services}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -10656,7 +10775,7 @@ projects_get <- function(project_id) { #' }} #' \item{workflows}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -10664,7 +10783,7 @@ projects_get <- function(project_id) { #' }} #' \item{reports}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -10672,14 +10791,14 @@ projects_get <- function(project_id) { #' }} #' \item{scriptTemplates}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, #' }} #' \item{files}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item fileName string, @@ -10688,7 +10807,7 @@ projects_get <- function(project_id) { #' }} #' \item{appInstances}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -10704,11 +10823,11 @@ projects_get <- function(project_id) { #' \item name string, #' \item icon string, #' \item author string, -#' \item archived string, The archival status of the requested object(s). +#' \item archived string, The archival status of the requested item(s). #' }} #' \item{note}{string, } -#' \item{hidden}{boolean, The hidden status of the object.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{hidden}{boolean, The hidden status of the item.} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export projects_put <- function(project_id, name = NULL, description = NULL, note = NULL) { @@ -10935,7 +11054,7 @@ projects_delete_shares_groups <- function(id, group_id) { #' \item online boolean, Whether this user is online. #' }} #' \item{name}{string, The name of this project.} -#' \item{description}{string, A description of the project} +#' \item{description}{string, A description of the project.} #' \item{users}{array, An array containing the following fields: #' \itemize{ #' \item id integer, The ID of this user. @@ -10958,13 +11077,13 @@ projects_delete_shares_groups <- function(id, group_id) { #' }} #' \item{surveys}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' }} #' \item{scripts}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -10974,7 +11093,7 @@ projects_delete_shares_groups <- function(id, group_id) { #' }} #' \item{imports}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -10984,7 +11103,7 @@ projects_delete_shares_groups <- function(id, group_id) { #' }} #' \item{models}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -10992,7 +11111,7 @@ projects_delete_shares_groups <- function(id, group_id) { #' }} #' \item{notebooks}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -11000,7 +11119,7 @@ projects_delete_shares_groups <- function(id, group_id) { #' }} #' \item{services}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -11008,7 +11127,7 @@ projects_delete_shares_groups <- function(id, group_id) { #' }} #' \item{workflows}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -11016,7 +11135,7 @@ projects_delete_shares_groups <- function(id, group_id) { #' }} #' \item{reports}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -11024,14 +11143,14 @@ projects_delete_shares_groups <- function(id, group_id) { #' }} #' \item{scriptTemplates}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, #' }} #' \item{files}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item fileName string, @@ -11040,7 +11159,7 @@ projects_delete_shares_groups <- function(id, group_id) { #' }} #' \item{appInstances}{array, An array containing the following fields: #' \itemize{ -#' \item id integer, The object ID. +#' \item id integer, The item's ID. #' \item createdAt string, #' \item updatedAt string, #' \item name string, @@ -11056,11 +11175,11 @@ projects_delete_shares_groups <- function(id, group_id) { #' \item name string, #' \item icon string, #' \item author string, -#' \item archived string, The archival status of the requested object(s). +#' \item archived string, The archival status of the requested item(s). #' }} #' \item{note}{string, } -#' \item{hidden}{boolean, The hidden status of the object.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{hidden}{boolean, The hidden status of the item.} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export projects_put_archive <- function(id, status) { @@ -11084,7 +11203,7 @@ projects_put_archive <- function(id, status) { #' @param author_id integer optional. The author of the query. #' @param created_before string optional. An upper bound for the creation date of the query. #' @param exclude_results boolean optional. If true, does not return cached query results. -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. #' @param limit integer optional. Number of results to return. Defaults to 20. Maximum allowed is 50. #' @param page_num integer optional. Page number of the results to return. Defaults to the first page, 1. #' @param order string optional. The field on which to order the result set. Defaults to created_at. Must be one of: created_at. @@ -11098,7 +11217,8 @@ projects_put_archive <- function(id, status) { #' \item{resultRows}{array, A preview of rows returned by the query.} #' \item{resultColumns}{array, A preview of columns returned by the query.} #' \item{scriptId}{integer, The ID of the script associated with this query.} -#' \item{exception}{string, Exception returned from the query, null if the query was a success.} +#' \item{exception}{string, Deprecated and not used.} +#' \item{error}{string, The error message for this run, if present.} #' \item{createdAt}{string, } #' \item{updatedAt}{string, } #' \item{finishedAt}{string, The end time of the last run.} @@ -11130,7 +11250,7 @@ queries_list <- function(database_id = NULL, author_id = NULL, created_before = #' @param sql string required. The SQL to execute. #' @param preview_rows integer required. The number of rows to save from the query's result (maximum: 100). #' @param credential integer optional. The credential ID. -#' @param hidden boolean optional. The hidden status of the object. +#' @param hidden boolean optional. The hidden status of the item. #' @param interactive boolean optional. Deprecated and not used. #' @param include_header boolean optional. Whether the CSV output should include a header row [default: true]. #' @param compression string optional. The type of compression. One of gzip or zip, or none [default: gzip]. @@ -11146,13 +11266,14 @@ queries_list <- function(database_id = NULL, author_id = NULL, created_before = #' \item{resultRows}{array, A preview of rows returned by the query.} #' \item{resultColumns}{array, A preview of columns returned by the query.} #' \item{scriptId}{integer, The ID of the script associated with this query.} -#' \item{exception}{string, Exception returned from the query, null if the query was a success.} +#' \item{exception}{string, Deprecated and not used.} +#' \item{error}{string, The error message for this run, if present.} #' \item{createdAt}{string, } #' \item{updatedAt}{string, } #' \item{finishedAt}{string, The end time of the last run.} #' \item{state}{string, The state of the last run.} #' \item{lastRunId}{integer, The ID of the last run.} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{interactive}{boolean, Deprecated and not used.} #' \item{previewRows}{integer, The number of rows to save from the query's result (maximum: 100).} #' \item{includeHeader}{boolean, Whether the CSV output should include a header row [default: true].} @@ -11336,13 +11457,14 @@ queries_list_runs_logs <- function(id, run_id, last_id = NULL, limit = NULL) { #' \item{resultRows}{array, A preview of rows returned by the query.} #' \item{resultColumns}{array, A preview of columns returned by the query.} #' \item{scriptId}{integer, The ID of the script associated with this query.} -#' \item{exception}{string, Exception returned from the query, null if the query was a success.} +#' \item{exception}{string, Deprecated and not used.} +#' \item{error}{string, The error message for this run, if present.} #' \item{createdAt}{string, } #' \item{updatedAt}{string, } #' \item{finishedAt}{string, The end time of the last run.} #' \item{state}{string, The state of the last run.} #' \item{lastRunId}{integer, The ID of the last run.} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{name}{string, The name of the query.} #' \item{author}{list, A list containing the following elements: #' \itemize{ @@ -11383,13 +11505,14 @@ queries_put_scripts <- function(id, script_id) { #' \item{resultRows}{array, A preview of rows returned by the query.} #' \item{resultColumns}{array, A preview of columns returned by the query.} #' \item{scriptId}{integer, The ID of the script associated with this query.} -#' \item{exception}{string, Exception returned from the query, null if the query was a success.} +#' \item{exception}{string, Deprecated and not used.} +#' \item{error}{string, The error message for this run, if present.} #' \item{createdAt}{string, } #' \item{updatedAt}{string, } #' \item{finishedAt}{string, The end time of the last run.} #' \item{state}{string, The state of the last run.} #' \item{lastRunId}{integer, The ID of the last run.} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{name}{string, The name of the query.} #' \item{author}{list, A list containing the following elements: #' \itemize{ @@ -11531,8 +11654,8 @@ remote_hosts_list_data_sets <- function(id, credential_id = NULL, username = NUL #' @param type string optional. If specified, return report of these types. It accepts a comma-separated list, possible values are 'tableau' or 'other'. #' @param author string optional. If specified, return reports from this author. It accepts a comma-separated list of author ids. #' @param template_id integer optional. If specified, return reports using the provided Template. -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. -#' @param archived string optional. The archival status of the requested object(s). +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. +#' @param archived string optional. The archival status of the requested item(s). #' @param limit integer optional. Number of results to return. Defaults to 20. Maximum allowed is 50. #' @param page_num integer optional. Page number of the results to return. Defaults to the first page, 1. #' @param order string optional. The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at. @@ -11579,7 +11702,7 @@ remote_hosts_list_data_sets <- function(id, credential_id = NULL, username = NUL #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export results_list <- function(type = NULL, author = NULL, template_id = NULL, hidden = NULL, archived = NULL, limit = NULL, page_num = NULL, order = NULL, order_dir = NULL) { @@ -11605,7 +11728,7 @@ results_list <- function(type = NULL, author = NULL, template_id = NULL, hidden #' @param app_state list optional. Any application state blob for this report. #' @param provide_api_key boolean optional. Allow the report to provide an API key to front-end code. #' @param template_id integer optional. The ID of the template used for this report. -#' @param hidden boolean optional. The hidden status of the object. +#' @param hidden boolean optional. The hidden status of the item. #' #' @return A list containing the following elements: #' \item{id}{integer, The ID of this report.} @@ -11648,8 +11771,8 @@ results_list <- function(type = NULL, author = NULL, template_id = NULL, hidden #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{archived}{string, The archival status of the requested object(s).} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{archived}{string, The archival status of the requested item(s).} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{authDataUrl}{string, } #' \item{authCodeUrl}{string, } #' \item{config}{string, Any configuration metadata for this report.} @@ -11681,8 +11804,8 @@ results_post <- function(script_id = NULL, name = NULL, code_body = NULL, app_st #' @param type string optional. If specified, return report of these types. It accepts a comma-separated list, possible values are 'tableau' or 'other'. #' @param author string optional. If specified, return reports from this author. It accepts a comma-separated list of author ids. #' @param template_id integer optional. If specified, return reports using the provided Template. -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. -#' @param archived string optional. The archival status of the requested object(s). +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. +#' @param archived string optional. The archival status of the requested item(s). #' @param limit integer optional. Number of results to return. Defaults to 20. Maximum allowed is 50. #' @param page_num integer optional. Page number of the results to return. Defaults to the first page, 1. #' @param order string optional. The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at. @@ -11729,7 +11852,7 @@ results_post <- function(script_id = NULL, name = NULL, code_body = NULL, app_st #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export reports_list <- function(type = NULL, author = NULL, template_id = NULL, hidden = NULL, archived = NULL, limit = NULL, page_num = NULL, order = NULL, order_dir = NULL) { @@ -11755,7 +11878,7 @@ reports_list <- function(type = NULL, author = NULL, template_id = NULL, hidden #' @param app_state list optional. Any application state blob for this report. #' @param provide_api_key boolean optional. Allow the report to provide an API key to front-end code. #' @param template_id integer optional. The ID of the template used for this report. -#' @param hidden boolean optional. The hidden status of the object. +#' @param hidden boolean optional. The hidden status of the item. #' #' @return A list containing the following elements: #' \item{id}{integer, The ID of this report.} @@ -11798,8 +11921,8 @@ reports_list <- function(type = NULL, author = NULL, template_id = NULL, hidden #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{archived}{string, The archival status of the requested object(s).} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{archived}{string, The archival status of the requested item(s).} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{authDataUrl}{string, } #' \item{authCodeUrl}{string, } #' \item{config}{string, Any configuration metadata for this report.} @@ -11828,7 +11951,7 @@ reports_post <- function(script_id = NULL, name = NULL, code_body = NULL, app_st #' Get the git metadata attached to this Report -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' #' @return A list containing the following elements: #' \item{gitRef}{string, A git reference specifying an unambiguous version of the file. Can be a branch name, or the full or shortened SHA of a commit.} @@ -11860,7 +11983,7 @@ results_list_git <- function(id) { #' Attach this Report to a git repo/file -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' @param git_ref string optional. A git reference specifying an unambiguous version of the file. Can be a branch name, or the full or shortened SHA of a commit. #' @param git_branch string optional. The git branch that the file is on. #' @param git_path string optional. The path of the file in the repository. @@ -11896,7 +12019,7 @@ results_put_git <- function(id, git_ref = NULL, git_branch = NULL, git_path = NU #' Get the git metadata attached to this Report -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' #' @return A list containing the following elements: #' \item{gitRef}{string, A git reference specifying an unambiguous version of the file. Can be a branch name, or the full or shortened SHA of a commit.} @@ -11928,7 +12051,7 @@ reports_list_git <- function(id) { #' Attach this Report to a git repo/file -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' @param git_ref string optional. A git reference specifying an unambiguous version of the file. Can be a branch name, or the full or shortened SHA of a commit. #' @param git_branch string optional. The git branch that the file is on. #' @param git_path string optional. The path of the file in the repository. @@ -11964,7 +12087,7 @@ reports_put_git <- function(id, git_ref = NULL, git_branch = NULL, git_path = NU #' Get the git commits for this Report -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' #' @return A list containing the following elements: #' \item{commitHash}{string, The SHA of the commit.} @@ -11990,7 +12113,7 @@ results_list_git_commits <- function(id) { #' Commit and push a new version of the file -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' @param content string required. The contents to commit to the file. #' @param message string required. A commit message describing the changes being made. #' @param file_hash string required. The full SHA of the file being replaced. @@ -12019,7 +12142,7 @@ results_post_git_commits <- function(id, content, message, file_hash) { #' Get the git commits for this Report -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' #' @return A list containing the following elements: #' \item{commitHash}{string, The SHA of the commit.} @@ -12045,7 +12168,7 @@ reports_list_git_commits <- function(id) { #' Commit and push a new version of the file -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' @param content string required. The contents to commit to the file. #' @param message string required. A commit message describing the changes being made. #' @param file_hash string required. The full SHA of the file being replaced. @@ -12074,7 +12197,7 @@ reports_post_git_commits <- function(id, content, message, file_hash) { #' Get file contents at commit_hash -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' @param commit_hash string required. The SHA (full or shortened) of the desired git commit. #' #' @return A list containing the following elements: @@ -12101,7 +12224,7 @@ results_get_git_commits <- function(id, commit_hash) { #' Get file contents at commit_hash -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' @param commit_hash string required. The SHA (full or shortened) of the desired git commit. #' #' @return A list containing the following elements: @@ -12171,8 +12294,8 @@ reports_get_git_commits <- function(id, commit_hash) { #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{archived}{string, The archival status of the requested object(s).} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{archived}{string, The archival status of the requested item(s).} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{authDataUrl}{string, } #' \item{authCodeUrl}{string, } #' \item{config}{string, Any configuration metadata for this report.} @@ -12252,8 +12375,8 @@ results_get <- function(id) { #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{archived}{string, The archival status of the requested object(s).} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{archived}{string, The archival status of the requested item(s).} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{authDataUrl}{string, } #' \item{authCodeUrl}{string, } #' \item{config}{string, Any configuration metadata for this report.} @@ -12325,8 +12448,8 @@ results_patch <- function(id, name = NULL, script_id = NULL, code_body = NULL, c #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{archived}{string, The archival status of the requested object(s).} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{archived}{string, The archival status of the requested item(s).} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{authDataUrl}{string, } #' \item{authCodeUrl}{string, } #' \item{config}{string, Any configuration metadata for this report.} @@ -12406,8 +12529,8 @@ reports_get <- function(id) { #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{archived}{string, The archival status of the requested object(s).} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{archived}{string, The archival status of the requested item(s).} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{authDataUrl}{string, } #' \item{authCodeUrl}{string, } #' \item{config}{string, Any configuration metadata for this report.} @@ -12479,8 +12602,8 @@ reports_patch <- function(id, name = NULL, script_id = NULL, code_body = NULL, c #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{archived}{string, The archival status of the requested object(s).} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{archived}{string, The archival status of the requested item(s).} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{authDataUrl}{string, } #' \item{authCodeUrl}{string, } #' \item{config}{string, Any configuration metadata for this report.} @@ -12574,8 +12697,8 @@ results_delete_grants <- function(id) { #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{archived}{string, The archival status of the requested object(s).} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{archived}{string, The archival status of the requested item(s).} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{authDataUrl}{string, } #' \item{authCodeUrl}{string, } #' \item{config}{string, Any configuration metadata for this report.} @@ -12640,11 +12763,11 @@ reports_delete_grants <- function(id) { #' \item{width}{integer, The width of the cropped snapshot image in screen pixels. The default value is 1440 pixels. Minimum value is 600 pixels.} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{parentId}{integer, The ID of the parent job that will trigger this snapshot.} #' @export @@ -12677,11 +12800,11 @@ results_list_snapshots <- function(id) { #' @param width integer optional. The width of the cropped snapshot image in screen pixels. The default value is 1440 pixels. Minimum value is 600 pixels. #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param parent_id integer optional. The ID of the parent job that will trigger this snapshot. #' @@ -12697,11 +12820,11 @@ results_list_snapshots <- function(id) { #' \item{width}{integer, The width of the cropped snapshot image in screen pixels. The default value is 1440 pixels. Minimum value is 600 pixels.} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{parentId}{integer, The ID of the parent job that will trigger this snapshot.} #' @export @@ -12734,11 +12857,11 @@ results_post_snapshots <- function(id, state = NULL, finished_at = NULL, send_em #' @param width integer optional. The width of the cropped snapshot image in screen pixels. The default value is 1440 pixels. Minimum value is 600 pixels. #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param parent_id integer optional. The ID of the parent job that will trigger this snapshot. #' @@ -12754,11 +12877,11 @@ results_post_snapshots <- function(id, state = NULL, finished_at = NULL, send_em #' \item{width}{integer, The width of the cropped snapshot image in screen pixels. The default value is 1440 pixels. Minimum value is 600 pixels.} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{parentId}{integer, The ID of the parent job that will trigger this snapshot.} #' @export @@ -12794,11 +12917,11 @@ results_patch_snapshots <- function(id, state = NULL, finished_at = NULL, send_e #' \item{width}{integer, The width of the cropped snapshot image in screen pixels. The default value is 1440 pixels. Minimum value is 600 pixels.} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{parentId}{integer, The ID of the parent job that will trigger this snapshot.} #' @export @@ -12831,11 +12954,11 @@ reports_list_snapshots <- function(id) { #' @param width integer optional. The width of the cropped snapshot image in screen pixels. The default value is 1440 pixels. Minimum value is 600 pixels. #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param parent_id integer optional. The ID of the parent job that will trigger this snapshot. #' @@ -12851,11 +12974,11 @@ reports_list_snapshots <- function(id) { #' \item{width}{integer, The width of the cropped snapshot image in screen pixels. The default value is 1440 pixels. Minimum value is 600 pixels.} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{parentId}{integer, The ID of the parent job that will trigger this snapshot.} #' @export @@ -12888,11 +13011,11 @@ reports_post_snapshots <- function(id, state = NULL, finished_at = NULL, send_em #' @param width integer optional. The width of the cropped snapshot image in screen pixels. The default value is 1440 pixels. Minimum value is 600 pixels. #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param parent_id integer optional. The ID of the parent job that will trigger this snapshot. #' @@ -12908,11 +13031,11 @@ reports_post_snapshots <- function(id, state = NULL, finished_at = NULL, send_em #' \item{width}{integer, The width of the cropped snapshot image in screen pixels. The default value is 1440 pixels. Minimum value is 600 pixels.} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{parentId}{integer, The ID of the parent job that will trigger this snapshot.} #' @export @@ -13277,7 +13400,7 @@ reports_delete_shares_groups <- function(id, group_id) { #' List the projects a Report belongs to #' @param id integer required. The ID of the resource. -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. #' #' @return An array containing the following fields: #' \item{id}{integer, The ID for this project.} @@ -13290,7 +13413,7 @@ reports_delete_shares_groups <- function(id, group_id) { #' \item online boolean, Whether this user is online. #' }} #' \item{name}{string, The name of this project.} -#' \item{description}{string, A description of the project} +#' \item{description}{string, A description of the project.} #' \item{users}{array, An array containing the following fields: #' \itemize{ #' \item id integer, The ID of this user. @@ -13302,7 +13425,7 @@ reports_delete_shares_groups <- function(id, group_id) { #' \item{autoShare}{boolean, } #' \item{createdAt}{string, } #' \item{updatedAt}{string, } -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export results_list_projects <- function(id, hidden = NULL) { @@ -13323,7 +13446,7 @@ results_list_projects <- function(id, hidden = NULL) { #' List the projects a Report belongs to #' @param id integer required. The ID of the resource. -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. #' #' @return An array containing the following fields: #' \item{id}{integer, The ID for this project.} @@ -13336,7 +13459,7 @@ results_list_projects <- function(id, hidden = NULL) { #' \item online boolean, Whether this user is online. #' }} #' \item{name}{string, The name of this project.} -#' \item{description}{string, A description of the project} +#' \item{description}{string, A description of the project.} #' \item{users}{array, An array containing the following fields: #' \itemize{ #' \item id integer, The ID of this user. @@ -13348,7 +13471,7 @@ results_list_projects <- function(id, hidden = NULL) { #' \item{autoShare}{boolean, } #' \item{createdAt}{string, } #' \item{updatedAt}{string, } -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export reports_list_projects <- function(id, hidden = NULL) { @@ -13368,8 +13491,8 @@ reports_list_projects <- function(id, hidden = NULL) { #' Add a Report to a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -13391,8 +13514,8 @@ results_put_projects <- function(id, project_id) { #' Remove a Report from a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -13414,8 +13537,8 @@ results_delete_projects <- function(id, project_id) { #' Add a Report to a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -13437,8 +13560,8 @@ reports_put_projects <- function(id, project_id) { #' Remove a Report from a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -13504,8 +13627,8 @@ reports_delete_projects <- function(id, project_id) { #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{archived}{string, The archival status of the requested object(s).} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{archived}{string, The archival status of the requested item(s).} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{authDataUrl}{string, } #' \item{authCodeUrl}{string, } #' \item{config}{string, Any configuration metadata for this report.} @@ -13578,8 +13701,8 @@ results_put_archive <- function(id, status) { #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{archived}{string, The archival status of the requested object(s).} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{archived}{string, The archival status of the requested item(s).} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{authDataUrl}{string, } #' \item{authCodeUrl}{string, } #' \item{config}{string, Any configuration metadata for this report.} @@ -14245,7 +14368,7 @@ scripts_list_history <- function(id) { #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' } -#' @param arguments list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params. +#' @param arguments list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters. #' @param template_script_id integer optional. The ID of the template script, if any. A script cannot both have a template script and be a template for other scripts. #' @param notifications list optional. A list containing the following elements: #' \itemize{ @@ -14260,7 +14383,7 @@ scripts_list_history <- function(id) { #' \item successOn boolean, If success email notifications are on. #' \item failureOn boolean, If failure email notifications are on. #' } -#' @param hidden boolean optional. The hidden status of the object. +#' @param hidden boolean optional. The hidden status of the item. #' #' @return A list containing the following elements: #' \item{id}{integer, The ID for the script.} @@ -14297,7 +14420,7 @@ scripts_list_history <- function(id) { #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -14310,11 +14433,11 @@ scripts_list_history <- function(id) { #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -14348,9 +14471,9 @@ scripts_list_history <- function(id) { #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{templateScriptId}{integer, The ID of the template script, if any.} #' @export scripts_post <- function(name, remote_host_id, credential_id, sql, params = NULL, arguments = NULL, template_script_id = NULL, notifications = NULL, hidden = NULL) { @@ -14371,12 +14494,12 @@ scripts_post <- function(name, remote_host_id, credential_id, sql, params = NULL #' List scripts -#' @param type string optional. If specified, return objects of these types. The valid types are sql, python3, javascript, r, and containers. +#' @param type string optional. If specified, return items of these types. The valid types are sql, python3, javascript, r, and containers. #' @param category string optional. A job category for filtering scripts. Must be one of script, import, export, and enhancement. -#' @param author string optional. If specified, return objects from this author. Must use user IDs. A comma separated list of IDs is also accepted to return objects from multiple authors. -#' @param status string optional. If specified, returns objects with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'. -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. -#' @param archived string optional. The archival status of the requested object(s). +#' @param author string optional. If specified, return items from this author. Must use user IDs. A comma separated list of IDs is also accepted to return items from multiple authors. +#' @param status string optional. If specified, returns items with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'. +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. +#' @param archived string optional. The archival status of the requested item(s). #' @param limit integer optional. Number of results to return. Defaults to 20. Maximum allowed is 50. #' @param page_num integer optional. Page number of the results to return. Defaults to the first page, 1. #' @param order string optional. The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at, last_run.updated_at. @@ -14421,7 +14544,7 @@ scripts_post <- function(name, remote_host_id, credential_id, sql, params = NULL #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{templateScriptId}{integer, The ID of the template script, if any.} #' @export scripts_list <- function(type = NULL, category = NULL, author = NULL, status = NULL, hidden = NULL, archived = NULL, limit = NULL, page_num = NULL, order = NULL, order_dir = NULL) { @@ -14456,15 +14579,15 @@ scripts_list <- function(type = NULL, category = NULL, author = NULL, status = N #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' } -#' @param arguments list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params. +#' @param arguments list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters. #' @param template_script_id integer optional. The ID of the template script, if any. A script cannot both have a template script and be a template for other scripts. #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param notifications list optional. A list containing the following elements: #' \itemize{ @@ -14516,7 +14639,7 @@ scripts_list <- function(type = NULL, category = NULL, author = NULL, status = N #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -14529,11 +14652,11 @@ scripts_list <- function(type = NULL, category = NULL, author = NULL, status = N #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -14567,9 +14690,9 @@ scripts_list <- function(type = NULL, category = NULL, author = NULL, status = N #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{sql}{string, The raw SQL query for the script.} #' \item{expandedArguments}{list, Expanded arguments for use in injecting into different environments.} #' \item{templateScriptId}{integer, The ID of the template script, if any.} @@ -14651,7 +14774,7 @@ scripts_delete <- function(id) { #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -14664,11 +14787,11 @@ scripts_delete <- function(id) { #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -14702,9 +14825,9 @@ scripts_delete <- function(id) { #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{sql}{string, The raw SQL query for the script.} #' \item{expandedArguments}{list, Expanded arguments for use in injecting into different environments.} #' \item{templateScriptId}{integer, The ID of the template script, if any.} @@ -14797,14 +14920,14 @@ scripts_post_cancel <- function(id) { #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' } -#' @param arguments list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params. +#' @param arguments list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters. #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param notifications list optional. A list containing the following elements: #' \itemize{ @@ -14824,9 +14947,10 @@ scripts_post_cancel <- function(id) { #' @param remote_host_credential_id integer optional. The id of the database credentials to pass into the environment of the container. #' @param git_credential_id integer optional. The id of the git credential to be used when checking out the specified git repo. If not supplied, the first git credential you've submitted will be used. Unnecessary if no git repo is specified or the git repo is public. #' @param docker_image_tag string optional. The tag of the docker image to pull from DockerHub (default: latest). +#' @param instance_type string optional. The EC2 instance type to deploy to. Only available for jobs running on kubernetes. #' @param cancel_timeout integer optional. The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0. #' @param time_zone string optional. The time zone of this script. -#' @param hidden boolean optional. The hidden status of the object. +#' @param hidden boolean optional. The hidden status of the item. #' @param target_project_id integer optional. Target project to which script outputs will be added. #' #' @return A list containing the following elements: @@ -14864,7 +14988,7 @@ scripts_post_cancel <- function(id) { #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{templateDependentsCount}{integer, How many other scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} @@ -14877,11 +15001,11 @@ scripts_post_cancel <- function(id) { #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -14917,6 +15041,7 @@ scripts_post_cancel <- function(id) { #' \item{dockerCommand}{string, The command to run on the container. Will be run via sh as: ["sh", "-c", dockerCommand]} #' \item{dockerImageName}{string, The name of the docker image to pull from DockerHub.} #' \item{dockerImageTag}{string, The tag of the docker image to pull from DockerHub (default: latest).} +#' \item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} #' \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} #' \item{lastRun}{list, A list containing the following elements: #' \itemize{ @@ -14928,17 +15053,17 @@ scripts_post_cancel <- function(id) { #' \item error string, The error message for this run, if present. #' }} #' \item{timeZone}{string, The time zone of this script.} -#' \item{hidden}{boolean, The hidden status of the object.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{hidden}{boolean, The hidden status of the item.} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} #' @export -scripts_post_containers <- function(required_resources, docker_command, docker_image_name, name = NULL, parent_id = NULL, user_context = NULL, params = NULL, arguments = NULL, schedule = NULL, notifications = NULL, repo_http_uri = NULL, repo_ref = NULL, remote_host_credential_id = NULL, git_credential_id = NULL, docker_image_tag = NULL, cancel_timeout = NULL, time_zone = NULL, hidden = NULL, target_project_id = NULL) { +scripts_post_containers <- function(required_resources, docker_command, docker_image_name, name = NULL, parent_id = NULL, user_context = NULL, params = NULL, arguments = NULL, schedule = NULL, notifications = NULL, repo_http_uri = NULL, repo_ref = NULL, remote_host_credential_id = NULL, git_credential_id = NULL, docker_image_tag = NULL, instance_type = NULL, cancel_timeout = NULL, time_zone = NULL, hidden = NULL, target_project_id = NULL) { args <- as.list(match.call())[-1] path <- "/scripts/containers" path_params <- list() query_params <- list() - body_params <- list(requiredResources = required_resources, dockerCommand = docker_command, dockerImageName = docker_image_name, name = name, parentId = parent_id, userContext = user_context, params = params, arguments = arguments, schedule = schedule, notifications = notifications, repoHttpUri = repo_http_uri, repoRef = repo_ref, remoteHostCredentialId = remote_host_credential_id, gitCredentialId = git_credential_id, dockerImageTag = docker_image_tag, cancelTimeout = cancel_timeout, timeZone = time_zone, hidden = hidden, targetProjectId = target_project_id) + body_params <- list(requiredResources = required_resources, dockerCommand = docker_command, dockerImageName = docker_image_name, name = name, parentId = parent_id, userContext = user_context, params = params, arguments = arguments, schedule = schedule, notifications = notifications, repoHttpUri = repo_http_uri, repoRef = repo_ref, remoteHostCredentialId = remote_host_credential_id, gitCredentialId = git_credential_id, dockerImageTag = docker_image_tag, instanceType = instance_type, cancelTimeout = cancel_timeout, timeZone = time_zone, hidden = hidden, targetProjectId = target_project_id) path_params <- path_params[match_params(path_params, args)] query_params <- query_params[match_params(query_params, args)] body_params <- body_params[match_params(body_params, args)] @@ -14987,7 +15112,7 @@ scripts_post_containers <- function(required_resources, docker_command, docker_i #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{templateDependentsCount}{integer, How many other scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} @@ -15000,11 +15125,11 @@ scripts_post_containers <- function(required_resources, docker_command, docker_i #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -15040,6 +15165,7 @@ scripts_post_containers <- function(required_resources, docker_command, docker_i #' \item{dockerCommand}{string, The command to run on the container. Will be run via sh as: ["sh", "-c", dockerCommand]} #' \item{dockerImageName}{string, The name of the docker image to pull from DockerHub.} #' \item{dockerImageTag}{string, The tag of the docker image to pull from DockerHub (default: latest).} +#' \item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} #' \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} #' \item{lastRun}{list, A list containing the following elements: #' \itemize{ @@ -15051,8 +15177,8 @@ scripts_post_containers <- function(required_resources, docker_command, docker_i #' \item error string, The error message for this run, if present. #' }} #' \item{timeZone}{string, The time zone of this script.} -#' \item{hidden}{boolean, The hidden status of the object.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{hidden}{boolean, The hidden status of the item.} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} #' @export scripts_get_containers <- function(id) { @@ -15097,14 +15223,14 @@ scripts_get_containers <- function(id) { #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' } -#' @param arguments list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params. +#' @param arguments list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters. #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param notifications list optional. A list containing the following elements: #' \itemize{ @@ -15124,6 +15250,7 @@ scripts_get_containers <- function(id) { #' @param remote_host_credential_id integer optional. The id of the database credentials to pass into the environment of the container. #' @param git_credential_id integer optional. The id of the git credential to be used when checking out the specified git repo. If not supplied, the first git credential you've submitted will be used. Unnecessary if no git repo is specified or the git repo is public. #' @param docker_image_tag string optional. The tag of the docker image to pull from DockerHub (default: latest). +#' @param instance_type string optional. The EC2 instance type to deploy to. Only available for jobs running on kubernetes. #' @param cancel_timeout integer optional. The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0. #' @param time_zone string optional. The time zone of this script. #' @param target_project_id integer optional. Target project to which script outputs will be added. @@ -15163,7 +15290,7 @@ scripts_get_containers <- function(id) { #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{templateDependentsCount}{integer, How many other scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} @@ -15176,11 +15303,11 @@ scripts_get_containers <- function(id) { #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -15216,6 +15343,7 @@ scripts_get_containers <- function(id) { #' \item{dockerCommand}{string, The command to run on the container. Will be run via sh as: ["sh", "-c", dockerCommand]} #' \item{dockerImageName}{string, The name of the docker image to pull from DockerHub.} #' \item{dockerImageTag}{string, The tag of the docker image to pull from DockerHub (default: latest).} +#' \item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} #' \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} #' \item{lastRun}{list, A list containing the following elements: #' \itemize{ @@ -15227,17 +15355,17 @@ scripts_get_containers <- function(id) { #' \item error string, The error message for this run, if present. #' }} #' \item{timeZone}{string, The time zone of this script.} -#' \item{hidden}{boolean, The hidden status of the object.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{hidden}{boolean, The hidden status of the item.} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} #' @export -scripts_put_containers <- function(id, required_resources, docker_command, docker_image_name, name = NULL, parent_id = NULL, user_context = NULL, params = NULL, arguments = NULL, schedule = NULL, notifications = NULL, repo_http_uri = NULL, repo_ref = NULL, remote_host_credential_id = NULL, git_credential_id = NULL, docker_image_tag = NULL, cancel_timeout = NULL, time_zone = NULL, target_project_id = NULL) { +scripts_put_containers <- function(id, required_resources, docker_command, docker_image_name, name = NULL, parent_id = NULL, user_context = NULL, params = NULL, arguments = NULL, schedule = NULL, notifications = NULL, repo_http_uri = NULL, repo_ref = NULL, remote_host_credential_id = NULL, git_credential_id = NULL, docker_image_tag = NULL, instance_type = NULL, cancel_timeout = NULL, time_zone = NULL, target_project_id = NULL) { args <- as.list(match.call())[-1] path <- "/scripts/containers/{id}" path_params <- list(id = id) query_params <- list() - body_params <- list(requiredResources = required_resources, dockerCommand = docker_command, dockerImageName = docker_image_name, name = name, parentId = parent_id, userContext = user_context, params = params, arguments = arguments, schedule = schedule, notifications = notifications, repoHttpUri = repo_http_uri, repoRef = repo_ref, remoteHostCredentialId = remote_host_credential_id, gitCredentialId = git_credential_id, dockerImageTag = docker_image_tag, cancelTimeout = cancel_timeout, timeZone = time_zone, targetProjectId = target_project_id) + body_params <- list(requiredResources = required_resources, dockerCommand = docker_command, dockerImageName = docker_image_name, name = name, parentId = parent_id, userContext = user_context, params = params, arguments = arguments, schedule = schedule, notifications = notifications, repoHttpUri = repo_http_uri, repoRef = repo_ref, remoteHostCredentialId = remote_host_credential_id, gitCredentialId = git_credential_id, dockerImageTag = docker_image_tag, instanceType = instance_type, cancelTimeout = cancel_timeout, timeZone = time_zone, targetProjectId = target_project_id) path_params <- path_params[match_params(path_params, args)] query_params <- query_params[match_params(query_params, args)] body_params <- body_params[match_params(body_params, args)] @@ -15264,14 +15392,14 @@ scripts_put_containers <- function(id, required_resources, docker_command, docke #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' } -#' @param arguments list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params. +#' @param arguments list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters. #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param notifications list optional. A list containing the following elements: #' \itemize{ @@ -15300,6 +15428,7 @@ scripts_put_containers <- function(id, required_resources, docker_command, docke #' @param docker_command string optional. The command to run on the container. Will be run via sh as: ["sh", "-c", dockerCommand] #' @param docker_image_name string optional. The name of the docker image to pull from DockerHub. #' @param docker_image_tag string optional. The tag of the docker image to pull from DockerHub (default: latest). +#' @param instance_type string optional. The EC2 instance type to deploy to. Only available for jobs running on kubernetes. #' @param cancel_timeout integer optional. The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0. #' @param time_zone string optional. The time zone of this script. #' @param target_project_id integer optional. Target project to which script outputs will be added. @@ -15339,7 +15468,7 @@ scripts_put_containers <- function(id, required_resources, docker_command, docke #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{templateDependentsCount}{integer, How many other scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} @@ -15352,11 +15481,11 @@ scripts_put_containers <- function(id, required_resources, docker_command, docke #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -15392,6 +15521,7 @@ scripts_put_containers <- function(id, required_resources, docker_command, docke #' \item{dockerCommand}{string, The command to run on the container. Will be run via sh as: ["sh", "-c", dockerCommand]} #' \item{dockerImageName}{string, The name of the docker image to pull from DockerHub.} #' \item{dockerImageTag}{string, The tag of the docker image to pull from DockerHub (default: latest).} +#' \item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} #' \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} #' \item{lastRun}{list, A list containing the following elements: #' \itemize{ @@ -15403,17 +15533,17 @@ scripts_put_containers <- function(id, required_resources, docker_command, docke #' \item error string, The error message for this run, if present. #' }} #' \item{timeZone}{string, The time zone of this script.} -#' \item{hidden}{boolean, The hidden status of the object.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{hidden}{boolean, The hidden status of the item.} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} #' @export -scripts_patch_containers <- function(id, name = NULL, parent_id = NULL, user_context = NULL, params = NULL, arguments = NULL, schedule = NULL, notifications = NULL, required_resources = NULL, repo_http_uri = NULL, repo_ref = NULL, remote_host_credential_id = NULL, git_credential_id = NULL, docker_command = NULL, docker_image_name = NULL, docker_image_tag = NULL, cancel_timeout = NULL, time_zone = NULL, target_project_id = NULL) { +scripts_patch_containers <- function(id, name = NULL, parent_id = NULL, user_context = NULL, params = NULL, arguments = NULL, schedule = NULL, notifications = NULL, required_resources = NULL, repo_http_uri = NULL, repo_ref = NULL, remote_host_credential_id = NULL, git_credential_id = NULL, docker_command = NULL, docker_image_name = NULL, docker_image_tag = NULL, instance_type = NULL, cancel_timeout = NULL, time_zone = NULL, target_project_id = NULL) { args <- as.list(match.call())[-1] path <- "/scripts/containers/{id}" path_params <- list(id = id) query_params <- list() - body_params <- list(name = name, parentId = parent_id, userContext = user_context, params = params, arguments = arguments, schedule = schedule, notifications = notifications, requiredResources = required_resources, repoHttpUri = repo_http_uri, repoRef = repo_ref, remoteHostCredentialId = remote_host_credential_id, gitCredentialId = git_credential_id, dockerCommand = docker_command, dockerImageName = docker_image_name, dockerImageTag = docker_image_tag, cancelTimeout = cancel_timeout, timeZone = time_zone, targetProjectId = target_project_id) + body_params <- list(name = name, parentId = parent_id, userContext = user_context, params = params, arguments = arguments, schedule = schedule, notifications = notifications, requiredResources = required_resources, repoHttpUri = repo_http_uri, repoRef = repo_ref, remoteHostCredentialId = remote_host_credential_id, gitCredentialId = git_credential_id, dockerCommand = docker_command, dockerImageName = docker_image_name, dockerImageTag = docker_image_tag, instanceType = instance_type, cancelTimeout = cancel_timeout, timeZone = time_zone, targetProjectId = target_project_id) path_params <- path_params[match_params(path_params, args)] query_params <- query_params[match_params(query_params, args)] body_params <- body_params[match_params(body_params, args)] @@ -15525,14 +15655,14 @@ scripts_list_containers_runs_logs <- function(id, run_id, last_id = NULL, limit #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' } -#' @param arguments list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params. +#' @param arguments list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters. #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param notifications list optional. A list containing the following elements: #' \itemize{ @@ -15549,7 +15679,7 @@ scripts_list_containers_runs_logs <- function(id, run_id, last_id = NULL, limit #' } #' @param next_run_at string optional. The time of the next scheduled run. #' @param time_zone string optional. The time zone of this script. -#' @param hidden boolean optional. The hidden status of the object. +#' @param hidden boolean optional. The hidden status of the item. #' @param target_project_id integer optional. Target project to which script outputs will be added. #' @param csv_settings list optional. A list containing the following elements: #' \itemize{ @@ -15596,7 +15726,7 @@ scripts_list_containers_runs_logs <- function(id, run_id, last_id = NULL, limit #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -15609,11 +15739,11 @@ scripts_list_containers_runs_logs <- function(id, run_id, last_id = NULL, limit #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -15647,9 +15777,9 @@ scripts_list_containers_runs_logs <- function(id, run_id, last_id = NULL, limit #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{sql}{string, The raw SQL query for the script.} #' \item{expandedArguments}{list, Expanded arguments for use in injecting into different environments.} #' \item{remoteHostId}{integer, The remote host ID that this script will connect to.} @@ -15720,7 +15850,7 @@ scripts_post_sql <- function(name, sql, remote_host_id, credential_id, parent_id #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -15733,11 +15863,11 @@ scripts_post_sql <- function(name, sql, remote_host_id, credential_id, parent_id #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -15771,9 +15901,9 @@ scripts_post_sql <- function(name, sql, remote_host_id, credential_id, parent_id #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{sql}{string, The raw SQL query for the script.} #' \item{expandedArguments}{list, Expanded arguments for use in injecting into different environments.} #' \item{remoteHostId}{integer, The remote host ID that this script will connect to.} @@ -15825,14 +15955,14 @@ scripts_get_sql <- function(id) { #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' } -#' @param arguments list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params. +#' @param arguments list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters. #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param notifications list optional. A list containing the following elements: #' \itemize{ @@ -15895,7 +16025,7 @@ scripts_get_sql <- function(id) { #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -15908,11 +16038,11 @@ scripts_get_sql <- function(id) { #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -15946,9 +16076,9 @@ scripts_get_sql <- function(id) { #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{sql}{string, The raw SQL query for the script.} #' \item{expandedArguments}{list, Expanded arguments for use in injecting into different environments.} #' \item{remoteHostId}{integer, The remote host ID that this script will connect to.} @@ -15997,14 +16127,14 @@ scripts_put_sql <- function(id, name, sql, remote_host_id, credential_id, parent #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' } -#' @param arguments list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params. +#' @param arguments list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters. #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param notifications list optional. A list containing the following elements: #' \itemize{ @@ -16070,7 +16200,7 @@ scripts_put_sql <- function(id, name, sql, remote_host_id, credential_id, parent #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -16083,11 +16213,11 @@ scripts_put_sql <- function(id, name, sql, remote_host_id, credential_id, parent #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -16121,9 +16251,9 @@ scripts_put_sql <- function(id, name, sql, remote_host_id, credential_id, parent #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{sql}{string, The raw SQL query for the script.} #' \item{expandedArguments}{list, Expanded arguments for use in injecting into different environments.} #' \item{remoteHostId}{integer, The remote host ID that this script will connect to.} @@ -16194,14 +16324,14 @@ scripts_delete_sql <- function(id) { #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' } -#' @param arguments list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params. +#' @param arguments list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters. #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param notifications list optional. A list containing the following elements: #' \itemize{ @@ -16218,7 +16348,7 @@ scripts_delete_sql <- function(id) { #' } #' @param next_run_at string optional. The time of the next scheduled run. #' @param time_zone string optional. The time zone of this script. -#' @param hidden boolean optional. The hidden status of the object. +#' @param hidden boolean optional. The hidden status of the item. #' @param target_project_id integer optional. Target project to which script outputs will be added. #' @param required_resources list optional. A list containing the following elements: #' \itemize{ @@ -16226,6 +16356,7 @@ scripts_delete_sql <- function(id) { #' \item memory integer, The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. #' \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. #' } +#' @param instance_type string optional. The EC2 instance type to deploy to. Only available for jobs running on kubernetes. #' @param cancel_timeout integer optional. The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0. #' #' @return A list containing the following elements: @@ -16263,7 +16394,7 @@ scripts_delete_sql <- function(id) { #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -16276,11 +16407,11 @@ scripts_delete_sql <- function(id) { #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -16314,25 +16445,26 @@ scripts_delete_sql <- function(id) { #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{requiredResources}{list, A list containing the following elements: #' \itemize{ #' \item cpu integer, The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares. #' \item memory integer, The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. #' \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. #' }} +#' \item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} #' \item{source}{string, The body/text of the script.} #' \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} #' @export -scripts_post_python3 <- function(name, source, parent_id = NULL, user_context = NULL, params = NULL, arguments = NULL, schedule = NULL, notifications = NULL, next_run_at = NULL, time_zone = NULL, hidden = NULL, target_project_id = NULL, required_resources = NULL, cancel_timeout = NULL) { +scripts_post_python3 <- function(name, source, parent_id = NULL, user_context = NULL, params = NULL, arguments = NULL, schedule = NULL, notifications = NULL, next_run_at = NULL, time_zone = NULL, hidden = NULL, target_project_id = NULL, required_resources = NULL, instance_type = NULL, cancel_timeout = NULL) { args <- as.list(match.call())[-1] path <- "/scripts/python3" path_params <- list() query_params <- list() - body_params <- list(name = name, source = source, parentId = parent_id, userContext = user_context, params = params, arguments = arguments, schedule = schedule, notifications = notifications, nextRunAt = next_run_at, timeZone = time_zone, hidden = hidden, targetProjectId = target_project_id, requiredResources = required_resources, cancelTimeout = cancel_timeout) + body_params <- list(name = name, source = source, parentId = parent_id, userContext = user_context, params = params, arguments = arguments, schedule = schedule, notifications = notifications, nextRunAt = next_run_at, timeZone = time_zone, hidden = hidden, targetProjectId = target_project_id, requiredResources = required_resources, instanceType = instance_type, cancelTimeout = cancel_timeout) path_params <- path_params[match_params(path_params, args)] query_params <- query_params[match_params(query_params, args)] body_params <- body_params[match_params(body_params, args)] @@ -16381,7 +16513,7 @@ scripts_post_python3 <- function(name, source, parent_id = NULL, user_context = #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -16394,11 +16526,11 @@ scripts_post_python3 <- function(name, source, parent_id = NULL, user_context = #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -16432,15 +16564,16 @@ scripts_post_python3 <- function(name, source, parent_id = NULL, user_context = #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{requiredResources}{list, A list containing the following elements: #' \itemize{ #' \item cpu integer, The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares. #' \item memory integer, The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. #' \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. #' }} +#' \item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} #' \item{source}{string, The body/text of the script.} #' \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} #' @export @@ -16478,14 +16611,14 @@ scripts_get_python3 <- function(id) { #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' } -#' @param arguments list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params. +#' @param arguments list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters. #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param notifications list optional. A list containing the following elements: #' \itemize{ @@ -16509,6 +16642,7 @@ scripts_get_python3 <- function(id) { #' \item memory integer, The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. #' \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. #' } +#' @param instance_type string optional. The EC2 instance type to deploy to. Only available for jobs running on kubernetes. #' @param cancel_timeout integer optional. The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0. #' #' @return A list containing the following elements: @@ -16546,7 +16680,7 @@ scripts_get_python3 <- function(id) { #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -16559,11 +16693,11 @@ scripts_get_python3 <- function(id) { #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -16597,25 +16731,26 @@ scripts_get_python3 <- function(id) { #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{requiredResources}{list, A list containing the following elements: #' \itemize{ #' \item cpu integer, The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares. #' \item memory integer, The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. #' \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. #' }} +#' \item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} #' \item{source}{string, The body/text of the script.} #' \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} #' @export -scripts_put_python3 <- function(id, name, source, parent_id = NULL, user_context = NULL, params = NULL, arguments = NULL, schedule = NULL, notifications = NULL, next_run_at = NULL, time_zone = NULL, target_project_id = NULL, required_resources = NULL, cancel_timeout = NULL) { +scripts_put_python3 <- function(id, name, source, parent_id = NULL, user_context = NULL, params = NULL, arguments = NULL, schedule = NULL, notifications = NULL, next_run_at = NULL, time_zone = NULL, target_project_id = NULL, required_resources = NULL, instance_type = NULL, cancel_timeout = NULL) { args <- as.list(match.call())[-1] path <- "/scripts/python3/{id}" path_params <- list(id = id) query_params <- list() - body_params <- list(name = name, source = source, parentId = parent_id, userContext = user_context, params = params, arguments = arguments, schedule = schedule, notifications = notifications, nextRunAt = next_run_at, timeZone = time_zone, targetProjectId = target_project_id, requiredResources = required_resources, cancelTimeout = cancel_timeout) + body_params <- list(name = name, source = source, parentId = parent_id, userContext = user_context, params = params, arguments = arguments, schedule = schedule, notifications = notifications, nextRunAt = next_run_at, timeZone = time_zone, targetProjectId = target_project_id, requiredResources = required_resources, instanceType = instance_type, cancelTimeout = cancel_timeout) path_params <- path_params[match_params(path_params, args)] query_params <- query_params[match_params(query_params, args)] body_params <- body_params[match_params(body_params, args)] @@ -16642,14 +16777,14 @@ scripts_put_python3 <- function(id, name, source, parent_id = NULL, user_context #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' } -#' @param arguments list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params. +#' @param arguments list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters. #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param notifications list optional. A list containing the following elements: #' \itemize{ @@ -16673,6 +16808,7 @@ scripts_put_python3 <- function(id, name, source, parent_id = NULL, user_context #' \item memory integer, The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. #' \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. #' } +#' @param instance_type string optional. The EC2 instance type to deploy to. Only available for jobs running on kubernetes. #' @param source string optional. The body/text of the script. #' @param cancel_timeout integer optional. The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0. #' @@ -16711,7 +16847,7 @@ scripts_put_python3 <- function(id, name, source, parent_id = NULL, user_context #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -16724,11 +16860,11 @@ scripts_put_python3 <- function(id, name, source, parent_id = NULL, user_context #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -16762,25 +16898,26 @@ scripts_put_python3 <- function(id, name, source, parent_id = NULL, user_context #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{requiredResources}{list, A list containing the following elements: #' \itemize{ #' \item cpu integer, The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares. #' \item memory integer, The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. #' \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. #' }} +#' \item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} #' \item{source}{string, The body/text of the script.} #' \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} #' @export -scripts_patch_python3 <- function(id, name = NULL, parent_id = NULL, user_context = NULL, params = NULL, arguments = NULL, schedule = NULL, notifications = NULL, next_run_at = NULL, time_zone = NULL, target_project_id = NULL, required_resources = NULL, source = NULL, cancel_timeout = NULL) { +scripts_patch_python3 <- function(id, name = NULL, parent_id = NULL, user_context = NULL, params = NULL, arguments = NULL, schedule = NULL, notifications = NULL, next_run_at = NULL, time_zone = NULL, target_project_id = NULL, required_resources = NULL, instance_type = NULL, source = NULL, cancel_timeout = NULL) { args <- as.list(match.call())[-1] path <- "/scripts/python3/{id}" path_params <- list(id = id) query_params <- list() - body_params <- list(name = name, parentId = parent_id, userContext = user_context, params = params, arguments = arguments, schedule = schedule, notifications = notifications, nextRunAt = next_run_at, timeZone = time_zone, targetProjectId = target_project_id, requiredResources = required_resources, source = source, cancelTimeout = cancel_timeout) + body_params <- list(name = name, parentId = parent_id, userContext = user_context, params = params, arguments = arguments, schedule = schedule, notifications = notifications, nextRunAt = next_run_at, timeZone = time_zone, targetProjectId = target_project_id, requiredResources = required_resources, instanceType = instance_type, source = source, cancelTimeout = cancel_timeout) path_params <- path_params[match_params(path_params, args)] query_params <- query_params[match_params(query_params, args)] body_params <- body_params[match_params(body_params, args)] @@ -16829,14 +16966,14 @@ scripts_delete_python3 <- function(id) { #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' } -#' @param arguments list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params. +#' @param arguments list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters. #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param notifications list optional. A list containing the following elements: #' \itemize{ @@ -16853,7 +16990,7 @@ scripts_delete_python3 <- function(id) { #' } #' @param next_run_at string optional. The time of the next scheduled run. #' @param time_zone string optional. The time zone of this script. -#' @param hidden boolean optional. The hidden status of the object. +#' @param hidden boolean optional. The hidden status of the item. #' @param target_project_id integer optional. Target project to which script outputs will be added. #' @param required_resources list optional. A list containing the following elements: #' \itemize{ @@ -16861,6 +16998,7 @@ scripts_delete_python3 <- function(id) { #' \item memory integer, The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. #' \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. #' } +#' @param instance_type string optional. The EC2 instance type to deploy to. Only available for jobs running on kubernetes. #' @param cancel_timeout integer optional. The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0. #' #' @return A list containing the following elements: @@ -16898,7 +17036,7 @@ scripts_delete_python3 <- function(id) { #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -16911,11 +17049,11 @@ scripts_delete_python3 <- function(id) { #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -16949,25 +17087,26 @@ scripts_delete_python3 <- function(id) { #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{requiredResources}{list, A list containing the following elements: #' \itemize{ #' \item cpu integer, The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares. #' \item memory integer, The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. #' \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. #' }} +#' \item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} #' \item{source}{string, The body/text of the script.} #' \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} #' @export -scripts_post_r <- function(name, source, parent_id = NULL, user_context = NULL, params = NULL, arguments = NULL, schedule = NULL, notifications = NULL, next_run_at = NULL, time_zone = NULL, hidden = NULL, target_project_id = NULL, required_resources = NULL, cancel_timeout = NULL) { +scripts_post_r <- function(name, source, parent_id = NULL, user_context = NULL, params = NULL, arguments = NULL, schedule = NULL, notifications = NULL, next_run_at = NULL, time_zone = NULL, hidden = NULL, target_project_id = NULL, required_resources = NULL, instance_type = NULL, cancel_timeout = NULL) { args <- as.list(match.call())[-1] path <- "/scripts/r" path_params <- list() query_params <- list() - body_params <- list(name = name, source = source, parentId = parent_id, userContext = user_context, params = params, arguments = arguments, schedule = schedule, notifications = notifications, nextRunAt = next_run_at, timeZone = time_zone, hidden = hidden, targetProjectId = target_project_id, requiredResources = required_resources, cancelTimeout = cancel_timeout) + body_params <- list(name = name, source = source, parentId = parent_id, userContext = user_context, params = params, arguments = arguments, schedule = schedule, notifications = notifications, nextRunAt = next_run_at, timeZone = time_zone, hidden = hidden, targetProjectId = target_project_id, requiredResources = required_resources, instanceType = instance_type, cancelTimeout = cancel_timeout) path_params <- path_params[match_params(path_params, args)] query_params <- query_params[match_params(query_params, args)] body_params <- body_params[match_params(body_params, args)] @@ -17016,7 +17155,7 @@ scripts_post_r <- function(name, source, parent_id = NULL, user_context = NULL, #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -17029,11 +17168,11 @@ scripts_post_r <- function(name, source, parent_id = NULL, user_context = NULL, #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -17067,15 +17206,16 @@ scripts_post_r <- function(name, source, parent_id = NULL, user_context = NULL, #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{requiredResources}{list, A list containing the following elements: #' \itemize{ #' \item cpu integer, The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares. #' \item memory integer, The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. #' \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. #' }} +#' \item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} #' \item{source}{string, The body/text of the script.} #' \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} #' @export @@ -17113,14 +17253,14 @@ scripts_get_r <- function(id) { #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' } -#' @param arguments list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params. +#' @param arguments list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters. #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param notifications list optional. A list containing the following elements: #' \itemize{ @@ -17144,6 +17284,7 @@ scripts_get_r <- function(id) { #' \item memory integer, The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. #' \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. #' } +#' @param instance_type string optional. The EC2 instance type to deploy to. Only available for jobs running on kubernetes. #' @param cancel_timeout integer optional. The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0. #' #' @return A list containing the following elements: @@ -17181,7 +17322,7 @@ scripts_get_r <- function(id) { #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -17194,11 +17335,11 @@ scripts_get_r <- function(id) { #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -17232,25 +17373,26 @@ scripts_get_r <- function(id) { #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{requiredResources}{list, A list containing the following elements: #' \itemize{ #' \item cpu integer, The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares. #' \item memory integer, The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. #' \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. #' }} +#' \item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} #' \item{source}{string, The body/text of the script.} #' \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} #' @export -scripts_put_r <- function(id, name, source, parent_id = NULL, user_context = NULL, params = NULL, arguments = NULL, schedule = NULL, notifications = NULL, next_run_at = NULL, time_zone = NULL, target_project_id = NULL, required_resources = NULL, cancel_timeout = NULL) { +scripts_put_r <- function(id, name, source, parent_id = NULL, user_context = NULL, params = NULL, arguments = NULL, schedule = NULL, notifications = NULL, next_run_at = NULL, time_zone = NULL, target_project_id = NULL, required_resources = NULL, instance_type = NULL, cancel_timeout = NULL) { args <- as.list(match.call())[-1] path <- "/scripts/r/{id}" path_params <- list(id = id) query_params <- list() - body_params <- list(name = name, source = source, parentId = parent_id, userContext = user_context, params = params, arguments = arguments, schedule = schedule, notifications = notifications, nextRunAt = next_run_at, timeZone = time_zone, targetProjectId = target_project_id, requiredResources = required_resources, cancelTimeout = cancel_timeout) + body_params <- list(name = name, source = source, parentId = parent_id, userContext = user_context, params = params, arguments = arguments, schedule = schedule, notifications = notifications, nextRunAt = next_run_at, timeZone = time_zone, targetProjectId = target_project_id, requiredResources = required_resources, instanceType = instance_type, cancelTimeout = cancel_timeout) path_params <- path_params[match_params(path_params, args)] query_params <- query_params[match_params(query_params, args)] body_params <- body_params[match_params(body_params, args)] @@ -17277,14 +17419,14 @@ scripts_put_r <- function(id, name, source, parent_id = NULL, user_context = NUL #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' } -#' @param arguments list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params. +#' @param arguments list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters. #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param notifications list optional. A list containing the following elements: #' \itemize{ @@ -17308,6 +17450,7 @@ scripts_put_r <- function(id, name, source, parent_id = NULL, user_context = NUL #' \item memory integer, The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. #' \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. #' } +#' @param instance_type string optional. The EC2 instance type to deploy to. Only available for jobs running on kubernetes. #' @param source string optional. The body/text of the script. #' @param cancel_timeout integer optional. The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0. #' @@ -17346,7 +17489,7 @@ scripts_put_r <- function(id, name, source, parent_id = NULL, user_context = NUL #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -17359,11 +17502,11 @@ scripts_put_r <- function(id, name, source, parent_id = NULL, user_context = NUL #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -17397,25 +17540,26 @@ scripts_put_r <- function(id, name, source, parent_id = NULL, user_context = NUL #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{requiredResources}{list, A list containing the following elements: #' \itemize{ #' \item cpu integer, The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares. #' \item memory integer, The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. #' \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. #' }} +#' \item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} #' \item{source}{string, The body/text of the script.} #' \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} #' @export -scripts_patch_r <- function(id, name = NULL, parent_id = NULL, user_context = NULL, params = NULL, arguments = NULL, schedule = NULL, notifications = NULL, next_run_at = NULL, time_zone = NULL, target_project_id = NULL, required_resources = NULL, source = NULL, cancel_timeout = NULL) { +scripts_patch_r <- function(id, name = NULL, parent_id = NULL, user_context = NULL, params = NULL, arguments = NULL, schedule = NULL, notifications = NULL, next_run_at = NULL, time_zone = NULL, target_project_id = NULL, required_resources = NULL, instance_type = NULL, source = NULL, cancel_timeout = NULL) { args <- as.list(match.call())[-1] path <- "/scripts/r/{id}" path_params <- list(id = id) query_params <- list() - body_params <- list(name = name, parentId = parent_id, userContext = user_context, params = params, arguments = arguments, schedule = schedule, notifications = notifications, nextRunAt = next_run_at, timeZone = time_zone, targetProjectId = target_project_id, requiredResources = required_resources, source = source, cancelTimeout = cancel_timeout) + body_params <- list(name = name, parentId = parent_id, userContext = user_context, params = params, arguments = arguments, schedule = schedule, notifications = notifications, nextRunAt = next_run_at, timeZone = time_zone, targetProjectId = target_project_id, requiredResources = required_resources, instanceType = instance_type, source = source, cancelTimeout = cancel_timeout) path_params <- path_params[match_params(path_params, args)] query_params <- query_params[match_params(query_params, args)] body_params <- body_params[match_params(body_params, args)] @@ -17466,14 +17610,14 @@ scripts_delete_r <- function(id) { #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' } -#' @param arguments list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params. +#' @param arguments list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters. #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param notifications list optional. A list containing the following elements: #' \itemize{ @@ -17490,7 +17634,7 @@ scripts_delete_r <- function(id) { #' } #' @param next_run_at string optional. The time of the next scheduled run. #' @param time_zone string optional. The time zone of this script. -#' @param hidden boolean optional. The hidden status of the object. +#' @param hidden boolean optional. The hidden status of the item. #' @param target_project_id integer optional. Target project to which script outputs will be added. #' #' @return A list containing the following elements: @@ -17528,7 +17672,7 @@ scripts_delete_r <- function(id) { #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -17541,11 +17685,11 @@ scripts_delete_r <- function(id) { #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -17579,9 +17723,9 @@ scripts_delete_r <- function(id) { #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{source}{string, The body/text of the script.} #' \item{remoteHostId}{integer, The remote host ID that this script will connect to.} #' \item{credentialId}{integer, The credential that this script will use.} @@ -17641,7 +17785,7 @@ scripts_post_javascript <- function(name, source, remote_host_id, credential_id, #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -17654,11 +17798,11 @@ scripts_post_javascript <- function(name, source, remote_host_id, credential_id, #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -17692,9 +17836,9 @@ scripts_post_javascript <- function(name, source, remote_host_id, credential_id, #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{source}{string, The body/text of the script.} #' \item{remoteHostId}{integer, The remote host ID that this script will connect to.} #' \item{credentialId}{integer, The credential that this script will use.} @@ -17735,14 +17879,14 @@ scripts_get_javascript <- function(id) { #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' } -#' @param arguments list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params. +#' @param arguments list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters. #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param notifications list optional. A list containing the following elements: #' \itemize{ @@ -17796,7 +17940,7 @@ scripts_get_javascript <- function(id) { #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -17809,11 +17953,11 @@ scripts_get_javascript <- function(id) { #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -17847,9 +17991,9 @@ scripts_get_javascript <- function(id) { #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{source}{string, The body/text of the script.} #' \item{remoteHostId}{integer, The remote host ID that this script will connect to.} #' \item{credentialId}{integer, The credential that this script will use.} @@ -17887,14 +18031,14 @@ scripts_put_javascript <- function(id, name, source, remote_host_id, credential_ #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' } -#' @param arguments list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params. +#' @param arguments list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters. #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param notifications list optional. A list containing the following elements: #' \itemize{ @@ -17951,7 +18095,7 @@ scripts_put_javascript <- function(id, name, source, remote_host_id, credential_ #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -17964,11 +18108,11 @@ scripts_put_javascript <- function(id, name, source, remote_host_id, credential_ #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -18002,9 +18146,9 @@ scripts_put_javascript <- function(id, name, source, remote_host_id, credential_ #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{source}{string, The body/text of the script.} #' \item{remoteHostId}{integer, The remote host ID that this script will connect to.} #' \item{credentialId}{integer, The credential that this script will use.} @@ -18050,10 +18194,10 @@ scripts_delete_javascript <- function(id) { #' List Custom Scripts #' @param from_template_id string optional. If specified, return scripts based on the template with this ID. Specify multiple IDs as a comma-separated list. -#' @param author string optional. If specified, return objects from this author. Must use user IDs. A comma separated list of IDs is also accepted to return objects from multiple authors. -#' @param status string optional. If specified, returns objects with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'. -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. -#' @param archived string optional. The archival status of the requested object(s). +#' @param author string optional. If specified, return items from this author. Must use user IDs. A comma separated list of IDs is also accepted to return items from multiple authors. +#' @param status string optional. If specified, returns items with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'. +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. +#' @param archived string optional. The archival status of the requested item(s). #' @param limit integer optional. Number of results to return. Defaults to its maximum of 50. #' @param page_num integer optional. Page number of the results to return. Defaults to the first page, 1. #' @param order string optional. The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at. @@ -18092,7 +18236,7 @@ scripts_delete_javascript <- function(id) { #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export scripts_list_custom <- function(from_template_id = NULL, author = NULL, status = NULL, hidden = NULL, archived = NULL, limit = NULL, page_num = NULL, order = NULL, order_dir = NULL) { @@ -18115,16 +18259,16 @@ scripts_list_custom <- function(from_template_id = NULL, author = NULL, status = #' @param from_template_id integer required. The ID of the template script. #' @param name string optional. The name of the script. #' @param parent_id integer optional. The ID of the parent job that will trigger this script -#' @param arguments list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params. +#' @param arguments list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters. #' @param remote_host_id integer optional. The remote host ID that this script will connect to. #' @param credential_id integer optional. The credential that this script will use. #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param notifications list optional. A list containing the following elements: #' \itemize{ @@ -18140,7 +18284,7 @@ scripts_list_custom <- function(from_template_id = NULL, author = NULL, status = #' \item failureOn boolean, If failure email notifications are on. #' } #' @param time_zone string optional. The time zone of this script. -#' @param hidden boolean optional. The hidden status of the object. +#' @param hidden boolean optional. The hidden status of the item. #' @param target_project_id integer optional. Target project to which script outputs will be added. #' #' @return A list containing the following elements: @@ -18177,7 +18321,7 @@ scripts_list_custom <- function(from_template_id = NULL, author = NULL, status = #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template script.} @@ -18191,11 +18335,11 @@ scripts_list_custom <- function(from_template_id = NULL, author = NULL, status = #' \item{codePreview}{string, The code that this script will run with arguments inserted.} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -18228,8 +18372,8 @@ scripts_list_custom <- function(from_template_id = NULL, author = NULL, status = #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{hidden}{boolean, The hidden status of the item.} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} #' @export scripts_post_custom <- function(from_template_id, name = NULL, parent_id = NULL, arguments = NULL, remote_host_id = NULL, credential_id = NULL, schedule = NULL, notifications = NULL, time_zone = NULL, hidden = NULL, target_project_id = NULL) { @@ -18286,7 +18430,7 @@ scripts_post_custom <- function(from_template_id, name = NULL, parent_id = NULL, #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template script.} @@ -18300,11 +18444,11 @@ scripts_post_custom <- function(from_template_id, name = NULL, parent_id = NULL, #' \item{codePreview}{string, The code that this script will run with arguments inserted.} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -18337,8 +18481,8 @@ scripts_post_custom <- function(from_template_id, name = NULL, parent_id = NULL, #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{hidden}{boolean, The hidden status of the item.} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} #' @export scripts_get_custom <- function(id) { @@ -18362,16 +18506,16 @@ scripts_get_custom <- function(id) { #' @param id integer required. The ID for the script. #' @param name string optional. The name of the script. #' @param parent_id integer optional. The ID of the parent job that will trigger this script -#' @param arguments list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params. +#' @param arguments list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters. #' @param remote_host_id integer optional. The remote host ID that this script will connect to. #' @param credential_id integer optional. The credential that this script will use. #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param notifications list optional. A list containing the following elements: #' \itemize{ @@ -18423,7 +18567,7 @@ scripts_get_custom <- function(id) { #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template script.} @@ -18437,11 +18581,11 @@ scripts_get_custom <- function(id) { #' \item{codePreview}{string, The code that this script will run with arguments inserted.} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -18474,8 +18618,8 @@ scripts_get_custom <- function(id) { #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{hidden}{boolean, The hidden status of the item.} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} #' @export scripts_put_custom <- function(id, name = NULL, parent_id = NULL, arguments = NULL, remote_host_id = NULL, credential_id = NULL, schedule = NULL, notifications = NULL, time_zone = NULL, target_project_id = NULL) { @@ -18499,16 +18643,16 @@ scripts_put_custom <- function(id, name = NULL, parent_id = NULL, arguments = NU #' @param id integer required. The ID for the script. #' @param name string optional. The name of the script. #' @param parent_id integer optional. The ID of the parent job that will trigger this script -#' @param arguments list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params. +#' @param arguments list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters. #' @param remote_host_id integer optional. The remote host ID that this script will connect to. #' @param credential_id integer optional. The credential that this script will use. #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param notifications list optional. A list containing the following elements: #' \itemize{ @@ -18560,7 +18704,7 @@ scripts_put_custom <- function(id, name = NULL, parent_id = NULL, arguments = NU #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template script.} @@ -18574,11 +18718,11 @@ scripts_put_custom <- function(id, name = NULL, parent_id = NULL, arguments = NU #' \item{codePreview}{string, The code that this script will run with arguments inserted.} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -18611,8 +18755,8 @@ scripts_put_custom <- function(id, name = NULL, parent_id = NULL, arguments = NU #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{hidden}{boolean, The hidden status of the item.} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} #' @export scripts_patch_custom <- function(id, name = NULL, parent_id = NULL, arguments = NULL, remote_host_id = NULL, credential_id = NULL, schedule = NULL, notifications = NULL, time_zone = NULL, target_project_id = NULL) { @@ -19517,9 +19661,9 @@ scripts_list_custom_runs_logs <- function(id, run_id, last_id = NULL, limit = NU #' #' @return An array containing the following fields: #' \item{objectType}{string, The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue} -#' \item{objectId}{integer, The ID of the output object.} -#' \item{name}{string, The name of the output object.} -#' \item{link}{string, The link to retrieve the output object.} +#' \item{objectId}{integer, The ID of the output.} +#' \item{name}{string, The name of the output.} +#' \item{link}{string, The hypermedia link to the output.} #' \item{value}{string, } #' @export scripts_list_sql_runs_outputs <- function(id, run_id, limit = NULL, page_num = NULL, order = NULL, order_dir = NULL) { @@ -19549,9 +19693,9 @@ scripts_list_sql_runs_outputs <- function(id, run_id, limit = NULL, page_num = N #' #' @return An array containing the following fields: #' \item{objectType}{string, The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue} -#' \item{objectId}{integer, The ID of the output object.} -#' \item{name}{string, The name of the output object.} -#' \item{link}{string, The link to retrieve the output object.} +#' \item{objectId}{integer, The ID of the output.} +#' \item{name}{string, The name of the output.} +#' \item{link}{string, The hypermedia link to the output.} #' \item{value}{string, } #' @export scripts_list_containers_runs_outputs <- function(id, run_id, limit = NULL, page_num = NULL, order = NULL, order_dir = NULL) { @@ -19575,13 +19719,13 @@ scripts_list_containers_runs_outputs <- function(id, run_id, limit = NULL, page_ #' @param id integer required. The ID of the container script. #' @param run_id integer required. The ID of the run. #' @param object_type string required. The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue -#' @param object_id integer required. The ID of the output object. +#' @param object_id integer required. The ID of the output. #' #' @return A list containing the following elements: #' \item{objectType}{string, The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue} -#' \item{objectId}{integer, The ID of the output object.} -#' \item{name}{string, The name of the output object.} -#' \item{link}{string, The link to retrieve the output object.} +#' \item{objectId}{integer, The ID of the output.} +#' \item{name}{string, The name of the output.} +#' \item{link}{string, The hypermedia link to the output.} #' \item{value}{string, } #' @export scripts_post_containers_runs_outputs <- function(id, run_id, object_type, object_id) { @@ -19611,9 +19755,9 @@ scripts_post_containers_runs_outputs <- function(id, run_id, object_type, object #' #' @return An array containing the following fields: #' \item{objectType}{string, The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue} -#' \item{objectId}{integer, The ID of the output object.} -#' \item{name}{string, The name of the output object.} -#' \item{link}{string, The link to retrieve the output object.} +#' \item{objectId}{integer, The ID of the output.} +#' \item{name}{string, The name of the output.} +#' \item{link}{string, The hypermedia link to the output.} #' \item{value}{string, } #' @export scripts_list_python3_runs_outputs <- function(id, run_id, limit = NULL, page_num = NULL, order = NULL, order_dir = NULL) { @@ -19637,13 +19781,13 @@ scripts_list_python3_runs_outputs <- function(id, run_id, limit = NULL, page_num #' @param id integer required. The ID of the python script. #' @param run_id integer required. The ID of the run. #' @param object_type string required. The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue -#' @param object_id integer required. The ID of the output object. +#' @param object_id integer required. The ID of the output. #' #' @return A list containing the following elements: #' \item{objectType}{string, The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue} -#' \item{objectId}{integer, The ID of the output object.} -#' \item{name}{string, The name of the output object.} -#' \item{link}{string, The link to retrieve the output object.} +#' \item{objectId}{integer, The ID of the output.} +#' \item{name}{string, The name of the output.} +#' \item{link}{string, The hypermedia link to the output.} #' \item{value}{string, } #' @export scripts_post_python3_runs_outputs <- function(id, run_id, object_type, object_id) { @@ -19673,9 +19817,9 @@ scripts_post_python3_runs_outputs <- function(id, run_id, object_type, object_id #' #' @return An array containing the following fields: #' \item{objectType}{string, The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue} -#' \item{objectId}{integer, The ID of the output object.} -#' \item{name}{string, The name of the output object.} -#' \item{link}{string, The link to retrieve the output object.} +#' \item{objectId}{integer, The ID of the output.} +#' \item{name}{string, The name of the output.} +#' \item{link}{string, The hypermedia link to the output.} #' \item{value}{string, } #' @export scripts_list_r_runs_outputs <- function(id, run_id, limit = NULL, page_num = NULL, order = NULL, order_dir = NULL) { @@ -19699,13 +19843,13 @@ scripts_list_r_runs_outputs <- function(id, run_id, limit = NULL, page_num = NUL #' @param id integer required. The ID of the r script. #' @param run_id integer required. The ID of the run. #' @param object_type string required. The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue -#' @param object_id integer required. The ID of the output object. +#' @param object_id integer required. The ID of the output. #' #' @return A list containing the following elements: #' \item{objectType}{string, The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue} -#' \item{objectId}{integer, The ID of the output object.} -#' \item{name}{string, The name of the output object.} -#' \item{link}{string, The link to retrieve the output object.} +#' \item{objectId}{integer, The ID of the output.} +#' \item{name}{string, The name of the output.} +#' \item{link}{string, The hypermedia link to the output.} #' \item{value}{string, } #' @export scripts_post_r_runs_outputs <- function(id, run_id, object_type, object_id) { @@ -19735,9 +19879,9 @@ scripts_post_r_runs_outputs <- function(id, run_id, object_type, object_id) { #' #' @return An array containing the following fields: #' \item{objectType}{string, The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue} -#' \item{objectId}{integer, The ID of the output object.} -#' \item{name}{string, The name of the output object.} -#' \item{link}{string, The link to retrieve the output object.} +#' \item{objectId}{integer, The ID of the output.} +#' \item{name}{string, The name of the output.} +#' \item{link}{string, The hypermedia link to the output.} #' \item{value}{string, } #' @export scripts_list_javascript_runs_outputs <- function(id, run_id, limit = NULL, page_num = NULL, order = NULL, order_dir = NULL) { @@ -19761,13 +19905,13 @@ scripts_list_javascript_runs_outputs <- function(id, run_id, limit = NULL, page_ #' @param id integer required. The ID of the javascript script. #' @param run_id integer required. The ID of the run. #' @param object_type string required. The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue -#' @param object_id integer required. The ID of the output object. +#' @param object_id integer required. The ID of the output. #' #' @return A list containing the following elements: #' \item{objectType}{string, The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue} -#' \item{objectId}{integer, The ID of the output object.} -#' \item{name}{string, The name of the output object.} -#' \item{link}{string, The link to retrieve the output object.} +#' \item{objectId}{integer, The ID of the output.} +#' \item{name}{string, The name of the output.} +#' \item{link}{string, The hypermedia link to the output.} #' \item{value}{string, } #' @export scripts_post_javascript_runs_outputs <- function(id, run_id, object_type, object_id) { @@ -19797,9 +19941,9 @@ scripts_post_javascript_runs_outputs <- function(id, run_id, object_type, object #' #' @return An array containing the following fields: #' \item{objectType}{string, The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue} -#' \item{objectId}{integer, The ID of the output object.} -#' \item{name}{string, The name of the output object.} -#' \item{link}{string, The link to retrieve the output object.} +#' \item{objectId}{integer, The ID of the output.} +#' \item{name}{string, The name of the output.} +#' \item{link}{string, The hypermedia link to the output.} #' \item{value}{string, } #' @export scripts_list_custom_runs_outputs <- function(id, run_id, limit = NULL, page_num = NULL, order = NULL, order_dir = NULL) { @@ -19823,13 +19967,13 @@ scripts_list_custom_runs_outputs <- function(id, run_id, limit = NULL, page_num #' @param id integer required. The ID of the custom script. #' @param run_id integer required. The ID of the run. #' @param object_type string required. The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue -#' @param object_id integer required. The ID of the output object. +#' @param object_id integer required. The ID of the output. #' #' @return A list containing the following elements: #' \item{objectType}{string, The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue} -#' \item{objectId}{integer, The ID of the output object.} -#' \item{name}{string, The name of the output object.} -#' \item{link}{string, The link to retrieve the output object.} +#' \item{objectId}{integer, The ID of the output.} +#' \item{name}{string, The name of the output.} +#' \item{link}{string, The hypermedia link to the output.} #' \item{value}{string, } #' @export scripts_post_custom_runs_outputs <- function(id, run_id, object_type, object_id) { @@ -19850,7 +19994,7 @@ scripts_post_custom_runs_outputs <- function(id, run_id, object_type, object_id) #' Get the git metadata attached to this scripts -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' #' @return A list containing the following elements: #' \item{gitRef}{string, A git reference specifying an unambiguous version of the file. Can be a branch name, or the full or shortened SHA of a commit.} @@ -19882,7 +20026,7 @@ scripts_list_sql_git <- function(id) { #' Attach this scripts to a git repo/file -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' @param git_ref string optional. A git reference specifying an unambiguous version of the file. Can be a branch name, or the full or shortened SHA of a commit. #' @param git_branch string optional. The git branch that the file is on. #' @param git_path string optional. The path of the file in the repository. @@ -19918,7 +20062,7 @@ scripts_put_sql_git <- function(id, git_ref = NULL, git_branch = NULL, git_path #' Get the git commits for this scripts -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' #' @return A list containing the following elements: #' \item{commitHash}{string, The SHA of the commit.} @@ -19944,7 +20088,7 @@ scripts_list_sql_git_commits <- function(id) { #' Commit and push a new version of the file -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' @param content string required. The contents to commit to the file. #' @param message string required. A commit message describing the changes being made. #' @param file_hash string required. The full SHA of the file being replaced. @@ -19973,7 +20117,7 @@ scripts_post_sql_git_commits <- function(id, content, message, file_hash) { #' Get file contents at commit_hash -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' @param commit_hash string required. The SHA (full or shortened) of the desired git commit. #' #' @return A list containing the following elements: @@ -20000,7 +20144,7 @@ scripts_get_sql_git_commits <- function(id, commit_hash) { #' Get the git metadata attached to this scripted sql -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' #' @return A list containing the following elements: #' \item{gitRef}{string, A git reference specifying an unambiguous version of the file. Can be a branch name, or the full or shortened SHA of a commit.} @@ -20032,7 +20176,7 @@ scripts_list_javascript_git <- function(id) { #' Attach this scripted sql to a git repo/file -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' @param git_ref string optional. A git reference specifying an unambiguous version of the file. Can be a branch name, or the full or shortened SHA of a commit. #' @param git_branch string optional. The git branch that the file is on. #' @param git_path string optional. The path of the file in the repository. @@ -20068,7 +20212,7 @@ scripts_put_javascript_git <- function(id, git_ref = NULL, git_branch = NULL, gi #' Get the git commits for this scripted sql -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' #' @return A list containing the following elements: #' \item{commitHash}{string, The SHA of the commit.} @@ -20094,7 +20238,7 @@ scripts_list_javascript_git_commits <- function(id) { #' Commit and push a new version of the file -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' @param content string required. The contents to commit to the file. #' @param message string required. A commit message describing the changes being made. #' @param file_hash string required. The full SHA of the file being replaced. @@ -20123,7 +20267,7 @@ scripts_post_javascript_git_commits <- function(id, content, message, file_hash) #' Get file contents at commit_hash -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' @param commit_hash string required. The SHA (full or shortened) of the desired git commit. #' #' @return A list containing the following elements: @@ -20150,7 +20294,7 @@ scripts_get_javascript_git_commits <- function(id, commit_hash) { #' Get the git metadata attached to this python docker -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' #' @return A list containing the following elements: #' \item{gitRef}{string, A git reference specifying an unambiguous version of the file. Can be a branch name, or the full or shortened SHA of a commit.} @@ -20182,7 +20326,7 @@ scripts_list_python3_git <- function(id) { #' Attach this python docker to a git repo/file -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' @param git_ref string optional. A git reference specifying an unambiguous version of the file. Can be a branch name, or the full or shortened SHA of a commit. #' @param git_branch string optional. The git branch that the file is on. #' @param git_path string optional. The path of the file in the repository. @@ -20218,7 +20362,7 @@ scripts_put_python3_git <- function(id, git_ref = NULL, git_branch = NULL, git_p #' Get the git commits for this python docker -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' #' @return A list containing the following elements: #' \item{commitHash}{string, The SHA of the commit.} @@ -20244,7 +20388,7 @@ scripts_list_python3_git_commits <- function(id) { #' Commit and push a new version of the file -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' @param content string required. The contents to commit to the file. #' @param message string required. A commit message describing the changes being made. #' @param file_hash string required. The full SHA of the file being replaced. @@ -20273,7 +20417,7 @@ scripts_post_python3_git_commits <- function(id, content, message, file_hash) { #' Get file contents at commit_hash -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' @param commit_hash string required. The SHA (full or shortened) of the desired git commit. #' #' @return A list containing the following elements: @@ -20300,7 +20444,7 @@ scripts_get_python3_git_commits <- function(id, commit_hash) { #' Get the git metadata attached to this r docker -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' #' @return A list containing the following elements: #' \item{gitRef}{string, A git reference specifying an unambiguous version of the file. Can be a branch name, or the full or shortened SHA of a commit.} @@ -20332,7 +20476,7 @@ scripts_list_r_git <- function(id) { #' Attach this r docker to a git repo/file -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' @param git_ref string optional. A git reference specifying an unambiguous version of the file. Can be a branch name, or the full or shortened SHA of a commit. #' @param git_branch string optional. The git branch that the file is on. #' @param git_path string optional. The path of the file in the repository. @@ -20368,7 +20512,7 @@ scripts_put_r_git <- function(id, git_ref = NULL, git_branch = NULL, git_path = #' Get the git commits for this r docker -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' #' @return A list containing the following elements: #' \item{commitHash}{string, The SHA of the commit.} @@ -20394,7 +20538,7 @@ scripts_list_r_git_commits <- function(id) { #' Commit and push a new version of the file -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' @param content string required. The contents to commit to the file. #' @param message string required. A commit message describing the changes being made. #' @param file_hash string required. The full SHA of the file being replaced. @@ -20423,7 +20567,7 @@ scripts_post_r_git_commits <- function(id, content, message, file_hash) { #' Get file contents at commit_hash -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' @param commit_hash string required. The SHA (full or shortened) of the desired git commit. #' #' @return A list containing the following elements: @@ -20622,7 +20766,7 @@ scripts_delete_sql_shares_groups <- function(id, group_id) { #' List the projects a scripts belongs to #' @param id integer required. The ID of the resource. -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. #' #' @return An array containing the following fields: #' \item{id}{integer, The ID for this project.} @@ -20635,7 +20779,7 @@ scripts_delete_sql_shares_groups <- function(id, group_id) { #' \item online boolean, Whether this user is online. #' }} #' \item{name}{string, The name of this project.} -#' \item{description}{string, A description of the project} +#' \item{description}{string, A description of the project.} #' \item{users}{array, An array containing the following fields: #' \itemize{ #' \item id integer, The ID of this user. @@ -20647,7 +20791,7 @@ scripts_delete_sql_shares_groups <- function(id, group_id) { #' \item{autoShare}{boolean, } #' \item{createdAt}{string, } #' \item{updatedAt}{string, } -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export scripts_list_sql_projects <- function(id, hidden = NULL) { @@ -20667,8 +20811,8 @@ scripts_list_sql_projects <- function(id, hidden = NULL) { #' Add a scripts to a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -20690,8 +20834,8 @@ scripts_put_sql_projects <- function(id, project_id) { #' Remove a scripts from a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -20751,7 +20895,7 @@ scripts_delete_sql_projects <- function(id, project_id) { #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -20764,11 +20908,11 @@ scripts_delete_sql_projects <- function(id, project_id) { #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -20802,9 +20946,9 @@ scripts_delete_sql_projects <- function(id, project_id) { #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{sql}{string, The raw SQL query for the script.} #' \item{expandedArguments}{list, Expanded arguments for use in injecting into different environments.} #' \item{remoteHostId}{integer, The remote host ID that this script will connect to.} @@ -21010,7 +21154,7 @@ scripts_delete_containers_shares_groups <- function(id, group_id) { #' List the projects a container docker belongs to #' @param id integer required. The ID of the resource. -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. #' #' @return An array containing the following fields: #' \item{id}{integer, The ID for this project.} @@ -21023,7 +21167,7 @@ scripts_delete_containers_shares_groups <- function(id, group_id) { #' \item online boolean, Whether this user is online. #' }} #' \item{name}{string, The name of this project.} -#' \item{description}{string, A description of the project} +#' \item{description}{string, A description of the project.} #' \item{users}{array, An array containing the following fields: #' \itemize{ #' \item id integer, The ID of this user. @@ -21035,7 +21179,7 @@ scripts_delete_containers_shares_groups <- function(id, group_id) { #' \item{autoShare}{boolean, } #' \item{createdAt}{string, } #' \item{updatedAt}{string, } -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export scripts_list_containers_projects <- function(id, hidden = NULL) { @@ -21055,8 +21199,8 @@ scripts_list_containers_projects <- function(id, hidden = NULL) { #' Add a container docker to a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -21078,8 +21222,8 @@ scripts_put_containers_projects <- function(id, project_id) { #' Remove a container docker from a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -21139,7 +21283,7 @@ scripts_delete_containers_projects <- function(id, project_id) { #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{templateDependentsCount}{integer, How many other scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} @@ -21152,11 +21296,11 @@ scripts_delete_containers_projects <- function(id, project_id) { #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -21192,6 +21336,7 @@ scripts_delete_containers_projects <- function(id, project_id) { #' \item{dockerCommand}{string, The command to run on the container. Will be run via sh as: ["sh", "-c", dockerCommand]} #' \item{dockerImageName}{string, The name of the docker image to pull from DockerHub.} #' \item{dockerImageTag}{string, The tag of the docker image to pull from DockerHub (default: latest).} +#' \item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} #' \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} #' \item{lastRun}{list, A list containing the following elements: #' \itemize{ @@ -21203,8 +21348,8 @@ scripts_delete_containers_projects <- function(id, project_id) { #' \item error string, The error message for this run, if present. #' }} #' \item{timeZone}{string, The time zone of this script.} -#' \item{hidden}{boolean, The hidden status of the object.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{hidden}{boolean, The hidden status of the item.} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} #' @export scripts_put_containers_archive <- function(id, status) { @@ -21397,7 +21542,7 @@ scripts_delete_python3_shares_groups <- function(id, group_id) { #' List the projects a python docker belongs to #' @param id integer required. The ID of the resource. -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. #' #' @return An array containing the following fields: #' \item{id}{integer, The ID for this project.} @@ -21410,7 +21555,7 @@ scripts_delete_python3_shares_groups <- function(id, group_id) { #' \item online boolean, Whether this user is online. #' }} #' \item{name}{string, The name of this project.} -#' \item{description}{string, A description of the project} +#' \item{description}{string, A description of the project.} #' \item{users}{array, An array containing the following fields: #' \itemize{ #' \item id integer, The ID of this user. @@ -21422,7 +21567,7 @@ scripts_delete_python3_shares_groups <- function(id, group_id) { #' \item{autoShare}{boolean, } #' \item{createdAt}{string, } #' \item{updatedAt}{string, } -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export scripts_list_python3_projects <- function(id, hidden = NULL) { @@ -21442,8 +21587,8 @@ scripts_list_python3_projects <- function(id, hidden = NULL) { #' Add a python docker to a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -21465,8 +21610,8 @@ scripts_put_python3_projects <- function(id, project_id) { #' Remove a python docker from a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -21526,7 +21671,7 @@ scripts_delete_python3_projects <- function(id, project_id) { #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -21539,11 +21684,11 @@ scripts_delete_python3_projects <- function(id, project_id) { #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -21577,15 +21722,16 @@ scripts_delete_python3_projects <- function(id, project_id) { #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{requiredResources}{list, A list containing the following elements: #' \itemize{ #' \item cpu integer, The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares. #' \item memory integer, The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. #' \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. #' }} +#' \item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} #' \item{source}{string, The body/text of the script.} #' \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} #' @export @@ -21779,7 +21925,7 @@ scripts_delete_r_shares_groups <- function(id, group_id) { #' List the projects a r docker belongs to #' @param id integer required. The ID of the resource. -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. #' #' @return An array containing the following fields: #' \item{id}{integer, The ID for this project.} @@ -21792,7 +21938,7 @@ scripts_delete_r_shares_groups <- function(id, group_id) { #' \item online boolean, Whether this user is online. #' }} #' \item{name}{string, The name of this project.} -#' \item{description}{string, A description of the project} +#' \item{description}{string, A description of the project.} #' \item{users}{array, An array containing the following fields: #' \itemize{ #' \item id integer, The ID of this user. @@ -21804,7 +21950,7 @@ scripts_delete_r_shares_groups <- function(id, group_id) { #' \item{autoShare}{boolean, } #' \item{createdAt}{string, } #' \item{updatedAt}{string, } -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export scripts_list_r_projects <- function(id, hidden = NULL) { @@ -21824,8 +21970,8 @@ scripts_list_r_projects <- function(id, hidden = NULL) { #' Add a r docker to a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -21847,8 +21993,8 @@ scripts_put_r_projects <- function(id, project_id) { #' Remove a r docker from a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -21908,7 +22054,7 @@ scripts_delete_r_projects <- function(id, project_id) { #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -21921,11 +22067,11 @@ scripts_delete_r_projects <- function(id, project_id) { #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -21959,15 +22105,16 @@ scripts_delete_r_projects <- function(id, project_id) { #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{requiredResources}{list, A list containing the following elements: #' \itemize{ #' \item cpu integer, The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares. #' \item memory integer, The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. #' \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. #' }} +#' \item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} #' \item{source}{string, The body/text of the script.} #' \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} #' @export @@ -22161,7 +22308,7 @@ scripts_delete_javascript_shares_groups <- function(id, group_id) { #' List the projects a scripted sql belongs to #' @param id integer required. The ID of the resource. -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. #' #' @return An array containing the following fields: #' \item{id}{integer, The ID for this project.} @@ -22174,7 +22321,7 @@ scripts_delete_javascript_shares_groups <- function(id, group_id) { #' \item online boolean, Whether this user is online. #' }} #' \item{name}{string, The name of this project.} -#' \item{description}{string, A description of the project} +#' \item{description}{string, A description of the project.} #' \item{users}{array, An array containing the following fields: #' \itemize{ #' \item id integer, The ID of this user. @@ -22186,7 +22333,7 @@ scripts_delete_javascript_shares_groups <- function(id, group_id) { #' \item{autoShare}{boolean, } #' \item{createdAt}{string, } #' \item{updatedAt}{string, } -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export scripts_list_javascript_projects <- function(id, hidden = NULL) { @@ -22206,8 +22353,8 @@ scripts_list_javascript_projects <- function(id, hidden = NULL) { #' Add a scripted sql to a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -22229,8 +22376,8 @@ scripts_put_javascript_projects <- function(id, project_id) { #' Remove a scripted sql from a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -22290,7 +22437,7 @@ scripts_delete_javascript_projects <- function(id, project_id) { #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -22303,11 +22450,11 @@ scripts_delete_javascript_projects <- function(id, project_id) { #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -22341,9 +22488,9 @@ scripts_delete_javascript_projects <- function(id, project_id) { #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{source}{string, The body/text of the script.} #' \item{remoteHostId}{integer, The remote host ID that this script will connect to.} #' \item{credentialId}{integer, The credential that this script will use.} @@ -22538,7 +22685,7 @@ scripts_delete_custom_shares_groups <- function(id, group_id) { #' List the projects a Job belongs to #' @param id integer required. The ID of the resource. -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. #' #' @return An array containing the following fields: #' \item{id}{integer, The ID for this project.} @@ -22551,7 +22698,7 @@ scripts_delete_custom_shares_groups <- function(id, group_id) { #' \item online boolean, Whether this user is online. #' }} #' \item{name}{string, The name of this project.} -#' \item{description}{string, A description of the project} +#' \item{description}{string, A description of the project.} #' \item{users}{array, An array containing the following fields: #' \itemize{ #' \item id integer, The ID of this user. @@ -22563,7 +22710,7 @@ scripts_delete_custom_shares_groups <- function(id, group_id) { #' \item{autoShare}{boolean, } #' \item{createdAt}{string, } #' \item{updatedAt}{string, } -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export scripts_list_custom_projects <- function(id, hidden = NULL) { @@ -22583,8 +22730,8 @@ scripts_list_custom_projects <- function(id, hidden = NULL) { #' Add a Job to a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -22606,8 +22753,8 @@ scripts_put_custom_projects <- function(id, project_id) { #' Remove a Job from a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -22666,7 +22813,7 @@ scripts_delete_custom_projects <- function(id, project_id) { #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template script.} @@ -22680,11 +22827,11 @@ scripts_delete_custom_projects <- function(id, project_id) { #' \item{codePreview}{string, The code that this script will run with arguments inserted.} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -22717,8 +22864,8 @@ scripts_delete_custom_projects <- function(id, project_id) { #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{hidden}{boolean, The hidden status of the item.} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} #' @export scripts_put_custom_archive <- function(id, status) { @@ -22779,7 +22926,7 @@ scripts_put_custom_archive <- function(id, status) { #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -22792,11 +22939,11 @@ scripts_put_custom_archive <- function(id, status) { #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -22830,9 +22977,9 @@ scripts_put_custom_archive <- function(id, status) { #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{sql}{string, The raw SQL query for the script.} #' \item{expandedArguments}{list, Expanded arguments for use in injecting into different environments.} #' \item{remoteHostId}{integer, The remote host ID that this script will connect to.} @@ -22906,7 +23053,7 @@ scripts_post_sql_clone <- function(id, clone_schedule = NULL, clone_triggers = N #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -22919,11 +23066,11 @@ scripts_post_sql_clone <- function(id, clone_schedule = NULL, clone_triggers = N #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -22957,9 +23104,9 @@ scripts_post_sql_clone <- function(id, clone_schedule = NULL, clone_triggers = N #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{source}{string, The body/text of the script.} #' \item{remoteHostId}{integer, The remote host ID that this script will connect to.} #' \item{credentialId}{integer, The credential that this script will use.} @@ -23022,7 +23169,7 @@ scripts_post_javascript_clone <- function(id, clone_schedule = NULL, clone_trigg #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -23035,11 +23182,11 @@ scripts_post_javascript_clone <- function(id, clone_schedule = NULL, clone_trigg #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -23073,15 +23220,16 @@ scripts_post_javascript_clone <- function(id, clone_schedule = NULL, clone_trigg #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{requiredResources}{list, A list containing the following elements: #' \itemize{ #' \item cpu integer, The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares. #' \item memory integer, The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. #' \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. #' }} +#' \item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} #' \item{source}{string, The body/text of the script.} #' \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} #' @export @@ -23143,7 +23291,7 @@ scripts_post_python3_clone <- function(id, clone_schedule = NULL, clone_triggers #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -23156,11 +23304,11 @@ scripts_post_python3_clone <- function(id, clone_schedule = NULL, clone_triggers #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -23194,15 +23342,16 @@ scripts_post_python3_clone <- function(id, clone_schedule = NULL, clone_triggers #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{requiredResources}{list, A list containing the following elements: #' \itemize{ #' \item cpu integer, The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares. #' \item memory integer, The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. #' \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. #' }} +#' \item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} #' \item{source}{string, The body/text of the script.} #' \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} #' @export @@ -23263,7 +23412,7 @@ scripts_post_r_clone <- function(id, clone_schedule = NULL, clone_triggers = NUL #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} #' \item{fromTemplateId}{integer, The ID of the template script.} @@ -23277,11 +23426,11 @@ scripts_post_r_clone <- function(id, clone_schedule = NULL, clone_triggers = NUL #' \item{codePreview}{string, The code that this script will run with arguments inserted.} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -23314,8 +23463,8 @@ scripts_post_r_clone <- function(id, clone_schedule = NULL, clone_triggers = NUL #' \item finishedAt string, The time that the run completed. #' \item error string, The error message for this run, if present. #' }} -#' \item{hidden}{boolean, The hidden status of the object.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{hidden}{boolean, The hidden status of the item.} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} #' @export scripts_post_custom_clone <- function(id, clone_schedule = NULL, clone_triggers = NULL, clone_notifications = NULL) { @@ -23376,7 +23525,7 @@ scripts_post_custom_clone <- function(id, clone_schedule = NULL, clone_triggers #' \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. #' \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` #' }} -#' \item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +#' \item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} #' \item{isTemplate}{boolean, Whether others scripts use this one as a template.} #' \item{templateDependentsCount}{integer, How many other scripts use this one as a template.} #' \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} @@ -23389,11 +23538,11 @@ scripts_post_custom_clone <- function(id, clone_schedule = NULL, clone_triggers #' }} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{notifications}{list, A list containing the following elements: #' \itemize{ @@ -23429,6 +23578,7 @@ scripts_post_custom_clone <- function(id, clone_schedule = NULL, clone_triggers #' \item{dockerCommand}{string, The command to run on the container. Will be run via sh as: ["sh", "-c", dockerCommand]} #' \item{dockerImageName}{string, The name of the docker image to pull from DockerHub.} #' \item{dockerImageTag}{string, The tag of the docker image to pull from DockerHub (default: latest).} +#' \item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} #' \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} #' \item{lastRun}{list, A list containing the following elements: #' \itemize{ @@ -23440,8 +23590,8 @@ scripts_post_custom_clone <- function(id, clone_schedule = NULL, clone_triggers #' \item error string, The error message for this run, if present. #' }} #' \item{timeZone}{string, The time zone of this script.} -#' \item{hidden}{boolean, The hidden status of the object.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{hidden}{boolean, The hidden status of the item.} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{targetProjectId}{integer, Target project to which script outputs will be added.} #' @export scripts_post_containers_clone <- function(id, clone_schedule = NULL, clone_triggers = NULL, clone_notifications = NULL) { @@ -23525,8 +23675,8 @@ search_list_types <- function() { #' List Services -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. -#' @param archived string optional. The archival status of the requested object(s). +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. +#' @param archived string optional. The archival status of the requested item(s). #' @param author string optional. If specified, return imports from this author. It accepts a comma-separated list of author IDs. #' @param status string optional. If specified, returns Services with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'idle'. #' @param limit integer optional. Number of results to return. Defaults to 20. Maximum allowed is 50. @@ -23550,7 +23700,7 @@ search_list_types <- function() { #' \item{updatedAt}{string, } #' \item{gitRepoUrl}{string, The url for the git repo where the Service code lives.} #' \item{gitRepoRef}{string, The git reference to use when pulling code from the repo.} -#' \item{gitPathDir}{string, The path to the Shiny app code within the git repo. If unspecified, the root directory will be used.} +#' \item{gitPathDir}{string, The path to the Service code within the git repo. If unspecified, the root directory will be used.} #' \item{currentDeployment}{list, A list containing the following elements: #' \itemize{ #' \item deploymentId integer, The ID for this deployment. @@ -23587,7 +23737,7 @@ search_list_types <- function() { #' \item published boolean, #' \item serviceId integer, The ID of owning Service #' }} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export services_list <- function(hidden = NULL, archived = NULL, author = NULL, status = NULL, limit = NULL, page_num = NULL, order = NULL, order_dir = NULL) { @@ -23614,7 +23764,7 @@ services_list <- function(hidden = NULL, archived = NULL, author = NULL, status #' @param schedule list optional. A list containing the following elements: #' \itemize{ #' \item runtimePlan string, Only affects the service when deployed. On Demand means that the service will be turned on when viewed and automatically turned off after periods of inactivity. Specific Times means the service will be on when scheduled. Always On means the deployed service will always be on. -#' \item recurrences array, List of day-hour combinations this object is scheduled for +#' \item recurrences array, List of day-hour combinations this item is scheduled for #' } #' @param replicas integer optional. The number of Service replicas to deploy. When maxReplicas is set, this field defines the minimum number of replicas to deploy. #' @param max_replicas integer optional. The maximum number of Service replicas to deploy. Defining this field enables autoscaling. @@ -23625,14 +23775,14 @@ services_list <- function(hidden = NULL, archived = NULL, author = NULL, status #' @param api_key_id integer optional. API key id of user #' @param git_repo_url string optional. The url for the git repo where the Service code lives. #' @param git_repo_ref string optional. The git reference to use when pulling code from the repo. -#' @param git_path_dir string optional. The path to the Shiny app code within the git repo. If unspecified, the root directory will be used. +#' @param git_path_dir string optional. The path to the Service code within the git repo. If unspecified, the root directory will be used. #' @param environment_variables list optional. Environment Variables to be passed into the Service. #' @param notifications list optional. A list containing the following elements: #' \itemize{ #' \item failureEmailAddresses array, Addresses to notify by e-mail when the service fails. #' \item failureOn boolean, If failure email notifications are on #' } -#' @param hidden boolean optional. The hidden status of the object. +#' @param hidden boolean optional. The hidden status of the item. #' #' @return A list containing the following elements: #' \item{id}{integer, The ID for this Service.} @@ -23651,7 +23801,7 @@ services_list <- function(hidden = NULL, archived = NULL, author = NULL, status #' \item{schedule}{list, A list containing the following elements: #' \itemize{ #' \item runtimePlan string, Only affects the service when deployed. On Demand means that the service will be turned on when viewed and automatically turned off after periods of inactivity. Specific Times means the service will be on when scheduled. Always On means the deployed service will always be on. -#' \item recurrences array, List of day-hour combinations this object is scheduled for +#' \item recurrences array, List of day-hour combinations this item is scheduled for #' }} #' \item{timeZone}{string, } #' \item{replicas}{integer, The number of Service replicas to deploy. When maxReplicas is set, this field defines the minimum number of replicas to deploy.} @@ -23665,7 +23815,7 @@ services_list <- function(hidden = NULL, archived = NULL, author = NULL, status #' \item{apiKeyId}{integer, API key id of user} #' \item{gitRepoUrl}{string, The url for the git repo where the Service code lives.} #' \item{gitRepoRef}{string, The git reference to use when pulling code from the repo.} -#' \item{gitPathDir}{string, The path to the Shiny app code within the git repo. If unspecified, the root directory will be used.} +#' \item{gitPathDir}{string, The path to the Service code within the git repo. If unspecified, the root directory will be used.} #' \item{reportId}{integer, The ID of the associated report.} #' \item{currentDeployment}{list, A list containing the following elements: #' \itemize{ @@ -23675,7 +23825,7 @@ services_list <- function(hidden = NULL, archived = NULL, author = NULL, status #' \item name string, Name of the deployment. #' \item dockerImageName string, The name of the docker image to pull from DockerHub. #' \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -#' \item displayUrl string, URL that displays the deployed platform object and includes auth token. +#' \item displayUrl string, A signed URL for viewing the deployed item. #' \item instanceType string, The EC2 instance type requested for the deployment. #' \item memory integer, The memory allocated to the deployment. #' \item cpu integer, The cpu allocated to the deployment. @@ -23694,7 +23844,7 @@ services_list <- function(hidden = NULL, archived = NULL, author = NULL, status #' \item name string, Name of the deployment. #' \item dockerImageName string, The name of the docker image to pull from DockerHub. #' \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -#' \item displayUrl string, URL that displays the deployed platform object and includes auth token. +#' \item displayUrl string, A signed URL for viewing the deployed item. #' \item instanceType string, The EC2 instance type requested for the deployment. #' \item memory integer, The memory allocated to the deployment. #' \item cpu integer, The cpu allocated to the deployment. @@ -23713,8 +23863,8 @@ services_list <- function(hidden = NULL, archived = NULL, author = NULL, status #' \item failureEmailAddresses array, Addresses to notify by e-mail when the service fails. #' \item failureOn boolean, If failure email notifications are on #' }} -#' \item{archived}{string, The archival status of the requested object(s).} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{archived}{string, The archival status of the requested item(s).} +#' \item{hidden}{boolean, The hidden status of the item.} #' @export services_post <- function(name = NULL, description = NULL, docker_image_name = NULL, docker_image_tag = NULL, schedule = NULL, replicas = NULL, max_replicas = NULL, instance_type = NULL, memory = NULL, cpu = NULL, credentials = NULL, api_key_id = NULL, git_repo_url = NULL, git_repo_ref = NULL, git_path_dir = NULL, environment_variables = NULL, notifications = NULL, hidden = NULL) { @@ -23753,7 +23903,7 @@ services_post <- function(name = NULL, description = NULL, docker_image_name = N #' \item{schedule}{list, A list containing the following elements: #' \itemize{ #' \item runtimePlan string, Only affects the service when deployed. On Demand means that the service will be turned on when viewed and automatically turned off after periods of inactivity. Specific Times means the service will be on when scheduled. Always On means the deployed service will always be on. -#' \item recurrences array, List of day-hour combinations this object is scheduled for +#' \item recurrences array, List of day-hour combinations this item is scheduled for #' }} #' \item{timeZone}{string, } #' \item{replicas}{integer, The number of Service replicas to deploy. When maxReplicas is set, this field defines the minimum number of replicas to deploy.} @@ -23767,7 +23917,7 @@ services_post <- function(name = NULL, description = NULL, docker_image_name = N #' \item{apiKeyId}{integer, API key id of user} #' \item{gitRepoUrl}{string, The url for the git repo where the Service code lives.} #' \item{gitRepoRef}{string, The git reference to use when pulling code from the repo.} -#' \item{gitPathDir}{string, The path to the Shiny app code within the git repo. If unspecified, the root directory will be used.} +#' \item{gitPathDir}{string, The path to the Service code within the git repo. If unspecified, the root directory will be used.} #' \item{reportId}{integer, The ID of the associated report.} #' \item{currentDeployment}{list, A list containing the following elements: #' \itemize{ @@ -23777,7 +23927,7 @@ services_post <- function(name = NULL, description = NULL, docker_image_name = N #' \item name string, Name of the deployment. #' \item dockerImageName string, The name of the docker image to pull from DockerHub. #' \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -#' \item displayUrl string, URL that displays the deployed platform object and includes auth token. +#' \item displayUrl string, A signed URL for viewing the deployed item. #' \item instanceType string, The EC2 instance type requested for the deployment. #' \item memory integer, The memory allocated to the deployment. #' \item cpu integer, The cpu allocated to the deployment. @@ -23796,7 +23946,7 @@ services_post <- function(name = NULL, description = NULL, docker_image_name = N #' \item name string, Name of the deployment. #' \item dockerImageName string, The name of the docker image to pull from DockerHub. #' \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -#' \item displayUrl string, URL that displays the deployed platform object and includes auth token. +#' \item displayUrl string, A signed URL for viewing the deployed item. #' \item instanceType string, The EC2 instance type requested for the deployment. #' \item memory integer, The memory allocated to the deployment. #' \item cpu integer, The cpu allocated to the deployment. @@ -23815,8 +23965,8 @@ services_post <- function(name = NULL, description = NULL, docker_image_name = N #' \item failureEmailAddresses array, Addresses to notify by e-mail when the service fails. #' \item failureOn boolean, If failure email notifications are on #' }} -#' \item{archived}{string, The archival status of the requested object(s).} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{archived}{string, The archival status of the requested item(s).} +#' \item{hidden}{boolean, The hidden status of the item.} #' @export services_get <- function(id) { @@ -23844,7 +23994,7 @@ services_get <- function(id) { #' @param schedule list optional. A list containing the following elements: #' \itemize{ #' \item runtimePlan string, Only affects the service when deployed. On Demand means that the service will be turned on when viewed and automatically turned off after periods of inactivity. Specific Times means the service will be on when scheduled. Always On means the deployed service will always be on. -#' \item recurrences array, List of day-hour combinations this object is scheduled for +#' \item recurrences array, List of day-hour combinations this item is scheduled for #' } #' @param replicas integer optional. The number of Service replicas to deploy. When maxReplicas is set, this field defines the minimum number of replicas to deploy. #' @param max_replicas integer optional. The maximum number of Service replicas to deploy. Defining this field enables autoscaling. @@ -23855,7 +24005,7 @@ services_get <- function(id) { #' @param api_key_id integer optional. API key id of user #' @param git_repo_url string optional. The url for the git repo where the Service code lives. #' @param git_repo_ref string optional. The git reference to use when pulling code from the repo. -#' @param git_path_dir string optional. The path to the Shiny app code within the git repo. If unspecified, the root directory will be used. +#' @param git_path_dir string optional. The path to the Service code within the git repo. If unspecified, the root directory will be used. #' @param environment_variables list optional. Environment Variables to be passed into the Service. #' @param notifications list optional. A list containing the following elements: #' \itemize{ @@ -23880,7 +24030,7 @@ services_get <- function(id) { #' \item{schedule}{list, A list containing the following elements: #' \itemize{ #' \item runtimePlan string, Only affects the service when deployed. On Demand means that the service will be turned on when viewed and automatically turned off after periods of inactivity. Specific Times means the service will be on when scheduled. Always On means the deployed service will always be on. -#' \item recurrences array, List of day-hour combinations this object is scheduled for +#' \item recurrences array, List of day-hour combinations this item is scheduled for #' }} #' \item{timeZone}{string, } #' \item{replicas}{integer, The number of Service replicas to deploy. When maxReplicas is set, this field defines the minimum number of replicas to deploy.} @@ -23894,7 +24044,7 @@ services_get <- function(id) { #' \item{apiKeyId}{integer, API key id of user} #' \item{gitRepoUrl}{string, The url for the git repo where the Service code lives.} #' \item{gitRepoRef}{string, The git reference to use when pulling code from the repo.} -#' \item{gitPathDir}{string, The path to the Shiny app code within the git repo. If unspecified, the root directory will be used.} +#' \item{gitPathDir}{string, The path to the Service code within the git repo. If unspecified, the root directory will be used.} #' \item{reportId}{integer, The ID of the associated report.} #' \item{currentDeployment}{list, A list containing the following elements: #' \itemize{ @@ -23904,7 +24054,7 @@ services_get <- function(id) { #' \item name string, Name of the deployment. #' \item dockerImageName string, The name of the docker image to pull from DockerHub. #' \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -#' \item displayUrl string, URL that displays the deployed platform object and includes auth token. +#' \item displayUrl string, A signed URL for viewing the deployed item. #' \item instanceType string, The EC2 instance type requested for the deployment. #' \item memory integer, The memory allocated to the deployment. #' \item cpu integer, The cpu allocated to the deployment. @@ -23923,7 +24073,7 @@ services_get <- function(id) { #' \item name string, Name of the deployment. #' \item dockerImageName string, The name of the docker image to pull from DockerHub. #' \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -#' \item displayUrl string, URL that displays the deployed platform object and includes auth token. +#' \item displayUrl string, A signed URL for viewing the deployed item. #' \item instanceType string, The EC2 instance type requested for the deployment. #' \item memory integer, The memory allocated to the deployment. #' \item cpu integer, The cpu allocated to the deployment. @@ -23942,8 +24092,8 @@ services_get <- function(id) { #' \item failureEmailAddresses array, Addresses to notify by e-mail when the service fails. #' \item failureOn boolean, If failure email notifications are on #' }} -#' \item{archived}{string, The archival status of the requested object(s).} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{archived}{string, The archival status of the requested item(s).} +#' \item{hidden}{boolean, The hidden status of the item.} #' @export services_put <- function(id, name = NULL, description = NULL, docker_image_name = NULL, docker_image_tag = NULL, schedule = NULL, replicas = NULL, max_replicas = NULL, instance_type = NULL, memory = NULL, cpu = NULL, credentials = NULL, api_key_id = NULL, git_repo_url = NULL, git_repo_ref = NULL, git_path_dir = NULL, environment_variables = NULL, notifications = NULL) { @@ -23971,7 +24121,7 @@ services_put <- function(id, name = NULL, description = NULL, docker_image_name #' @param schedule list optional. A list containing the following elements: #' \itemize{ #' \item runtimePlan string, Only affects the service when deployed. On Demand means that the service will be turned on when viewed and automatically turned off after periods of inactivity. Specific Times means the service will be on when scheduled. Always On means the deployed service will always be on. -#' \item recurrences array, List of day-hour combinations this object is scheduled for +#' \item recurrences array, List of day-hour combinations this item is scheduled for #' } #' @param replicas integer optional. The number of Service replicas to deploy. When maxReplicas is set, this field defines the minimum number of replicas to deploy. #' @param max_replicas integer optional. The maximum number of Service replicas to deploy. Defining this field enables autoscaling. @@ -23982,7 +24132,7 @@ services_put <- function(id, name = NULL, description = NULL, docker_image_name #' @param api_key_id integer optional. API key id of user #' @param git_repo_url string optional. The url for the git repo where the Service code lives. #' @param git_repo_ref string optional. The git reference to use when pulling code from the repo. -#' @param git_path_dir string optional. The path to the Shiny app code within the git repo. If unspecified, the root directory will be used. +#' @param git_path_dir string optional. The path to the Service code within the git repo. If unspecified, the root directory will be used. #' @param environment_variables list optional. Environment Variables to be passed into the Service. #' @param notifications list optional. A list containing the following elements: #' \itemize{ @@ -24007,7 +24157,7 @@ services_put <- function(id, name = NULL, description = NULL, docker_image_name #' \item{schedule}{list, A list containing the following elements: #' \itemize{ #' \item runtimePlan string, Only affects the service when deployed. On Demand means that the service will be turned on when viewed and automatically turned off after periods of inactivity. Specific Times means the service will be on when scheduled. Always On means the deployed service will always be on. -#' \item recurrences array, List of day-hour combinations this object is scheduled for +#' \item recurrences array, List of day-hour combinations this item is scheduled for #' }} #' \item{timeZone}{string, } #' \item{replicas}{integer, The number of Service replicas to deploy. When maxReplicas is set, this field defines the minimum number of replicas to deploy.} @@ -24021,7 +24171,7 @@ services_put <- function(id, name = NULL, description = NULL, docker_image_name #' \item{apiKeyId}{integer, API key id of user} #' \item{gitRepoUrl}{string, The url for the git repo where the Service code lives.} #' \item{gitRepoRef}{string, The git reference to use when pulling code from the repo.} -#' \item{gitPathDir}{string, The path to the Shiny app code within the git repo. If unspecified, the root directory will be used.} +#' \item{gitPathDir}{string, The path to the Service code within the git repo. If unspecified, the root directory will be used.} #' \item{reportId}{integer, The ID of the associated report.} #' \item{currentDeployment}{list, A list containing the following elements: #' \itemize{ @@ -24031,7 +24181,7 @@ services_put <- function(id, name = NULL, description = NULL, docker_image_name #' \item name string, Name of the deployment. #' \item dockerImageName string, The name of the docker image to pull from DockerHub. #' \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -#' \item displayUrl string, URL that displays the deployed platform object and includes auth token. +#' \item displayUrl string, A signed URL for viewing the deployed item. #' \item instanceType string, The EC2 instance type requested for the deployment. #' \item memory integer, The memory allocated to the deployment. #' \item cpu integer, The cpu allocated to the deployment. @@ -24050,7 +24200,7 @@ services_put <- function(id, name = NULL, description = NULL, docker_image_name #' \item name string, Name of the deployment. #' \item dockerImageName string, The name of the docker image to pull from DockerHub. #' \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -#' \item displayUrl string, URL that displays the deployed platform object and includes auth token. +#' \item displayUrl string, A signed URL for viewing the deployed item. #' \item instanceType string, The EC2 instance type requested for the deployment. #' \item memory integer, The memory allocated to the deployment. #' \item cpu integer, The cpu allocated to the deployment. @@ -24069,8 +24219,8 @@ services_put <- function(id, name = NULL, description = NULL, docker_image_name #' \item failureEmailAddresses array, Addresses to notify by e-mail when the service fails. #' \item failureOn boolean, If failure email notifications are on #' }} -#' \item{archived}{string, The archival status of the requested object(s).} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{archived}{string, The archival status of the requested item(s).} +#' \item{hidden}{boolean, The hidden status of the item.} #' @export services_patch <- function(id, name = NULL, description = NULL, docker_image_name = NULL, docker_image_tag = NULL, schedule = NULL, replicas = NULL, max_replicas = NULL, instance_type = NULL, memory = NULL, cpu = NULL, credentials = NULL, api_key_id = NULL, git_repo_url = NULL, git_repo_ref = NULL, git_path_dir = NULL, environment_variables = NULL, notifications = NULL) { @@ -24303,7 +24453,7 @@ services_delete_shares_groups <- function(id, group_id) { #' \item{schedule}{list, A list containing the following elements: #' \itemize{ #' \item runtimePlan string, Only affects the service when deployed. On Demand means that the service will be turned on when viewed and automatically turned off after periods of inactivity. Specific Times means the service will be on when scheduled. Always On means the deployed service will always be on. -#' \item recurrences array, List of day-hour combinations this object is scheduled for +#' \item recurrences array, List of day-hour combinations this item is scheduled for #' }} #' \item{timeZone}{string, } #' \item{replicas}{integer, The number of Service replicas to deploy. When maxReplicas is set, this field defines the minimum number of replicas to deploy.} @@ -24317,7 +24467,7 @@ services_delete_shares_groups <- function(id, group_id) { #' \item{apiKeyId}{integer, API key id of user} #' \item{gitRepoUrl}{string, The url for the git repo where the Service code lives.} #' \item{gitRepoRef}{string, The git reference to use when pulling code from the repo.} -#' \item{gitPathDir}{string, The path to the Shiny app code within the git repo. If unspecified, the root directory will be used.} +#' \item{gitPathDir}{string, The path to the Service code within the git repo. If unspecified, the root directory will be used.} #' \item{reportId}{integer, The ID of the associated report.} #' \item{currentDeployment}{list, A list containing the following elements: #' \itemize{ @@ -24327,7 +24477,7 @@ services_delete_shares_groups <- function(id, group_id) { #' \item name string, Name of the deployment. #' \item dockerImageName string, The name of the docker image to pull from DockerHub. #' \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -#' \item displayUrl string, URL that displays the deployed platform object and includes auth token. +#' \item displayUrl string, A signed URL for viewing the deployed item. #' \item instanceType string, The EC2 instance type requested for the deployment. #' \item memory integer, The memory allocated to the deployment. #' \item cpu integer, The cpu allocated to the deployment. @@ -24346,7 +24496,7 @@ services_delete_shares_groups <- function(id, group_id) { #' \item name string, Name of the deployment. #' \item dockerImageName string, The name of the docker image to pull from DockerHub. #' \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -#' \item displayUrl string, URL that displays the deployed platform object and includes auth token. +#' \item displayUrl string, A signed URL for viewing the deployed item. #' \item instanceType string, The EC2 instance type requested for the deployment. #' \item memory integer, The memory allocated to the deployment. #' \item cpu integer, The cpu allocated to the deployment. @@ -24365,8 +24515,8 @@ services_delete_shares_groups <- function(id, group_id) { #' \item failureEmailAddresses array, Addresses to notify by e-mail when the service fails. #' \item failureOn boolean, If failure email notifications are on #' }} -#' \item{archived}{string, The archival status of the requested object(s).} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{archived}{string, The archival status of the requested item(s).} +#' \item{hidden}{boolean, The hidden status of the item.} #' @export services_put_archive <- function(id, status) { @@ -24385,9 +24535,9 @@ services_put_archive <- function(id, status) { } -#' List the projects a ShinyApp belongs to +#' List the projects a Service belongs to #' @param id integer required. The ID of the resource. -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. #' #' @return An array containing the following fields: #' \item{id}{integer, The ID for this project.} @@ -24400,7 +24550,7 @@ services_put_archive <- function(id, status) { #' \item online boolean, Whether this user is online. #' }} #' \item{name}{string, The name of this project.} -#' \item{description}{string, A description of the project} +#' \item{description}{string, A description of the project.} #' \item{users}{array, An array containing the following fields: #' \itemize{ #' \item id integer, The ID of this user. @@ -24412,7 +24562,7 @@ services_put_archive <- function(id, status) { #' \item{autoShare}{boolean, } #' \item{createdAt}{string, } #' \item{updatedAt}{string, } -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export services_list_projects <- function(id, hidden = NULL) { @@ -24431,9 +24581,9 @@ services_list_projects <- function(id, hidden = NULL) { } -#' Add a ShinyApp to a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' Add a Service to a project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -24454,9 +24604,9 @@ services_put_projects <- function(id, project_id) { } -#' Remove a ShinyApp from a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' Remove a Service from a project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -24477,8 +24627,8 @@ services_delete_projects <- function(id, project_id) { } -#' List deployments for a ShinyApp -#' @param service_id integer required. The ID of the owning ShinyApp +#' List deployments for a Service +#' @param service_id integer required. The ID of the owning Service #' @param deployment_id integer optional. The ID for this deployment #' @param limit integer optional. Number of results to return. Defaults to 20. Maximum allowed is 50. #' @param page_num integer optional. Page number of the results to return. Defaults to the first page, 1. @@ -24519,8 +24669,8 @@ services_list_deployments <- function(service_id, deployment_id = NULL, limit = } -#' Deploy a ShinyApp -#' @param service_id integer required. The ID of the owning ShinyApp +#' Deploy a Service +#' @param service_id integer required. The ID of the owning Service #' @param deployment_id integer optional. The ID for this deployment #' @param published boolean optional. #' @@ -24531,7 +24681,7 @@ services_list_deployments <- function(service_id, deployment_id = NULL, limit = #' \item{name}{string, Name of the deployment.} #' \item{dockerImageName}{string, The name of the docker image to pull from DockerHub.} #' \item{dockerImageTag}{string, The tag of the docker image to pull from DockerHub (default: latest).} -#' \item{displayUrl}{string, URL that displays the deployed platform object and includes auth token.} +#' \item{displayUrl}{string, A signed URL for viewing the deployed item.} #' \item{instanceType}{string, The EC2 instance type requested for the deployment.} #' \item{memory}{integer, The memory allocated to the deployment.} #' \item{cpu}{integer, The cpu allocated to the deployment.} @@ -24559,8 +24709,8 @@ services_post_deployments <- function(service_id, deployment_id = NULL, publishe } -#' Get details about a ShinyApp deployment -#' @param service_id integer required. The ID of the owning ShinyApp +#' Get details about a Service deployment +#' @param service_id integer required. The ID of the owning Service #' @param deployment_id integer required. The ID for this deployment #' #' @return A list containing the following elements: @@ -24570,7 +24720,7 @@ services_post_deployments <- function(service_id, deployment_id = NULL, publishe #' \item{name}{string, Name of the deployment.} #' \item{dockerImageName}{string, The name of the docker image to pull from DockerHub.} #' \item{dockerImageTag}{string, The tag of the docker image to pull from DockerHub (default: latest).} -#' \item{displayUrl}{string, URL that displays the deployed platform object and includes auth token.} +#' \item{displayUrl}{string, A signed URL for viewing the deployed item.} #' \item{instanceType}{string, The EC2 instance type requested for the deployment.} #' \item{memory}{integer, The memory allocated to the deployment.} #' \item{cpu}{integer, The cpu allocated to the deployment.} @@ -24598,8 +24748,8 @@ services_get_deployments <- function(service_id, deployment_id) { } -#' Delete a ShinyApp deployment -#' @param service_id integer required. The ID of the owning ShinyApp +#' Delete a Service deployment +#' @param service_id integer required. The ID of the owning Service #' @param deployment_id integer required. The ID for this deployment #' #' @return An empty HTTP response @@ -24621,8 +24771,8 @@ services_delete_deployments <- function(service_id, deployment_id) { } -#' Redeploy a ShinyApp -#' @param service_id integer required. The ID of the owning ShinyApp +#' Redeploy a Service +#' @param service_id integer required. The ID of the owning Service #' @param deployment_id integer optional. The ID for this deployment #' @param published boolean optional. #' @@ -24633,7 +24783,7 @@ services_delete_deployments <- function(service_id, deployment_id) { #' \item{name}{string, Name of the deployment.} #' \item{dockerImageName}{string, The name of the docker image to pull from DockerHub.} #' \item{dockerImageTag}{string, The tag of the docker image to pull from DockerHub (default: latest).} -#' \item{displayUrl}{string, URL that displays the deployed platform object and includes auth token.} +#' \item{displayUrl}{string, A signed URL for viewing the deployed item.} #' \item{instanceType}{string, The EC2 instance type requested for the deployment.} #' \item{memory}{integer, The memory allocated to the deployment.} #' \item{cpu}{integer, The cpu allocated to the deployment.} @@ -24710,7 +24860,7 @@ services_list_deployments_logs <- function(id, deployment_id, start_at = NULL, l #' \item{schedule}{list, A list containing the following elements: #' \itemize{ #' \item runtimePlan string, Only affects the service when deployed. On Demand means that the service will be turned on when viewed and automatically turned off after periods of inactivity. Specific Times means the service will be on when scheduled. Always On means the deployed service will always be on. -#' \item recurrences array, List of day-hour combinations this object is scheduled for +#' \item recurrences array, List of day-hour combinations this item is scheduled for #' }} #' \item{timeZone}{string, } #' \item{replicas}{integer, The number of Service replicas to deploy. When maxReplicas is set, this field defines the minimum number of replicas to deploy.} @@ -24724,7 +24874,7 @@ services_list_deployments_logs <- function(id, deployment_id, start_at = NULL, l #' \item{apiKeyId}{integer, API key id of user} #' \item{gitRepoUrl}{string, The url for the git repo where the Service code lives.} #' \item{gitRepoRef}{string, The git reference to use when pulling code from the repo.} -#' \item{gitPathDir}{string, The path to the Shiny app code within the git repo. If unspecified, the root directory will be used.} +#' \item{gitPathDir}{string, The path to the Service code within the git repo. If unspecified, the root directory will be used.} #' \item{reportId}{integer, The ID of the associated report.} #' \item{currentDeployment}{list, A list containing the following elements: #' \itemize{ @@ -24734,7 +24884,7 @@ services_list_deployments_logs <- function(id, deployment_id, start_at = NULL, l #' \item name string, Name of the deployment. #' \item dockerImageName string, The name of the docker image to pull from DockerHub. #' \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -#' \item displayUrl string, URL that displays the deployed platform object and includes auth token. +#' \item displayUrl string, A signed URL for viewing the deployed item. #' \item instanceType string, The EC2 instance type requested for the deployment. #' \item memory integer, The memory allocated to the deployment. #' \item cpu integer, The cpu allocated to the deployment. @@ -24753,7 +24903,7 @@ services_list_deployments_logs <- function(id, deployment_id, start_at = NULL, l #' \item name string, Name of the deployment. #' \item dockerImageName string, The name of the docker image to pull from DockerHub. #' \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -#' \item displayUrl string, URL that displays the deployed platform object and includes auth token. +#' \item displayUrl string, A signed URL for viewing the deployed item. #' \item instanceType string, The EC2 instance type requested for the deployment. #' \item memory integer, The memory allocated to the deployment. #' \item cpu integer, The cpu allocated to the deployment. @@ -24772,8 +24922,8 @@ services_list_deployments_logs <- function(id, deployment_id, start_at = NULL, l #' \item failureEmailAddresses array, Addresses to notify by e-mail when the service fails. #' \item failureOn boolean, If failure email notifications are on #' }} -#' \item{archived}{string, The archival status of the requested object(s).} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{archived}{string, The archival status of the requested item(s).} +#' \item{hidden}{boolean, The hidden status of the item.} #' @export services_post_clone <- function(id) { @@ -25684,7 +25834,7 @@ templates_delete_reports_shares_groups <- function(id, group_id) { #' List Report Templates -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. #' @param category string optional. A category to filter results by, one of: dataset-viz #' @param limit integer optional. Number of results to return. Defaults to 50. Maximum allowed is 1000. #' @param page_num integer optional. Page number of the results to return. Defaults to the first page, 1. @@ -25732,7 +25882,7 @@ templates_list_reports <- function(hidden = NULL, category = NULL, limit = NULL, #' @param category string optional. The category of this report template. Can be left blank. Acceptable values are: dataset-viz #' @param archived boolean optional. Whether the template has been archived. #' @param provide_api_key boolean optional. Whether reports based on this template request an API Key from the report viewer. -#' @param hidden boolean optional. The hidden status of the object. +#' @param hidden boolean optional. The hidden status of the item. #' #' @return A list containing the following elements: #' \item{id}{integer, } @@ -25753,7 +25903,7 @@ templates_list_reports <- function(hidden = NULL, category = NULL, limit = NULL, #' \item{techReviewed}{boolean, Whether this template has been audited by Civis for security vulnerability and correctness.} #' \item{authCodeUrl}{string, A URL to the template's stored code body.} #' \item{provideAPIKey}{boolean, Whether reports based on this template request an API Key from the report viewer.} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' @export templates_post_reports <- function(name, code_body, category = NULL, archived = NULL, provide_api_key = NULL, hidden = NULL) { @@ -25794,7 +25944,7 @@ templates_post_reports <- function(name, code_body, category = NULL, archived = #' \item{techReviewed}{boolean, Whether this template has been audited by Civis for security vulnerability and correctness.} #' \item{authCodeUrl}{string, A URL to the template's stored code body.} #' \item{provideAPIKey}{boolean, Whether reports based on this template request an API Key from the report viewer.} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' @export templates_get_reports <- function(id) { @@ -25840,7 +25990,7 @@ templates_get_reports <- function(id) { #' \item{techReviewed}{boolean, Whether this template has been audited by Civis for security vulnerability and correctness.} #' \item{authCodeUrl}{string, A URL to the template's stored code body.} #' \item{provideAPIKey}{boolean, Whether reports based on this template request an API Key from the report viewer.} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' @export templates_put_reports <- function(id, name, code_body, category = NULL, archived = NULL, provide_api_key = NULL) { @@ -25886,7 +26036,7 @@ templates_put_reports <- function(id, name, code_body, category = NULL, archived #' \item{techReviewed}{boolean, Whether this template has been audited by Civis for security vulnerability and correctness.} #' \item{authCodeUrl}{string, A URL to the template's stored code body.} #' \item{provideAPIKey}{boolean, Whether reports based on this template request an API Key from the report viewer.} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' @export templates_patch_reports <- function(id, name = NULL, category = NULL, archived = NULL, code_body = NULL, provide_api_key = NULL) { @@ -26100,7 +26250,7 @@ templates_delete_scripts_shares_groups <- function(id, group_id) { #' List the projects a Template::Script belongs to #' @param id integer required. The ID of the resource. -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. #' #' @return An array containing the following fields: #' \item{id}{integer, The ID for this project.} @@ -26113,7 +26263,7 @@ templates_delete_scripts_shares_groups <- function(id, group_id) { #' \item online boolean, Whether this user is online. #' }} #' \item{name}{string, The name of this project.} -#' \item{description}{string, A description of the project} +#' \item{description}{string, A description of the project.} #' \item{users}{array, An array containing the following fields: #' \itemize{ #' \item id integer, The ID of this user. @@ -26125,7 +26275,7 @@ templates_delete_scripts_shares_groups <- function(id, group_id) { #' \item{autoShare}{boolean, } #' \item{createdAt}{string, } #' \item{updatedAt}{string, } -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export templates_list_scripts_projects <- function(id, hidden = NULL) { @@ -26145,8 +26295,8 @@ templates_list_scripts_projects <- function(id, hidden = NULL) { #' Add a Template::Script to a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -26168,8 +26318,8 @@ templates_put_scripts_projects <- function(id, project_id) { #' Remove a Template::Script from a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -26191,7 +26341,7 @@ templates_delete_scripts_projects <- function(id, project_id) { #' List Script Templates -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. #' @param category string optional. A category to filter results by, one of: import, export, enhancement, model, and script #' @param limit integer optional. Number of results to return. Defaults to 50. Maximum allowed is 1000. #' @param page_num integer optional. Page number of the results to return. Defaults to the first page, 1. @@ -26234,7 +26384,7 @@ templates_list_scripts <- function(hidden = NULL, category = NULL, limit = NULL, #' @param note string optional. A note describing what this template is used for; custom scripts created off this template will display this description. #' @param ui_report_id integer optional. The id of the report that this template uses. #' @param archived boolean optional. Whether the template has been archived. -#' @param hidden boolean optional. The hidden status of the object. +#' @param hidden boolean optional. The hidden status of the item. #' #' @return A list containing the following elements: #' \item{id}{integer, } @@ -26249,7 +26399,7 @@ templates_list_scripts <- function(hidden = NULL, category = NULL, limit = NULL, #' \item{uiReportId}{integer, The id of the report that this template uses.} #' \item{techReviewed}{boolean, Whether this template has been audited by Civis for security vulnerability and correctness.} #' \item{archived}{boolean, Whether the template has been archived.} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' @export templates_post_scripts <- function(script_id, name, note = NULL, ui_report_id = NULL, archived = NULL, hidden = NULL) { @@ -26284,7 +26434,7 @@ templates_post_scripts <- function(script_id, name, note = NULL, ui_report_id = #' \item{uiReportId}{integer, The id of the report that this template uses.} #' \item{techReviewed}{boolean, Whether this template has been audited by Civis for security vulnerability and correctness.} #' \item{archived}{boolean, Whether the template has been archived.} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' @export templates_get_scripts <- function(id) { @@ -26323,7 +26473,7 @@ templates_get_scripts <- function(id) { #' \item{uiReportId}{integer, The id of the report that this template uses.} #' \item{techReviewed}{boolean, Whether this template has been audited by Civis for security vulnerability and correctness.} #' \item{archived}{boolean, Whether the template has been archived.} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' @export templates_put_scripts <- function(id, name, note = NULL, ui_report_id = NULL, archived = NULL) { @@ -26362,7 +26512,7 @@ templates_put_scripts <- function(id, name, note = NULL, ui_report_id = NULL, ar #' \item{uiReportId}{integer, The id of the report that this template uses.} #' \item{techReviewed}{boolean, Whether this template has been audited by Civis for security vulnerability and correctness.} #' \item{archived}{boolean, Whether the template has been archived.} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{hidden}{boolean, The hidden status of the item.} #' @export templates_patch_scripts <- function(id, name = NULL, note = NULL, ui_report_id = NULL, archived = NULL) { @@ -26832,8 +26982,8 @@ users_delete_api_keys <- function(id, key_id) { #' List Workflows -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. -#' @param archived string optional. The archival status of the requested object(s). +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. +#' @param archived string optional. The archival status of the requested item(s). #' @param author string optional. If specified, return workflows from this author. It accepts a comma-separated list of author ids. #' @param limit integer optional. Number of results to return. Defaults to 20. Maximum allowed is 50. #' @param page_num integer optional. Page number of the results to return. Defaults to the first page, 1. @@ -26857,15 +27007,15 @@ users_delete_api_keys <- function(id, key_id) { #' \item{state}{string, The state of the workflow. State is "running" if any execution is running, otherwise reflects most recent execution state.} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{timeZone}{string, The time zone of this workflow.} #' \item{nextExecutionAt}{string, The time of the next scheduled execution.} -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' \item{createdAt}{string, } #' \item{updatedAt}{string, } #' @export @@ -26893,11 +27043,11 @@ workflows_list <- function(hidden = NULL, archived = NULL, author = NULL, limit #' @param definition string optional. The definition of the workflow in YAML format. Must not be specified if `fromJobChain` is specified. #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param time_zone string optional. The time zone of this workflow. #' @param notifications list optional. A list containing the following elements: @@ -26910,7 +27060,7 @@ workflows_list <- function(hidden = NULL, archived = NULL, author = NULL, limit #' \item successOn boolean, If success email notifications are on #' \item failureOn boolean, If failure email notifications are on #' } -#' @param hidden boolean optional. The hidden status of the object. +#' @param hidden boolean optional. The hidden status of the item. #' #' @return A list containing the following elements: #' \item{id}{integer, The ID for this workflow.} @@ -26931,11 +27081,11 @@ workflows_list <- function(hidden = NULL, archived = NULL, author = NULL, limit #' \item{state}{string, The state of the workflow. State is "running" if any execution is running, otherwise reflects most recent execution state.} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{timeZone}{string, The time zone of this workflow.} #' \item{nextExecutionAt}{string, The time of the next scheduled execution.} @@ -26949,8 +27099,8 @@ workflows_list <- function(hidden = NULL, archived = NULL, author = NULL, limit #' \item successOn boolean, If success email notifications are on #' \item failureOn boolean, If failure email notifications are on #' }} -#' \item{archived}{string, The archival status of the requested object(s).} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{archived}{string, The archival status of the requested item(s).} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{createdAt}{string, } #' \item{updatedAt}{string, } #' @export @@ -26993,11 +27143,11 @@ workflows_post <- function(name, description = NULL, from_job_chain = NULL, defi #' \item{state}{string, The state of the workflow. State is "running" if any execution is running, otherwise reflects most recent execution state.} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{timeZone}{string, The time zone of this workflow.} #' \item{nextExecutionAt}{string, The time of the next scheduled execution.} @@ -27011,8 +27161,8 @@ workflows_post <- function(name, description = NULL, from_job_chain = NULL, defi #' \item successOn boolean, If success email notifications are on #' \item failureOn boolean, If failure email notifications are on #' }} -#' \item{archived}{string, The archival status of the requested object(s).} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{archived}{string, The archival status of the requested item(s).} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{createdAt}{string, } #' \item{updatedAt}{string, } #' @export @@ -27040,11 +27190,11 @@ workflows_get <- function(id) { #' @param definition string optional. The definition of the workflow in YAML format. Must not be specified if `fromJobChain` is specified. #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param time_zone string optional. The time zone of this workflow. #' @param notifications list optional. A list containing the following elements: @@ -27077,11 +27227,11 @@ workflows_get <- function(id) { #' \item{state}{string, The state of the workflow. State is "running" if any execution is running, otherwise reflects most recent execution state.} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{timeZone}{string, The time zone of this workflow.} #' \item{nextExecutionAt}{string, The time of the next scheduled execution.} @@ -27095,8 +27245,8 @@ workflows_get <- function(id) { #' \item successOn boolean, If success email notifications are on #' \item failureOn boolean, If failure email notifications are on #' }} -#' \item{archived}{string, The archival status of the requested object(s).} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{archived}{string, The archival status of the requested item(s).} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{createdAt}{string, } #' \item{updatedAt}{string, } #' @export @@ -27124,11 +27274,11 @@ workflows_put <- function(id, name, description = NULL, definition = NULL, sched #' @param definition string optional. The definition of the workflow in YAML format. Must not be specified if `fromJobChain` is specified. #' @param schedule list optional. A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' } #' @param time_zone string optional. The time zone of this workflow. #' @param notifications list optional. A list containing the following elements: @@ -27161,11 +27311,11 @@ workflows_put <- function(id, name, description = NULL, definition = NULL, sched #' \item{state}{string, The state of the workflow. State is "running" if any execution is running, otherwise reflects most recent execution state.} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{timeZone}{string, The time zone of this workflow.} #' \item{nextExecutionAt}{string, The time of the next scheduled execution.} @@ -27179,8 +27329,8 @@ workflows_put <- function(id, name, description = NULL, definition = NULL, sched #' \item successOn boolean, If success email notifications are on #' \item failureOn boolean, If failure email notifications are on #' }} -#' \item{archived}{string, The archival status of the requested object(s).} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{archived}{string, The archival status of the requested item(s).} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{createdAt}{string, } #' \item{updatedAt}{string, } #' @export @@ -27395,11 +27545,11 @@ workflows_delete_shares_groups <- function(id, group_id) { #' \item{state}{string, The state of the workflow. State is "running" if any execution is running, otherwise reflects most recent execution state.} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{timeZone}{string, The time zone of this workflow.} #' \item{nextExecutionAt}{string, The time of the next scheduled execution.} @@ -27413,8 +27563,8 @@ workflows_delete_shares_groups <- function(id, group_id) { #' \item successOn boolean, If success email notifications are on #' \item failureOn boolean, If failure email notifications are on #' }} -#' \item{archived}{string, The archival status of the requested object(s).} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{archived}{string, The archival status of the requested item(s).} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{createdAt}{string, } #' \item{updatedAt}{string, } #' @export @@ -27437,7 +27587,7 @@ workflows_put_archive <- function(id, status) { #' List the projects a Workflow::Workflow belongs to #' @param id integer required. The ID of the resource. -#' @param hidden boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects. +#' @param hidden boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. #' #' @return An array containing the following fields: #' \item{id}{integer, The ID for this project.} @@ -27450,7 +27600,7 @@ workflows_put_archive <- function(id, status) { #' \item online boolean, Whether this user is online. #' }} #' \item{name}{string, The name of this project.} -#' \item{description}{string, A description of the project} +#' \item{description}{string, A description of the project.} #' \item{users}{array, An array containing the following fields: #' \itemize{ #' \item id integer, The ID of this user. @@ -27462,7 +27612,7 @@ workflows_put_archive <- function(id, status) { #' \item{autoShare}{boolean, } #' \item{createdAt}{string, } #' \item{updatedAt}{string, } -#' \item{archived}{string, The archival status of the requested object(s).} +#' \item{archived}{string, The archival status of the requested item(s).} #' @export workflows_list_projects <- function(id, hidden = NULL) { @@ -27482,8 +27632,8 @@ workflows_list_projects <- function(id, hidden = NULL) { #' Add a Workflow::Workflow to a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -27505,8 +27655,8 @@ workflows_put_projects <- function(id, project_id) { #' Remove a Workflow::Workflow from a project -#' @param id integer required. ID of the resource -#' @param project_id integer required. The ID of the project +#' @param id integer required. The ID of the resource. +#' @param project_id integer required. The ID of the project. #' #' @return An empty HTTP response #' @export @@ -27528,7 +27678,7 @@ workflows_delete_projects <- function(id, project_id) { #' Get the git metadata attached to this Workflow::Workflow -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' #' @return A list containing the following elements: #' \item{gitRef}{string, A git reference specifying an unambiguous version of the file. Can be a branch name, or the full or shortened SHA of a commit.} @@ -27560,7 +27710,7 @@ workflows_list_git <- function(id) { #' Attach this Workflow::Workflow to a git repo/file -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' @param git_ref string optional. A git reference specifying an unambiguous version of the file. Can be a branch name, or the full or shortened SHA of a commit. #' @param git_branch string optional. The git branch that the file is on. #' @param git_path string optional. The path of the file in the repository. @@ -27596,7 +27746,7 @@ workflows_put_git <- function(id, git_ref = NULL, git_branch = NULL, git_path = #' Get the git commits for this Workflow::Workflow -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' #' @return A list containing the following elements: #' \item{commitHash}{string, The SHA of the commit.} @@ -27622,7 +27772,7 @@ workflows_list_git_commits <- function(id) { #' Commit and push a new version of the file -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' @param content string required. The contents to commit to the file. #' @param message string required. A commit message describing the changes being made. #' @param file_hash string required. The full SHA of the file being replaced. @@ -27651,7 +27801,7 @@ workflows_post_git_commits <- function(id, content, message, file_hash) { #' Get file contents at commit_hash -#' @param id integer required. The ID of the object. +#' @param id integer required. The ID of the file. #' @param commit_hash string required. The SHA (full or shortened) of the desired git commit. #' #' @return A list containing the following elements: @@ -27701,11 +27851,11 @@ workflows_get_git_commits <- function(id, commit_hash) { #' \item{state}{string, The state of the workflow. State is "running" if any execution is running, otherwise reflects most recent execution state.} #' \item{schedule}{list, A list containing the following elements: #' \itemize{ -#' \item scheduled boolean, If the object is scheduled -#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday -#' \item scheduledHours array, Hours of the day it is scheduled on -#' \item scheduledMinutes array, Minutes of the day it is scheduled on -#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +#' \item scheduled boolean, If the item is scheduled. +#' \item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +#' \item scheduledHours array, Hours of the day it is scheduled on. +#' \item scheduledMinutes array, Minutes of the day it is scheduled on. +#' \item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. #' }} #' \item{timeZone}{string, The time zone of this workflow.} #' \item{nextExecutionAt}{string, The time of the next scheduled execution.} @@ -27719,8 +27869,8 @@ workflows_get_git_commits <- function(id, commit_hash) { #' \item successOn boolean, If success email notifications are on #' \item failureOn boolean, If failure email notifications are on #' }} -#' \item{archived}{string, The archival status of the requested object(s).} -#' \item{hidden}{boolean, The hidden status of the object.} +#' \item{archived}{string, The archival status of the requested item(s).} +#' \item{hidden}{boolean, The hidden status of the item.} #' \item{createdAt}{string, } #' \item{updatedAt}{string, } #' @export @@ -27786,7 +27936,7 @@ workflows_list_executions <- function(id, limit = NULL, page_num = NULL, order = #' Execute a workflow #' @param id integer required. The ID for the workflow. #' @param target_task string optional. For a reverse workflow, the name of the task to target. -#' @param input list optional. The dictionary of name/value input pairs defined for this execution. +#' @param input list optional. Key-value pairs to send to this execution as inputs. #' @param included_tasks array optional. If specified, executes only the subset of workflow tasks included. #' #' @return A list containing the following elements: @@ -27803,7 +27953,7 @@ workflows_list_executions <- function(id, limit = NULL, page_num = NULL, order = #' \item online boolean, Whether this user is online. #' }} #' \item{definition}{string, The definition of the workflow for this execution.} -#' \item{input}{list, The dictionary of name/value input pairs defined for this execution.} +#' \item{input}{list, Key-value pairs defined for this execution.} #' \item{includedTasks}{array, The subset of workflow tasks selected to execute.} #' \item{tasks}{array, An array containing the following fields: #' \itemize{ @@ -27853,7 +28003,7 @@ workflows_post_executions <- function(id, target_task = NULL, input = NULL, incl #' \item online boolean, Whether this user is online. #' }} #' \item{definition}{string, The definition of the workflow for this execution.} -#' \item{input}{list, The dictionary of name/value input pairs defined for this execution.} +#' \item{input}{list, Key-value pairs defined for this execution.} #' \item{includedTasks}{array, The subset of workflow tasks selected to execute.} #' \item{tasks}{array, An array containing the following fields: #' \itemize{ @@ -27903,7 +28053,7 @@ workflows_get_executions <- function(id, execution_id) { #' \item online boolean, Whether this user is online. #' }} #' \item{definition}{string, The definition of the workflow for this execution.} -#' \item{input}{list, The dictionary of name/value input pairs defined for this execution.} +#' \item{input}{list, Key-value pairs defined for this execution.} #' \item{includedTasks}{array, The subset of workflow tasks selected to execute.} #' \item{tasks}{array, An array containing the following fields: #' \itemize{ @@ -27953,7 +28103,7 @@ workflows_post_executions_cancel <- function(id, execution_id) { #' \item online boolean, Whether this user is online. #' }} #' \item{definition}{string, The definition of the workflow for this execution.} -#' \item{input}{list, The dictionary of name/value input pairs defined for this execution.} +#' \item{input}{list, Key-value pairs defined for this execution.} #' \item{includedTasks}{array, The subset of workflow tasks selected to execute.} #' \item{tasks}{array, An array containing the following fields: #' \itemize{ @@ -28004,7 +28154,7 @@ workflows_post_executions_resume <- function(id, execution_id) { #' \item online boolean, Whether this user is online. #' }} #' \item{definition}{string, The definition of the workflow for this execution.} -#' \item{input}{list, The dictionary of name/value input pairs defined for this execution.} +#' \item{input}{list, Key-value pairs defined for this execution.} #' \item{includedTasks}{array, The subset of workflow tasks selected to execute.} #' \item{tasks}{array, An array containing the following fields: #' \itemize{ diff --git a/R/sysdata.rda b/R/sysdata.rda index f6b71fb5..17f2ce03 100644 Binary files a/R/sysdata.rda and b/R/sysdata.rda differ diff --git a/cran-comments.md b/cran-comments.md index fac50a24..77e88a6d 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -1,6 +1,6 @@ This is a patch release fixing a bug and doc error from changes in the Civis API. -The version has been bumped to 1.4.0. +The version has been bumped to 1.5.0. ## Test environments * local OS X install, R 3.5.0 diff --git a/man/apps_delete_instances_projects.Rd b/man/apps_delete_instances_projects.Rd index 554bf7b7..b0bfb091 100644 --- a/man/apps_delete_instances_projects.Rd +++ b/man/apps_delete_instances_projects.Rd @@ -7,9 +7,9 @@ apps_delete_instances_projects(id, project_id, slug) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} \item{slug}{string required. The slug for the application.} } diff --git a/man/apps_get_instances.Rd b/man/apps_get_instances.Rd index 88c81d82..3e69ec04 100644 --- a/man/apps_get_instances.Rd +++ b/man/apps_get_instances.Rd @@ -26,7 +26,7 @@ A list containing the following elements: \item initials string, This user's initials. \item online boolean, Whether this user is online. }} -\item{projectId}{integer, The id of the project collecting all the objects that belong to this app instance.} +\item{projectId}{integer, The id of the project collecting all the items that belong to this app instance.} \item{authCodeUrl}{string, } \item{apiKey}{string, A Civis API key that can be used by this app instance.} } diff --git a/man/apps_list_instances.Rd b/man/apps_list_instances.Rd index ef09bbd7..54037241 100644 --- a/man/apps_list_instances.Rd +++ b/man/apps_list_instances.Rd @@ -10,7 +10,7 @@ apps_list_instances(slug, archived = NULL, app_release_id = NULL, \arguments{ \item{slug}{string required. The slug for the application.} -\item{archived}{string optional. The archival status of the requested object(s).} +\item{archived}{string optional. The archival status of the requested item(s).} \item{app_release_id}{integer optional. If supplied, return only instances matching this release.} @@ -37,7 +37,7 @@ An array containing the following fields: \item initials string, This user's initials. \item online boolean, Whether this user is online. }} -\item{projectId}{integer, The id of the project collecting all the objects that belong to this app instance.} +\item{projectId}{integer, The id of the project collecting all the items that belong to this app instance.} } \description{ List the instances of a Decision Application diff --git a/man/apps_list_instances_projects.Rd b/man/apps_list_instances_projects.Rd index 1f34e2e0..5517690d 100644 --- a/man/apps_list_instances_projects.Rd +++ b/man/apps_list_instances_projects.Rd @@ -11,7 +11,7 @@ apps_list_instances_projects(id, slug, hidden = NULL) \item{slug}{string required. The slug for the application.} -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} } \value{ An array containing the following fields: @@ -25,7 +25,7 @@ An array containing the following fields: \item online boolean, Whether this user is online. }} \item{name}{string, The name of this project.} -\item{description}{string, A description of the project} +\item{description}{string, A description of the project.} \item{users}{array, An array containing the following fields: \itemize{ \item id integer, The ID of this user. @@ -37,7 +37,7 @@ An array containing the following fields: \item{autoShare}{boolean, } \item{createdAt}{string, } \item{updatedAt}{string, } -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ List the projects a AppInstance belongs to diff --git a/man/apps_list_releases.Rd b/man/apps_list_releases.Rd index 588d6b47..4f49d8c9 100644 --- a/man/apps_list_releases.Rd +++ b/man/apps_list_releases.Rd @@ -10,7 +10,7 @@ apps_list_releases(slug, archived = NULL, limit = NULL, page_num = NULL, \arguments{ \item{slug}{string required. The slug for the application.} -\item{archived}{string optional. The archival status of the requested object(s).} +\item{archived}{string optional. The archival status of the requested item(s).} \item{limit}{integer optional. Number of results to return. Defaults to its maximum of 50.} diff --git a/man/apps_patch_instances.Rd b/man/apps_patch_instances.Rd index 7df65bc3..44f7ec6c 100644 --- a/man/apps_patch_instances.Rd +++ b/man/apps_patch_instances.Rd @@ -28,7 +28,7 @@ A list containing the following elements: \item initials string, This user's initials. \item online boolean, Whether this user is online. }} -\item{projectId}{integer, The id of the project collecting all the objects that belong to this app instance.} +\item{projectId}{integer, The id of the project collecting all the items that belong to this app instance.} \item{authCodeUrl}{string, } \item{apiKey}{string, A Civis API key that can be used by this app instance.} } diff --git a/man/apps_post_instances.Rd b/man/apps_post_instances.Rd index a0a5eff8..f2219070 100644 --- a/man/apps_post_instances.Rd +++ b/man/apps_post_instances.Rd @@ -26,7 +26,7 @@ A list containing the following elements: \item initials string, This user's initials. \item online boolean, Whether this user is online. }} -\item{projectId}{integer, The id of the project collecting all the objects that belong to this app instance.} +\item{projectId}{integer, The id of the project collecting all the items that belong to this app instance.} \item{authCodeUrl}{string, } \item{apiKey}{string, A Civis API key that can be used by this app instance.} } diff --git a/man/apps_put_instances_archive.Rd b/man/apps_put_instances_archive.Rd index f552caf1..6b672991 100644 --- a/man/apps_put_instances_archive.Rd +++ b/man/apps_put_instances_archive.Rd @@ -28,7 +28,7 @@ A list containing the following elements: \item initials string, This user's initials. \item online boolean, Whether this user is online. }} -\item{projectId}{integer, The id of the project collecting all the objects that belong to this app instance.} +\item{projectId}{integer, The id of the project collecting all the items that belong to this app instance.} \item{authCodeUrl}{string, } \item{apiKey}{string, A Civis API key that can be used by this app instance.} } diff --git a/man/apps_put_instances_projects.Rd b/man/apps_put_instances_projects.Rd index 9d9f970b..4b0f32ea 100644 --- a/man/apps_put_instances_projects.Rd +++ b/man/apps_put_instances_projects.Rd @@ -7,9 +7,9 @@ apps_put_instances_projects(id, project_id, slug) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} \item{slug}{string required. The slug for the application.} } diff --git a/man/clusters_get_kubernetes.Rd b/man/clusters_get_kubernetes.Rd index 3ca4fdbc..a9a2cac6 100644 --- a/man/clusters_get_kubernetes.Rd +++ b/man/clusters_get_kubernetes.Rd @@ -20,10 +20,19 @@ A list containing the following elements: \item instanceMaxMemory integer, The amount of memory available to a single instance of that type. \item instanceMaxCpu integer, The number of processor shares available to a single instance of that type. }} -\item{defaultInstanceType}{string, The default EC2 instance type in this cluster.} +\item{defaultInstanceType}{string, Deprecated. The default EC2 instance type in this cluster.} \item{organizationId}{string, The id of this cluster's organization.} \item{organizationSlug}{string, The slug of this cluster's organization.} \item{securityGroupId}{string, The security group to be added to the nodes of this cluster} +\item{clusterPartitions}{array, An array containing the following fields: +\itemize{ +\item clusterPartitionId integer, The ID of this cluster partition. +\item name string, The name of the cluster partition. +\item labels array, Labels associated with this partition. +\item instanceConfigs array, The instances configured for this cluster partition. +\item defaultInstanceConfigId integer, The id of the InstanceConfig that is the default for this partition. +}} +\item{isNatEnabled}{boolean, Whether this cluster needs a NAT gateway or not.} } \description{ Describe a Kubernetes Cluster diff --git a/man/clusters_get_kubernetes_partitions.Rd b/man/clusters_get_kubernetes_partitions.Rd new file mode 100644 index 00000000..36e4b664 --- /dev/null +++ b/man/clusters_get_kubernetes_partitions.Rd @@ -0,0 +1,32 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/generated_client.R +\name{clusters_get_kubernetes_partitions} +\alias{clusters_get_kubernetes_partitions} +\title{Describe a Cluster Partition} +\usage{ +clusters_get_kubernetes_partitions(id, cluster_partition_id) +} +\arguments{ +\item{id}{integer required. The ID of the cluster which this partition belongs to.} + +\item{cluster_partition_id}{integer required. The ID of this cluster partition.} +} +\value{ +A list containing the following elements: +\item{clusterPartitionId}{integer, The ID of this cluster partition.} +\item{name}{string, The name of the cluster partition.} +\item{labels}{array, Labels associated with this partition.} +\item{instanceConfigs}{array, An array containing the following fields: +\itemize{ +\item instanceConfigId integer, The ID of this InstanceConfig. +\item instanceType string, An EC2 instance type. Possible values include t2.large, m4.xlarge, m4.2xlarge, and p2.xlarge. +\item minInstances integer, The minimum number of instances of that type in this cluster. +\item maxInstances integer, The maximum number of instances of that type in this cluster. +\item instanceMaxMemory number, The amount of memory (RAM) available to a single instance of that type in megabytes. +\item instanceMaxCpu number, The number of processor shares available to a single instance of that type in millicores. +}} +\item{defaultInstanceConfigId}{integer, The id of the InstanceConfig that is the default for this partition.} +} +\description{ +Describe a Cluster Partition +} diff --git a/man/clusters_list_kubernetes.Rd b/man/clusters_list_kubernetes.Rd index e9472ece..28760e24 100644 --- a/man/clusters_list_kubernetes.Rd +++ b/man/clusters_list_kubernetes.Rd @@ -29,10 +29,19 @@ An array containing the following fields: \item instanceMaxMemory integer, The amount of memory available to a single instance of that type. \item instanceMaxCpu integer, The number of processor shares available to a single instance of that type. }} -\item{defaultInstanceType}{string, The default EC2 instance type in this cluster.} +\item{defaultInstanceType}{string, Deprecated. The default EC2 instance type in this cluster.} \item{organizationId}{string, The id of this cluster's organization.} \item{organizationSlug}{string, The slug of this cluster's organization.} \item{securityGroupId}{string, The security group to be added to the nodes of this cluster} +\item{clusterPartitions}{array, An array containing the following fields: +\itemize{ +\item clusterPartitionId integer, The ID of this cluster partition. +\item name string, The name of the cluster partition. +\item labels array, Labels associated with this partition. +\item instanceConfigs array, The instances configured for this cluster partition. +\item defaultInstanceConfigId integer, The id of the InstanceConfig that is the default for this partition. +}} +\item{isNatEnabled}{boolean, Whether this cluster needs a NAT gateway or not.} } \description{ List Kubernetes Clusters diff --git a/man/clusters_list_kubernetes_partitions.Rd b/man/clusters_list_kubernetes_partitions.Rd new file mode 100644 index 00000000..d7d12d3f --- /dev/null +++ b/man/clusters_list_kubernetes_partitions.Rd @@ -0,0 +1,30 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/generated_client.R +\name{clusters_list_kubernetes_partitions} +\alias{clusters_list_kubernetes_partitions} +\title{List Cluster Partitions for given cluster} +\usage{ +clusters_list_kubernetes_partitions(id) +} +\arguments{ +\item{id}{integer required. The ID of this cluster.} +} +\value{ +An array containing the following fields: +\item{clusterPartitionId}{integer, The ID of this cluster partition.} +\item{name}{string, The name of the cluster partition.} +\item{labels}{array, Labels associated with this partition.} +\item{instanceConfigs}{array, An array containing the following fields: +\itemize{ +\item instanceConfigId integer, The ID of this InstanceConfig. +\item instanceType string, An EC2 instance type. Possible values include t2.large, m4.xlarge, m4.2xlarge, and p2.xlarge. +\item minInstances integer, The minimum number of instances of that type in this cluster. +\item maxInstances integer, The maximum number of instances of that type in this cluster. +\item instanceMaxMemory number, The amount of memory (RAM) available to a single instance of that type in megabytes. +\item instanceMaxCpu number, The number of processor shares available to a single instance of that type in millicores. +}} +\item{defaultInstanceConfigId}{integer, The id of the InstanceConfig that is the default for this partition.} +} +\description{ +List Cluster Partitions for given cluster +} diff --git a/man/clusters_list_workers_active_jobs.Rd b/man/clusters_list_workers_active_jobs.Rd index 3f879ab4..9166ea4a 100644 --- a/man/clusters_list_workers_active_jobs.Rd +++ b/man/clusters_list_workers_active_jobs.Rd @@ -36,7 +36,7 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{requiredCpu}{integer, The CPU shares required by the script.} \item{requiredDiskSpace}{integer, The disk space in GB required by the script.} \item{requiredMemory}{integer, The memory in MB required by the script.} diff --git a/man/clusters_list_workers_queued_jobs.Rd b/man/clusters_list_workers_queued_jobs.Rd index 34f63dca..4854a8d9 100644 --- a/man/clusters_list_workers_queued_jobs.Rd +++ b/man/clusters_list_workers_queued_jobs.Rd @@ -36,7 +36,7 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{requiredCpu}{integer, The CPU shares required by the script.} \item{requiredDiskSpace}{integer, The disk space in GB required by the script.} \item{requiredMemory}{integer, The memory in MB required by the script.} diff --git a/man/credentials_get.Rd b/man/credentials_get.Rd index 77db44ef..9d3d91ee 100644 --- a/man/credentials_get.Rd +++ b/man/credentials_get.Rd @@ -19,6 +19,7 @@ A list containing the following elements: \item{owner}{string, The name of the user who this credential belongs to.} \item{remoteHostId}{integer, The ID of the remote host associated with this credential.} \item{remoteHostName}{string, The name of the remote host associated with this credential.} +\item{state}{string, The U.S. state for the credential. Only for VAN credentials.} \item{createdAt}{string, The creation time for this credential.} \item{updatedAt}{string, The last modification time for this credential.} } diff --git a/man/credentials_list.Rd b/man/credentials_list.Rd index b3f22ce9..8c3a0e4f 100644 --- a/man/credentials_list.Rd +++ b/man/credentials_list.Rd @@ -30,6 +30,7 @@ An array containing the following fields: \item{owner}{string, The name of the user who this credential belongs to.} \item{remoteHostId}{integer, The ID of the remote host associated with this credential.} \item{remoteHostName}{string, The name of the remote host associated with this credential.} +\item{state}{string, The U.S. state for the credential. Only for VAN credentials.} \item{createdAt}{string, The creation time for this credential.} \item{updatedAt}{string, The last modification time for this credential.} } diff --git a/man/credentials_post.Rd b/man/credentials_post.Rd index 409bc6f8..092ed45c 100644 --- a/man/credentials_post.Rd +++ b/man/credentials_post.Rd @@ -5,7 +5,7 @@ \title{Create a credential} \usage{ credentials_post(type, username, password, name = NULL, description = NULL, - remote_host_id = NULL, system_credential = NULL) + remote_host_id = NULL, state = NULL, system_credential = NULL) } \arguments{ \item{type}{string required.} @@ -20,6 +20,8 @@ credentials_post(type, username, password, name = NULL, description = NULL, \item{remote_host_id}{integer optional. The ID of the remote host associated with the credential.} +\item{state}{string optional. The U.S. state for the credential. Only for VAN credentials.} + \item{system_credential}{boolean optional.} } \value{ @@ -32,6 +34,7 @@ A list containing the following elements: \item{owner}{string, The name of the user who this credential belongs to.} \item{remoteHostId}{integer, The ID of the remote host associated with this credential.} \item{remoteHostName}{string, The name of the remote host associated with this credential.} +\item{state}{string, The U.S. state for the credential. Only for VAN credentials.} \item{createdAt}{string, The creation time for this credential.} \item{updatedAt}{string, The last modification time for this credential.} } diff --git a/man/credentials_post_authenticate.Rd b/man/credentials_post_authenticate.Rd index ad0a8772..3f463f59 100644 --- a/man/credentials_post_authenticate.Rd +++ b/man/credentials_post_authenticate.Rd @@ -9,7 +9,7 @@ credentials_post_authenticate(url, remote_host_type, username, password) \arguments{ \item{url}{string required. The URL to your host.} -\item{remote_host_type}{string required. The type of remote host. One of: RemoteHostTypes::Bitbucket, RemoteHostTypes::Ftp, RemoteHostTypes::Github, RemoteHostTypes::GoogleDoc, RemoteHostTypes::JDBC, RemoteHostTypes::Redshift, RemoteHostTypes::Salesforce, and RemoteHostTypes::Van} +\item{remote_host_type}{string required. The type of remote host. One of: RemoteHostTypes::Bitbucket, RemoteHostTypes::Ftp, RemoteHostTypes::Github, RemoteHostTypes::GoogleDoc, RemoteHostTypes::JDBC, RemoteHostTypes::Postgres, RemoteHostTypes::Redshift, RemoteHostTypes::Salesforce, and RemoteHostTypes::Van} \item{username}{string required. The username for the credential.} @@ -25,6 +25,7 @@ A list containing the following elements: \item{owner}{string, The name of the user who this credential belongs to.} \item{remoteHostId}{integer, The ID of the remote host associated with this credential.} \item{remoteHostName}{string, The name of the remote host associated with this credential.} +\item{state}{string, The U.S. state for the credential. Only for VAN credentials.} \item{createdAt}{string, The creation time for this credential.} \item{updatedAt}{string, The last modification time for this credential.} } diff --git a/man/credentials_put.Rd b/man/credentials_put.Rd index edb11ee5..c014e418 100644 --- a/man/credentials_put.Rd +++ b/man/credentials_put.Rd @@ -5,7 +5,8 @@ \title{Update an existing credential} \usage{ credentials_put(id, type, username, password, name = NULL, - description = NULL, remote_host_id = NULL, system_credential = NULL) + description = NULL, remote_host_id = NULL, state = NULL, + system_credential = NULL) } \arguments{ \item{id}{integer required. The ID of the credential.} @@ -22,6 +23,8 @@ credentials_put(id, type, username, password, name = NULL, \item{remote_host_id}{integer optional. The ID of the remote host associated with the credential.} +\item{state}{string optional. The U.S. state for the credential. Only for VAN credentials.} + \item{system_credential}{boolean optional.} } \value{ @@ -34,6 +37,7 @@ A list containing the following elements: \item{owner}{string, The name of the user who this credential belongs to.} \item{remoteHostId}{integer, The ID of the remote host associated with this credential.} \item{remoteHostName}{string, The name of the remote host associated with this credential.} +\item{state}{string, The U.S. state for the credential. Only for VAN credentials.} \item{createdAt}{string, The creation time for this credential.} \item{updatedAt}{string, The last modification time for this credential.} } diff --git a/man/enhancements_delete_cass_ncoa_projects.Rd b/man/enhancements_delete_cass_ncoa_projects.Rd index f70c478d..bf6c698b 100644 --- a/man/enhancements_delete_cass_ncoa_projects.Rd +++ b/man/enhancements_delete_cass_ncoa_projects.Rd @@ -7,9 +7,9 @@ enhancements_delete_cass_ncoa_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/enhancements_delete_person_matching_projects.Rd b/man/enhancements_delete_person_matching_projects.Rd index a561876f..43b23c71 100644 --- a/man/enhancements_delete_person_matching_projects.Rd +++ b/man/enhancements_delete_person_matching_projects.Rd @@ -7,9 +7,9 @@ enhancements_delete_person_matching_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/enhancements_get_cass_ncoa.Rd b/man/enhancements_get_cass_ncoa.Rd index 77ad265d..89aa1a88 100644 --- a/man/enhancements_get_cass_ncoa.Rd +++ b/man/enhancements_get_cass_ncoa.Rd @@ -12,7 +12,7 @@ enhancements_get_cass_ncoa(id) \value{ A list containing the following elements: \item{id}{integer, The ID for the enhancement.} -\item{name}{string, The name of the enhancement.} +\item{name}{string, The name of the enhancement job.} \item{type}{string, The type of the enhancement (e.g CASS-NCOA)} \item{createdAt}{string, The time this enhancement was created.} \item{updatedAt}{string, The time the enhancement was last updated.} @@ -27,11 +27,11 @@ A list containing the following elements: \item{state}{string, The status of the enhancement's last run} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{parentId}{integer, Parent ID that triggers this enhancement.} \item{notifications}{list, A list containing the following elements: @@ -78,7 +78,7 @@ A list containing the following elements: \item{ncoaCredentialId}{integer, Credential to use when performing NCOA updates. Required if 'performNcoa' is true.} \item{outputLevel}{string, The set of fields persisted by a CASS or NCOA enhancement.For CASS enhancements, one of 'cass' or 'all.'For NCOA enhancements, one of 'cass', 'ncoa' , 'coalesced' or 'all'.By default, all fields will be returned.} \item{limitingSQL}{string, The limiting sql.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ Get a CASS/NCOA Enhancement diff --git a/man/enhancements_list.Rd b/man/enhancements_list.Rd index fb5fc98f..3a94871e 100644 --- a/man/enhancements_list.Rd +++ b/man/enhancements_list.Rd @@ -9,13 +9,13 @@ enhancements_list(type = NULL, author = NULL, status = NULL, order_dir = NULL) } \arguments{ -\item{type}{string optional. If specified, return objects of these types.} +\item{type}{string optional. If specified, return items of these types.} -\item{author}{string optional. If specified, return objects from this author. Must use user IDs. A comma separated list of IDs is also accepted to return objects from multiple authors.} +\item{author}{string optional. If specified, return items from this author. Must use user IDs. A comma separated list of IDs is also accepted to return items from multiple authors.} -\item{status}{string optional. If specified, returns objects with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'.} +\item{status}{string optional. If specified, returns items with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'.} -\item{archived}{string optional. The archival status of the requested object(s).} +\item{archived}{string optional. The archival status of the requested item(s).} \item{limit}{integer optional. Number of results to return. Defaults to 20. Maximum allowed is 50.} @@ -28,7 +28,7 @@ enhancements_list(type = NULL, author = NULL, status = NULL, \value{ An array containing the following fields: \item{id}{integer, The ID for the enhancement.} -\item{name}{string, The name of the enhancement.} +\item{name}{string, The name of the enhancement job.} \item{type}{string, The type of the enhancement (e.g CASS-NCOA)} \item{createdAt}{string, The time this enhancement was created.} \item{updatedAt}{string, The time the enhancement was last updated.} @@ -41,7 +41,7 @@ An array containing the following fields: \item online boolean, Whether this user is online. }} \item{state}{string, The status of the enhancement's last run} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ List Enhancements diff --git a/man/enhancements_list_cass_ncoa_projects.Rd b/man/enhancements_list_cass_ncoa_projects.Rd index 2d5224f9..58560a6d 100644 --- a/man/enhancements_list_cass_ncoa_projects.Rd +++ b/man/enhancements_list_cass_ncoa_projects.Rd @@ -9,7 +9,7 @@ enhancements_list_cass_ncoa_projects(id, hidden = NULL) \arguments{ \item{id}{integer required. The ID of the resource.} -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} } \value{ An array containing the following fields: @@ -23,7 +23,7 @@ An array containing the following fields: \item online boolean, Whether this user is online. }} \item{name}{string, The name of this project.} -\item{description}{string, A description of the project} +\item{description}{string, A description of the project.} \item{users}{array, An array containing the following fields: \itemize{ \item id integer, The ID of this user. @@ -35,7 +35,7 @@ An array containing the following fields: \item{autoShare}{boolean, } \item{createdAt}{string, } \item{updatedAt}{string, } -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ List the projects a JobTypes::CassNcoa belongs to diff --git a/man/enhancements_list_cass_ncoa_runs_outputs.Rd b/man/enhancements_list_cass_ncoa_runs_outputs.Rd index 5ea38766..81d32f76 100644 --- a/man/enhancements_list_cass_ncoa_runs_outputs.Rd +++ b/man/enhancements_list_cass_ncoa_runs_outputs.Rd @@ -23,9 +23,9 @@ enhancements_list_cass_ncoa_runs_outputs(id, run_id, limit = NULL, \value{ An array containing the following fields: \item{objectType}{string, The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue} -\item{objectId}{integer, The ID of the output object.} -\item{name}{string, The name of the output object.} -\item{link}{string, The link to retrieve the output object.} +\item{objectId}{integer, The ID of the output.} +\item{name}{string, The name of the output.} +\item{link}{string, The hypermedia link to the output.} \item{value}{string, } } \description{ diff --git a/man/enhancements_list_field_mapping.Rd b/man/enhancements_list_field_mapping.Rd new file mode 100644 index 00000000..84b98516 --- /dev/null +++ b/man/enhancements_list_field_mapping.Rd @@ -0,0 +1,16 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/generated_client.R +\name{enhancements_list_field_mapping} +\alias{enhancements_list_field_mapping} +\title{List the fields in a field mapping for Civis Data Match, Data Unification, and Table Deduplication jobs} +\usage{ +enhancements_list_field_mapping() +} +\value{ +An array containing the following fields: +\item{field}{string, The name of the field.} +\item{description}{string, The description of the field.} +} +\description{ +List the fields in a field mapping for Civis Data Match, Data Unification, and Table Deduplication jobs +} diff --git a/man/enhancements_list_person_matching_projects.Rd b/man/enhancements_list_person_matching_projects.Rd index 5c5c0381..118a92df 100644 --- a/man/enhancements_list_person_matching_projects.Rd +++ b/man/enhancements_list_person_matching_projects.Rd @@ -9,7 +9,7 @@ enhancements_list_person_matching_projects(id, hidden = NULL) \arguments{ \item{id}{integer required. The ID of the resource.} -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} } \value{ An array containing the following fields: @@ -23,7 +23,7 @@ An array containing the following fields: \item online boolean, Whether this user is online. }} \item{name}{string, The name of this project.} -\item{description}{string, A description of the project} +\item{description}{string, A description of the project.} \item{users}{array, An array containing the following fields: \itemize{ \item id integer, The ID of this user. @@ -35,7 +35,7 @@ An array containing the following fields: \item{autoShare}{boolean, } \item{createdAt}{string, } \item{updatedAt}{string, } -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ List the projects a container docker belongs to diff --git a/man/enhancements_patch_cass_ncoa.Rd b/man/enhancements_patch_cass_ncoa.Rd index a8c5a480..07e79bcd 100644 --- a/man/enhancements_patch_cass_ncoa.Rd +++ b/man/enhancements_patch_cass_ncoa.Rd @@ -13,15 +13,15 @@ enhancements_patch_cass_ncoa(id, name = NULL, schedule = NULL, \arguments{ \item{id}{integer required. The ID for the enhancement.} -\item{name}{string optional. The name of the enhancement.} +\item{name}{string optional. The name of the enhancement job.} \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{parent_id}{integer optional. Parent ID that triggers this enhancement.} @@ -74,7 +74,7 @@ enhancements_patch_cass_ncoa(id, name = NULL, schedule = NULL, \value{ A list containing the following elements: \item{id}{integer, The ID for the enhancement.} -\item{name}{string, The name of the enhancement.} +\item{name}{string, The name of the enhancement job.} \item{type}{string, The type of the enhancement (e.g CASS-NCOA)} \item{createdAt}{string, The time this enhancement was created.} \item{updatedAt}{string, The time the enhancement was last updated.} @@ -89,11 +89,11 @@ A list containing the following elements: \item{state}{string, The status of the enhancement's last run} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{parentId}{integer, Parent ID that triggers this enhancement.} \item{notifications}{list, A list containing the following elements: @@ -140,7 +140,7 @@ A list containing the following elements: \item{ncoaCredentialId}{integer, Credential to use when performing NCOA updates. Required if 'performNcoa' is true.} \item{outputLevel}{string, The set of fields persisted by a CASS or NCOA enhancement.For CASS enhancements, one of 'cass' or 'all.'For NCOA enhancements, one of 'cass', 'ncoa' , 'coalesced' or 'all'.By default, all fields will be returned.} \item{limitingSQL}{string, The limiting sql.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ Update some attributes of this CASS/NCOA Enhancement diff --git a/man/enhancements_post_cass_ncoa.Rd b/man/enhancements_post_cass_ncoa.Rd index 270222b2..c7afcb10 100644 --- a/man/enhancements_post_cass_ncoa.Rd +++ b/man/enhancements_post_cass_ncoa.Rd @@ -10,7 +10,7 @@ enhancements_post_cass_ncoa(name, source, schedule = NULL, parent_id = NULL, ncoa_credential_id = NULL, output_level = NULL, limiting_sql = NULL) } \arguments{ -\item{name}{string required. The name of the enhancement.} +\item{name}{string required. The name of the enhancement job.} \item{source}{list required. A list containing the following elements: \itemize{ @@ -19,11 +19,11 @@ enhancements_post_cass_ncoa(name, source, schedule = NULL, parent_id = NULL, \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{parent_id}{integer optional. Parent ID that triggers this enhancement.} @@ -71,7 +71,7 @@ enhancements_post_cass_ncoa(name, source, schedule = NULL, parent_id = NULL, \value{ A list containing the following elements: \item{id}{integer, The ID for the enhancement.} -\item{name}{string, The name of the enhancement.} +\item{name}{string, The name of the enhancement job.} \item{type}{string, The type of the enhancement (e.g CASS-NCOA)} \item{createdAt}{string, The time this enhancement was created.} \item{updatedAt}{string, The time the enhancement was last updated.} @@ -86,11 +86,11 @@ A list containing the following elements: \item{state}{string, The status of the enhancement's last run} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{parentId}{integer, Parent ID that triggers this enhancement.} \item{notifications}{list, A list containing the following elements: @@ -137,7 +137,7 @@ A list containing the following elements: \item{ncoaCredentialId}{integer, Credential to use when performing NCOA updates. Required if 'performNcoa' is true.} \item{outputLevel}{string, The set of fields persisted by a CASS or NCOA enhancement.For CASS enhancements, one of 'cass' or 'all.'For NCOA enhancements, one of 'cass', 'ncoa' , 'coalesced' or 'all'.By default, all fields will be returned.} \item{limitingSQL}{string, The limiting sql.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ Create a CASS/NCOA Enhancement diff --git a/man/enhancements_put_cass_ncoa.Rd b/man/enhancements_put_cass_ncoa.Rd index 60079f38..aca217e8 100644 --- a/man/enhancements_put_cass_ncoa.Rd +++ b/man/enhancements_put_cass_ncoa.Rd @@ -13,7 +13,7 @@ enhancements_put_cass_ncoa(id, name, source, schedule = NULL, \arguments{ \item{id}{integer required. The ID for the enhancement.} -\item{name}{string required. The name of the enhancement.} +\item{name}{string required. The name of the enhancement job.} \item{source}{list required. A list containing the following elements: \itemize{ @@ -22,11 +22,11 @@ enhancements_put_cass_ncoa(id, name, source, schedule = NULL, \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{parent_id}{integer optional. Parent ID that triggers this enhancement.} @@ -74,7 +74,7 @@ enhancements_put_cass_ncoa(id, name, source, schedule = NULL, \value{ A list containing the following elements: \item{id}{integer, The ID for the enhancement.} -\item{name}{string, The name of the enhancement.} +\item{name}{string, The name of the enhancement job.} \item{type}{string, The type of the enhancement (e.g CASS-NCOA)} \item{createdAt}{string, The time this enhancement was created.} \item{updatedAt}{string, The time the enhancement was last updated.} @@ -89,11 +89,11 @@ A list containing the following elements: \item{state}{string, The status of the enhancement's last run} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{parentId}{integer, Parent ID that triggers this enhancement.} \item{notifications}{list, A list containing the following elements: @@ -140,7 +140,7 @@ A list containing the following elements: \item{ncoaCredentialId}{integer, Credential to use when performing NCOA updates. Required if 'performNcoa' is true.} \item{outputLevel}{string, The set of fields persisted by a CASS or NCOA enhancement.For CASS enhancements, one of 'cass' or 'all.'For NCOA enhancements, one of 'cass', 'ncoa' , 'coalesced' or 'all'.By default, all fields will be returned.} \item{limitingSQL}{string, The limiting sql.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ Replace all attributes of this CASS/NCOA Enhancement diff --git a/man/enhancements_put_cass_ncoa_archive.Rd b/man/enhancements_put_cass_ncoa_archive.Rd index 9edd210c..7972272c 100644 --- a/man/enhancements_put_cass_ncoa_archive.Rd +++ b/man/enhancements_put_cass_ncoa_archive.Rd @@ -14,7 +14,7 @@ enhancements_put_cass_ncoa_archive(id, status) \value{ A list containing the following elements: \item{id}{integer, The ID for the enhancement.} -\item{name}{string, The name of the enhancement.} +\item{name}{string, The name of the enhancement job.} \item{type}{string, The type of the enhancement (e.g CASS-NCOA)} \item{createdAt}{string, The time this enhancement was created.} \item{updatedAt}{string, The time the enhancement was last updated.} @@ -29,11 +29,11 @@ A list containing the following elements: \item{state}{string, The status of the enhancement's last run} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{parentId}{integer, Parent ID that triggers this enhancement.} \item{notifications}{list, A list containing the following elements: @@ -80,7 +80,7 @@ A list containing the following elements: \item{ncoaCredentialId}{integer, Credential to use when performing NCOA updates. Required if 'performNcoa' is true.} \item{outputLevel}{string, The set of fields persisted by a CASS or NCOA enhancement.For CASS enhancements, one of 'cass' or 'all.'For NCOA enhancements, one of 'cass', 'ncoa' , 'coalesced' or 'all'.By default, all fields will be returned.} \item{limitingSQL}{string, The limiting sql.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ Update the archive status of this object diff --git a/man/enhancements_put_cass_ncoa_projects.Rd b/man/enhancements_put_cass_ncoa_projects.Rd index d808ad0d..0f01de47 100644 --- a/man/enhancements_put_cass_ncoa_projects.Rd +++ b/man/enhancements_put_cass_ncoa_projects.Rd @@ -7,9 +7,9 @@ enhancements_put_cass_ncoa_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/enhancements_put_person_matching_archive.Rd b/man/enhancements_put_person_matching_archive.Rd index 290b641f..202e48bc 100644 --- a/man/enhancements_put_person_matching_archive.Rd +++ b/man/enhancements_put_person_matching_archive.Rd @@ -14,7 +14,7 @@ enhancements_put_person_matching_archive(id, status) \value{ A list containing the following elements: \item{id}{integer, The ID for the enhancement.} -\item{name}{string, The name of the enhancement.} +\item{name}{string, The name of the enhancement job.} \item{type}{string, The type of the enhancement (e.g CASS-NCOA)} \item{createdAt}{string, The time this enhancement was created.} \item{updatedAt}{string, The time the enhancement was last updated.} @@ -29,11 +29,11 @@ A list containing the following elements: \item{state}{string, The status of the enhancement's last run} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{parentId}{integer, Parent ID that triggers this enhancement.} \item{notifications}{list, A list containing the following elements: diff --git a/man/enhancements_put_person_matching_projects.Rd b/man/enhancements_put_person_matching_projects.Rd index dae33805..a8f45a6f 100644 --- a/man/enhancements_put_person_matching_projects.Rd +++ b/man/enhancements_put_person_matching_projects.Rd @@ -7,9 +7,9 @@ enhancements_put_person_matching_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/exports_list.Rd b/man/exports_list.Rd index 25899a06..d019ab67 100644 --- a/man/exports_list.Rd +++ b/man/exports_list.Rd @@ -15,9 +15,9 @@ exports_list(type = NULL, author = NULL, status = NULL, hidden = NULL, \item{status}{string optional. If specified, returns export with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'.} -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} -\item{archived}{string optional. The archival status of the requested object(s).} +\item{archived}{string optional. The archival status of the requested item(s).} \item{limit}{integer optional. Number of results to return. Defaults to 20. Maximum allowed is 50.} diff --git a/man/files_delete_projects.Rd b/man/files_delete_projects.Rd index 552317d6..a998f8dc 100644 --- a/man/files_delete_projects.Rd +++ b/man/files_delete_projects.Rd @@ -7,9 +7,9 @@ files_delete_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/files_get.Rd b/man/files_get.Rd index 39b48a1a..b75e1200 100644 --- a/man/files_get.Rd +++ b/man/files_get.Rd @@ -7,7 +7,7 @@ files_get(id, link_expires_at = NULL, inline = NULL) } \arguments{ -\item{id}{integer required. The ID of the file object.} +\item{id}{integer required. The ID of the file.} \item{link_expires_at}{string optional. The date and time the download link will expire. Must be a time between now and 36 hours from now. Defaults to 30 minutes from now.} @@ -15,7 +15,7 @@ files_get(id, link_expires_at = NULL, inline = NULL) } \value{ A list containing the following elements: -\item{id}{integer, The ID of the file object.} +\item{id}{integer, The ID of the file.} \item{name}{string, The file name.} \item{createdAt}{string, The date and time the file was created.} \item{fileSize}{integer, The file size.} diff --git a/man/files_list_projects.Rd b/man/files_list_projects.Rd index c035be7a..d920cfdd 100644 --- a/man/files_list_projects.Rd +++ b/man/files_list_projects.Rd @@ -9,7 +9,7 @@ files_list_projects(id, hidden = NULL) \arguments{ \item{id}{integer required. The ID of the resource.} -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} } \value{ An array containing the following fields: @@ -23,7 +23,7 @@ An array containing the following fields: \item online boolean, Whether this user is online. }} \item{name}{string, The name of this project.} -\item{description}{string, A description of the project} +\item{description}{string, A description of the project.} \item{users}{array, An array containing the following fields: \itemize{ \item id integer, The ID of this user. @@ -35,7 +35,7 @@ An array containing the following fields: \item{autoShare}{boolean, } \item{createdAt}{string, } \item{updatedAt}{string, } -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ List the projects a Data::S3File belongs to diff --git a/man/files_post.Rd b/man/files_post.Rd index 24ab0d7e..ccb0a932 100644 --- a/man/files_post.Rd +++ b/man/files_post.Rd @@ -13,7 +13,7 @@ files_post(name, expires_at = NULL) } \value{ A list containing the following elements: -\item{id}{integer, The ID of the file object.} +\item{id}{integer, The ID of the file.} \item{name}{string, The file name.} \item{createdAt}{string, The date and time the file was created.} \item{fileSize}{integer, The file size.} diff --git a/man/files_post_multipart.Rd b/man/files_post_multipart.Rd index d71a2433..c7b9beb3 100644 --- a/man/files_post_multipart.Rd +++ b/man/files_post_multipart.Rd @@ -15,7 +15,7 @@ files_post_multipart(name, num_parts, expires_at = NULL) } \value{ A list containing the following elements: -\item{id}{integer, The ID of the file object.} +\item{id}{integer, The ID of the file.} \item{name}{string, The file name.} \item{createdAt}{string, The date and time the file was created.} \item{fileSize}{integer, The file size.} diff --git a/man/files_post_multipart_complete.Rd b/man/files_post_multipart_complete.Rd index 3eed431b..e389a433 100644 --- a/man/files_post_multipart_complete.Rd +++ b/man/files_post_multipart_complete.Rd @@ -7,7 +7,7 @@ files_post_multipart_complete(id) } \arguments{ -\item{id}{integer required. The ID of the file object.} +\item{id}{integer required. The ID of the file.} } \value{ An empty HTTP response diff --git a/man/files_put_projects.Rd b/man/files_put_projects.Rd index 340132cb..67b4b1f4 100644 --- a/man/files_put_projects.Rd +++ b/man/files_put_projects.Rd @@ -7,9 +7,9 @@ files_put_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/imports_delete_projects.Rd b/man/imports_delete_projects.Rd index 02cf4dda..0ba1f999 100644 --- a/man/imports_delete_projects.Rd +++ b/man/imports_delete_projects.Rd @@ -7,9 +7,9 @@ imports_delete_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/imports_get.Rd b/man/imports_get.Rd index 7d21a97a..86d9b87d 100644 --- a/man/imports_get.Rd +++ b/man/imports_get.Rd @@ -29,11 +29,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -89,8 +89,8 @@ A list containing the following elements: }} \item{nextRunAt}{string, The time of the next scheduled run.} \item{timeZone}{string, The time zone of this import.} -\item{hidden}{boolean, The hidden status of the object.} -\item{archived}{string, The archival status of the requested object(s).} +\item{hidden}{boolean, The hidden status of the item.} +\item{archived}{string, The archival status of the requested item(s).} } \description{ Get details about an import diff --git a/man/imports_get_batches.Rd b/man/imports_get_batches.Rd index 225945c1..294cb286 100644 --- a/man/imports_get_batches.Rd +++ b/man/imports_get_batches.Rd @@ -19,7 +19,7 @@ A list containing the following elements: \item{startedAt}{string, The time the last run started at.} \item{finishedAt}{string, The time the last run completed.} \item{error}{string, The error returned by the run, if any.} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} } \description{ Get details about a batch import diff --git a/man/imports_list.Rd b/man/imports_list.Rd index ae401ddb..6448fef1 100644 --- a/man/imports_list.Rd +++ b/man/imports_list.Rd @@ -17,9 +17,9 @@ imports_list(type = NULL, author = NULL, destination = NULL, \item{status}{string optional. If specified, returns imports with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'.} -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} -\item{archived}{string optional. The archival status of the requested object(s).} +\item{archived}{string optional. The archival status of the requested item(s).} \item{limit}{integer optional. Number of results to return. Defaults to 20. Maximum allowed is 50.} @@ -49,11 +49,11 @@ An array containing the following fields: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{id}{integer, The ID for the import.} \item{isOutbound}{boolean, } @@ -79,7 +79,7 @@ An array containing the following fields: \item online boolean, Whether this user is online. }} \item{timeZone}{string, The time zone of this import.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ List diff --git a/man/imports_list_batches.Rd b/man/imports_list_batches.Rd index 556ca587..d3fe4e73 100644 --- a/man/imports_list_batches.Rd +++ b/man/imports_list_batches.Rd @@ -8,7 +8,7 @@ imports_list_batches(hidden = NULL, limit = NULL, page_num = NULL, order = NULL, order_dir = NULL) } \arguments{ -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} \item{limit}{integer optional. Number of results to return. Defaults to 20. Maximum allowed is 50.} diff --git a/man/imports_list_projects.Rd b/man/imports_list_projects.Rd index 0f7a05ab..38d8b2fb 100644 --- a/man/imports_list_projects.Rd +++ b/man/imports_list_projects.Rd @@ -9,7 +9,7 @@ imports_list_projects(id, hidden = NULL) \arguments{ \item{id}{integer required. The ID of the resource.} -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} } \value{ An array containing the following fields: @@ -23,7 +23,7 @@ An array containing the following fields: \item online boolean, Whether this user is online. }} \item{name}{string, The name of this project.} -\item{description}{string, A description of the project} +\item{description}{string, A description of the project.} \item{users}{array, An array containing the following fields: \itemize{ \item id integer, The ID of this user. @@ -35,7 +35,7 @@ An array containing the following fields: \item{autoShare}{boolean, } \item{createdAt}{string, } \item{updatedAt}{string, } -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ List the projects a JobTypes::Import belongs to diff --git a/man/imports_post.Rd b/man/imports_post.Rd index ff54e7c2..b7b50186 100644 --- a/man/imports_post.Rd +++ b/man/imports_post.Rd @@ -31,11 +31,11 @@ imports_post(name, sync_type, is_outbound, source = NULL, \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list optional. A list containing the following elements: @@ -58,7 +58,7 @@ imports_post(name, sync_type, is_outbound, source = NULL, \item{time_zone}{string optional. The time zone of this import.} -\item{hidden}{boolean optional. The hidden status of the object.} +\item{hidden}{boolean optional. The hidden status of the item.} } \value{ A list containing the following elements: @@ -80,11 +80,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -140,8 +140,8 @@ A list containing the following elements: }} \item{nextRunAt}{string, The time of the next scheduled run.} \item{timeZone}{string, The time zone of this import.} -\item{hidden}{boolean, The hidden status of the object.} -\item{archived}{string, The archival status of the requested object(s).} +\item{hidden}{boolean, The hidden status of the item.} +\item{archived}{string, The archival status of the requested item(s).} } \description{ Create a new import configuration diff --git a/man/imports_post_batches.Rd b/man/imports_post_batches.Rd index ad229ff8..169cbbb7 100644 --- a/man/imports_post_batches.Rd +++ b/man/imports_post_batches.Rd @@ -25,7 +25,7 @@ imports_post_batches(file_ids, schema, table, remote_host_id, credential_id, \item{compression}{string optional. The type of compression. Valid arguments are "gzip", "zip", and "none". If unspecified, defaults to "gzip".} -\item{hidden}{boolean optional. The hidden status of the object.} +\item{hidden}{boolean optional. The hidden status of the item.} } \value{ A list containing the following elements: @@ -37,7 +37,7 @@ A list containing the following elements: \item{startedAt}{string, The time the last run started at.} \item{finishedAt}{string, The time the last run completed.} \item{error}{string, The error returned by the run, if any.} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} } \description{ Upload multiple files to Redshift diff --git a/man/imports_post_files.Rd b/man/imports_post_files.Rd index 19b49e15..331904c2 100644 --- a/man/imports_post_files.Rd +++ b/man/imports_post_files.Rd @@ -37,13 +37,13 @@ imports_post_files(schema, name, remote_host_id, credential_id, \item{multipart}{boolean optional. If true, the upload URI will require a `multipart/form-data` POST request. Defaults to false.} -\item{hidden}{boolean optional. The hidden status of the object.} +\item{hidden}{boolean optional. The hidden status of the item.} } \value{ A list containing the following elements: \item{id}{integer, The id of the import.} -\item{uploadUri}{string, The URI which may be used to upload a tabular file for import. You must use this URI to upload the file you wish imported and then inform the Civis API when your upload is complete using the URI given by the runUri field of this reponse.} -\item{runUri}{string, The URI to POST to once the file upload is complete. After uploading the file using the URI given in the uploadUri attribute of the reponse, POST to this URI to initiate the import of your uploaded file into the platform.} +\item{uploadUri}{string, The URI which may be used to upload a tabular file for import. You must use this URI to upload the file you wish imported and then inform the Civis API when your upload is complete using the URI given by the runUri field of this response.} +\item{runUri}{string, The URI to POST to once the file upload is complete. After uploading the file using the URI given in the uploadUri attribute of the response, POST to this URI to initiate the import of your uploaded file into the platform.} \item{uploadFields}{list, If multipart was set to true, these fields should be included in the multipart upload.} } \description{ diff --git a/man/imports_put.Rd b/man/imports_put.Rd index bb459bd7..424ee1de 100644 --- a/man/imports_put.Rd +++ b/man/imports_put.Rd @@ -33,11 +33,11 @@ imports_put(id, name, sync_type, is_outbound, source = NULL, \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list optional. A list containing the following elements: @@ -80,11 +80,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -140,8 +140,8 @@ A list containing the following elements: }} \item{nextRunAt}{string, The time of the next scheduled run.} \item{timeZone}{string, The time zone of this import.} -\item{hidden}{boolean, The hidden status of the object.} -\item{archived}{string, The archival status of the requested object(s).} +\item{hidden}{boolean, The hidden status of the item.} +\item{archived}{string, The archival status of the requested item(s).} } \description{ Update an import diff --git a/man/imports_put_archive.Rd b/man/imports_put_archive.Rd index f1b138fc..20e3b7c5 100644 --- a/man/imports_put_archive.Rd +++ b/man/imports_put_archive.Rd @@ -31,11 +31,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -91,8 +91,8 @@ A list containing the following elements: }} \item{nextRunAt}{string, The time of the next scheduled run.} \item{timeZone}{string, The time zone of this import.} -\item{hidden}{boolean, The hidden status of the object.} -\item{archived}{string, The archival status of the requested object(s).} +\item{hidden}{boolean, The hidden status of the item.} +\item{archived}{string, The archival status of the requested item(s).} } \description{ Update the archive status of this object diff --git a/man/imports_put_projects.Rd b/man/imports_put_projects.Rd index d7b895c8..407d9b8e 100644 --- a/man/imports_put_projects.Rd +++ b/man/imports_put_projects.Rd @@ -7,9 +7,9 @@ imports_put_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/jobs_delete_projects.Rd b/man/jobs_delete_projects.Rd index 046e482f..a0de0e49 100644 --- a/man/jobs_delete_projects.Rd +++ b/man/jobs_delete_projects.Rd @@ -7,9 +7,9 @@ jobs_delete_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/jobs_get.Rd b/man/jobs_get.Rd index 50254cab..bb2cd1bd 100644 --- a/man/jobs_get.Rd +++ b/man/jobs_get.Rd @@ -36,15 +36,15 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} -\item{archived}{string, The archival status of the requested object(s).} +\item{hidden}{boolean, The hidden status of the item.} +\item{archived}{string, The archival status of the requested item(s).} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} } \description{ diff --git a/man/jobs_list.Rd b/man/jobs_list.Rd index 4d917867..e73fa4fc 100644 --- a/man/jobs_list.Rd +++ b/man/jobs_list.Rd @@ -13,15 +13,15 @@ jobs_list(state = NULL, type = NULL, q = NULL, permission = NULL, \item{type}{string optional. The job's type. Specify multiple values as a comma-separated list (e.g., "A,B").} -\item{q}{string optional. Query string to search on the id, name, and job type} +\item{q}{string optional. Query string to search on the id, name, and job type.} \item{permission}{string optional. A permissions string, one of "read", "write", or "manage". Lists only jobs for which the current user has that permission.} -\item{scheduled}{boolean optional. If the object is scheduled.} +\item{scheduled}{boolean optional. If the item is scheduled.} -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} -\item{archived}{string optional. The archival status of the requested object(s).} +\item{archived}{string optional. The archival status of the requested item(s).} \item{limit}{integer optional. Number of results to return. Defaults to its maximum of 50.} @@ -49,14 +49,14 @@ An array containing the following fields: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} } \description{ diff --git a/man/jobs_list_parents.Rd b/man/jobs_list_parents.Rd index b3b64cfe..4b9b5495 100644 --- a/man/jobs_list_parents.Rd +++ b/man/jobs_list_parents.Rd @@ -36,15 +36,15 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} -\item{archived}{string, The archival status of the requested object(s).} +\item{hidden}{boolean, The hidden status of the item.} +\item{archived}{string, The archival status of the requested item(s).} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} } \description{ diff --git a/man/jobs_list_projects.Rd b/man/jobs_list_projects.Rd index 5f97f9a0..c273ce0f 100644 --- a/man/jobs_list_projects.Rd +++ b/man/jobs_list_projects.Rd @@ -9,7 +9,7 @@ jobs_list_projects(id, hidden = NULL) \arguments{ \item{id}{integer required. The ID of the resource.} -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} } \value{ An array containing the following fields: @@ -23,7 +23,7 @@ An array containing the following fields: \item online boolean, Whether this user is online. }} \item{name}{string, The name of this project.} -\item{description}{string, A description of the project} +\item{description}{string, A description of the project.} \item{users}{array, An array containing the following fields: \itemize{ \item id integer, The ID of this user. @@ -35,7 +35,7 @@ An array containing the following fields: \item{autoShare}{boolean, } \item{createdAt}{string, } \item{updatedAt}{string, } -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ List the projects a Job belongs to diff --git a/man/jobs_list_workflows.Rd b/man/jobs_list_workflows.Rd index 96b0c33a..cf5e692a 100644 --- a/man/jobs_list_workflows.Rd +++ b/man/jobs_list_workflows.Rd @@ -9,7 +9,7 @@ jobs_list_workflows(id, archived = NULL) \arguments{ \item{id}{integer required.} -\item{archived}{string optional. The archival status of the requested object(s).} +\item{archived}{string optional. The archival status of the requested item(s).} } \value{ An array containing the following fields: @@ -29,15 +29,15 @@ An array containing the following fields: \item{state}{string, The state of the workflow. State is "running" if any execution is running, otherwise reflects most recent execution state.} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{timeZone}{string, The time zone of this workflow.} \item{nextExecutionAt}{string, The time of the next scheduled execution.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{createdAt}{string, } \item{updatedAt}{string, } } diff --git a/man/jobs_put_projects.Rd b/man/jobs_put_projects.Rd index c33481fe..25ad9fdf 100644 --- a/man/jobs_put_projects.Rd +++ b/man/jobs_put_projects.Rd @@ -7,9 +7,9 @@ jobs_put_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/media_get_optimizations.Rd b/man/media_get_optimizations.Rd index 0c04b65c..589c1116 100644 --- a/man/media_get_optimizations.Rd +++ b/man/media_get_optimizations.Rd @@ -27,7 +27,7 @@ A list containing the following elements: \item{state}{string, The state of the last run.} \item{lastRunId}{integer, The ID of the last run.} \item{spotOrderId}{integer, The ID for the spot order produced by the optimization.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{reportLink}{string, A link to the visual report for the optimization.} \item{spotOrderLink}{string, A link to the json version of the spot order.} \item{fileLinks}{array, Links to the csv and xml versions of the spot order.} diff --git a/man/media_get_ratecards.Rd b/man/media_get_ratecards.Rd index 6b725bec..97a71b8f 100644 --- a/man/media_get_ratecards.Rd +++ b/man/media_get_ratecards.Rd @@ -16,7 +16,7 @@ A list containing the following elements: \item{startOn}{string, First day to which the ratecard applies.} \item{endOn}{string, Last day to which the ratecard applies.} \item{dmaNumber}{integer, Number of the DMA associated with the ratecard.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ Get a Ratecard diff --git a/man/media_get_spot_orders.Rd b/man/media_get_spot_orders.Rd index 3a90cff2..bed23868 100644 --- a/man/media_get_spot_orders.Rd +++ b/man/media_get_spot_orders.Rd @@ -12,7 +12,7 @@ media_get_spot_orders(id) \value{ A list containing the following elements: \item{id}{integer, The ID for the spot order.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{csvS3Uri}{string, S3 URI for the spot order CSV file.} \item{jsonS3Uri}{string, S3 URI for the spot order JSON file.} \item{xmlArchiveS3Uri}{string, S3 URI for the spot order XML archive.} diff --git a/man/media_list_optimizations.Rd b/man/media_list_optimizations.Rd index a995cc8f..a5beb1de 100644 --- a/man/media_list_optimizations.Rd +++ b/man/media_list_optimizations.Rd @@ -8,7 +8,7 @@ media_list_optimizations(archived = NULL, limit = NULL, page_num = NULL, order = NULL, order_dir = NULL) } \arguments{ -\item{archived}{string optional. The archival status of the requested object(s).} +\item{archived}{string optional. The archival status of the requested item(s).} \item{limit}{integer optional. Number of results to return. Defaults to 20. Maximum allowed is 50.} @@ -36,7 +36,7 @@ An array containing the following fields: \item{state}{string, The state of the last run.} \item{lastRunId}{integer, The ID of the last run.} \item{spotOrderId}{integer, The ID for the spot order produced by the optimization.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ List all optimizations diff --git a/man/media_list_ratecards.Rd b/man/media_list_ratecards.Rd index 7700d36b..31ef9553 100644 --- a/man/media_list_ratecards.Rd +++ b/man/media_list_ratecards.Rd @@ -7,7 +7,7 @@ media_list_ratecards(archived = NULL, filename = NULL, dma_number = NULL) } \arguments{ -\item{archived}{string optional. The archival status of the requested object(s).} +\item{archived}{string optional. The archival status of the requested item(s).} \item{filename}{string optional. If specified, will be used to filter the ratecards returned. Substring matching is supported with "\%" and "*" wildcards (e.g., "filename=\%ratecard\%" will return both "ratecard 1" and "my ratecard").} @@ -20,7 +20,7 @@ An array containing the following fields: \item{startOn}{string, First day to which the ratecard applies.} \item{endOn}{string, Last day to which the ratecard applies.} \item{dmaNumber}{integer, Number of the DMA associated with the ratecard.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ List all ratecards diff --git a/man/media_list_spot_orders.Rd b/man/media_list_spot_orders.Rd index 0f7e1b2e..1b722e5a 100644 --- a/man/media_list_spot_orders.Rd +++ b/man/media_list_spot_orders.Rd @@ -9,12 +9,12 @@ media_list_spot_orders(id = NULL, archived = NULL) \arguments{ \item{id}{integer optional. The ID for the spot order.} -\item{archived}{string optional. The archival status of the requested object(s).} +\item{archived}{string optional. The archival status of the requested item(s).} } \value{ An array containing the following fields: \item{id}{integer, The ID for the spot order.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ List all spot orders diff --git a/man/media_patch_optimizations.Rd b/man/media_patch_optimizations.Rd index 461f87b6..18d59f4a 100644 --- a/man/media_patch_optimizations.Rd +++ b/man/media_patch_optimizations.Rd @@ -53,7 +53,7 @@ A list containing the following elements: \item{state}{string, The state of the last run.} \item{lastRunId}{integer, The ID of the last run.} \item{spotOrderId}{integer, The ID for the spot order produced by the optimization.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{reportLink}{string, A link to the visual report for the optimization.} \item{spotOrderLink}{string, A link to the json version of the spot order.} \item{fileLinks}{array, Links to the csv and xml versions of the spot order.} diff --git a/man/media_patch_ratecards.Rd b/man/media_patch_ratecards.Rd index 26a75dc8..656f82b6 100644 --- a/man/media_patch_ratecards.Rd +++ b/man/media_patch_ratecards.Rd @@ -25,7 +25,7 @@ A list containing the following elements: \item{startOn}{string, First day to which the ratecard applies.} \item{endOn}{string, Last day to which the ratecard applies.} \item{dmaNumber}{integer, Number of the DMA associated with the ratecard.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ Update some attributes of this Ratecard diff --git a/man/media_post_optimizations.Rd b/man/media_post_optimizations.Rd index a59b9983..9d461b4e 100644 --- a/man/media_post_optimizations.Rd +++ b/man/media_post_optimizations.Rd @@ -51,7 +51,7 @@ A list containing the following elements: \item{state}{string, The state of the last run.} \item{lastRunId}{integer, The ID of the last run.} \item{spotOrderId}{integer, The ID for the spot order produced by the optimization.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{reportLink}{string, A link to the visual report for the optimization.} \item{spotOrderLink}{string, A link to the json version of the spot order.} \item{fileLinks}{array, Links to the csv and xml versions of the spot order.} diff --git a/man/media_post_optimizations_clone.Rd b/man/media_post_optimizations_clone.Rd index bafe7a41..e0c076a7 100644 --- a/man/media_post_optimizations_clone.Rd +++ b/man/media_post_optimizations_clone.Rd @@ -27,7 +27,7 @@ A list containing the following elements: \item{state}{string, The state of the last run.} \item{lastRunId}{integer, The ID of the last run.} \item{spotOrderId}{integer, The ID for the spot order produced by the optimization.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{reportLink}{string, A link to the visual report for the optimization.} \item{spotOrderLink}{string, A link to the json version of the spot order.} \item{fileLinks}{array, Links to the csv and xml versions of the spot order.} diff --git a/man/media_post_ratecards.Rd b/man/media_post_ratecards.Rd index c547e885..d87e5cd4 100644 --- a/man/media_post_ratecards.Rd +++ b/man/media_post_ratecards.Rd @@ -22,7 +22,7 @@ A list containing the following elements: \item{startOn}{string, First day to which the ratecard applies.} \item{endOn}{string, Last day to which the ratecard applies.} \item{dmaNumber}{integer, Number of the DMA associated with the ratecard.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ Create a Ratecard diff --git a/man/media_post_spot_orders.Rd b/man/media_post_spot_orders.Rd index 4ac04cd1..1f9dd991 100644 --- a/man/media_post_spot_orders.Rd +++ b/man/media_post_spot_orders.Rd @@ -12,7 +12,7 @@ media_post_spot_orders(body = NULL) \value{ A list containing the following elements: \item{id}{integer, The ID for the spot order.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{csvS3Uri}{string, S3 URI for the spot order CSV file.} \item{jsonS3Uri}{string, S3 URI for the spot order JSON file.} \item{xmlArchiveS3Uri}{string, S3 URI for the spot order XML archive.} diff --git a/man/media_put_optimizations_archive.Rd b/man/media_put_optimizations_archive.Rd index c702771f..399916d0 100644 --- a/man/media_put_optimizations_archive.Rd +++ b/man/media_put_optimizations_archive.Rd @@ -29,7 +29,7 @@ A list containing the following elements: \item{state}{string, The state of the last run.} \item{lastRunId}{integer, The ID of the last run.} \item{spotOrderId}{integer, The ID for the spot order produced by the optimization.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{reportLink}{string, A link to the visual report for the optimization.} \item{spotOrderLink}{string, A link to the json version of the spot order.} \item{fileLinks}{array, Links to the csv and xml versions of the spot order.} diff --git a/man/media_put_ratecards.Rd b/man/media_put_ratecards.Rd index ef8737bd..a4b5b8f7 100644 --- a/man/media_put_ratecards.Rd +++ b/man/media_put_ratecards.Rd @@ -24,7 +24,7 @@ A list containing the following elements: \item{startOn}{string, First day to which the ratecard applies.} \item{endOn}{string, Last day to which the ratecard applies.} \item{dmaNumber}{integer, Number of the DMA associated with the ratecard.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ Replace all attributes of this Ratecard diff --git a/man/media_put_ratecards_archive.Rd b/man/media_put_ratecards_archive.Rd index 3021016a..45b11d1f 100644 --- a/man/media_put_ratecards_archive.Rd +++ b/man/media_put_ratecards_archive.Rd @@ -18,7 +18,7 @@ A list containing the following elements: \item{startOn}{string, First day to which the ratecard applies.} \item{endOn}{string, Last day to which the ratecard applies.} \item{dmaNumber}{integer, Number of the DMA associated with the ratecard.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ Update the archive status of this object diff --git a/man/media_put_spot_orders.Rd b/man/media_put_spot_orders.Rd index bc569e03..90ba493b 100644 --- a/man/media_put_spot_orders.Rd +++ b/man/media_put_spot_orders.Rd @@ -14,7 +14,7 @@ media_put_spot_orders(id, body = NULL) \value{ A list containing the following elements: \item{id}{integer, The ID for the spot order.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{csvS3Uri}{string, S3 URI for the spot order CSV file.} \item{jsonS3Uri}{string, S3 URI for the spot order JSON file.} \item{xmlArchiveS3Uri}{string, S3 URI for the spot order XML archive.} diff --git a/man/media_put_spot_orders_archive.Rd b/man/media_put_spot_orders_archive.Rd index bb7018ac..e61d1a9f 100644 --- a/man/media_put_spot_orders_archive.Rd +++ b/man/media_put_spot_orders_archive.Rd @@ -14,7 +14,7 @@ media_put_spot_orders_archive(id, status) \value{ A list containing the following elements: \item{id}{integer, The ID for the spot order.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{csvS3Uri}{string, S3 URI for the spot order CSV file.} \item{jsonS3Uri}{string, S3 URI for the spot order JSON file.} \item{xmlArchiveS3Uri}{string, S3 URI for the spot order XML archive.} diff --git a/man/models_delete_projects.Rd b/man/models_delete_projects.Rd index 08722c6b..ea838bed 100644 --- a/man/models_delete_projects.Rd +++ b/man/models_delete_projects.Rd @@ -7,9 +7,9 @@ models_delete_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/models_get.Rd b/man/models_get.Rd index 6c2764da..9410ffe3 100644 --- a/man/models_get.Rd +++ b/man/models_get.Rd @@ -43,11 +43,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{parentId}{integer, The ID of the parent job that will trigger this model.} \item{runningAs}{list, A list containing the following elements: @@ -68,7 +68,7 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{user}{list, A list containing the following elements: \itemize{ \item id integer, The ID of this user. @@ -102,7 +102,7 @@ A list containing the following elements: \item state string, The status of the prediction. One of: "succeeded", "failed", "queued", or "running,"or "idle", if no build has been attempted. }} \item{lastOutputLocation}{string, The output JSON for the last build.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ Retrieve model configuration diff --git a/man/models_list.Rd b/man/models_list.Rd index 8aa0d156..448ae02a 100644 --- a/man/models_list.Rd +++ b/man/models_list.Rd @@ -20,9 +20,9 @@ models_list(model_name = NULL, training_table_name = NULL, \item{status}{string optional. If specified, returns models with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'.} -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} -\item{archived}{string optional. The archival status of the requested object(s).} +\item{archived}{string optional. The archival status of the requested item(s).} \item{limit}{integer optional. Number of results to return. Defaults to its maximum of 50.} @@ -52,11 +52,11 @@ An array containing the following fields: \item{numberOfFolds}{integer, Number of folds for cross validation. Default value is 5.} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{parentId}{integer, The ID of the parent job that will trigger this model.} \item{timeZone}{string, The time zone of this model.} @@ -101,7 +101,7 @@ An array containing the following fields: \item state string, The status of the prediction. One of: "succeeded", "failed", "queued", or "running,"or "idle", if no build has been attempted. }} \item{lastOutputLocation}{string, The output JSON for the last build.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ List diff --git a/man/models_list_projects.Rd b/man/models_list_projects.Rd index 4162d358..423af185 100644 --- a/man/models_list_projects.Rd +++ b/man/models_list_projects.Rd @@ -9,7 +9,7 @@ models_list_projects(id, hidden = NULL) \arguments{ \item{id}{integer required. The ID of the resource.} -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} } \value{ An array containing the following fields: @@ -23,7 +23,7 @@ An array containing the following fields: \item online boolean, Whether this user is online. }} \item{name}{string, The name of this project.} -\item{description}{string, A description of the project} +\item{description}{string, A description of the project.} \item{users}{array, An array containing the following fields: \itemize{ \item id integer, The ID of this user. @@ -35,7 +35,7 @@ An array containing the following fields: \item{autoShare}{boolean, } \item{createdAt}{string, } \item{updatedAt}{string, } -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ List the projects a models belongs to diff --git a/man/models_list_schedules.Rd b/man/models_list_schedules.Rd index 6827600a..3ddbfc7c 100644 --- a/man/models_list_schedules.Rd +++ b/man/models_list_schedules.Rd @@ -14,11 +14,11 @@ A list containing the following elements: \item{id}{integer, The ID of the model associated with this schedule.} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} } \description{ diff --git a/man/models_patch.Rd b/man/models_patch.Rd index b745bf64..3fb7c442 100644 --- a/man/models_patch.Rd +++ b/man/models_patch.Rd @@ -65,11 +65,11 @@ models_patch(id, table_name = NULL, database_id = NULL, \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{parent_id}{integer optional. The ID of the parent job that will trigger this model.} diff --git a/man/models_post.Rd b/man/models_post.Rd index b8537c0f..33ceb5c4 100644 --- a/man/models_post.Rd +++ b/man/models_post.Rd @@ -62,18 +62,18 @@ models_post(table_name = NULL, database_id = NULL, credential_id = NULL, \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{parent_id}{integer optional. The ID of the parent job that will trigger this model.} \item{time_zone}{string optional. The time zone of this model.} -\item{hidden}{boolean optional. The hidden status of the object.} +\item{hidden}{boolean optional. The hidden status of the item.} } \value{ A list containing the following elements: @@ -109,11 +109,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{parentId}{integer, The ID of the parent job that will trigger this model.} \item{runningAs}{list, A list containing the following elements: @@ -134,7 +134,7 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{user}{list, A list containing the following elements: \itemize{ \item id integer, The ID of this user. @@ -168,7 +168,7 @@ A list containing the following elements: \item state string, The status of the prediction. One of: "succeeded", "failed", "queued", or "running,"or "idle", if no build has been attempted. }} \item{lastOutputLocation}{string, The output JSON for the last build.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ Create new configuration for a model diff --git a/man/models_put_archive.Rd b/man/models_put_archive.Rd index e85990d6..89a384bb 100644 --- a/man/models_put_archive.Rd +++ b/man/models_put_archive.Rd @@ -45,11 +45,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{parentId}{integer, The ID of the parent job that will trigger this model.} \item{runningAs}{list, A list containing the following elements: @@ -70,7 +70,7 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{user}{list, A list containing the following elements: \itemize{ \item id integer, The ID of this user. @@ -104,7 +104,7 @@ A list containing the following elements: \item state string, The status of the prediction. One of: "succeeded", "failed", "queued", or "running,"or "idle", if no build has been attempted. }} \item{lastOutputLocation}{string, The output JSON for the last build.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ Update the archive status of this object diff --git a/man/models_put_predictions.Rd b/man/models_put_predictions.Rd index 1ca4f457..52aa78e4 100644 --- a/man/models_put_predictions.Rd +++ b/man/models_put_predictions.Rd @@ -20,11 +20,11 @@ models_put_predictions(id, table_name, primary_key, limiting_sql = NULL, \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} } \value{ @@ -36,11 +36,11 @@ A list containing the following elements: \item{outputTable}{string, The qualified name of the table to be created which will contain the model's predictions.} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{state}{string, The status of the prediction. One of: "succeeded", "failed", "queued", or "running,"or "idle", if no build has been attempted.} } diff --git a/man/models_put_projects.Rd b/man/models_put_projects.Rd index 6d52dbd5..95655e41 100644 --- a/man/models_put_projects.Rd +++ b/man/models_put_projects.Rd @@ -7,9 +7,9 @@ models_put_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/models_put_schedules.Rd b/man/models_put_schedules.Rd index a1762873..f6a5e881 100644 --- a/man/models_put_schedules.Rd +++ b/man/models_put_schedules.Rd @@ -11,11 +11,11 @@ models_put_schedules(id, schedule) \item{schedule}{list required. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} } \value{ @@ -23,11 +23,11 @@ A list containing the following elements: \item{id}{integer, The ID of the model associated with this schedule.} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} } \description{ diff --git a/man/notebooks_delete_projects.Rd b/man/notebooks_delete_projects.Rd index 542dd043..0468f43e 100644 --- a/man/notebooks_delete_projects.Rd +++ b/man/notebooks_delete_projects.Rd @@ -7,9 +7,9 @@ notebooks_delete_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/notebooks_get.Rd b/man/notebooks_get.Rd index 21ef17fb..5203a642 100644 --- a/man/notebooks_get.Rd +++ b/man/notebooks_get.Rd @@ -43,7 +43,7 @@ A list containing the following elements: \item name string, Name of the deployment. \item dockerImageName string, The name of the docker image to pull from DockerHub. \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -\item displayUrl string, URL that displays the deployed platform object and includes auth token. +\item displayUrl string, A signed URL for viewing the deployed item. \item instanceType string, The EC2 instance type requested for the deployment. \item memory integer, The memory allocated to the deployment. \item cpu integer, The cpu allocated to the deployment. @@ -61,8 +61,8 @@ A list containing the following elements: \item{gitRepoUrl}{string, The url of the git repository} \item{gitRef}{string, The git reference if git repo is specified} \item{gitPath}{string, The path to the .ipynb file in the git repo that will be started up on notebook launch} -\item{archived}{string, The archival status of the requested object(s).} -\item{hidden}{boolean, The hidden status of the object.} +\item{archived}{string, The archival status of the requested item(s).} +\item{hidden}{boolean, The hidden status of the item.} } \description{ Get a Notebook diff --git a/man/notebooks_get_deployments.Rd b/man/notebooks_get_deployments.Rd index 16b412fd..bc04f50d 100644 --- a/man/notebooks_get_deployments.Rd +++ b/man/notebooks_get_deployments.Rd @@ -19,7 +19,7 @@ A list containing the following elements: \item{name}{string, Name of the deployment.} \item{dockerImageName}{string, The name of the docker image to pull from DockerHub.} \item{dockerImageTag}{string, The tag of the docker image to pull from DockerHub (default: latest).} -\item{displayUrl}{string, URL that displays the deployed platform object and includes auth token.} +\item{displayUrl}{string, A signed URL for viewing the deployed item.} \item{instanceType}{string, The EC2 instance type requested for the deployment.} \item{memory}{integer, The memory allocated to the deployment.} \item{cpu}{integer, The cpu allocated to the deployment.} diff --git a/man/notebooks_get_git_commits.Rd b/man/notebooks_get_git_commits.Rd index 31f80758..29749708 100644 --- a/man/notebooks_get_git_commits.Rd +++ b/man/notebooks_get_git_commits.Rd @@ -7,7 +7,7 @@ notebooks_get_git_commits(id, commit_hash) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} \item{commit_hash}{string required. The SHA (full or shortened) of the desired git commit.} } diff --git a/man/notebooks_list.Rd b/man/notebooks_list.Rd index 63a92c0a..b8325599 100644 --- a/man/notebooks_list.Rd +++ b/man/notebooks_list.Rd @@ -9,9 +9,9 @@ notebooks_list(hidden = NULL, archived = NULL, author = NULL, order_dir = NULL) } \arguments{ -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} -\item{archived}{string optional. The archival status of the requested object(s).} +\item{archived}{string optional. The archival status of the requested item(s).} \item{author}{string optional. If specified, return imports from this author. It accepts a comma-separated list of author IDs.} @@ -59,7 +59,7 @@ An array containing the following fields: \item published boolean, \item notebookId integer, The ID of owning Notebook }} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ List Notebooks diff --git a/man/notebooks_list_git.Rd b/man/notebooks_list_git.Rd index 088125d1..b5377d52 100644 --- a/man/notebooks_list_git.Rd +++ b/man/notebooks_list_git.Rd @@ -7,7 +7,7 @@ notebooks_list_git(id) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} } \value{ A list containing the following elements: diff --git a/man/notebooks_list_git_commits.Rd b/man/notebooks_list_git_commits.Rd index a705b3d1..acc5475c 100644 --- a/man/notebooks_list_git_commits.Rd +++ b/man/notebooks_list_git_commits.Rd @@ -7,7 +7,7 @@ notebooks_list_git_commits(id) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} } \value{ A list containing the following elements: diff --git a/man/notebooks_list_projects.Rd b/man/notebooks_list_projects.Rd index 578865dd..82c30849 100644 --- a/man/notebooks_list_projects.Rd +++ b/man/notebooks_list_projects.Rd @@ -9,7 +9,7 @@ notebooks_list_projects(id, hidden = NULL) \arguments{ \item{id}{integer required. The ID of the resource.} -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} } \value{ An array containing the following fields: @@ -23,7 +23,7 @@ An array containing the following fields: \item online boolean, Whether this user is online. }} \item{name}{string, The name of this project.} -\item{description}{string, A description of the project} +\item{description}{string, A description of the project.} \item{users}{array, An array containing the following fields: \itemize{ \item id integer, The ID of this user. @@ -35,7 +35,7 @@ An array containing the following fields: \item{autoShare}{boolean, } \item{createdAt}{string, } \item{updatedAt}{string, } -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ List the projects a Notebook belongs to diff --git a/man/notebooks_patch.Rd b/man/notebooks_patch.Rd index ea51fc0e..4aa714d9 100644 --- a/man/notebooks_patch.Rd +++ b/man/notebooks_patch.Rd @@ -82,7 +82,7 @@ A list containing the following elements: \item name string, Name of the deployment. \item dockerImageName string, The name of the docker image to pull from DockerHub. \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -\item displayUrl string, URL that displays the deployed platform object and includes auth token. +\item displayUrl string, A signed URL for viewing the deployed item. \item instanceType string, The EC2 instance type requested for the deployment. \item memory integer, The memory allocated to the deployment. \item cpu integer, The cpu allocated to the deployment. @@ -100,8 +100,8 @@ A list containing the following elements: \item{gitRepoUrl}{string, The url of the git repository} \item{gitRef}{string, The git reference if git repo is specified} \item{gitPath}{string, The path to the .ipynb file in the git repo that will be started up on notebook launch} -\item{archived}{string, The archival status of the requested object(s).} -\item{hidden}{boolean, The hidden status of the object.} +\item{archived}{string, The archival status of the requested item(s).} +\item{hidden}{boolean, The hidden status of the item.} } \description{ Update some attributes of this Notebook diff --git a/man/notebooks_post.Rd b/man/notebooks_post.Rd index 748d60fd..654fb008 100644 --- a/man/notebooks_post.Rd +++ b/man/notebooks_post.Rd @@ -46,7 +46,7 @@ notebooks_post(name = NULL, language = NULL, description = NULL, \item{git_path}{string optional. The path to the .ipynb file in the git repo that will be started up on notebook launch} -\item{hidden}{boolean optional. The hidden status of the object.} +\item{hidden}{boolean optional. The hidden status of the item.} } \value{ A list containing the following elements: @@ -82,7 +82,7 @@ A list containing the following elements: \item name string, Name of the deployment. \item dockerImageName string, The name of the docker image to pull from DockerHub. \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -\item displayUrl string, URL that displays the deployed platform object and includes auth token. +\item displayUrl string, A signed URL for viewing the deployed item. \item instanceType string, The EC2 instance type requested for the deployment. \item memory integer, The memory allocated to the deployment. \item cpu integer, The cpu allocated to the deployment. @@ -100,8 +100,8 @@ A list containing the following elements: \item{gitRepoUrl}{string, The url of the git repository} \item{gitRef}{string, The git reference if git repo is specified} \item{gitPath}{string, The path to the .ipynb file in the git repo that will be started up on notebook launch} -\item{archived}{string, The archival status of the requested object(s).} -\item{hidden}{boolean, The hidden status of the object.} +\item{archived}{string, The archival status of the requested item(s).} +\item{hidden}{boolean, The hidden status of the item.} } \description{ Create a Notebook diff --git a/man/notebooks_post_clone.Rd b/man/notebooks_post_clone.Rd index 90e160b4..e5ef0da9 100644 --- a/man/notebooks_post_clone.Rd +++ b/man/notebooks_post_clone.Rd @@ -43,7 +43,7 @@ A list containing the following elements: \item name string, Name of the deployment. \item dockerImageName string, The name of the docker image to pull from DockerHub. \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -\item displayUrl string, URL that displays the deployed platform object and includes auth token. +\item displayUrl string, A signed URL for viewing the deployed item. \item instanceType string, The EC2 instance type requested for the deployment. \item memory integer, The memory allocated to the deployment. \item cpu integer, The cpu allocated to the deployment. @@ -61,8 +61,8 @@ A list containing the following elements: \item{gitRepoUrl}{string, The url of the git repository} \item{gitRef}{string, The git reference if git repo is specified} \item{gitPath}{string, The path to the .ipynb file in the git repo that will be started up on notebook launch} -\item{archived}{string, The archival status of the requested object(s).} -\item{hidden}{boolean, The hidden status of the object.} +\item{archived}{string, The archival status of the requested item(s).} +\item{hidden}{boolean, The hidden status of the item.} } \description{ Clone this Notebook diff --git a/man/notebooks_post_deployments.Rd b/man/notebooks_post_deployments.Rd index b3973f7e..eed37f6c 100644 --- a/man/notebooks_post_deployments.Rd +++ b/man/notebooks_post_deployments.Rd @@ -22,7 +22,7 @@ A list containing the following elements: \item{name}{string, Name of the deployment.} \item{dockerImageName}{string, The name of the docker image to pull from DockerHub.} \item{dockerImageTag}{string, The tag of the docker image to pull from DockerHub (default: latest).} -\item{displayUrl}{string, URL that displays the deployed platform object and includes auth token.} +\item{displayUrl}{string, A signed URL for viewing the deployed item.} \item{instanceType}{string, The EC2 instance type requested for the deployment.} \item{memory}{integer, The memory allocated to the deployment.} \item{cpu}{integer, The cpu allocated to the deployment.} diff --git a/man/notebooks_post_git_commits.Rd b/man/notebooks_post_git_commits.Rd index 58f9faa3..24c1c811 100644 --- a/man/notebooks_post_git_commits.Rd +++ b/man/notebooks_post_git_commits.Rd @@ -7,7 +7,7 @@ notebooks_post_git_commits(id, content, message, file_hash) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} \item{content}{string required. The contents to commit to the file.} diff --git a/man/notebooks_put.Rd b/man/notebooks_put.Rd index f886646c..ff101628 100644 --- a/man/notebooks_put.Rd +++ b/man/notebooks_put.Rd @@ -82,7 +82,7 @@ A list containing the following elements: \item name string, Name of the deployment. \item dockerImageName string, The name of the docker image to pull from DockerHub. \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -\item displayUrl string, URL that displays the deployed platform object and includes auth token. +\item displayUrl string, A signed URL for viewing the deployed item. \item instanceType string, The EC2 instance type requested for the deployment. \item memory integer, The memory allocated to the deployment. \item cpu integer, The cpu allocated to the deployment. @@ -100,8 +100,8 @@ A list containing the following elements: \item{gitRepoUrl}{string, The url of the git repository} \item{gitRef}{string, The git reference if git repo is specified} \item{gitPath}{string, The path to the .ipynb file in the git repo that will be started up on notebook launch} -\item{archived}{string, The archival status of the requested object(s).} -\item{hidden}{boolean, The hidden status of the object.} +\item{archived}{string, The archival status of the requested item(s).} +\item{hidden}{boolean, The hidden status of the item.} } \description{ Replace all attributes of this Notebook diff --git a/man/notebooks_put_archive.Rd b/man/notebooks_put_archive.Rd index e35caeec..6c02d8d3 100644 --- a/man/notebooks_put_archive.Rd +++ b/man/notebooks_put_archive.Rd @@ -45,7 +45,7 @@ A list containing the following elements: \item name string, Name of the deployment. \item dockerImageName string, The name of the docker image to pull from DockerHub. \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -\item displayUrl string, URL that displays the deployed platform object and includes auth token. +\item displayUrl string, A signed URL for viewing the deployed item. \item instanceType string, The EC2 instance type requested for the deployment. \item memory integer, The memory allocated to the deployment. \item cpu integer, The cpu allocated to the deployment. @@ -63,8 +63,8 @@ A list containing the following elements: \item{gitRepoUrl}{string, The url of the git repository} \item{gitRef}{string, The git reference if git repo is specified} \item{gitPath}{string, The path to the .ipynb file in the git repo that will be started up on notebook launch} -\item{archived}{string, The archival status of the requested object(s).} -\item{hidden}{boolean, The hidden status of the object.} +\item{archived}{string, The archival status of the requested item(s).} +\item{hidden}{boolean, The hidden status of the item.} } \description{ Update the archive status of this object diff --git a/man/notebooks_put_git.Rd b/man/notebooks_put_git.Rd index 17f92a8e..8fb4fbb6 100644 --- a/man/notebooks_put_git.Rd +++ b/man/notebooks_put_git.Rd @@ -8,7 +8,7 @@ notebooks_put_git(id, git_ref = NULL, git_branch = NULL, git_path = NULL, git_repo_url = NULL) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} \item{git_ref}{string optional. A git reference specifying an unambiguous version of the file. Can be a branch name, or the full or shortened SHA of a commit.} diff --git a/man/notebooks_put_projects.Rd b/man/notebooks_put_projects.Rd index 33e4c190..872bf061 100644 --- a/man/notebooks_put_projects.Rd +++ b/man/notebooks_put_projects.Rd @@ -7,9 +7,9 @@ notebooks_put_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/predictions_get.Rd b/man/predictions_get.Rd index 5aaa9c80..7f788feb 100644 --- a/man/predictions_get.Rd +++ b/man/predictions_get.Rd @@ -39,11 +39,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{limitingSQL}{string, A SQL WHERE clause used to scope the rows to be predicted.} \item{primaryKey}{array, The primary key or composite keys of the table being predicted.} diff --git a/man/predictions_list_schedules.Rd b/man/predictions_list_schedules.Rd index 0fefa07b..3c513426 100644 --- a/man/predictions_list_schedules.Rd +++ b/man/predictions_list_schedules.Rd @@ -14,11 +14,11 @@ A list containing the following elements: \item{id}{integer, ID of the prediction associated with this schedule.} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{scoreOnModelBuild}{boolean, Whether the prediction will run after a rebuild of the associated model.} } diff --git a/man/predictions_patch.Rd b/man/predictions_patch.Rd index a8a1e67e..03ec308b 100644 --- a/man/predictions_patch.Rd +++ b/man/predictions_patch.Rd @@ -46,11 +46,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{limitingSQL}{string, A SQL WHERE clause used to scope the rows to be predicted.} \item{primaryKey}{array, The primary key or composite keys of the table being predicted.} diff --git a/man/predictions_put_schedules.Rd b/man/predictions_put_schedules.Rd index 6abeb8fb..d6c7e6e2 100644 --- a/man/predictions_put_schedules.Rd +++ b/man/predictions_put_schedules.Rd @@ -11,11 +11,11 @@ predictions_put_schedules(id, schedule = NULL, score_on_model_build = NULL) \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{score_on_model_build}{boolean optional. Whether the prediction will run after a rebuild of the associated model.} @@ -25,11 +25,11 @@ A list containing the following elements: \item{id}{integer, ID of the prediction associated with this schedule.} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{scoreOnModelBuild}{boolean, Whether the prediction will run after a rebuild of the associated model.} } diff --git a/man/projects_get.Rd b/man/projects_get.Rd index 4bbaaa8a..1989edb5 100644 --- a/man/projects_get.Rd +++ b/man/projects_get.Rd @@ -21,7 +21,7 @@ A list containing the following elements: \item online boolean, Whether this user is online. }} \item{name}{string, The name of this project.} -\item{description}{string, A description of the project} +\item{description}{string, A description of the project.} \item{users}{array, An array containing the following fields: \itemize{ \item id integer, The ID of this user. @@ -44,13 +44,13 @@ A list containing the following elements: }} \item{surveys}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, }} \item{scripts}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -60,7 +60,7 @@ A list containing the following elements: }} \item{imports}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -70,7 +70,7 @@ A list containing the following elements: }} \item{models}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -78,7 +78,7 @@ A list containing the following elements: }} \item{notebooks}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -86,7 +86,7 @@ A list containing the following elements: }} \item{services}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -94,7 +94,7 @@ A list containing the following elements: }} \item{workflows}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -102,7 +102,7 @@ A list containing the following elements: }} \item{reports}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -110,14 +110,14 @@ A list containing the following elements: }} \item{scriptTemplates}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, }} \item{files}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item fileName string, @@ -126,7 +126,7 @@ A list containing the following elements: }} \item{appInstances}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -142,11 +142,11 @@ A list containing the following elements: \item name string, \item icon string, \item author string, -\item archived string, The archival status of the requested object(s). +\item archived string, The archival status of the requested item(s). }} \item{note}{string, } -\item{hidden}{boolean, The hidden status of the object.} -\item{archived}{string, The archival status of the requested object(s).} +\item{hidden}{boolean, The hidden status of the item.} +\item{archived}{string, The archival status of the requested item(s).} } \description{ Get a detailed view of a project and the objects in it diff --git a/man/projects_list.Rd b/man/projects_list.Rd index 05eac5dc..c232c97c 100644 --- a/man/projects_list.Rd +++ b/man/projects_list.Rd @@ -13,9 +13,9 @@ projects_list(author = NULL, permission = NULL, hidden = NULL, \item{permission}{string optional. A permissions string, one of "read", "write", or "manage". Lists only projects for which the current user has that permission.} -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} -\item{archived}{string optional. The archival status of the requested object(s).} +\item{archived}{string optional. The archival status of the requested item(s).} \item{limit}{integer optional. Number of results to return. Defaults to 20. Maximum allowed is 1000.} @@ -37,7 +37,7 @@ An array containing the following fields: \item online boolean, Whether this user is online. }} \item{name}{string, The name of this project.} -\item{description}{string, A description of the project} +\item{description}{string, A description of the project.} \item{users}{array, An array containing the following fields: \itemize{ \item id integer, The ID of this user. @@ -49,7 +49,7 @@ An array containing the following fields: \item{autoShare}{boolean, } \item{createdAt}{string, } \item{updatedAt}{string, } -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ List projects diff --git a/man/projects_post.Rd b/man/projects_post.Rd index eeee7d3b..e992fb1f 100644 --- a/man/projects_post.Rd +++ b/man/projects_post.Rd @@ -9,11 +9,11 @@ projects_post(name, description, note = NULL, hidden = NULL) \arguments{ \item{name}{string required. The name of this project.} -\item{description}{string required. A description of the project} +\item{description}{string required. A description of the project.} -\item{note}{string optional. Notes for the project} +\item{note}{string optional. Notes for the project.} -\item{hidden}{boolean optional. The hidden status of the object.} +\item{hidden}{boolean optional. The hidden status of the item.} } \value{ A list containing the following elements: @@ -27,7 +27,7 @@ A list containing the following elements: \item online boolean, Whether this user is online. }} \item{name}{string, The name of this project.} -\item{description}{string, A description of the project} +\item{description}{string, A description of the project.} \item{users}{array, An array containing the following fields: \itemize{ \item id integer, The ID of this user. @@ -50,13 +50,13 @@ A list containing the following elements: }} \item{surveys}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, }} \item{scripts}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -66,7 +66,7 @@ A list containing the following elements: }} \item{imports}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -76,7 +76,7 @@ A list containing the following elements: }} \item{models}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -84,7 +84,7 @@ A list containing the following elements: }} \item{notebooks}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -92,7 +92,7 @@ A list containing the following elements: }} \item{services}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -100,7 +100,7 @@ A list containing the following elements: }} \item{workflows}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -108,7 +108,7 @@ A list containing the following elements: }} \item{reports}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -116,14 +116,14 @@ A list containing the following elements: }} \item{scriptTemplates}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, }} \item{files}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item fileName string, @@ -132,7 +132,7 @@ A list containing the following elements: }} \item{appInstances}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -148,11 +148,11 @@ A list containing the following elements: \item name string, \item icon string, \item author string, -\item archived string, The archival status of the requested object(s). +\item archived string, The archival status of the requested item(s). }} \item{note}{string, } -\item{hidden}{boolean, The hidden status of the object.} -\item{archived}{string, The archival status of the requested object(s).} +\item{hidden}{boolean, The hidden status of the item.} +\item{archived}{string, The archival status of the requested item(s).} } \description{ Create a project diff --git a/man/projects_put.Rd b/man/projects_put.Rd index 50b5017a..a4e31874 100644 --- a/man/projects_put.Rd +++ b/man/projects_put.Rd @@ -11,9 +11,9 @@ projects_put(project_id, name = NULL, description = NULL, note = NULL) \item{name}{string optional. The name of this project.} -\item{description}{string optional. A description of the project} +\item{description}{string optional. A description of the project.} -\item{note}{string optional. Notes for the project} +\item{note}{string optional. Notes for the project.} } \value{ A list containing the following elements: @@ -27,7 +27,7 @@ A list containing the following elements: \item online boolean, Whether this user is online. }} \item{name}{string, The name of this project.} -\item{description}{string, A description of the project} +\item{description}{string, A description of the project.} \item{users}{array, An array containing the following fields: \itemize{ \item id integer, The ID of this user. @@ -50,13 +50,13 @@ A list containing the following elements: }} \item{surveys}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, }} \item{scripts}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -66,7 +66,7 @@ A list containing the following elements: }} \item{imports}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -76,7 +76,7 @@ A list containing the following elements: }} \item{models}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -84,7 +84,7 @@ A list containing the following elements: }} \item{notebooks}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -92,7 +92,7 @@ A list containing the following elements: }} \item{services}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -100,7 +100,7 @@ A list containing the following elements: }} \item{workflows}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -108,7 +108,7 @@ A list containing the following elements: }} \item{reports}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -116,14 +116,14 @@ A list containing the following elements: }} \item{scriptTemplates}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, }} \item{files}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item fileName string, @@ -132,7 +132,7 @@ A list containing the following elements: }} \item{appInstances}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -148,11 +148,11 @@ A list containing the following elements: \item name string, \item icon string, \item author string, -\item archived string, The archival status of the requested object(s). +\item archived string, The archival status of the requested item(s). }} \item{note}{string, } -\item{hidden}{boolean, The hidden status of the object.} -\item{archived}{string, The archival status of the requested object(s).} +\item{hidden}{boolean, The hidden status of the item.} +\item{archived}{string, The archival status of the requested item(s).} } \description{ Update a project diff --git a/man/projects_put_archive.Rd b/man/projects_put_archive.Rd index f27651c0..5ce7f353 100644 --- a/man/projects_put_archive.Rd +++ b/man/projects_put_archive.Rd @@ -23,7 +23,7 @@ A list containing the following elements: \item online boolean, Whether this user is online. }} \item{name}{string, The name of this project.} -\item{description}{string, A description of the project} +\item{description}{string, A description of the project.} \item{users}{array, An array containing the following fields: \itemize{ \item id integer, The ID of this user. @@ -46,13 +46,13 @@ A list containing the following elements: }} \item{surveys}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, }} \item{scripts}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -62,7 +62,7 @@ A list containing the following elements: }} \item{imports}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -72,7 +72,7 @@ A list containing the following elements: }} \item{models}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -80,7 +80,7 @@ A list containing the following elements: }} \item{notebooks}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -88,7 +88,7 @@ A list containing the following elements: }} \item{services}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -96,7 +96,7 @@ A list containing the following elements: }} \item{workflows}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -104,7 +104,7 @@ A list containing the following elements: }} \item{reports}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -112,14 +112,14 @@ A list containing the following elements: }} \item{scriptTemplates}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, }} \item{files}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item fileName string, @@ -128,7 +128,7 @@ A list containing the following elements: }} \item{appInstances}{array, An array containing the following fields: \itemize{ -\item id integer, The object ID. +\item id integer, The item's ID. \item createdAt string, \item updatedAt string, \item name string, @@ -144,11 +144,11 @@ A list containing the following elements: \item name string, \item icon string, \item author string, -\item archived string, The archival status of the requested object(s). +\item archived string, The archival status of the requested item(s). }} \item{note}{string, } -\item{hidden}{boolean, The hidden status of the object.} -\item{archived}{string, The archival status of the requested object(s).} +\item{hidden}{boolean, The hidden status of the item.} +\item{archived}{string, The archival status of the requested item(s).} } \description{ Update the archive status of this object diff --git a/man/queries_get.Rd b/man/queries_get.Rd index eee1d0a0..ab9e1242 100644 --- a/man/queries_get.Rd +++ b/man/queries_get.Rd @@ -18,13 +18,14 @@ A list containing the following elements: \item{resultRows}{array, A preview of rows returned by the query.} \item{resultColumns}{array, A preview of columns returned by the query.} \item{scriptId}{integer, The ID of the script associated with this query.} -\item{exception}{string, Exception returned from the query, null if the query was a success.} +\item{exception}{string, Deprecated and not used.} +\item{error}{string, The error message for this run, if present.} \item{createdAt}{string, } \item{updatedAt}{string, } \item{finishedAt}{string, The end time of the last run.} \item{state}{string, The state of the last run.} \item{lastRunId}{integer, The ID of the last run.} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{name}{string, The name of the query.} \item{author}{list, A list containing the following elements: \itemize{ diff --git a/man/queries_list.Rd b/man/queries_list.Rd index 12c3128c..9d1b392e 100644 --- a/man/queries_list.Rd +++ b/man/queries_list.Rd @@ -17,7 +17,7 @@ queries_list(database_id = NULL, author_id = NULL, created_before = NULL, \item{exclude_results}{boolean optional. If true, does not return cached query results.} -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} \item{limit}{integer optional. Number of results to return. Defaults to 20. Maximum allowed is 50.} @@ -36,7 +36,8 @@ An array containing the following fields: \item{resultRows}{array, A preview of rows returned by the query.} \item{resultColumns}{array, A preview of columns returned by the query.} \item{scriptId}{integer, The ID of the script associated with this query.} -\item{exception}{string, Exception returned from the query, null if the query was a success.} +\item{exception}{string, Deprecated and not used.} +\item{error}{string, The error message for this run, if present.} \item{createdAt}{string, } \item{updatedAt}{string, } \item{finishedAt}{string, The end time of the last run.} diff --git a/man/queries_post.Rd b/man/queries_post.Rd index 18ce8e5f..26874757 100644 --- a/man/queries_post.Rd +++ b/man/queries_post.Rd @@ -17,7 +17,7 @@ queries_post(database, sql, preview_rows, credential = NULL, hidden = NULL, \item{credential}{integer optional. The credential ID.} -\item{hidden}{boolean optional. The hidden status of the object.} +\item{hidden}{boolean optional. The hidden status of the item.} \item{interactive}{boolean optional. Deprecated and not used.} @@ -40,13 +40,14 @@ A list containing the following elements: \item{resultRows}{array, A preview of rows returned by the query.} \item{resultColumns}{array, A preview of columns returned by the query.} \item{scriptId}{integer, The ID of the script associated with this query.} -\item{exception}{string, Exception returned from the query, null if the query was a success.} +\item{exception}{string, Deprecated and not used.} +\item{error}{string, The error message for this run, if present.} \item{createdAt}{string, } \item{updatedAt}{string, } \item{finishedAt}{string, The end time of the last run.} \item{state}{string, The state of the last run.} \item{lastRunId}{integer, The ID of the last run.} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{interactive}{boolean, Deprecated and not used.} \item{previewRows}{integer, The number of rows to save from the query's result (maximum: 100).} \item{includeHeader}{boolean, Whether the CSV output should include a header row [default: true].} diff --git a/man/queries_put_scripts.Rd b/man/queries_put_scripts.Rd index b1a0a621..bf0276e3 100644 --- a/man/queries_put_scripts.Rd +++ b/man/queries_put_scripts.Rd @@ -20,13 +20,14 @@ A list containing the following elements: \item{resultRows}{array, A preview of rows returned by the query.} \item{resultColumns}{array, A preview of columns returned by the query.} \item{scriptId}{integer, The ID of the script associated with this query.} -\item{exception}{string, Exception returned from the query, null if the query was a success.} +\item{exception}{string, Deprecated and not used.} +\item{error}{string, The error message for this run, if present.} \item{createdAt}{string, } \item{updatedAt}{string, } \item{finishedAt}{string, The end time of the last run.} \item{state}{string, The state of the last run.} \item{lastRunId}{integer, The ID of the last run.} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{name}{string, The name of the query.} \item{author}{list, A list containing the following elements: \itemize{ diff --git a/man/reports_delete_projects.Rd b/man/reports_delete_projects.Rd index 0e1bd2bf..6173d547 100644 --- a/man/reports_delete_projects.Rd +++ b/man/reports_delete_projects.Rd @@ -7,9 +7,9 @@ reports_delete_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/reports_get.Rd b/man/reports_get.Rd index 3fddc500..c88c790e 100644 --- a/man/reports_get.Rd +++ b/man/reports_get.Rd @@ -51,8 +51,8 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{archived}{string, The archival status of the requested object(s).} -\item{hidden}{boolean, The hidden status of the object.} +\item{archived}{string, The archival status of the requested item(s).} +\item{hidden}{boolean, The hidden status of the item.} \item{authDataUrl}{string, } \item{authCodeUrl}{string, } \item{config}{string, Any configuration metadata for this report.} diff --git a/man/reports_get_git_commits.Rd b/man/reports_get_git_commits.Rd index 23a31b51..c8b5392e 100644 --- a/man/reports_get_git_commits.Rd +++ b/man/reports_get_git_commits.Rd @@ -7,7 +7,7 @@ reports_get_git_commits(id, commit_hash) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} \item{commit_hash}{string required. The SHA (full or shortened) of the desired git commit.} } diff --git a/man/reports_list.Rd b/man/reports_list.Rd index effba23a..81901339 100644 --- a/man/reports_list.Rd +++ b/man/reports_list.Rd @@ -15,9 +15,9 @@ reports_list(type = NULL, author = NULL, template_id = NULL, \item{template_id}{integer optional. If specified, return reports using the provided Template.} -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} -\item{archived}{string optional. The archival status of the requested object(s).} +\item{archived}{string optional. The archival status of the requested item(s).} \item{limit}{integer optional. Number of results to return. Defaults to 20. Maximum allowed is 50.} @@ -69,7 +69,7 @@ An array containing the following fields: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ List diff --git a/man/reports_list_git.Rd b/man/reports_list_git.Rd index 9f56d5a8..33b6f7d6 100644 --- a/man/reports_list_git.Rd +++ b/man/reports_list_git.Rd @@ -7,7 +7,7 @@ reports_list_git(id) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} } \value{ A list containing the following elements: diff --git a/man/reports_list_git_commits.Rd b/man/reports_list_git_commits.Rd index 6eec1033..d0ba9e34 100644 --- a/man/reports_list_git_commits.Rd +++ b/man/reports_list_git_commits.Rd @@ -7,7 +7,7 @@ reports_list_git_commits(id) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} } \value{ A list containing the following elements: diff --git a/man/reports_list_projects.Rd b/man/reports_list_projects.Rd index ef20b990..51e0f099 100644 --- a/man/reports_list_projects.Rd +++ b/man/reports_list_projects.Rd @@ -9,7 +9,7 @@ reports_list_projects(id, hidden = NULL) \arguments{ \item{id}{integer required. The ID of the resource.} -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} } \value{ An array containing the following fields: @@ -23,7 +23,7 @@ An array containing the following fields: \item online boolean, Whether this user is online. }} \item{name}{string, The name of this project.} -\item{description}{string, A description of the project} +\item{description}{string, A description of the project.} \item{users}{array, An array containing the following fields: \itemize{ \item id integer, The ID of this user. @@ -35,7 +35,7 @@ An array containing the following fields: \item{autoShare}{boolean, } \item{createdAt}{string, } \item{updatedAt}{string, } -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ List the projects a Report belongs to diff --git a/man/reports_list_snapshots.Rd b/man/reports_list_snapshots.Rd index 2b968270..4cdf74e2 100644 --- a/man/reports_list_snapshots.Rd +++ b/man/reports_list_snapshots.Rd @@ -22,11 +22,11 @@ A list containing the following elements: \item{width}{integer, The width of the cropped snapshot image in screen pixels. The default value is 1440 pixels. Minimum value is 600 pixels.} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{parentId}{integer, The ID of the parent job that will trigger this snapshot.} } diff --git a/man/reports_patch.Rd b/man/reports_patch.Rd index fddc4351..8db07056 100644 --- a/man/reports_patch.Rd +++ b/man/reports_patch.Rd @@ -69,8 +69,8 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{archived}{string, The archival status of the requested object(s).} -\item{hidden}{boolean, The hidden status of the object.} +\item{archived}{string, The archival status of the requested item(s).} +\item{hidden}{boolean, The hidden status of the item.} \item{authDataUrl}{string, } \item{authCodeUrl}{string, } \item{config}{string, Any configuration metadata for this report.} diff --git a/man/reports_patch_snapshots.Rd b/man/reports_patch_snapshots.Rd index 1bd634b1..97184c9d 100644 --- a/man/reports_patch_snapshots.Rd +++ b/man/reports_patch_snapshots.Rd @@ -30,11 +30,11 @@ reports_patch_snapshots(id, state = NULL, finished_at = NULL, \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{parent_id}{integer optional. The ID of the parent job that will trigger this snapshot.} @@ -52,11 +52,11 @@ A list containing the following elements: \item{width}{integer, The width of the cropped snapshot image in screen pixels. The default value is 1440 pixels. Minimum value is 600 pixels.} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{parentId}{integer, The ID of the parent job that will trigger this snapshot.} } diff --git a/man/reports_post.Rd b/man/reports_post.Rd index 784e78d8..ee57f3f0 100644 --- a/man/reports_post.Rd +++ b/man/reports_post.Rd @@ -21,7 +21,7 @@ reports_post(script_id = NULL, name = NULL, code_body = NULL, \item{template_id}{integer optional. The ID of the template used for this report.} -\item{hidden}{boolean optional. The hidden status of the object.} +\item{hidden}{boolean optional. The hidden status of the item.} } \value{ A list containing the following elements: @@ -65,8 +65,8 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{archived}{string, The archival status of the requested object(s).} -\item{hidden}{boolean, The hidden status of the object.} +\item{archived}{string, The archival status of the requested item(s).} +\item{hidden}{boolean, The hidden status of the item.} \item{authDataUrl}{string, } \item{authCodeUrl}{string, } \item{config}{string, Any configuration metadata for this report.} diff --git a/man/reports_post_git_commits.Rd b/man/reports_post_git_commits.Rd index 33f25353..84b64cf4 100644 --- a/man/reports_post_git_commits.Rd +++ b/man/reports_post_git_commits.Rd @@ -7,7 +7,7 @@ reports_post_git_commits(id, content, message, file_hash) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} \item{content}{string required. The contents to commit to the file.} diff --git a/man/reports_post_grants.Rd b/man/reports_post_grants.Rd index c222b6bf..c3399d1d 100644 --- a/man/reports_post_grants.Rd +++ b/man/reports_post_grants.Rd @@ -51,8 +51,8 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{archived}{string, The archival status of the requested object(s).} -\item{hidden}{boolean, The hidden status of the object.} +\item{archived}{string, The archival status of the requested item(s).} +\item{hidden}{boolean, The hidden status of the item.} \item{authDataUrl}{string, } \item{authCodeUrl}{string, } \item{config}{string, Any configuration metadata for this report.} diff --git a/man/reports_post_snapshots.Rd b/man/reports_post_snapshots.Rd index 181b9aee..f86a82ef 100644 --- a/man/reports_post_snapshots.Rd +++ b/man/reports_post_snapshots.Rd @@ -30,11 +30,11 @@ reports_post_snapshots(id, state = NULL, finished_at = NULL, \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{parent_id}{integer optional. The ID of the parent job that will trigger this snapshot.} @@ -52,11 +52,11 @@ A list containing the following elements: \item{width}{integer, The width of the cropped snapshot image in screen pixels. The default value is 1440 pixels. Minimum value is 600 pixels.} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{parentId}{integer, The ID of the parent job that will trigger this snapshot.} } diff --git a/man/reports_put_archive.Rd b/man/reports_put_archive.Rd index c7e64f93..a24d15df 100644 --- a/man/reports_put_archive.Rd +++ b/man/reports_put_archive.Rd @@ -53,8 +53,8 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{archived}{string, The archival status of the requested object(s).} -\item{hidden}{boolean, The hidden status of the object.} +\item{archived}{string, The archival status of the requested item(s).} +\item{hidden}{boolean, The hidden status of the item.} \item{authDataUrl}{string, } \item{authCodeUrl}{string, } \item{config}{string, Any configuration metadata for this report.} diff --git a/man/reports_put_git.Rd b/man/reports_put_git.Rd index 82b9cea8..2ad7f0f5 100644 --- a/man/reports_put_git.Rd +++ b/man/reports_put_git.Rd @@ -8,7 +8,7 @@ reports_put_git(id, git_ref = NULL, git_branch = NULL, git_path = NULL, git_repo_url = NULL) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} \item{git_ref}{string optional. A git reference specifying an unambiguous version of the file. Can be a branch name, or the full or shortened SHA of a commit.} diff --git a/man/reports_put_projects.Rd b/man/reports_put_projects.Rd index f56d08ad..2175faeb 100644 --- a/man/reports_put_projects.Rd +++ b/man/reports_put_projects.Rd @@ -7,9 +7,9 @@ reports_put_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/results_delete_projects.Rd b/man/results_delete_projects.Rd index f82db8c9..f7877cd6 100644 --- a/man/results_delete_projects.Rd +++ b/man/results_delete_projects.Rd @@ -7,9 +7,9 @@ results_delete_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/results_get.Rd b/man/results_get.Rd index bab63e1c..3474d179 100644 --- a/man/results_get.Rd +++ b/man/results_get.Rd @@ -51,8 +51,8 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{archived}{string, The archival status of the requested object(s).} -\item{hidden}{boolean, The hidden status of the object.} +\item{archived}{string, The archival status of the requested item(s).} +\item{hidden}{boolean, The hidden status of the item.} \item{authDataUrl}{string, } \item{authCodeUrl}{string, } \item{config}{string, Any configuration metadata for this report.} diff --git a/man/results_get_git_commits.Rd b/man/results_get_git_commits.Rd index 7df1eac2..48c659e0 100644 --- a/man/results_get_git_commits.Rd +++ b/man/results_get_git_commits.Rd @@ -7,7 +7,7 @@ results_get_git_commits(id, commit_hash) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} \item{commit_hash}{string required. The SHA (full or shortened) of the desired git commit.} } diff --git a/man/results_list.Rd b/man/results_list.Rd index fcbe4dd1..c2946f17 100644 --- a/man/results_list.Rd +++ b/man/results_list.Rd @@ -15,9 +15,9 @@ results_list(type = NULL, author = NULL, template_id = NULL, \item{template_id}{integer optional. If specified, return reports using the provided Template.} -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} -\item{archived}{string optional. The archival status of the requested object(s).} +\item{archived}{string optional. The archival status of the requested item(s).} \item{limit}{integer optional. Number of results to return. Defaults to 20. Maximum allowed is 50.} @@ -69,7 +69,7 @@ An array containing the following fields: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ List diff --git a/man/results_list_git.Rd b/man/results_list_git.Rd index 94bb2886..5e6b95eb 100644 --- a/man/results_list_git.Rd +++ b/man/results_list_git.Rd @@ -7,7 +7,7 @@ results_list_git(id) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} } \value{ A list containing the following elements: diff --git a/man/results_list_git_commits.Rd b/man/results_list_git_commits.Rd index 007da2d8..65ed338a 100644 --- a/man/results_list_git_commits.Rd +++ b/man/results_list_git_commits.Rd @@ -7,7 +7,7 @@ results_list_git_commits(id) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} } \value{ A list containing the following elements: diff --git a/man/results_list_projects.Rd b/man/results_list_projects.Rd index fd2a4252..b687c361 100644 --- a/man/results_list_projects.Rd +++ b/man/results_list_projects.Rd @@ -9,7 +9,7 @@ results_list_projects(id, hidden = NULL) \arguments{ \item{id}{integer required. The ID of the resource.} -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} } \value{ An array containing the following fields: @@ -23,7 +23,7 @@ An array containing the following fields: \item online boolean, Whether this user is online. }} \item{name}{string, The name of this project.} -\item{description}{string, A description of the project} +\item{description}{string, A description of the project.} \item{users}{array, An array containing the following fields: \itemize{ \item id integer, The ID of this user. @@ -35,7 +35,7 @@ An array containing the following fields: \item{autoShare}{boolean, } \item{createdAt}{string, } \item{updatedAt}{string, } -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ List the projects a Report belongs to diff --git a/man/results_list_snapshots.Rd b/man/results_list_snapshots.Rd index 9e605c36..3ac4a0a2 100644 --- a/man/results_list_snapshots.Rd +++ b/man/results_list_snapshots.Rd @@ -22,11 +22,11 @@ A list containing the following elements: \item{width}{integer, The width of the cropped snapshot image in screen pixels. The default value is 1440 pixels. Minimum value is 600 pixels.} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{parentId}{integer, The ID of the parent job that will trigger this snapshot.} } diff --git a/man/results_patch.Rd b/man/results_patch.Rd index 3a3184d2..7c70bb7b 100644 --- a/man/results_patch.Rd +++ b/man/results_patch.Rd @@ -69,8 +69,8 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{archived}{string, The archival status of the requested object(s).} -\item{hidden}{boolean, The hidden status of the object.} +\item{archived}{string, The archival status of the requested item(s).} +\item{hidden}{boolean, The hidden status of the item.} \item{authDataUrl}{string, } \item{authCodeUrl}{string, } \item{config}{string, Any configuration metadata for this report.} diff --git a/man/results_patch_snapshots.Rd b/man/results_patch_snapshots.Rd index 3f0eb34d..0f909aa8 100644 --- a/man/results_patch_snapshots.Rd +++ b/man/results_patch_snapshots.Rd @@ -30,11 +30,11 @@ results_patch_snapshots(id, state = NULL, finished_at = NULL, \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{parent_id}{integer optional. The ID of the parent job that will trigger this snapshot.} @@ -52,11 +52,11 @@ A list containing the following elements: \item{width}{integer, The width of the cropped snapshot image in screen pixels. The default value is 1440 pixels. Minimum value is 600 pixels.} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{parentId}{integer, The ID of the parent job that will trigger this snapshot.} } diff --git a/man/results_post.Rd b/man/results_post.Rd index d3187fca..ba6e4eaa 100644 --- a/man/results_post.Rd +++ b/man/results_post.Rd @@ -21,7 +21,7 @@ results_post(script_id = NULL, name = NULL, code_body = NULL, \item{template_id}{integer optional. The ID of the template used for this report.} -\item{hidden}{boolean optional. The hidden status of the object.} +\item{hidden}{boolean optional. The hidden status of the item.} } \value{ A list containing the following elements: @@ -65,8 +65,8 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{archived}{string, The archival status of the requested object(s).} -\item{hidden}{boolean, The hidden status of the object.} +\item{archived}{string, The archival status of the requested item(s).} +\item{hidden}{boolean, The hidden status of the item.} \item{authDataUrl}{string, } \item{authCodeUrl}{string, } \item{config}{string, Any configuration metadata for this report.} diff --git a/man/results_post_git_commits.Rd b/man/results_post_git_commits.Rd index 61f1ca76..669c0c0a 100644 --- a/man/results_post_git_commits.Rd +++ b/man/results_post_git_commits.Rd @@ -7,7 +7,7 @@ results_post_git_commits(id, content, message, file_hash) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} \item{content}{string required. The contents to commit to the file.} diff --git a/man/results_post_grants.Rd b/man/results_post_grants.Rd index c8addc30..101c1e01 100644 --- a/man/results_post_grants.Rd +++ b/man/results_post_grants.Rd @@ -51,8 +51,8 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{archived}{string, The archival status of the requested object(s).} -\item{hidden}{boolean, The hidden status of the object.} +\item{archived}{string, The archival status of the requested item(s).} +\item{hidden}{boolean, The hidden status of the item.} \item{authDataUrl}{string, } \item{authCodeUrl}{string, } \item{config}{string, Any configuration metadata for this report.} diff --git a/man/results_post_snapshots.Rd b/man/results_post_snapshots.Rd index bb107f80..4414b9dd 100644 --- a/man/results_post_snapshots.Rd +++ b/man/results_post_snapshots.Rd @@ -30,11 +30,11 @@ results_post_snapshots(id, state = NULL, finished_at = NULL, \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{parent_id}{integer optional. The ID of the parent job that will trigger this snapshot.} @@ -52,11 +52,11 @@ A list containing the following elements: \item{width}{integer, The width of the cropped snapshot image in screen pixels. The default value is 1440 pixels. Minimum value is 600 pixels.} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{parentId}{integer, The ID of the parent job that will trigger this snapshot.} } diff --git a/man/results_put_archive.Rd b/man/results_put_archive.Rd index 6bab94bf..ea5ccffc 100644 --- a/man/results_put_archive.Rd +++ b/man/results_put_archive.Rd @@ -53,8 +53,8 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{archived}{string, The archival status of the requested object(s).} -\item{hidden}{boolean, The hidden status of the object.} +\item{archived}{string, The archival status of the requested item(s).} +\item{hidden}{boolean, The hidden status of the item.} \item{authDataUrl}{string, } \item{authCodeUrl}{string, } \item{config}{string, Any configuration metadata for this report.} diff --git a/man/results_put_git.Rd b/man/results_put_git.Rd index b85c0a1b..9a9fbe8b 100644 --- a/man/results_put_git.Rd +++ b/man/results_put_git.Rd @@ -8,7 +8,7 @@ results_put_git(id, git_ref = NULL, git_branch = NULL, git_path = NULL, git_repo_url = NULL) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} \item{git_ref}{string optional. A git reference specifying an unambiguous version of the file. Can be a branch name, or the full or shortened SHA of a commit.} diff --git a/man/results_put_projects.Rd b/man/results_put_projects.Rd index 0b980dd9..220deb6d 100644 --- a/man/results_put_projects.Rd +++ b/man/results_put_projects.Rd @@ -7,9 +7,9 @@ results_put_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/scripts_delete_containers_projects.Rd b/man/scripts_delete_containers_projects.Rd index b25999bb..edcda88b 100644 --- a/man/scripts_delete_containers_projects.Rd +++ b/man/scripts_delete_containers_projects.Rd @@ -7,9 +7,9 @@ scripts_delete_containers_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/scripts_delete_custom_projects.Rd b/man/scripts_delete_custom_projects.Rd index 614ac87c..cea8bfa3 100644 --- a/man/scripts_delete_custom_projects.Rd +++ b/man/scripts_delete_custom_projects.Rd @@ -7,9 +7,9 @@ scripts_delete_custom_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/scripts_delete_javascript_projects.Rd b/man/scripts_delete_javascript_projects.Rd index 24dbf3df..aea63d3b 100644 --- a/man/scripts_delete_javascript_projects.Rd +++ b/man/scripts_delete_javascript_projects.Rd @@ -7,9 +7,9 @@ scripts_delete_javascript_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/scripts_delete_python3_projects.Rd b/man/scripts_delete_python3_projects.Rd index fb45e2f0..6ed5e619 100644 --- a/man/scripts_delete_python3_projects.Rd +++ b/man/scripts_delete_python3_projects.Rd @@ -7,9 +7,9 @@ scripts_delete_python3_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/scripts_delete_r_projects.Rd b/man/scripts_delete_r_projects.Rd index 1eb3e6b1..b51b0b2a 100644 --- a/man/scripts_delete_r_projects.Rd +++ b/man/scripts_delete_r_projects.Rd @@ -7,9 +7,9 @@ scripts_delete_r_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/scripts_delete_sql_projects.Rd b/man/scripts_delete_sql_projects.Rd index 4ffff5e4..97575519 100644 --- a/man/scripts_delete_sql_projects.Rd +++ b/man/scripts_delete_sql_projects.Rd @@ -7,9 +7,9 @@ scripts_delete_sql_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/scripts_get.Rd b/man/scripts_get.Rd index 2fb39aca..858bc085 100644 --- a/man/scripts_get.Rd +++ b/man/scripts_get.Rd @@ -45,7 +45,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -58,11 +58,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -96,9 +96,9 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{targetProjectId}{integer, Target project to which script outputs will be added.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{sql}{string, The raw SQL query for the script.} \item{expandedArguments}{list, Expanded arguments for use in injecting into different environments.} \item{templateScriptId}{integer, The ID of the template script, if any.} diff --git a/man/scripts_get_containers.Rd b/man/scripts_get_containers.Rd index d66621cf..e2a14bc9 100644 --- a/man/scripts_get_containers.Rd +++ b/man/scripts_get_containers.Rd @@ -45,7 +45,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{templateDependentsCount}{integer, How many other scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} @@ -58,11 +58,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -98,6 +98,7 @@ A list containing the following elements: \item{dockerCommand}{string, The command to run on the container. Will be run via sh as: ["sh", "-c", dockerCommand]} \item{dockerImageName}{string, The name of the docker image to pull from DockerHub.} \item{dockerImageTag}{string, The tag of the docker image to pull from DockerHub (default: latest).} +\item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} \item{lastRun}{list, A list containing the following elements: \itemize{ @@ -109,8 +110,8 @@ A list containing the following elements: \item error string, The error message for this run, if present. }} \item{timeZone}{string, The time zone of this script.} -\item{hidden}{boolean, The hidden status of the object.} -\item{archived}{string, The archival status of the requested object(s).} +\item{hidden}{boolean, The hidden status of the item.} +\item{archived}{string, The archival status of the requested item(s).} \item{targetProjectId}{integer, Target project to which script outputs will be added.} } \description{ diff --git a/man/scripts_get_custom.Rd b/man/scripts_get_custom.Rd index f20684d4..dd0e6c29 100644 --- a/man/scripts_get_custom.Rd +++ b/man/scripts_get_custom.Rd @@ -44,7 +44,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template script.} @@ -58,11 +58,11 @@ A list containing the following elements: \item{codePreview}{string, The code that this script will run with arguments inserted.} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -95,8 +95,8 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} -\item{archived}{string, The archival status of the requested object(s).} +\item{hidden}{boolean, The hidden status of the item.} +\item{archived}{string, The archival status of the requested item(s).} \item{targetProjectId}{integer, Target project to which script outputs will be added.} } \description{ diff --git a/man/scripts_get_javascript.Rd b/man/scripts_get_javascript.Rd index df85ba65..78e1a9b1 100644 --- a/man/scripts_get_javascript.Rd +++ b/man/scripts_get_javascript.Rd @@ -45,7 +45,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -58,11 +58,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -96,9 +96,9 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{targetProjectId}{integer, Target project to which script outputs will be added.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{source}{string, The body/text of the script.} \item{remoteHostId}{integer, The remote host ID that this script will connect to.} \item{credentialId}{integer, The credential that this script will use.} diff --git a/man/scripts_get_javascript_git_commits.Rd b/man/scripts_get_javascript_git_commits.Rd index 653e72b8..47e9df1d 100644 --- a/man/scripts_get_javascript_git_commits.Rd +++ b/man/scripts_get_javascript_git_commits.Rd @@ -7,7 +7,7 @@ scripts_get_javascript_git_commits(id, commit_hash) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} \item{commit_hash}{string required. The SHA (full or shortened) of the desired git commit.} } diff --git a/man/scripts_get_python3.Rd b/man/scripts_get_python3.Rd index 1d137c27..74f1217c 100644 --- a/man/scripts_get_python3.Rd +++ b/man/scripts_get_python3.Rd @@ -45,7 +45,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -58,11 +58,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -96,15 +96,16 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{targetProjectId}{integer, Target project to which script outputs will be added.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{requiredResources}{list, A list containing the following elements: \itemize{ \item cpu integer, The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares. \item memory integer, The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. }} +\item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} \item{source}{string, The body/text of the script.} \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} } diff --git a/man/scripts_get_python3_git_commits.Rd b/man/scripts_get_python3_git_commits.Rd index 6e773388..3d772ab3 100644 --- a/man/scripts_get_python3_git_commits.Rd +++ b/man/scripts_get_python3_git_commits.Rd @@ -7,7 +7,7 @@ scripts_get_python3_git_commits(id, commit_hash) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} \item{commit_hash}{string required. The SHA (full or shortened) of the desired git commit.} } diff --git a/man/scripts_get_r.Rd b/man/scripts_get_r.Rd index 47344c49..800067a0 100644 --- a/man/scripts_get_r.Rd +++ b/man/scripts_get_r.Rd @@ -45,7 +45,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -58,11 +58,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -96,15 +96,16 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{targetProjectId}{integer, Target project to which script outputs will be added.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{requiredResources}{list, A list containing the following elements: \itemize{ \item cpu integer, The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares. \item memory integer, The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. }} +\item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} \item{source}{string, The body/text of the script.} \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} } diff --git a/man/scripts_get_r_git_commits.Rd b/man/scripts_get_r_git_commits.Rd index 9611bc93..5ffb1d05 100644 --- a/man/scripts_get_r_git_commits.Rd +++ b/man/scripts_get_r_git_commits.Rd @@ -7,7 +7,7 @@ scripts_get_r_git_commits(id, commit_hash) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} \item{commit_hash}{string required. The SHA (full or shortened) of the desired git commit.} } diff --git a/man/scripts_get_sql.Rd b/man/scripts_get_sql.Rd index a62683c2..79160a8e 100644 --- a/man/scripts_get_sql.Rd +++ b/man/scripts_get_sql.Rd @@ -45,7 +45,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -58,11 +58,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -96,9 +96,9 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{targetProjectId}{integer, Target project to which script outputs will be added.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{sql}{string, The raw SQL query for the script.} \item{expandedArguments}{list, Expanded arguments for use in injecting into different environments.} \item{remoteHostId}{integer, The remote host ID that this script will connect to.} diff --git a/man/scripts_get_sql_git_commits.Rd b/man/scripts_get_sql_git_commits.Rd index 6a0b098c..6c1cabb0 100644 --- a/man/scripts_get_sql_git_commits.Rd +++ b/man/scripts_get_sql_git_commits.Rd @@ -7,7 +7,7 @@ scripts_get_sql_git_commits(id, commit_hash) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} \item{commit_hash}{string required. The SHA (full or shortened) of the desired git commit.} } diff --git a/man/scripts_list.Rd b/man/scripts_list.Rd index 1f81e946..2d40c165 100644 --- a/man/scripts_list.Rd +++ b/man/scripts_list.Rd @@ -9,17 +9,17 @@ scripts_list(type = NULL, category = NULL, author = NULL, status = NULL, order = NULL, order_dir = NULL) } \arguments{ -\item{type}{string optional. If specified, return objects of these types. The valid types are sql, python3, javascript, r, and containers.} +\item{type}{string optional. If specified, return items of these types. The valid types are sql, python3, javascript, r, and containers.} \item{category}{string optional. A job category for filtering scripts. Must be one of script, import, export, and enhancement.} -\item{author}{string optional. If specified, return objects from this author. Must use user IDs. A comma separated list of IDs is also accepted to return objects from multiple authors.} +\item{author}{string optional. If specified, return items from this author. Must use user IDs. A comma separated list of IDs is also accepted to return items from multiple authors.} -\item{status}{string optional. If specified, returns objects with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'.} +\item{status}{string optional. If specified, returns items with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'.} -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} -\item{archived}{string optional. The archival status of the requested object(s).} +\item{archived}{string optional. The archival status of the requested item(s).} \item{limit}{integer optional. Number of results to return. Defaults to 20. Maximum allowed is 50.} @@ -69,7 +69,7 @@ An array containing the following fields: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{templateScriptId}{integer, The ID of the template script, if any.} } \description{ diff --git a/man/scripts_list_containers_projects.Rd b/man/scripts_list_containers_projects.Rd index b34792b9..f5f49037 100644 --- a/man/scripts_list_containers_projects.Rd +++ b/man/scripts_list_containers_projects.Rd @@ -9,7 +9,7 @@ scripts_list_containers_projects(id, hidden = NULL) \arguments{ \item{id}{integer required. The ID of the resource.} -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} } \value{ An array containing the following fields: @@ -23,7 +23,7 @@ An array containing the following fields: \item online boolean, Whether this user is online. }} \item{name}{string, The name of this project.} -\item{description}{string, A description of the project} +\item{description}{string, A description of the project.} \item{users}{array, An array containing the following fields: \itemize{ \item id integer, The ID of this user. @@ -35,7 +35,7 @@ An array containing the following fields: \item{autoShare}{boolean, } \item{createdAt}{string, } \item{updatedAt}{string, } -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ List the projects a container docker belongs to diff --git a/man/scripts_list_containers_runs_outputs.Rd b/man/scripts_list_containers_runs_outputs.Rd index 7c382130..22c2571e 100644 --- a/man/scripts_list_containers_runs_outputs.Rd +++ b/man/scripts_list_containers_runs_outputs.Rd @@ -23,9 +23,9 @@ scripts_list_containers_runs_outputs(id, run_id, limit = NULL, \value{ An array containing the following fields: \item{objectType}{string, The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue} -\item{objectId}{integer, The ID of the output object.} -\item{name}{string, The name of the output object.} -\item{link}{string, The link to retrieve the output object.} +\item{objectId}{integer, The ID of the output.} +\item{name}{string, The name of the output.} +\item{link}{string, The hypermedia link to the output.} \item{value}{string, } } \description{ diff --git a/man/scripts_list_custom.Rd b/man/scripts_list_custom.Rd index 57d1b8a1..a2283a26 100644 --- a/man/scripts_list_custom.Rd +++ b/man/scripts_list_custom.Rd @@ -11,13 +11,13 @@ scripts_list_custom(from_template_id = NULL, author = NULL, status = NULL, \arguments{ \item{from_template_id}{string optional. If specified, return scripts based on the template with this ID. Specify multiple IDs as a comma-separated list.} -\item{author}{string optional. If specified, return objects from this author. Must use user IDs. A comma separated list of IDs is also accepted to return objects from multiple authors.} +\item{author}{string optional. If specified, return items from this author. Must use user IDs. A comma separated list of IDs is also accepted to return items from multiple authors.} -\item{status}{string optional. If specified, returns objects with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'.} +\item{status}{string optional. If specified, returns items with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'.} -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} -\item{archived}{string optional. The archival status of the requested object(s).} +\item{archived}{string optional. The archival status of the requested item(s).} \item{limit}{integer optional. Number of results to return. Defaults to its maximum of 50.} @@ -61,7 +61,7 @@ An array containing the following fields: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ List Custom Scripts diff --git a/man/scripts_list_custom_projects.Rd b/man/scripts_list_custom_projects.Rd index 979452d3..8e7f5955 100644 --- a/man/scripts_list_custom_projects.Rd +++ b/man/scripts_list_custom_projects.Rd @@ -9,7 +9,7 @@ scripts_list_custom_projects(id, hidden = NULL) \arguments{ \item{id}{integer required. The ID of the resource.} -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} } \value{ An array containing the following fields: @@ -23,7 +23,7 @@ An array containing the following fields: \item online boolean, Whether this user is online. }} \item{name}{string, The name of this project.} -\item{description}{string, A description of the project} +\item{description}{string, A description of the project.} \item{users}{array, An array containing the following fields: \itemize{ \item id integer, The ID of this user. @@ -35,7 +35,7 @@ An array containing the following fields: \item{autoShare}{boolean, } \item{createdAt}{string, } \item{updatedAt}{string, } -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ List the projects a Job belongs to diff --git a/man/scripts_list_custom_runs_outputs.Rd b/man/scripts_list_custom_runs_outputs.Rd index 52cb869a..44dde5e9 100644 --- a/man/scripts_list_custom_runs_outputs.Rd +++ b/man/scripts_list_custom_runs_outputs.Rd @@ -23,9 +23,9 @@ scripts_list_custom_runs_outputs(id, run_id, limit = NULL, page_num = NULL, \value{ An array containing the following fields: \item{objectType}{string, The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue} -\item{objectId}{integer, The ID of the output object.} -\item{name}{string, The name of the output object.} -\item{link}{string, The link to retrieve the output object.} +\item{objectId}{integer, The ID of the output.} +\item{name}{string, The name of the output.} +\item{link}{string, The hypermedia link to the output.} \item{value}{string, } } \description{ diff --git a/man/scripts_list_javascript_git.Rd b/man/scripts_list_javascript_git.Rd index bb29c5da..91f32836 100644 --- a/man/scripts_list_javascript_git.Rd +++ b/man/scripts_list_javascript_git.Rd @@ -7,7 +7,7 @@ scripts_list_javascript_git(id) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} } \value{ A list containing the following elements: diff --git a/man/scripts_list_javascript_git_commits.Rd b/man/scripts_list_javascript_git_commits.Rd index d18e4b43..35088f33 100644 --- a/man/scripts_list_javascript_git_commits.Rd +++ b/man/scripts_list_javascript_git_commits.Rd @@ -7,7 +7,7 @@ scripts_list_javascript_git_commits(id) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} } \value{ A list containing the following elements: diff --git a/man/scripts_list_javascript_projects.Rd b/man/scripts_list_javascript_projects.Rd index d0f376a8..dfd220f1 100644 --- a/man/scripts_list_javascript_projects.Rd +++ b/man/scripts_list_javascript_projects.Rd @@ -9,7 +9,7 @@ scripts_list_javascript_projects(id, hidden = NULL) \arguments{ \item{id}{integer required. The ID of the resource.} -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} } \value{ An array containing the following fields: @@ -23,7 +23,7 @@ An array containing the following fields: \item online boolean, Whether this user is online. }} \item{name}{string, The name of this project.} -\item{description}{string, A description of the project} +\item{description}{string, A description of the project.} \item{users}{array, An array containing the following fields: \itemize{ \item id integer, The ID of this user. @@ -35,7 +35,7 @@ An array containing the following fields: \item{autoShare}{boolean, } \item{createdAt}{string, } \item{updatedAt}{string, } -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ List the projects a scripted sql belongs to diff --git a/man/scripts_list_javascript_runs_outputs.Rd b/man/scripts_list_javascript_runs_outputs.Rd index 125fac4e..1cdaaf5d 100644 --- a/man/scripts_list_javascript_runs_outputs.Rd +++ b/man/scripts_list_javascript_runs_outputs.Rd @@ -23,9 +23,9 @@ scripts_list_javascript_runs_outputs(id, run_id, limit = NULL, \value{ An array containing the following fields: \item{objectType}{string, The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue} -\item{objectId}{integer, The ID of the output object.} -\item{name}{string, The name of the output object.} -\item{link}{string, The link to retrieve the output object.} +\item{objectId}{integer, The ID of the output.} +\item{name}{string, The name of the output.} +\item{link}{string, The hypermedia link to the output.} \item{value}{string, } } \description{ diff --git a/man/scripts_list_python3_git.Rd b/man/scripts_list_python3_git.Rd index 1bc23d4d..40c0c921 100644 --- a/man/scripts_list_python3_git.Rd +++ b/man/scripts_list_python3_git.Rd @@ -7,7 +7,7 @@ scripts_list_python3_git(id) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} } \value{ A list containing the following elements: diff --git a/man/scripts_list_python3_git_commits.Rd b/man/scripts_list_python3_git_commits.Rd index 8b3a45a9..4b6680a3 100644 --- a/man/scripts_list_python3_git_commits.Rd +++ b/man/scripts_list_python3_git_commits.Rd @@ -7,7 +7,7 @@ scripts_list_python3_git_commits(id) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} } \value{ A list containing the following elements: diff --git a/man/scripts_list_python3_projects.Rd b/man/scripts_list_python3_projects.Rd index b8a1b92e..6ac46e7a 100644 --- a/man/scripts_list_python3_projects.Rd +++ b/man/scripts_list_python3_projects.Rd @@ -9,7 +9,7 @@ scripts_list_python3_projects(id, hidden = NULL) \arguments{ \item{id}{integer required. The ID of the resource.} -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} } \value{ An array containing the following fields: @@ -23,7 +23,7 @@ An array containing the following fields: \item online boolean, Whether this user is online. }} \item{name}{string, The name of this project.} -\item{description}{string, A description of the project} +\item{description}{string, A description of the project.} \item{users}{array, An array containing the following fields: \itemize{ \item id integer, The ID of this user. @@ -35,7 +35,7 @@ An array containing the following fields: \item{autoShare}{boolean, } \item{createdAt}{string, } \item{updatedAt}{string, } -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ List the projects a python docker belongs to diff --git a/man/scripts_list_python3_runs_outputs.Rd b/man/scripts_list_python3_runs_outputs.Rd index e8cfca6f..23a50faf 100644 --- a/man/scripts_list_python3_runs_outputs.Rd +++ b/man/scripts_list_python3_runs_outputs.Rd @@ -23,9 +23,9 @@ scripts_list_python3_runs_outputs(id, run_id, limit = NULL, page_num = NULL, \value{ An array containing the following fields: \item{objectType}{string, The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue} -\item{objectId}{integer, The ID of the output object.} -\item{name}{string, The name of the output object.} -\item{link}{string, The link to retrieve the output object.} +\item{objectId}{integer, The ID of the output.} +\item{name}{string, The name of the output.} +\item{link}{string, The hypermedia link to the output.} \item{value}{string, } } \description{ diff --git a/man/scripts_list_r_git.Rd b/man/scripts_list_r_git.Rd index e212f96c..d0072eee 100644 --- a/man/scripts_list_r_git.Rd +++ b/man/scripts_list_r_git.Rd @@ -7,7 +7,7 @@ scripts_list_r_git(id) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} } \value{ A list containing the following elements: diff --git a/man/scripts_list_r_git_commits.Rd b/man/scripts_list_r_git_commits.Rd index d01865f4..4c8c2e88 100644 --- a/man/scripts_list_r_git_commits.Rd +++ b/man/scripts_list_r_git_commits.Rd @@ -7,7 +7,7 @@ scripts_list_r_git_commits(id) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} } \value{ A list containing the following elements: diff --git a/man/scripts_list_r_projects.Rd b/man/scripts_list_r_projects.Rd index 6443691e..e1346219 100644 --- a/man/scripts_list_r_projects.Rd +++ b/man/scripts_list_r_projects.Rd @@ -9,7 +9,7 @@ scripts_list_r_projects(id, hidden = NULL) \arguments{ \item{id}{integer required. The ID of the resource.} -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} } \value{ An array containing the following fields: @@ -23,7 +23,7 @@ An array containing the following fields: \item online boolean, Whether this user is online. }} \item{name}{string, The name of this project.} -\item{description}{string, A description of the project} +\item{description}{string, A description of the project.} \item{users}{array, An array containing the following fields: \itemize{ \item id integer, The ID of this user. @@ -35,7 +35,7 @@ An array containing the following fields: \item{autoShare}{boolean, } \item{createdAt}{string, } \item{updatedAt}{string, } -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ List the projects a r docker belongs to diff --git a/man/scripts_list_r_runs_outputs.Rd b/man/scripts_list_r_runs_outputs.Rd index 5e193ae6..80fbf5c5 100644 --- a/man/scripts_list_r_runs_outputs.Rd +++ b/man/scripts_list_r_runs_outputs.Rd @@ -23,9 +23,9 @@ scripts_list_r_runs_outputs(id, run_id, limit = NULL, page_num = NULL, \value{ An array containing the following fields: \item{objectType}{string, The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue} -\item{objectId}{integer, The ID of the output object.} -\item{name}{string, The name of the output object.} -\item{link}{string, The link to retrieve the output object.} +\item{objectId}{integer, The ID of the output.} +\item{name}{string, The name of the output.} +\item{link}{string, The hypermedia link to the output.} \item{value}{string, } } \description{ diff --git a/man/scripts_list_sql_git.Rd b/man/scripts_list_sql_git.Rd index 4f8b0add..84965a9a 100644 --- a/man/scripts_list_sql_git.Rd +++ b/man/scripts_list_sql_git.Rd @@ -7,7 +7,7 @@ scripts_list_sql_git(id) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} } \value{ A list containing the following elements: diff --git a/man/scripts_list_sql_git_commits.Rd b/man/scripts_list_sql_git_commits.Rd index e0e3d034..b5d06647 100644 --- a/man/scripts_list_sql_git_commits.Rd +++ b/man/scripts_list_sql_git_commits.Rd @@ -7,7 +7,7 @@ scripts_list_sql_git_commits(id) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} } \value{ A list containing the following elements: diff --git a/man/scripts_list_sql_projects.Rd b/man/scripts_list_sql_projects.Rd index 669d343c..a94dee6f 100644 --- a/man/scripts_list_sql_projects.Rd +++ b/man/scripts_list_sql_projects.Rd @@ -9,7 +9,7 @@ scripts_list_sql_projects(id, hidden = NULL) \arguments{ \item{id}{integer required. The ID of the resource.} -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} } \value{ An array containing the following fields: @@ -23,7 +23,7 @@ An array containing the following fields: \item online boolean, Whether this user is online. }} \item{name}{string, The name of this project.} -\item{description}{string, A description of the project} +\item{description}{string, A description of the project.} \item{users}{array, An array containing the following fields: \itemize{ \item id integer, The ID of this user. @@ -35,7 +35,7 @@ An array containing the following fields: \item{autoShare}{boolean, } \item{createdAt}{string, } \item{updatedAt}{string, } -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ List the projects a scripts belongs to diff --git a/man/scripts_list_sql_runs_outputs.Rd b/man/scripts_list_sql_runs_outputs.Rd index 3b8513ee..8c9bb2b6 100644 --- a/man/scripts_list_sql_runs_outputs.Rd +++ b/man/scripts_list_sql_runs_outputs.Rd @@ -23,9 +23,9 @@ scripts_list_sql_runs_outputs(id, run_id, limit = NULL, page_num = NULL, \value{ An array containing the following fields: \item{objectType}{string, The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue} -\item{objectId}{integer, The ID of the output object.} -\item{name}{string, The name of the output object.} -\item{link}{string, The link to retrieve the output object.} +\item{objectId}{integer, The ID of the output.} +\item{name}{string, The name of the output.} +\item{link}{string, The hypermedia link to the output.} \item{value}{string, } } \description{ diff --git a/man/scripts_patch.Rd b/man/scripts_patch.Rd index 15c5fbf9..26967880 100644 --- a/man/scripts_patch.Rd +++ b/man/scripts_patch.Rd @@ -27,17 +27,17 @@ scripts_patch(id, name = NULL, sql = NULL, params = NULL, \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{template_script_id}{integer optional. The ID of the template script, if any. A script cannot both have a template script and be a template for other scripts.} \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list optional. A list containing the following elements: @@ -92,7 +92,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -105,11 +105,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -143,9 +143,9 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{targetProjectId}{integer, Target project to which script outputs will be added.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{sql}{string, The raw SQL query for the script.} \item{expandedArguments}{list, Expanded arguments for use in injecting into different environments.} \item{templateScriptId}{integer, The ID of the template script, if any.} diff --git a/man/scripts_patch_containers.Rd b/man/scripts_patch_containers.Rd index d3375f9e..cd3811ee 100644 --- a/man/scripts_patch_containers.Rd +++ b/man/scripts_patch_containers.Rd @@ -9,7 +9,7 @@ scripts_patch_containers(id, name = NULL, parent_id = NULL, notifications = NULL, required_resources = NULL, repo_http_uri = NULL, repo_ref = NULL, remote_host_credential_id = NULL, git_credential_id = NULL, docker_command = NULL, - docker_image_name = NULL, docker_image_tag = NULL, + docker_image_name = NULL, docker_image_tag = NULL, instance_type = NULL, cancel_timeout = NULL, time_zone = NULL, target_project_id = NULL) } \arguments{ @@ -33,15 +33,15 @@ scripts_patch_containers(id, name = NULL, parent_id = NULL, \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list optional. A list containing the following elements: @@ -80,6 +80,8 @@ scripts_patch_containers(id, name = NULL, parent_id = NULL, \item{docker_image_tag}{string optional. The tag of the docker image to pull from DockerHub (default: latest).} +\item{instance_type}{string optional. The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} + \item{cancel_timeout}{integer optional. The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} \item{time_zone}{string optional. The time zone of this script.} @@ -122,7 +124,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{templateDependentsCount}{integer, How many other scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} @@ -135,11 +137,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -175,6 +177,7 @@ A list containing the following elements: \item{dockerCommand}{string, The command to run on the container. Will be run via sh as: ["sh", "-c", dockerCommand]} \item{dockerImageName}{string, The name of the docker image to pull from DockerHub.} \item{dockerImageTag}{string, The tag of the docker image to pull from DockerHub (default: latest).} +\item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} \item{lastRun}{list, A list containing the following elements: \itemize{ @@ -186,8 +189,8 @@ A list containing the following elements: \item error string, The error message for this run, if present. }} \item{timeZone}{string, The time zone of this script.} -\item{hidden}{boolean, The hidden status of the object.} -\item{archived}{string, The archival status of the requested object(s).} +\item{hidden}{boolean, The hidden status of the item.} +\item{archived}{string, The archival status of the requested item(s).} \item{targetProjectId}{integer, Target project to which script outputs will be added.} } \description{ diff --git a/man/scripts_patch_custom.Rd b/man/scripts_patch_custom.Rd index 995daaea..beba129e 100644 --- a/man/scripts_patch_custom.Rd +++ b/man/scripts_patch_custom.Rd @@ -15,7 +15,7 @@ scripts_patch_custom(id, name = NULL, parent_id = NULL, arguments = NULL, \item{parent_id}{integer optional. The ID of the parent job that will trigger this script} -\item{arguments}{list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{remote_host_id}{integer optional. The remote host ID that this script will connect to.} @@ -23,11 +23,11 @@ scripts_patch_custom(id, name = NULL, parent_id = NULL, arguments = NULL, \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list optional. A list containing the following elements: @@ -83,7 +83,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template script.} @@ -97,11 +97,11 @@ A list containing the following elements: \item{codePreview}{string, The code that this script will run with arguments inserted.} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -134,8 +134,8 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} -\item{archived}{string, The archival status of the requested object(s).} +\item{hidden}{boolean, The hidden status of the item.} +\item{archived}{string, The archival status of the requested item(s).} \item{targetProjectId}{integer, Target project to which script outputs will be added.} } \description{ diff --git a/man/scripts_patch_javascript.Rd b/man/scripts_patch_javascript.Rd index 5fc660e7..4c815439 100644 --- a/man/scripts_patch_javascript.Rd +++ b/man/scripts_patch_javascript.Rd @@ -31,15 +31,15 @@ scripts_patch_javascript(id, name = NULL, parent_id = NULL, \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list optional. A list containing the following elements: @@ -104,7 +104,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -117,11 +117,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -155,9 +155,9 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{targetProjectId}{integer, Target project to which script outputs will be added.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{source}{string, The body/text of the script.} \item{remoteHostId}{integer, The remote host ID that this script will connect to.} \item{credentialId}{integer, The credential that this script will use.} diff --git a/man/scripts_patch_python3.Rd b/man/scripts_patch_python3.Rd index cf3f9dca..f40a72e9 100644 --- a/man/scripts_patch_python3.Rd +++ b/man/scripts_patch_python3.Rd @@ -7,8 +7,8 @@ scripts_patch_python3(id, name = NULL, parent_id = NULL, user_context = NULL, params = NULL, arguments = NULL, schedule = NULL, notifications = NULL, next_run_at = NULL, time_zone = NULL, - target_project_id = NULL, required_resources = NULL, source = NULL, - cancel_timeout = NULL) + target_project_id = NULL, required_resources = NULL, + instance_type = NULL, source = NULL, cancel_timeout = NULL) } \arguments{ \item{id}{integer required. The ID for the script.} @@ -31,15 +31,15 @@ scripts_patch_python3(id, name = NULL, parent_id = NULL, \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list optional. A list containing the following elements: @@ -69,6 +69,8 @@ scripts_patch_python3(id, name = NULL, parent_id = NULL, \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. }} +\item{instance_type}{string optional. The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} + \item{source}{string optional. The body/text of the script.} \item{cancel_timeout}{integer optional. The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} @@ -109,7 +111,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -122,11 +124,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -160,15 +162,16 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{targetProjectId}{integer, Target project to which script outputs will be added.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{requiredResources}{list, A list containing the following elements: \itemize{ \item cpu integer, The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares. \item memory integer, The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. }} +\item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} \item{source}{string, The body/text of the script.} \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} } diff --git a/man/scripts_patch_r.Rd b/man/scripts_patch_r.Rd index 5acd87f9..cd376f10 100644 --- a/man/scripts_patch_r.Rd +++ b/man/scripts_patch_r.Rd @@ -7,8 +7,8 @@ scripts_patch_r(id, name = NULL, parent_id = NULL, user_context = NULL, params = NULL, arguments = NULL, schedule = NULL, notifications = NULL, next_run_at = NULL, time_zone = NULL, - target_project_id = NULL, required_resources = NULL, source = NULL, - cancel_timeout = NULL) + target_project_id = NULL, required_resources = NULL, + instance_type = NULL, source = NULL, cancel_timeout = NULL) } \arguments{ \item{id}{integer required. The ID for the script.} @@ -31,15 +31,15 @@ scripts_patch_r(id, name = NULL, parent_id = NULL, user_context = NULL, \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list optional. A list containing the following elements: @@ -69,6 +69,8 @@ scripts_patch_r(id, name = NULL, parent_id = NULL, user_context = NULL, \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. }} +\item{instance_type}{string optional. The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} + \item{source}{string optional. The body/text of the script.} \item{cancel_timeout}{integer optional. The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} @@ -109,7 +111,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -122,11 +124,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -160,15 +162,16 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{targetProjectId}{integer, Target project to which script outputs will be added.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{requiredResources}{list, A list containing the following elements: \itemize{ \item cpu integer, The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares. \item memory integer, The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. }} +\item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} \item{source}{string, The body/text of the script.} \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} } diff --git a/man/scripts_patch_sql.Rd b/man/scripts_patch_sql.Rd index 6666d385..8f21ca76 100644 --- a/man/scripts_patch_sql.Rd +++ b/man/scripts_patch_sql.Rd @@ -31,15 +31,15 @@ scripts_patch_sql(id, name = NULL, parent_id = NULL, user_context = NULL, \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list optional. A list containing the following elements: @@ -114,7 +114,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -127,11 +127,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -165,9 +165,9 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{targetProjectId}{integer, Target project to which script outputs will be added.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{sql}{string, The raw SQL query for the script.} \item{expandedArguments}{list, Expanded arguments for use in injecting into different environments.} \item{remoteHostId}{integer, The remote host ID that this script will connect to.} diff --git a/man/scripts_post.Rd b/man/scripts_post.Rd index 31a57429..ad039af1 100644 --- a/man/scripts_post.Rd +++ b/man/scripts_post.Rd @@ -29,7 +29,7 @@ scripts_post(name, remote_host_id, credential_id, sql, params = NULL, \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{template_script_id}{integer optional. The ID of the template script, if any. A script cannot both have a template script and be a template for other scripts.} @@ -47,7 +47,7 @@ scripts_post(name, remote_host_id, credential_id, sql, params = NULL, \item failureOn boolean, If failure email notifications are on. }} -\item{hidden}{boolean optional. The hidden status of the object.} +\item{hidden}{boolean optional. The hidden status of the item.} } \value{ A list containing the following elements: @@ -85,7 +85,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -98,11 +98,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -136,9 +136,9 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{targetProjectId}{integer, Target project to which script outputs will be added.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{templateScriptId}{integer, The ID of the template script, if any.} } \description{ diff --git a/man/scripts_post_containers.Rd b/man/scripts_post_containers.Rd index a42b4a23..cb88d196 100644 --- a/man/scripts_post_containers.Rd +++ b/man/scripts_post_containers.Rd @@ -8,7 +8,7 @@ scripts_post_containers(required_resources, docker_command, docker_image_name, name = NULL, parent_id = NULL, user_context = NULL, params = NULL, arguments = NULL, schedule = NULL, notifications = NULL, repo_http_uri = NULL, repo_ref = NULL, remote_host_credential_id = NULL, - git_credential_id = NULL, docker_image_tag = NULL, + git_credential_id = NULL, docker_image_tag = NULL, instance_type = NULL, cancel_timeout = NULL, time_zone = NULL, hidden = NULL, target_project_id = NULL) } @@ -43,15 +43,15 @@ scripts_post_containers(required_resources, docker_command, docker_image_name, \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list optional. A list containing the following elements: @@ -78,11 +78,13 @@ scripts_post_containers(required_resources, docker_command, docker_image_name, \item{docker_image_tag}{string optional. The tag of the docker image to pull from DockerHub (default: latest).} +\item{instance_type}{string optional. The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} + \item{cancel_timeout}{integer optional. The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} \item{time_zone}{string optional. The time zone of this script.} -\item{hidden}{boolean optional. The hidden status of the object.} +\item{hidden}{boolean optional. The hidden status of the item.} \item{target_project_id}{integer optional. Target project to which script outputs will be added.} } @@ -122,7 +124,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{templateDependentsCount}{integer, How many other scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} @@ -135,11 +137,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -175,6 +177,7 @@ A list containing the following elements: \item{dockerCommand}{string, The command to run on the container. Will be run via sh as: ["sh", "-c", dockerCommand]} \item{dockerImageName}{string, The name of the docker image to pull from DockerHub.} \item{dockerImageTag}{string, The tag of the docker image to pull from DockerHub (default: latest).} +\item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} \item{lastRun}{list, A list containing the following elements: \itemize{ @@ -186,8 +189,8 @@ A list containing the following elements: \item error string, The error message for this run, if present. }} \item{timeZone}{string, The time zone of this script.} -\item{hidden}{boolean, The hidden status of the object.} -\item{archived}{string, The archival status of the requested object(s).} +\item{hidden}{boolean, The hidden status of the item.} +\item{archived}{string, The archival status of the requested item(s).} \item{targetProjectId}{integer, Target project to which script outputs will be added.} } \description{ diff --git a/man/scripts_post_containers_clone.Rd b/man/scripts_post_containers_clone.Rd index 077e35ac..51166680 100644 --- a/man/scripts_post_containers_clone.Rd +++ b/man/scripts_post_containers_clone.Rd @@ -52,7 +52,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{templateDependentsCount}{integer, How many other scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} @@ -65,11 +65,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -105,6 +105,7 @@ A list containing the following elements: \item{dockerCommand}{string, The command to run on the container. Will be run via sh as: ["sh", "-c", dockerCommand]} \item{dockerImageName}{string, The name of the docker image to pull from DockerHub.} \item{dockerImageTag}{string, The tag of the docker image to pull from DockerHub (default: latest).} +\item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} \item{lastRun}{list, A list containing the following elements: \itemize{ @@ -116,8 +117,8 @@ A list containing the following elements: \item error string, The error message for this run, if present. }} \item{timeZone}{string, The time zone of this script.} -\item{hidden}{boolean, The hidden status of the object.} -\item{archived}{string, The archival status of the requested object(s).} +\item{hidden}{boolean, The hidden status of the item.} +\item{archived}{string, The archival status of the requested item(s).} \item{targetProjectId}{integer, Target project to which script outputs will be added.} } \description{ diff --git a/man/scripts_post_containers_runs_outputs.Rd b/man/scripts_post_containers_runs_outputs.Rd index 8c7270e7..bc9d2020 100644 --- a/man/scripts_post_containers_runs_outputs.Rd +++ b/man/scripts_post_containers_runs_outputs.Rd @@ -13,14 +13,14 @@ scripts_post_containers_runs_outputs(id, run_id, object_type, object_id) \item{object_type}{string required. The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue} -\item{object_id}{integer required. The ID of the output object.} +\item{object_id}{integer required. The ID of the output.} } \value{ A list containing the following elements: \item{objectType}{string, The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue} -\item{objectId}{integer, The ID of the output object.} -\item{name}{string, The name of the output object.} -\item{link}{string, The link to retrieve the output object.} +\item{objectId}{integer, The ID of the output.} +\item{name}{string, The name of the output.} +\item{link}{string, The hypermedia link to the output.} \item{value}{string, } } \description{ diff --git a/man/scripts_post_custom.Rd b/man/scripts_post_custom.Rd index b5515d6e..72509556 100644 --- a/man/scripts_post_custom.Rd +++ b/man/scripts_post_custom.Rd @@ -16,7 +16,7 @@ scripts_post_custom(from_template_id, name = NULL, parent_id = NULL, \item{parent_id}{integer optional. The ID of the parent job that will trigger this script} -\item{arguments}{list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{remote_host_id}{integer optional. The remote host ID that this script will connect to.} @@ -24,11 +24,11 @@ scripts_post_custom(from_template_id, name = NULL, parent_id = NULL, \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list optional. A list containing the following elements: @@ -47,7 +47,7 @@ scripts_post_custom(from_template_id, name = NULL, parent_id = NULL, \item{time_zone}{string optional. The time zone of this script.} -\item{hidden}{boolean optional. The hidden status of the object.} +\item{hidden}{boolean optional. The hidden status of the item.} \item{target_project_id}{integer optional. Target project to which script outputs will be added.} } @@ -86,7 +86,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template script.} @@ -100,11 +100,11 @@ A list containing the following elements: \item{codePreview}{string, The code that this script will run with arguments inserted.} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -137,8 +137,8 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} -\item{archived}{string, The archival status of the requested object(s).} +\item{hidden}{boolean, The hidden status of the item.} +\item{archived}{string, The archival status of the requested item(s).} \item{targetProjectId}{integer, Target project to which script outputs will be added.} } \description{ diff --git a/man/scripts_post_custom_clone.Rd b/man/scripts_post_custom_clone.Rd index 77f48d34..b110010d 100644 --- a/man/scripts_post_custom_clone.Rd +++ b/man/scripts_post_custom_clone.Rd @@ -51,7 +51,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template script.} @@ -65,11 +65,11 @@ A list containing the following elements: \item{codePreview}{string, The code that this script will run with arguments inserted.} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -102,8 +102,8 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} -\item{archived}{string, The archival status of the requested object(s).} +\item{hidden}{boolean, The hidden status of the item.} +\item{archived}{string, The archival status of the requested item(s).} \item{targetProjectId}{integer, Target project to which script outputs will be added.} } \description{ diff --git a/man/scripts_post_custom_runs_outputs.Rd b/man/scripts_post_custom_runs_outputs.Rd index ca9364c6..0be16df3 100644 --- a/man/scripts_post_custom_runs_outputs.Rd +++ b/man/scripts_post_custom_runs_outputs.Rd @@ -13,14 +13,14 @@ scripts_post_custom_runs_outputs(id, run_id, object_type, object_id) \item{object_type}{string required. The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue} -\item{object_id}{integer required. The ID of the output object.} +\item{object_id}{integer required. The ID of the output.} } \value{ A list containing the following elements: \item{objectType}{string, The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue} -\item{objectId}{integer, The ID of the output object.} -\item{name}{string, The name of the output object.} -\item{link}{string, The link to retrieve the output object.} +\item{objectId}{integer, The ID of the output.} +\item{name}{string, The name of the output.} +\item{link}{string, The hypermedia link to the output.} \item{value}{string, } } \description{ diff --git a/man/scripts_post_javascript.Rd b/man/scripts_post_javascript.Rd index 9a7d2ae7..ad736523 100644 --- a/man/scripts_post_javascript.Rd +++ b/man/scripts_post_javascript.Rd @@ -35,15 +35,15 @@ scripts_post_javascript(name, source, remote_host_id, credential_id, \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list optional. A list containing the following elements: @@ -64,7 +64,7 @@ scripts_post_javascript(name, source, remote_host_id, credential_id, \item{time_zone}{string optional. The time zone of this script.} -\item{hidden}{boolean optional. The hidden status of the object.} +\item{hidden}{boolean optional. The hidden status of the item.} \item{target_project_id}{integer optional. Target project to which script outputs will be added.} } @@ -104,7 +104,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -117,11 +117,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -155,9 +155,9 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{targetProjectId}{integer, Target project to which script outputs will be added.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{source}{string, The body/text of the script.} \item{remoteHostId}{integer, The remote host ID that this script will connect to.} \item{credentialId}{integer, The credential that this script will use.} diff --git a/man/scripts_post_javascript_clone.Rd b/man/scripts_post_javascript_clone.Rd index caa1d8db..a5325fa0 100644 --- a/man/scripts_post_javascript_clone.Rd +++ b/man/scripts_post_javascript_clone.Rd @@ -52,7 +52,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -65,11 +65,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -103,9 +103,9 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{targetProjectId}{integer, Target project to which script outputs will be added.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{source}{string, The body/text of the script.} \item{remoteHostId}{integer, The remote host ID that this script will connect to.} \item{credentialId}{integer, The credential that this script will use.} diff --git a/man/scripts_post_javascript_git_commits.Rd b/man/scripts_post_javascript_git_commits.Rd index 1c496b34..7ccf7a7f 100644 --- a/man/scripts_post_javascript_git_commits.Rd +++ b/man/scripts_post_javascript_git_commits.Rd @@ -7,7 +7,7 @@ scripts_post_javascript_git_commits(id, content, message, file_hash) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} \item{content}{string required. The contents to commit to the file.} diff --git a/man/scripts_post_javascript_runs_outputs.Rd b/man/scripts_post_javascript_runs_outputs.Rd index 5f27953c..4dc21e3a 100644 --- a/man/scripts_post_javascript_runs_outputs.Rd +++ b/man/scripts_post_javascript_runs_outputs.Rd @@ -13,14 +13,14 @@ scripts_post_javascript_runs_outputs(id, run_id, object_type, object_id) \item{object_type}{string required. The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue} -\item{object_id}{integer required. The ID of the output object.} +\item{object_id}{integer required. The ID of the output.} } \value{ A list containing the following elements: \item{objectType}{string, The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue} -\item{objectId}{integer, The ID of the output object.} -\item{name}{string, The name of the output object.} -\item{link}{string, The link to retrieve the output object.} +\item{objectId}{integer, The ID of the output.} +\item{name}{string, The name of the output.} +\item{link}{string, The hypermedia link to the output.} \item{value}{string, } } \description{ diff --git a/man/scripts_post_python3.Rd b/man/scripts_post_python3.Rd index a1f8b5cf..15180c4d 100644 --- a/man/scripts_post_python3.Rd +++ b/man/scripts_post_python3.Rd @@ -8,7 +8,7 @@ scripts_post_python3(name, source, parent_id = NULL, user_context = NULL, params = NULL, arguments = NULL, schedule = NULL, notifications = NULL, next_run_at = NULL, time_zone = NULL, hidden = NULL, target_project_id = NULL, required_resources = NULL, - cancel_timeout = NULL) + instance_type = NULL, cancel_timeout = NULL) } \arguments{ \item{name}{string required. The name of the script.} @@ -31,15 +31,15 @@ scripts_post_python3(name, source, parent_id = NULL, user_context = NULL, \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list optional. A list containing the following elements: @@ -60,7 +60,7 @@ scripts_post_python3(name, source, parent_id = NULL, user_context = NULL, \item{time_zone}{string optional. The time zone of this script.} -\item{hidden}{boolean optional. The hidden status of the object.} +\item{hidden}{boolean optional. The hidden status of the item.} \item{target_project_id}{integer optional. Target project to which script outputs will be added.} @@ -71,6 +71,8 @@ scripts_post_python3(name, source, parent_id = NULL, user_context = NULL, \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. }} +\item{instance_type}{string optional. The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} + \item{cancel_timeout}{integer optional. The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} } \value{ @@ -109,7 +111,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -122,11 +124,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -160,15 +162,16 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{targetProjectId}{integer, Target project to which script outputs will be added.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{requiredResources}{list, A list containing the following elements: \itemize{ \item cpu integer, The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares. \item memory integer, The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. }} +\item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} \item{source}{string, The body/text of the script.} \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} } diff --git a/man/scripts_post_python3_clone.Rd b/man/scripts_post_python3_clone.Rd index 5a8ae233..86836446 100644 --- a/man/scripts_post_python3_clone.Rd +++ b/man/scripts_post_python3_clone.Rd @@ -52,7 +52,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -65,11 +65,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -103,15 +103,16 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{targetProjectId}{integer, Target project to which script outputs will be added.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{requiredResources}{list, A list containing the following elements: \itemize{ \item cpu integer, The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares. \item memory integer, The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. }} +\item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} \item{source}{string, The body/text of the script.} \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} } diff --git a/man/scripts_post_python3_git_commits.Rd b/man/scripts_post_python3_git_commits.Rd index 47e35ee7..8ae31c82 100644 --- a/man/scripts_post_python3_git_commits.Rd +++ b/man/scripts_post_python3_git_commits.Rd @@ -7,7 +7,7 @@ scripts_post_python3_git_commits(id, content, message, file_hash) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} \item{content}{string required. The contents to commit to the file.} diff --git a/man/scripts_post_python3_runs_outputs.Rd b/man/scripts_post_python3_runs_outputs.Rd index e8773a3d..fb732f89 100644 --- a/man/scripts_post_python3_runs_outputs.Rd +++ b/man/scripts_post_python3_runs_outputs.Rd @@ -13,14 +13,14 @@ scripts_post_python3_runs_outputs(id, run_id, object_type, object_id) \item{object_type}{string required. The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue} -\item{object_id}{integer required. The ID of the output object.} +\item{object_id}{integer required. The ID of the output.} } \value{ A list containing the following elements: \item{objectType}{string, The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue} -\item{objectId}{integer, The ID of the output object.} -\item{name}{string, The name of the output object.} -\item{link}{string, The link to retrieve the output object.} +\item{objectId}{integer, The ID of the output.} +\item{name}{string, The name of the output.} +\item{link}{string, The hypermedia link to the output.} \item{value}{string, } } \description{ diff --git a/man/scripts_post_r.Rd b/man/scripts_post_r.Rd index 389ed889..4faf2351 100644 --- a/man/scripts_post_r.Rd +++ b/man/scripts_post_r.Rd @@ -8,7 +8,7 @@ scripts_post_r(name, source, parent_id = NULL, user_context = NULL, params = NULL, arguments = NULL, schedule = NULL, notifications = NULL, next_run_at = NULL, time_zone = NULL, hidden = NULL, target_project_id = NULL, required_resources = NULL, - cancel_timeout = NULL) + instance_type = NULL, cancel_timeout = NULL) } \arguments{ \item{name}{string required. The name of the script.} @@ -31,15 +31,15 @@ scripts_post_r(name, source, parent_id = NULL, user_context = NULL, \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list optional. A list containing the following elements: @@ -60,7 +60,7 @@ scripts_post_r(name, source, parent_id = NULL, user_context = NULL, \item{time_zone}{string optional. The time zone of this script.} -\item{hidden}{boolean optional. The hidden status of the object.} +\item{hidden}{boolean optional. The hidden status of the item.} \item{target_project_id}{integer optional. Target project to which script outputs will be added.} @@ -71,6 +71,8 @@ scripts_post_r(name, source, parent_id = NULL, user_context = NULL, \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. }} +\item{instance_type}{string optional. The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} + \item{cancel_timeout}{integer optional. The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} } \value{ @@ -109,7 +111,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -122,11 +124,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -160,15 +162,16 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{targetProjectId}{integer, Target project to which script outputs will be added.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{requiredResources}{list, A list containing the following elements: \itemize{ \item cpu integer, The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares. \item memory integer, The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. }} +\item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} \item{source}{string, The body/text of the script.} \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} } diff --git a/man/scripts_post_r_clone.Rd b/man/scripts_post_r_clone.Rd index ebc08617..d605014a 100644 --- a/man/scripts_post_r_clone.Rd +++ b/man/scripts_post_r_clone.Rd @@ -52,7 +52,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -65,11 +65,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -103,15 +103,16 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{targetProjectId}{integer, Target project to which script outputs will be added.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{requiredResources}{list, A list containing the following elements: \itemize{ \item cpu integer, The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares. \item memory integer, The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. }} +\item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} \item{source}{string, The body/text of the script.} \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} } diff --git a/man/scripts_post_r_git_commits.Rd b/man/scripts_post_r_git_commits.Rd index b60492fe..d96045e5 100644 --- a/man/scripts_post_r_git_commits.Rd +++ b/man/scripts_post_r_git_commits.Rd @@ -7,7 +7,7 @@ scripts_post_r_git_commits(id, content, message, file_hash) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} \item{content}{string required. The contents to commit to the file.} diff --git a/man/scripts_post_r_runs_outputs.Rd b/man/scripts_post_r_runs_outputs.Rd index 088d1933..25af8d54 100644 --- a/man/scripts_post_r_runs_outputs.Rd +++ b/man/scripts_post_r_runs_outputs.Rd @@ -13,14 +13,14 @@ scripts_post_r_runs_outputs(id, run_id, object_type, object_id) \item{object_type}{string required. The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue} -\item{object_id}{integer required. The ID of the output object.} +\item{object_id}{integer required. The ID of the output.} } \value{ A list containing the following elements: \item{objectType}{string, The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue} -\item{objectId}{integer, The ID of the output object.} -\item{name}{string, The name of the output object.} -\item{link}{string, The link to retrieve the output object.} +\item{objectId}{integer, The ID of the output.} +\item{name}{string, The name of the output.} +\item{link}{string, The hypermedia link to the output.} \item{value}{string, } } \description{ diff --git a/man/scripts_post_sql.Rd b/man/scripts_post_sql.Rd index 40bfe05b..cc01a1f5 100644 --- a/man/scripts_post_sql.Rd +++ b/man/scripts_post_sql.Rd @@ -34,15 +34,15 @@ scripts_post_sql(name, sql, remote_host_id, credential_id, parent_id = NULL, \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list optional. A list containing the following elements: @@ -63,7 +63,7 @@ scripts_post_sql(name, sql, remote_host_id, credential_id, parent_id = NULL, \item{time_zone}{string optional. The time zone of this script.} -\item{hidden}{boolean optional. The hidden status of the object.} +\item{hidden}{boolean optional. The hidden status of the item.} \item{target_project_id}{integer optional. Target project to which script outputs will be added.} @@ -113,7 +113,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -126,11 +126,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -164,9 +164,9 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{targetProjectId}{integer, Target project to which script outputs will be added.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{sql}{string, The raw SQL query for the script.} \item{expandedArguments}{list, Expanded arguments for use in injecting into different environments.} \item{remoteHostId}{integer, The remote host ID that this script will connect to.} diff --git a/man/scripts_post_sql_clone.Rd b/man/scripts_post_sql_clone.Rd index 2b651a36..345266f4 100644 --- a/man/scripts_post_sql_clone.Rd +++ b/man/scripts_post_sql_clone.Rd @@ -52,7 +52,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -65,11 +65,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -103,9 +103,9 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{targetProjectId}{integer, Target project to which script outputs will be added.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{sql}{string, The raw SQL query for the script.} \item{expandedArguments}{list, Expanded arguments for use in injecting into different environments.} \item{remoteHostId}{integer, The remote host ID that this script will connect to.} diff --git a/man/scripts_post_sql_git_commits.Rd b/man/scripts_post_sql_git_commits.Rd index 9bde4335..df1d7073 100644 --- a/man/scripts_post_sql_git_commits.Rd +++ b/man/scripts_post_sql_git_commits.Rd @@ -7,7 +7,7 @@ scripts_post_sql_git_commits(id, content, message, file_hash) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} \item{content}{string required. The contents to commit to the file.} diff --git a/man/scripts_put_containers.Rd b/man/scripts_put_containers.Rd index 9d538a38..d00de3e6 100644 --- a/man/scripts_put_containers.Rd +++ b/man/scripts_put_containers.Rd @@ -9,8 +9,8 @@ scripts_put_containers(id, required_resources, docker_command, params = NULL, arguments = NULL, schedule = NULL, notifications = NULL, repo_http_uri = NULL, repo_ref = NULL, remote_host_credential_id = NULL, git_credential_id = NULL, - docker_image_tag = NULL, cancel_timeout = NULL, time_zone = NULL, - target_project_id = NULL) + docker_image_tag = NULL, instance_type = NULL, cancel_timeout = NULL, + time_zone = NULL, target_project_id = NULL) } \arguments{ \item{id}{integer required. The ID for the script.} @@ -45,15 +45,15 @@ scripts_put_containers(id, required_resources, docker_command, \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list optional. A list containing the following elements: @@ -80,6 +80,8 @@ scripts_put_containers(id, required_resources, docker_command, \item{docker_image_tag}{string optional. The tag of the docker image to pull from DockerHub (default: latest).} +\item{instance_type}{string optional. The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} + \item{cancel_timeout}{integer optional. The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} \item{time_zone}{string optional. The time zone of this script.} @@ -122,7 +124,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{templateDependentsCount}{integer, How many other scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} @@ -135,11 +137,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -175,6 +177,7 @@ A list containing the following elements: \item{dockerCommand}{string, The command to run on the container. Will be run via sh as: ["sh", "-c", dockerCommand]} \item{dockerImageName}{string, The name of the docker image to pull from DockerHub.} \item{dockerImageTag}{string, The tag of the docker image to pull from DockerHub (default: latest).} +\item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} \item{lastRun}{list, A list containing the following elements: \itemize{ @@ -186,8 +189,8 @@ A list containing the following elements: \item error string, The error message for this run, if present. }} \item{timeZone}{string, The time zone of this script.} -\item{hidden}{boolean, The hidden status of the object.} -\item{archived}{string, The archival status of the requested object(s).} +\item{hidden}{boolean, The hidden status of the item.} +\item{archived}{string, The archival status of the requested item(s).} \item{targetProjectId}{integer, Target project to which script outputs will be added.} } \description{ diff --git a/man/scripts_put_containers_archive.Rd b/man/scripts_put_containers_archive.Rd index 5db8dc26..a92d6e6f 100644 --- a/man/scripts_put_containers_archive.Rd +++ b/man/scripts_put_containers_archive.Rd @@ -47,7 +47,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{templateDependentsCount}{integer, How many other scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} @@ -60,11 +60,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -100,6 +100,7 @@ A list containing the following elements: \item{dockerCommand}{string, The command to run on the container. Will be run via sh as: ["sh", "-c", dockerCommand]} \item{dockerImageName}{string, The name of the docker image to pull from DockerHub.} \item{dockerImageTag}{string, The tag of the docker image to pull from DockerHub (default: latest).} +\item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} \item{lastRun}{list, A list containing the following elements: \itemize{ @@ -111,8 +112,8 @@ A list containing the following elements: \item error string, The error message for this run, if present. }} \item{timeZone}{string, The time zone of this script.} -\item{hidden}{boolean, The hidden status of the object.} -\item{archived}{string, The archival status of the requested object(s).} +\item{hidden}{boolean, The hidden status of the item.} +\item{archived}{string, The archival status of the requested item(s).} \item{targetProjectId}{integer, Target project to which script outputs will be added.} } \description{ diff --git a/man/scripts_put_containers_projects.Rd b/man/scripts_put_containers_projects.Rd index e24f46e2..bd41ace3 100644 --- a/man/scripts_put_containers_projects.Rd +++ b/man/scripts_put_containers_projects.Rd @@ -7,9 +7,9 @@ scripts_put_containers_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/scripts_put_custom.Rd b/man/scripts_put_custom.Rd index d47b5e07..099f0054 100644 --- a/man/scripts_put_custom.Rd +++ b/man/scripts_put_custom.Rd @@ -15,7 +15,7 @@ scripts_put_custom(id, name = NULL, parent_id = NULL, arguments = NULL, \item{parent_id}{integer optional. The ID of the parent job that will trigger this script} -\item{arguments}{list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{remote_host_id}{integer optional. The remote host ID that this script will connect to.} @@ -23,11 +23,11 @@ scripts_put_custom(id, name = NULL, parent_id = NULL, arguments = NULL, \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list optional. A list containing the following elements: @@ -83,7 +83,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template script.} @@ -97,11 +97,11 @@ A list containing the following elements: \item{codePreview}{string, The code that this script will run with arguments inserted.} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -134,8 +134,8 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} -\item{archived}{string, The archival status of the requested object(s).} +\item{hidden}{boolean, The hidden status of the item.} +\item{archived}{string, The archival status of the requested item(s).} \item{targetProjectId}{integer, Target project to which script outputs will be added.} } \description{ diff --git a/man/scripts_put_custom_archive.Rd b/man/scripts_put_custom_archive.Rd index b9eba15f..b3fcd409 100644 --- a/man/scripts_put_custom_archive.Rd +++ b/man/scripts_put_custom_archive.Rd @@ -46,7 +46,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template script.} @@ -60,11 +60,11 @@ A list containing the following elements: \item{codePreview}{string, The code that this script will run with arguments inserted.} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -97,8 +97,8 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} -\item{archived}{string, The archival status of the requested object(s).} +\item{hidden}{boolean, The hidden status of the item.} +\item{archived}{string, The archival status of the requested item(s).} \item{targetProjectId}{integer, Target project to which script outputs will be added.} } \description{ diff --git a/man/scripts_put_custom_projects.Rd b/man/scripts_put_custom_projects.Rd index 5a7f4711..5e3c6759 100644 --- a/man/scripts_put_custom_projects.Rd +++ b/man/scripts_put_custom_projects.Rd @@ -7,9 +7,9 @@ scripts_put_custom_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/scripts_put_javascript.Rd b/man/scripts_put_javascript.Rd index 6eb138f3..9d4cb39a 100644 --- a/man/scripts_put_javascript.Rd +++ b/man/scripts_put_javascript.Rd @@ -36,15 +36,15 @@ scripts_put_javascript(id, name, source, remote_host_id, credential_id, \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list optional. A list containing the following elements: @@ -103,7 +103,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -116,11 +116,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -154,9 +154,9 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{targetProjectId}{integer, Target project to which script outputs will be added.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{source}{string, The body/text of the script.} \item{remoteHostId}{integer, The remote host ID that this script will connect to.} \item{credentialId}{integer, The credential that this script will use.} diff --git a/man/scripts_put_javascript_archive.Rd b/man/scripts_put_javascript_archive.Rd index b8fd8954..e531bf2c 100644 --- a/man/scripts_put_javascript_archive.Rd +++ b/man/scripts_put_javascript_archive.Rd @@ -47,7 +47,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -60,11 +60,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -98,9 +98,9 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{targetProjectId}{integer, Target project to which script outputs will be added.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{source}{string, The body/text of the script.} \item{remoteHostId}{integer, The remote host ID that this script will connect to.} \item{credentialId}{integer, The credential that this script will use.} diff --git a/man/scripts_put_javascript_git.Rd b/man/scripts_put_javascript_git.Rd index 323c4da9..f7cc5f14 100644 --- a/man/scripts_put_javascript_git.Rd +++ b/man/scripts_put_javascript_git.Rd @@ -8,7 +8,7 @@ scripts_put_javascript_git(id, git_ref = NULL, git_branch = NULL, git_path = NULL, git_repo_url = NULL) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} \item{git_ref}{string optional. A git reference specifying an unambiguous version of the file. Can be a branch name, or the full or shortened SHA of a commit.} diff --git a/man/scripts_put_javascript_projects.Rd b/man/scripts_put_javascript_projects.Rd index 1bf4510f..ba9a2d84 100644 --- a/man/scripts_put_javascript_projects.Rd +++ b/man/scripts_put_javascript_projects.Rd @@ -7,9 +7,9 @@ scripts_put_javascript_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/scripts_put_python3.Rd b/man/scripts_put_python3.Rd index 7729e219..fb125eee 100644 --- a/man/scripts_put_python3.Rd +++ b/man/scripts_put_python3.Rd @@ -8,7 +8,7 @@ scripts_put_python3(id, name, source, parent_id = NULL, user_context = NULL, params = NULL, arguments = NULL, schedule = NULL, notifications = NULL, next_run_at = NULL, time_zone = NULL, target_project_id = NULL, required_resources = NULL, - cancel_timeout = NULL) + instance_type = NULL, cancel_timeout = NULL) } \arguments{ \item{id}{integer required. The ID for the script.} @@ -33,15 +33,15 @@ scripts_put_python3(id, name, source, parent_id = NULL, user_context = NULL, \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list optional. A list containing the following elements: @@ -71,6 +71,8 @@ scripts_put_python3(id, name, source, parent_id = NULL, user_context = NULL, \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. }} +\item{instance_type}{string optional. The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} + \item{cancel_timeout}{integer optional. The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} } \value{ @@ -109,7 +111,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -122,11 +124,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -160,15 +162,16 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{targetProjectId}{integer, Target project to which script outputs will be added.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{requiredResources}{list, A list containing the following elements: \itemize{ \item cpu integer, The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares. \item memory integer, The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. }} +\item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} \item{source}{string, The body/text of the script.} \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} } diff --git a/man/scripts_put_python3_archive.Rd b/man/scripts_put_python3_archive.Rd index 47b90eaf..3797ac02 100644 --- a/man/scripts_put_python3_archive.Rd +++ b/man/scripts_put_python3_archive.Rd @@ -47,7 +47,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -60,11 +60,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -98,15 +98,16 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{targetProjectId}{integer, Target project to which script outputs will be added.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{requiredResources}{list, A list containing the following elements: \itemize{ \item cpu integer, The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares. \item memory integer, The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. }} +\item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} \item{source}{string, The body/text of the script.} \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} } diff --git a/man/scripts_put_python3_git.Rd b/man/scripts_put_python3_git.Rd index 008e7c38..cb531f1e 100644 --- a/man/scripts_put_python3_git.Rd +++ b/man/scripts_put_python3_git.Rd @@ -8,7 +8,7 @@ scripts_put_python3_git(id, git_ref = NULL, git_branch = NULL, git_path = NULL, git_repo_url = NULL) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} \item{git_ref}{string optional. A git reference specifying an unambiguous version of the file. Can be a branch name, or the full or shortened SHA of a commit.} diff --git a/man/scripts_put_python3_projects.Rd b/man/scripts_put_python3_projects.Rd index 9724a671..bcc5197e 100644 --- a/man/scripts_put_python3_projects.Rd +++ b/man/scripts_put_python3_projects.Rd @@ -7,9 +7,9 @@ scripts_put_python3_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/scripts_put_r.Rd b/man/scripts_put_r.Rd index 886eb884..5cd9c8e7 100644 --- a/man/scripts_put_r.Rd +++ b/man/scripts_put_r.Rd @@ -8,7 +8,7 @@ scripts_put_r(id, name, source, parent_id = NULL, user_context = NULL, params = NULL, arguments = NULL, schedule = NULL, notifications = NULL, next_run_at = NULL, time_zone = NULL, target_project_id = NULL, required_resources = NULL, - cancel_timeout = NULL) + instance_type = NULL, cancel_timeout = NULL) } \arguments{ \item{id}{integer required. The ID for the script.} @@ -33,15 +33,15 @@ scripts_put_r(id, name, source, parent_id = NULL, user_context = NULL, \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list optional. A list containing the following elements: @@ -71,6 +71,8 @@ scripts_put_r(id, name, source, parent_id = NULL, user_context = NULL, \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. }} +\item{instance_type}{string optional. The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} + \item{cancel_timeout}{integer optional. The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} } \value{ @@ -109,7 +111,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -122,11 +124,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -160,15 +162,16 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{targetProjectId}{integer, Target project to which script outputs will be added.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{requiredResources}{list, A list containing the following elements: \itemize{ \item cpu integer, The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares. \item memory integer, The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. }} +\item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} \item{source}{string, The body/text of the script.} \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} } diff --git a/man/scripts_put_r_archive.Rd b/man/scripts_put_r_archive.Rd index d92f190c..268507ed 100644 --- a/man/scripts_put_r_archive.Rd +++ b/man/scripts_put_r_archive.Rd @@ -47,7 +47,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -60,11 +60,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -98,15 +98,16 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{targetProjectId}{integer, Target project to which script outputs will be added.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{requiredResources}{list, A list containing the following elements: \itemize{ \item cpu integer, The number of CPU shares to allocate for the container. Each core has 1024 shares. Must be at least 2 shares. \item memory integer, The amount of RAM to allocate for the container (in MiB). Must be at least 4 MiB. \item diskSpace number, The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported. }} +\item{instanceType}{string, The EC2 instance type to deploy to. Only available for jobs running on kubernetes.} \item{source}{string, The body/text of the script.} \item{cancelTimeout}{integer, The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.} } diff --git a/man/scripts_put_r_git.Rd b/man/scripts_put_r_git.Rd index 27919360..a97ad5d5 100644 --- a/man/scripts_put_r_git.Rd +++ b/man/scripts_put_r_git.Rd @@ -8,7 +8,7 @@ scripts_put_r_git(id, git_ref = NULL, git_branch = NULL, git_path = NULL, git_repo_url = NULL) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} \item{git_ref}{string optional. A git reference specifying an unambiguous version of the file. Can be a branch name, or the full or shortened SHA of a commit.} diff --git a/man/scripts_put_r_projects.Rd b/man/scripts_put_r_projects.Rd index 2e7d8656..adc54c98 100644 --- a/man/scripts_put_r_projects.Rd +++ b/man/scripts_put_r_projects.Rd @@ -7,9 +7,9 @@ scripts_put_r_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/scripts_put_sql.Rd b/man/scripts_put_sql.Rd index 4f908bbc..04ed14b6 100644 --- a/man/scripts_put_sql.Rd +++ b/man/scripts_put_sql.Rd @@ -37,15 +37,15 @@ scripts_put_sql(id, name, sql, remote_host_id, credential_id, \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list optional. Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list optional. Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list optional. A list containing the following elements: @@ -114,7 +114,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -127,11 +127,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -165,9 +165,9 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{targetProjectId}{integer, Target project to which script outputs will be added.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{sql}{string, The raw SQL query for the script.} \item{expandedArguments}{list, Expanded arguments for use in injecting into different environments.} \item{remoteHostId}{integer, The remote host ID that this script will connect to.} diff --git a/man/scripts_put_sql_archive.Rd b/man/scripts_put_sql_archive.Rd index a3099653..b26dd352 100644 --- a/man/scripts_put_sql_archive.Rd +++ b/man/scripts_put_sql_archive.Rd @@ -47,7 +47,7 @@ A list containing the following elements: \item default string, If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type. \item allowedValues array, The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}` }} -\item{arguments}{list, Dictionary of name/value pairs to use to run this script. Only settable if this script has defined params.} +\item{arguments}{list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.} \item{isTemplate}{boolean, Whether others scripts use this one as a template.} \item{publishedAsTemplateId}{integer, The ID of the template that this script is backing.} \item{fromTemplateId}{integer, The ID of the template this script uses, if any.} @@ -60,11 +60,11 @@ A list containing the following elements: }} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{notifications}{list, A list containing the following elements: \itemize{ @@ -98,9 +98,9 @@ A list containing the following elements: \item finishedAt string, The time that the run completed. \item error string, The error message for this run, if present. }} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} \item{targetProjectId}{integer, Target project to which script outputs will be added.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{sql}{string, The raw SQL query for the script.} \item{expandedArguments}{list, Expanded arguments for use in injecting into different environments.} \item{remoteHostId}{integer, The remote host ID that this script will connect to.} diff --git a/man/scripts_put_sql_git.Rd b/man/scripts_put_sql_git.Rd index ce9b4e28..7321b7c9 100644 --- a/man/scripts_put_sql_git.Rd +++ b/man/scripts_put_sql_git.Rd @@ -8,7 +8,7 @@ scripts_put_sql_git(id, git_ref = NULL, git_branch = NULL, git_path = NULL, git_repo_url = NULL) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} \item{git_ref}{string optional. A git reference specifying an unambiguous version of the file. Can be a branch name, or the full or shortened SHA of a commit.} diff --git a/man/scripts_put_sql_projects.Rd b/man/scripts_put_sql_projects.Rd index e0eeec5e..6b0c04fd 100644 --- a/man/scripts_put_sql_projects.Rd +++ b/man/scripts_put_sql_projects.Rd @@ -7,9 +7,9 @@ scripts_put_sql_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/services_delete_deployments.Rd b/man/services_delete_deployments.Rd index 1471feb5..79c8c0d7 100644 --- a/man/services_delete_deployments.Rd +++ b/man/services_delete_deployments.Rd @@ -2,12 +2,12 @@ % Please edit documentation in R/generated_client.R \name{services_delete_deployments} \alias{services_delete_deployments} -\title{Delete a ShinyApp deployment} +\title{Delete a Service deployment} \usage{ services_delete_deployments(service_id, deployment_id) } \arguments{ -\item{service_id}{integer required. The ID of the owning ShinyApp} +\item{service_id}{integer required. The ID of the owning Service} \item{deployment_id}{integer required. The ID for this deployment} } @@ -15,5 +15,5 @@ services_delete_deployments(service_id, deployment_id) An empty HTTP response } \description{ -Delete a ShinyApp deployment +Delete a Service deployment } diff --git a/man/services_delete_projects.Rd b/man/services_delete_projects.Rd index 259fa1a4..a73f087a 100644 --- a/man/services_delete_projects.Rd +++ b/man/services_delete_projects.Rd @@ -2,18 +2,18 @@ % Please edit documentation in R/generated_client.R \name{services_delete_projects} \alias{services_delete_projects} -\title{Remove a ShinyApp from a project} +\title{Remove a Service from a project} \usage{ services_delete_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response } \description{ -Remove a ShinyApp from a project +Remove a Service from a project } diff --git a/man/services_get.Rd b/man/services_get.Rd index 855965ef..31851771 100644 --- a/man/services_get.Rd +++ b/man/services_get.Rd @@ -27,7 +27,7 @@ A list containing the following elements: \item{schedule}{list, A list containing the following elements: \itemize{ \item runtimePlan string, Only affects the service when deployed. On Demand means that the service will be turned on when viewed and automatically turned off after periods of inactivity. Specific Times means the service will be on when scheduled. Always On means the deployed service will always be on. -\item recurrences array, List of day-hour combinations this object is scheduled for +\item recurrences array, List of day-hour combinations this item is scheduled for }} \item{timeZone}{string, } \item{replicas}{integer, The number of Service replicas to deploy. When maxReplicas is set, this field defines the minimum number of replicas to deploy.} @@ -41,7 +41,7 @@ A list containing the following elements: \item{apiKeyId}{integer, API key id of user} \item{gitRepoUrl}{string, The url for the git repo where the Service code lives.} \item{gitRepoRef}{string, The git reference to use when pulling code from the repo.} -\item{gitPathDir}{string, The path to the Shiny app code within the git repo. If unspecified, the root directory will be used.} +\item{gitPathDir}{string, The path to the Service code within the git repo. If unspecified, the root directory will be used.} \item{reportId}{integer, The ID of the associated report.} \item{currentDeployment}{list, A list containing the following elements: \itemize{ @@ -51,7 +51,7 @@ A list containing the following elements: \item name string, Name of the deployment. \item dockerImageName string, The name of the docker image to pull from DockerHub. \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -\item displayUrl string, URL that displays the deployed platform object and includes auth token. +\item displayUrl string, A signed URL for viewing the deployed item. \item instanceType string, The EC2 instance type requested for the deployment. \item memory integer, The memory allocated to the deployment. \item cpu integer, The cpu allocated to the deployment. @@ -70,7 +70,7 @@ A list containing the following elements: \item name string, Name of the deployment. \item dockerImageName string, The name of the docker image to pull from DockerHub. \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -\item displayUrl string, URL that displays the deployed platform object and includes auth token. +\item displayUrl string, A signed URL for viewing the deployed item. \item instanceType string, The EC2 instance type requested for the deployment. \item memory integer, The memory allocated to the deployment. \item cpu integer, The cpu allocated to the deployment. @@ -89,8 +89,8 @@ A list containing the following elements: \item failureEmailAddresses array, Addresses to notify by e-mail when the service fails. \item failureOn boolean, If failure email notifications are on }} -\item{archived}{string, The archival status of the requested object(s).} -\item{hidden}{boolean, The hidden status of the object.} +\item{archived}{string, The archival status of the requested item(s).} +\item{hidden}{boolean, The hidden status of the item.} } \description{ Get a Service diff --git a/man/services_get_deployments.Rd b/man/services_get_deployments.Rd index b44cff04..7637422e 100644 --- a/man/services_get_deployments.Rd +++ b/man/services_get_deployments.Rd @@ -2,12 +2,12 @@ % Please edit documentation in R/generated_client.R \name{services_get_deployments} \alias{services_get_deployments} -\title{Get details about a ShinyApp deployment} +\title{Get details about a Service deployment} \usage{ services_get_deployments(service_id, deployment_id) } \arguments{ -\item{service_id}{integer required. The ID of the owning ShinyApp} +\item{service_id}{integer required. The ID of the owning Service} \item{deployment_id}{integer required. The ID for this deployment} } @@ -19,7 +19,7 @@ A list containing the following elements: \item{name}{string, Name of the deployment.} \item{dockerImageName}{string, The name of the docker image to pull from DockerHub.} \item{dockerImageTag}{string, The tag of the docker image to pull from DockerHub (default: latest).} -\item{displayUrl}{string, URL that displays the deployed platform object and includes auth token.} +\item{displayUrl}{string, A signed URL for viewing the deployed item.} \item{instanceType}{string, The EC2 instance type requested for the deployment.} \item{memory}{integer, The memory allocated to the deployment.} \item{cpu}{integer, The cpu allocated to the deployment.} @@ -31,5 +31,5 @@ A list containing the following elements: \item{serviceId}{integer, The ID of owning Service} } \description{ -Get details about a ShinyApp deployment +Get details about a Service deployment } diff --git a/man/services_list.Rd b/man/services_list.Rd index 4eb949c5..f5000fee 100644 --- a/man/services_list.Rd +++ b/man/services_list.Rd @@ -9,9 +9,9 @@ services_list(hidden = NULL, archived = NULL, author = NULL, order_dir = NULL) } \arguments{ -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} -\item{archived}{string optional. The archival status of the requested object(s).} +\item{archived}{string optional. The archival status of the requested item(s).} \item{author}{string optional. If specified, return imports from this author. It accepts a comma-separated list of author IDs.} @@ -42,7 +42,7 @@ An array containing the following fields: \item{updatedAt}{string, } \item{gitRepoUrl}{string, The url for the git repo where the Service code lives.} \item{gitRepoRef}{string, The git reference to use when pulling code from the repo.} -\item{gitPathDir}{string, The path to the Shiny app code within the git repo. If unspecified, the root directory will be used.} +\item{gitPathDir}{string, The path to the Service code within the git repo. If unspecified, the root directory will be used.} \item{currentDeployment}{list, A list containing the following elements: \itemize{ \item deploymentId integer, The ID for this deployment. @@ -79,7 +79,7 @@ An array containing the following fields: \item published boolean, \item serviceId integer, The ID of owning Service }} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ List Services diff --git a/man/services_list_deployments.Rd b/man/services_list_deployments.Rd index 2e05382d..0ca30a40 100644 --- a/man/services_list_deployments.Rd +++ b/man/services_list_deployments.Rd @@ -2,13 +2,13 @@ % Please edit documentation in R/generated_client.R \name{services_list_deployments} \alias{services_list_deployments} -\title{List deployments for a ShinyApp} +\title{List deployments for a Service} \usage{ services_list_deployments(service_id, deployment_id = NULL, limit = NULL, page_num = NULL, order = NULL, order_dir = NULL) } \arguments{ -\item{service_id}{integer required. The ID of the owning ShinyApp} +\item{service_id}{integer required. The ID of the owning Service} \item{deployment_id}{integer optional. The ID for this deployment} @@ -39,5 +39,5 @@ An array containing the following fields: \item{serviceId}{integer, The ID of owning Service} } \description{ -List deployments for a ShinyApp +List deployments for a Service } diff --git a/man/services_list_projects.Rd b/man/services_list_projects.Rd index 374d7944..ad8dc8f4 100644 --- a/man/services_list_projects.Rd +++ b/man/services_list_projects.Rd @@ -2,14 +2,14 @@ % Please edit documentation in R/generated_client.R \name{services_list_projects} \alias{services_list_projects} -\title{List the projects a ShinyApp belongs to} +\title{List the projects a Service belongs to} \usage{ services_list_projects(id, hidden = NULL) } \arguments{ \item{id}{integer required. The ID of the resource.} -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} } \value{ An array containing the following fields: @@ -23,7 +23,7 @@ An array containing the following fields: \item online boolean, Whether this user is online. }} \item{name}{string, The name of this project.} -\item{description}{string, A description of the project} +\item{description}{string, A description of the project.} \item{users}{array, An array containing the following fields: \itemize{ \item id integer, The ID of this user. @@ -35,8 +35,8 @@ An array containing the following fields: \item{autoShare}{boolean, } \item{createdAt}{string, } \item{updatedAt}{string, } -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ -List the projects a ShinyApp belongs to +List the projects a Service belongs to } diff --git a/man/services_patch.Rd b/man/services_patch.Rd index 27c4d240..3b73dad8 100644 --- a/man/services_patch.Rd +++ b/man/services_patch.Rd @@ -25,7 +25,7 @@ services_patch(id, name = NULL, description = NULL, \item{schedule}{list optional. A list containing the following elements: \itemize{ \item runtimePlan string, Only affects the service when deployed. On Demand means that the service will be turned on when viewed and automatically turned off after periods of inactivity. Specific Times means the service will be on when scheduled. Always On means the deployed service will always be on. -\item recurrences array, List of day-hour combinations this object is scheduled for +\item recurrences array, List of day-hour combinations this item is scheduled for }} \item{replicas}{integer optional. The number of Service replicas to deploy. When maxReplicas is set, this field defines the minimum number of replicas to deploy.} @@ -46,7 +46,7 @@ services_patch(id, name = NULL, description = NULL, \item{git_repo_ref}{string optional. The git reference to use when pulling code from the repo.} -\item{git_path_dir}{string optional. The path to the Shiny app code within the git repo. If unspecified, the root directory will be used.} +\item{git_path_dir}{string optional. The path to the Service code within the git repo. If unspecified, the root directory will be used.} \item{environment_variables}{list optional. Environment Variables to be passed into the Service.} @@ -74,7 +74,7 @@ A list containing the following elements: \item{schedule}{list, A list containing the following elements: \itemize{ \item runtimePlan string, Only affects the service when deployed. On Demand means that the service will be turned on when viewed and automatically turned off after periods of inactivity. Specific Times means the service will be on when scheduled. Always On means the deployed service will always be on. -\item recurrences array, List of day-hour combinations this object is scheduled for +\item recurrences array, List of day-hour combinations this item is scheduled for }} \item{timeZone}{string, } \item{replicas}{integer, The number of Service replicas to deploy. When maxReplicas is set, this field defines the minimum number of replicas to deploy.} @@ -88,7 +88,7 @@ A list containing the following elements: \item{apiKeyId}{integer, API key id of user} \item{gitRepoUrl}{string, The url for the git repo where the Service code lives.} \item{gitRepoRef}{string, The git reference to use when pulling code from the repo.} -\item{gitPathDir}{string, The path to the Shiny app code within the git repo. If unspecified, the root directory will be used.} +\item{gitPathDir}{string, The path to the Service code within the git repo. If unspecified, the root directory will be used.} \item{reportId}{integer, The ID of the associated report.} \item{currentDeployment}{list, A list containing the following elements: \itemize{ @@ -98,7 +98,7 @@ A list containing the following elements: \item name string, Name of the deployment. \item dockerImageName string, The name of the docker image to pull from DockerHub. \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -\item displayUrl string, URL that displays the deployed platform object and includes auth token. +\item displayUrl string, A signed URL for viewing the deployed item. \item instanceType string, The EC2 instance type requested for the deployment. \item memory integer, The memory allocated to the deployment. \item cpu integer, The cpu allocated to the deployment. @@ -117,7 +117,7 @@ A list containing the following elements: \item name string, Name of the deployment. \item dockerImageName string, The name of the docker image to pull from DockerHub. \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -\item displayUrl string, URL that displays the deployed platform object and includes auth token. +\item displayUrl string, A signed URL for viewing the deployed item. \item instanceType string, The EC2 instance type requested for the deployment. \item memory integer, The memory allocated to the deployment. \item cpu integer, The cpu allocated to the deployment. @@ -136,8 +136,8 @@ A list containing the following elements: \item failureEmailAddresses array, Addresses to notify by e-mail when the service fails. \item failureOn boolean, If failure email notifications are on }} -\item{archived}{string, The archival status of the requested object(s).} -\item{hidden}{boolean, The hidden status of the object.} +\item{archived}{string, The archival status of the requested item(s).} +\item{hidden}{boolean, The hidden status of the item.} } \description{ Update some attributes of this Service diff --git a/man/services_post.Rd b/man/services_post.Rd index 8991fafc..7a1e6197 100644 --- a/man/services_post.Rd +++ b/man/services_post.Rd @@ -23,7 +23,7 @@ services_post(name = NULL, description = NULL, docker_image_name = NULL, \item{schedule}{list optional. A list containing the following elements: \itemize{ \item runtimePlan string, Only affects the service when deployed. On Demand means that the service will be turned on when viewed and automatically turned off after periods of inactivity. Specific Times means the service will be on when scheduled. Always On means the deployed service will always be on. -\item recurrences array, List of day-hour combinations this object is scheduled for +\item recurrences array, List of day-hour combinations this item is scheduled for }} \item{replicas}{integer optional. The number of Service replicas to deploy. When maxReplicas is set, this field defines the minimum number of replicas to deploy.} @@ -44,7 +44,7 @@ services_post(name = NULL, description = NULL, docker_image_name = NULL, \item{git_repo_ref}{string optional. The git reference to use when pulling code from the repo.} -\item{git_path_dir}{string optional. The path to the Shiny app code within the git repo. If unspecified, the root directory will be used.} +\item{git_path_dir}{string optional. The path to the Service code within the git repo. If unspecified, the root directory will be used.} \item{environment_variables}{list optional. Environment Variables to be passed into the Service.} @@ -54,7 +54,7 @@ services_post(name = NULL, description = NULL, docker_image_name = NULL, \item failureOn boolean, If failure email notifications are on }} -\item{hidden}{boolean optional. The hidden status of the object.} +\item{hidden}{boolean optional. The hidden status of the item.} } \value{ A list containing the following elements: @@ -74,7 +74,7 @@ A list containing the following elements: \item{schedule}{list, A list containing the following elements: \itemize{ \item runtimePlan string, Only affects the service when deployed. On Demand means that the service will be turned on when viewed and automatically turned off after periods of inactivity. Specific Times means the service will be on when scheduled. Always On means the deployed service will always be on. -\item recurrences array, List of day-hour combinations this object is scheduled for +\item recurrences array, List of day-hour combinations this item is scheduled for }} \item{timeZone}{string, } \item{replicas}{integer, The number of Service replicas to deploy. When maxReplicas is set, this field defines the minimum number of replicas to deploy.} @@ -88,7 +88,7 @@ A list containing the following elements: \item{apiKeyId}{integer, API key id of user} \item{gitRepoUrl}{string, The url for the git repo where the Service code lives.} \item{gitRepoRef}{string, The git reference to use when pulling code from the repo.} -\item{gitPathDir}{string, The path to the Shiny app code within the git repo. If unspecified, the root directory will be used.} +\item{gitPathDir}{string, The path to the Service code within the git repo. If unspecified, the root directory will be used.} \item{reportId}{integer, The ID of the associated report.} \item{currentDeployment}{list, A list containing the following elements: \itemize{ @@ -98,7 +98,7 @@ A list containing the following elements: \item name string, Name of the deployment. \item dockerImageName string, The name of the docker image to pull from DockerHub. \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -\item displayUrl string, URL that displays the deployed platform object and includes auth token. +\item displayUrl string, A signed URL for viewing the deployed item. \item instanceType string, The EC2 instance type requested for the deployment. \item memory integer, The memory allocated to the deployment. \item cpu integer, The cpu allocated to the deployment. @@ -117,7 +117,7 @@ A list containing the following elements: \item name string, Name of the deployment. \item dockerImageName string, The name of the docker image to pull from DockerHub. \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -\item displayUrl string, URL that displays the deployed platform object and includes auth token. +\item displayUrl string, A signed URL for viewing the deployed item. \item instanceType string, The EC2 instance type requested for the deployment. \item memory integer, The memory allocated to the deployment. \item cpu integer, The cpu allocated to the deployment. @@ -136,8 +136,8 @@ A list containing the following elements: \item failureEmailAddresses array, Addresses to notify by e-mail when the service fails. \item failureOn boolean, If failure email notifications are on }} -\item{archived}{string, The archival status of the requested object(s).} -\item{hidden}{boolean, The hidden status of the object.} +\item{archived}{string, The archival status of the requested item(s).} +\item{hidden}{boolean, The hidden status of the item.} } \description{ Create a Service diff --git a/man/services_post_clone.Rd b/man/services_post_clone.Rd index f035d441..5238686e 100644 --- a/man/services_post_clone.Rd +++ b/man/services_post_clone.Rd @@ -27,7 +27,7 @@ A list containing the following elements: \item{schedule}{list, A list containing the following elements: \itemize{ \item runtimePlan string, Only affects the service when deployed. On Demand means that the service will be turned on when viewed and automatically turned off after periods of inactivity. Specific Times means the service will be on when scheduled. Always On means the deployed service will always be on. -\item recurrences array, List of day-hour combinations this object is scheduled for +\item recurrences array, List of day-hour combinations this item is scheduled for }} \item{timeZone}{string, } \item{replicas}{integer, The number of Service replicas to deploy. When maxReplicas is set, this field defines the minimum number of replicas to deploy.} @@ -41,7 +41,7 @@ A list containing the following elements: \item{apiKeyId}{integer, API key id of user} \item{gitRepoUrl}{string, The url for the git repo where the Service code lives.} \item{gitRepoRef}{string, The git reference to use when pulling code from the repo.} -\item{gitPathDir}{string, The path to the Shiny app code within the git repo. If unspecified, the root directory will be used.} +\item{gitPathDir}{string, The path to the Service code within the git repo. If unspecified, the root directory will be used.} \item{reportId}{integer, The ID of the associated report.} \item{currentDeployment}{list, A list containing the following elements: \itemize{ @@ -51,7 +51,7 @@ A list containing the following elements: \item name string, Name of the deployment. \item dockerImageName string, The name of the docker image to pull from DockerHub. \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -\item displayUrl string, URL that displays the deployed platform object and includes auth token. +\item displayUrl string, A signed URL for viewing the deployed item. \item instanceType string, The EC2 instance type requested for the deployment. \item memory integer, The memory allocated to the deployment. \item cpu integer, The cpu allocated to the deployment. @@ -70,7 +70,7 @@ A list containing the following elements: \item name string, Name of the deployment. \item dockerImageName string, The name of the docker image to pull from DockerHub. \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -\item displayUrl string, URL that displays the deployed platform object and includes auth token. +\item displayUrl string, A signed URL for viewing the deployed item. \item instanceType string, The EC2 instance type requested for the deployment. \item memory integer, The memory allocated to the deployment. \item cpu integer, The cpu allocated to the deployment. @@ -89,8 +89,8 @@ A list containing the following elements: \item failureEmailAddresses array, Addresses to notify by e-mail when the service fails. \item failureOn boolean, If failure email notifications are on }} -\item{archived}{string, The archival status of the requested object(s).} -\item{hidden}{boolean, The hidden status of the object.} +\item{archived}{string, The archival status of the requested item(s).} +\item{hidden}{boolean, The hidden status of the item.} } \description{ Clone this Service diff --git a/man/services_post_deployments.Rd b/man/services_post_deployments.Rd index 3a9ecf8f..62284592 100644 --- a/man/services_post_deployments.Rd +++ b/man/services_post_deployments.Rd @@ -2,13 +2,13 @@ % Please edit documentation in R/generated_client.R \name{services_post_deployments} \alias{services_post_deployments} -\title{Deploy a ShinyApp} +\title{Deploy a Service} \usage{ services_post_deployments(service_id, deployment_id = NULL, published = NULL) } \arguments{ -\item{service_id}{integer required. The ID of the owning ShinyApp} +\item{service_id}{integer required. The ID of the owning Service} \item{deployment_id}{integer optional. The ID for this deployment} @@ -22,7 +22,7 @@ A list containing the following elements: \item{name}{string, Name of the deployment.} \item{dockerImageName}{string, The name of the docker image to pull from DockerHub.} \item{dockerImageTag}{string, The tag of the docker image to pull from DockerHub (default: latest).} -\item{displayUrl}{string, URL that displays the deployed platform object and includes auth token.} +\item{displayUrl}{string, A signed URL for viewing the deployed item.} \item{instanceType}{string, The EC2 instance type requested for the deployment.} \item{memory}{integer, The memory allocated to the deployment.} \item{cpu}{integer, The cpu allocated to the deployment.} @@ -34,5 +34,5 @@ A list containing the following elements: \item{serviceId}{integer, The ID of owning Service} } \description{ -Deploy a ShinyApp +Deploy a Service } diff --git a/man/services_post_redeploy.Rd b/man/services_post_redeploy.Rd index ebd8ae49..2d3a0403 100644 --- a/man/services_post_redeploy.Rd +++ b/man/services_post_redeploy.Rd @@ -2,12 +2,12 @@ % Please edit documentation in R/generated_client.R \name{services_post_redeploy} \alias{services_post_redeploy} -\title{Redeploy a ShinyApp} +\title{Redeploy a Service} \usage{ services_post_redeploy(service_id, deployment_id = NULL, published = NULL) } \arguments{ -\item{service_id}{integer required. The ID of the owning ShinyApp} +\item{service_id}{integer required. The ID of the owning Service} \item{deployment_id}{integer optional. The ID for this deployment} @@ -21,7 +21,7 @@ A list containing the following elements: \item{name}{string, Name of the deployment.} \item{dockerImageName}{string, The name of the docker image to pull from DockerHub.} \item{dockerImageTag}{string, The tag of the docker image to pull from DockerHub (default: latest).} -\item{displayUrl}{string, URL that displays the deployed platform object and includes auth token.} +\item{displayUrl}{string, A signed URL for viewing the deployed item.} \item{instanceType}{string, The EC2 instance type requested for the deployment.} \item{memory}{integer, The memory allocated to the deployment.} \item{cpu}{integer, The cpu allocated to the deployment.} @@ -33,5 +33,5 @@ A list containing the following elements: \item{serviceId}{integer, The ID of owning Service} } \description{ -Redeploy a ShinyApp +Redeploy a Service } diff --git a/man/services_put.Rd b/man/services_put.Rd index 539e905d..b290becb 100644 --- a/man/services_put.Rd +++ b/man/services_put.Rd @@ -25,7 +25,7 @@ services_put(id, name = NULL, description = NULL, \item{schedule}{list optional. A list containing the following elements: \itemize{ \item runtimePlan string, Only affects the service when deployed. On Demand means that the service will be turned on when viewed and automatically turned off after periods of inactivity. Specific Times means the service will be on when scheduled. Always On means the deployed service will always be on. -\item recurrences array, List of day-hour combinations this object is scheduled for +\item recurrences array, List of day-hour combinations this item is scheduled for }} \item{replicas}{integer optional. The number of Service replicas to deploy. When maxReplicas is set, this field defines the minimum number of replicas to deploy.} @@ -46,7 +46,7 @@ services_put(id, name = NULL, description = NULL, \item{git_repo_ref}{string optional. The git reference to use when pulling code from the repo.} -\item{git_path_dir}{string optional. The path to the Shiny app code within the git repo. If unspecified, the root directory will be used.} +\item{git_path_dir}{string optional. The path to the Service code within the git repo. If unspecified, the root directory will be used.} \item{environment_variables}{list optional. Environment Variables to be passed into the Service.} @@ -74,7 +74,7 @@ A list containing the following elements: \item{schedule}{list, A list containing the following elements: \itemize{ \item runtimePlan string, Only affects the service when deployed. On Demand means that the service will be turned on when viewed and automatically turned off after periods of inactivity. Specific Times means the service will be on when scheduled. Always On means the deployed service will always be on. -\item recurrences array, List of day-hour combinations this object is scheduled for +\item recurrences array, List of day-hour combinations this item is scheduled for }} \item{timeZone}{string, } \item{replicas}{integer, The number of Service replicas to deploy. When maxReplicas is set, this field defines the minimum number of replicas to deploy.} @@ -88,7 +88,7 @@ A list containing the following elements: \item{apiKeyId}{integer, API key id of user} \item{gitRepoUrl}{string, The url for the git repo where the Service code lives.} \item{gitRepoRef}{string, The git reference to use when pulling code from the repo.} -\item{gitPathDir}{string, The path to the Shiny app code within the git repo. If unspecified, the root directory will be used.} +\item{gitPathDir}{string, The path to the Service code within the git repo. If unspecified, the root directory will be used.} \item{reportId}{integer, The ID of the associated report.} \item{currentDeployment}{list, A list containing the following elements: \itemize{ @@ -98,7 +98,7 @@ A list containing the following elements: \item name string, Name of the deployment. \item dockerImageName string, The name of the docker image to pull from DockerHub. \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -\item displayUrl string, URL that displays the deployed platform object and includes auth token. +\item displayUrl string, A signed URL for viewing the deployed item. \item instanceType string, The EC2 instance type requested for the deployment. \item memory integer, The memory allocated to the deployment. \item cpu integer, The cpu allocated to the deployment. @@ -117,7 +117,7 @@ A list containing the following elements: \item name string, Name of the deployment. \item dockerImageName string, The name of the docker image to pull from DockerHub. \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -\item displayUrl string, URL that displays the deployed platform object and includes auth token. +\item displayUrl string, A signed URL for viewing the deployed item. \item instanceType string, The EC2 instance type requested for the deployment. \item memory integer, The memory allocated to the deployment. \item cpu integer, The cpu allocated to the deployment. @@ -136,8 +136,8 @@ A list containing the following elements: \item failureEmailAddresses array, Addresses to notify by e-mail when the service fails. \item failureOn boolean, If failure email notifications are on }} -\item{archived}{string, The archival status of the requested object(s).} -\item{hidden}{boolean, The hidden status of the object.} +\item{archived}{string, The archival status of the requested item(s).} +\item{hidden}{boolean, The hidden status of the item.} } \description{ Replace all attributes of this Service diff --git a/man/services_put_archive.Rd b/man/services_put_archive.Rd index 2fd4fc64..c9be8f53 100644 --- a/man/services_put_archive.Rd +++ b/man/services_put_archive.Rd @@ -29,7 +29,7 @@ A list containing the following elements: \item{schedule}{list, A list containing the following elements: \itemize{ \item runtimePlan string, Only affects the service when deployed. On Demand means that the service will be turned on when viewed and automatically turned off after periods of inactivity. Specific Times means the service will be on when scheduled. Always On means the deployed service will always be on. -\item recurrences array, List of day-hour combinations this object is scheduled for +\item recurrences array, List of day-hour combinations this item is scheduled for }} \item{timeZone}{string, } \item{replicas}{integer, The number of Service replicas to deploy. When maxReplicas is set, this field defines the minimum number of replicas to deploy.} @@ -43,7 +43,7 @@ A list containing the following elements: \item{apiKeyId}{integer, API key id of user} \item{gitRepoUrl}{string, The url for the git repo where the Service code lives.} \item{gitRepoRef}{string, The git reference to use when pulling code from the repo.} -\item{gitPathDir}{string, The path to the Shiny app code within the git repo. If unspecified, the root directory will be used.} +\item{gitPathDir}{string, The path to the Service code within the git repo. If unspecified, the root directory will be used.} \item{reportId}{integer, The ID of the associated report.} \item{currentDeployment}{list, A list containing the following elements: \itemize{ @@ -53,7 +53,7 @@ A list containing the following elements: \item name string, Name of the deployment. \item dockerImageName string, The name of the docker image to pull from DockerHub. \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -\item displayUrl string, URL that displays the deployed platform object and includes auth token. +\item displayUrl string, A signed URL for viewing the deployed item. \item instanceType string, The EC2 instance type requested for the deployment. \item memory integer, The memory allocated to the deployment. \item cpu integer, The cpu allocated to the deployment. @@ -72,7 +72,7 @@ A list containing the following elements: \item name string, Name of the deployment. \item dockerImageName string, The name of the docker image to pull from DockerHub. \item dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest). -\item displayUrl string, URL that displays the deployed platform object and includes auth token. +\item displayUrl string, A signed URL for viewing the deployed item. \item instanceType string, The EC2 instance type requested for the deployment. \item memory integer, The memory allocated to the deployment. \item cpu integer, The cpu allocated to the deployment. @@ -91,8 +91,8 @@ A list containing the following elements: \item failureEmailAddresses array, Addresses to notify by e-mail when the service fails. \item failureOn boolean, If failure email notifications are on }} -\item{archived}{string, The archival status of the requested object(s).} -\item{hidden}{boolean, The hidden status of the object.} +\item{archived}{string, The archival status of the requested item(s).} +\item{hidden}{boolean, The hidden status of the item.} } \description{ Update the archive status of this object diff --git a/man/services_put_projects.Rd b/man/services_put_projects.Rd index 443945ad..717671bc 100644 --- a/man/services_put_projects.Rd +++ b/man/services_put_projects.Rd @@ -2,18 +2,18 @@ % Please edit documentation in R/generated_client.R \name{services_put_projects} \alias{services_put_projects} -\title{Add a ShinyApp to a project} +\title{Add a Service to a project} \usage{ services_put_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response } \description{ -Add a ShinyApp to a project +Add a Service to a project } diff --git a/man/templates_delete_scripts_projects.Rd b/man/templates_delete_scripts_projects.Rd index abb17bd8..aabbc1fa 100644 --- a/man/templates_delete_scripts_projects.Rd +++ b/man/templates_delete_scripts_projects.Rd @@ -7,9 +7,9 @@ templates_delete_scripts_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/templates_get_reports.Rd b/man/templates_get_reports.Rd index ef0421c7..2a42c67c 100644 --- a/man/templates_get_reports.Rd +++ b/man/templates_get_reports.Rd @@ -29,7 +29,7 @@ A list containing the following elements: \item{techReviewed}{boolean, Whether this template has been audited by Civis for security vulnerability and correctness.} \item{authCodeUrl}{string, A URL to the template's stored code body.} \item{provideAPIKey}{boolean, Whether reports based on this template request an API Key from the report viewer.} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} } \description{ Get a Report Template diff --git a/man/templates_get_scripts.Rd b/man/templates_get_scripts.Rd index 240121d9..5d41ed6b 100644 --- a/man/templates_get_scripts.Rd +++ b/man/templates_get_scripts.Rd @@ -23,7 +23,7 @@ A list containing the following elements: \item{uiReportId}{integer, The id of the report that this template uses.} \item{techReviewed}{boolean, Whether this template has been audited by Civis for security vulnerability and correctness.} \item{archived}{boolean, Whether the template has been archived.} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} } \description{ Get a Script Template diff --git a/man/templates_list_reports.Rd b/man/templates_list_reports.Rd index 7b6eab44..d1751782 100644 --- a/man/templates_list_reports.Rd +++ b/man/templates_list_reports.Rd @@ -8,7 +8,7 @@ templates_list_reports(hidden = NULL, category = NULL, limit = NULL, page_num = NULL, order = NULL, order_dir = NULL) } \arguments{ -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} \item{category}{string optional. A category to filter results by, one of: dataset-viz} diff --git a/man/templates_list_scripts.Rd b/man/templates_list_scripts.Rd index c5b2ec83..5613464f 100644 --- a/man/templates_list_scripts.Rd +++ b/man/templates_list_scripts.Rd @@ -8,7 +8,7 @@ templates_list_scripts(hidden = NULL, category = NULL, limit = NULL, page_num = NULL, order = NULL, order_dir = NULL) } \arguments{ -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} \item{category}{string optional. A category to filter results by, one of: import, export, enhancement, model, and script} diff --git a/man/templates_list_scripts_projects.Rd b/man/templates_list_scripts_projects.Rd index 08e3bbda..9262fbd5 100644 --- a/man/templates_list_scripts_projects.Rd +++ b/man/templates_list_scripts_projects.Rd @@ -9,7 +9,7 @@ templates_list_scripts_projects(id, hidden = NULL) \arguments{ \item{id}{integer required. The ID of the resource.} -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} } \value{ An array containing the following fields: @@ -23,7 +23,7 @@ An array containing the following fields: \item online boolean, Whether this user is online. }} \item{name}{string, The name of this project.} -\item{description}{string, A description of the project} +\item{description}{string, A description of the project.} \item{users}{array, An array containing the following fields: \itemize{ \item id integer, The ID of this user. @@ -35,7 +35,7 @@ An array containing the following fields: \item{autoShare}{boolean, } \item{createdAt}{string, } \item{updatedAt}{string, } -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ List the projects a Template::Script belongs to diff --git a/man/templates_patch_reports.Rd b/man/templates_patch_reports.Rd index 5046b198..4214e4a9 100644 --- a/man/templates_patch_reports.Rd +++ b/man/templates_patch_reports.Rd @@ -40,7 +40,7 @@ A list containing the following elements: \item{techReviewed}{boolean, Whether this template has been audited by Civis for security vulnerability and correctness.} \item{authCodeUrl}{string, A URL to the template's stored code body.} \item{provideAPIKey}{boolean, Whether reports based on this template request an API Key from the report viewer.} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} } \description{ Update some attributes of this Report Template diff --git a/man/templates_patch_scripts.Rd b/man/templates_patch_scripts.Rd index bc186bbc..1d2360ad 100644 --- a/man/templates_patch_scripts.Rd +++ b/man/templates_patch_scripts.Rd @@ -32,7 +32,7 @@ A list containing the following elements: \item{uiReportId}{integer, The id of the report that this template uses.} \item{techReviewed}{boolean, Whether this template has been audited by Civis for security vulnerability and correctness.} \item{archived}{boolean, Whether the template has been archived.} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} } \description{ Update some attributes of this Script Template diff --git a/man/templates_post_reports.Rd b/man/templates_post_reports.Rd index 74c6452c..9dfefa65 100644 --- a/man/templates_post_reports.Rd +++ b/man/templates_post_reports.Rd @@ -18,7 +18,7 @@ templates_post_reports(name, code_body, category = NULL, archived = NULL, \item{provide_api_key}{boolean optional. Whether reports based on this template request an API Key from the report viewer.} -\item{hidden}{boolean optional. The hidden status of the object.} +\item{hidden}{boolean optional. The hidden status of the item.} } \value{ A list containing the following elements: @@ -40,7 +40,7 @@ A list containing the following elements: \item{techReviewed}{boolean, Whether this template has been audited by Civis for security vulnerability and correctness.} \item{authCodeUrl}{string, A URL to the template's stored code body.} \item{provideAPIKey}{boolean, Whether reports based on this template request an API Key from the report viewer.} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} } \description{ Create a Report Template diff --git a/man/templates_post_scripts.Rd b/man/templates_post_scripts.Rd index 1c82c9ea..695c74cd 100644 --- a/man/templates_post_scripts.Rd +++ b/man/templates_post_scripts.Rd @@ -18,7 +18,7 @@ templates_post_scripts(script_id, name, note = NULL, ui_report_id = NULL, \item{archived}{boolean optional. Whether the template has been archived.} -\item{hidden}{boolean optional. The hidden status of the object.} +\item{hidden}{boolean optional. The hidden status of the item.} } \value{ A list containing the following elements: @@ -34,7 +34,7 @@ A list containing the following elements: \item{uiReportId}{integer, The id of the report that this template uses.} \item{techReviewed}{boolean, Whether this template has been audited by Civis for security vulnerability and correctness.} \item{archived}{boolean, Whether the template has been archived.} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} } \description{ Create a Script Template diff --git a/man/templates_put_reports.Rd b/man/templates_put_reports.Rd index a8428545..4e488996 100644 --- a/man/templates_put_reports.Rd +++ b/man/templates_put_reports.Rd @@ -40,7 +40,7 @@ A list containing the following elements: \item{techReviewed}{boolean, Whether this template has been audited by Civis for security vulnerability and correctness.} \item{authCodeUrl}{string, A URL to the template's stored code body.} \item{provideAPIKey}{boolean, Whether reports based on this template request an API Key from the report viewer.} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} } \description{ Replace all attributes of this Report Template diff --git a/man/templates_put_scripts.Rd b/man/templates_put_scripts.Rd index 60e9f542..92af8ed8 100644 --- a/man/templates_put_scripts.Rd +++ b/man/templates_put_scripts.Rd @@ -32,7 +32,7 @@ A list containing the following elements: \item{uiReportId}{integer, The id of the report that this template uses.} \item{techReviewed}{boolean, Whether this template has been audited by Civis for security vulnerability and correctness.} \item{archived}{boolean, Whether the template has been archived.} -\item{hidden}{boolean, The hidden status of the object.} +\item{hidden}{boolean, The hidden status of the item.} } \description{ Replace all attributes of this Script Template diff --git a/man/templates_put_scripts_projects.Rd b/man/templates_put_scripts_projects.Rd index 7d8a0c91..468e599b 100644 --- a/man/templates_put_scripts_projects.Rd +++ b/man/templates_put_scripts_projects.Rd @@ -7,9 +7,9 @@ templates_put_scripts_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/workflows_delete_projects.Rd b/man/workflows_delete_projects.Rd index bfd5f60e..9deddbef 100644 --- a/man/workflows_delete_projects.Rd +++ b/man/workflows_delete_projects.Rd @@ -7,9 +7,9 @@ workflows_delete_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/man/workflows_get.Rd b/man/workflows_get.Rd index e4c56ada..05c48e43 100644 --- a/man/workflows_get.Rd +++ b/man/workflows_get.Rd @@ -29,11 +29,11 @@ A list containing the following elements: \item{state}{string, The state of the workflow. State is "running" if any execution is running, otherwise reflects most recent execution state.} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{timeZone}{string, The time zone of this workflow.} \item{nextExecutionAt}{string, The time of the next scheduled execution.} @@ -47,8 +47,8 @@ A list containing the following elements: \item successOn boolean, If success email notifications are on \item failureOn boolean, If failure email notifications are on }} -\item{archived}{string, The archival status of the requested object(s).} -\item{hidden}{boolean, The hidden status of the object.} +\item{archived}{string, The archival status of the requested item(s).} +\item{hidden}{boolean, The hidden status of the item.} \item{createdAt}{string, } \item{updatedAt}{string, } } diff --git a/man/workflows_get_executions.Rd b/man/workflows_get_executions.Rd index 47fb20d7..e6b95700 100644 --- a/man/workflows_get_executions.Rd +++ b/man/workflows_get_executions.Rd @@ -26,7 +26,7 @@ A list containing the following elements: \item online boolean, Whether this user is online. }} \item{definition}{string, The definition of the workflow for this execution.} -\item{input}{list, The dictionary of name/value input pairs defined for this execution.} +\item{input}{list, Key-value pairs defined for this execution.} \item{includedTasks}{array, The subset of workflow tasks selected to execute.} \item{tasks}{array, An array containing the following fields: \itemize{ diff --git a/man/workflows_get_git_commits.Rd b/man/workflows_get_git_commits.Rd index 370bb713..0b8465fd 100644 --- a/man/workflows_get_git_commits.Rd +++ b/man/workflows_get_git_commits.Rd @@ -7,7 +7,7 @@ workflows_get_git_commits(id, commit_hash) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} \item{commit_hash}{string required. The SHA (full or shortened) of the desired git commit.} } diff --git a/man/workflows_list.Rd b/man/workflows_list.Rd index 366a3df7..8a8f1bd1 100644 --- a/man/workflows_list.Rd +++ b/man/workflows_list.Rd @@ -8,9 +8,9 @@ workflows_list(hidden = NULL, archived = NULL, author = NULL, limit = NULL, page_num = NULL, order = NULL, order_dir = NULL) } \arguments{ -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} -\item{archived}{string optional. The archival status of the requested object(s).} +\item{archived}{string optional. The archival status of the requested item(s).} \item{author}{string optional. If specified, return workflows from this author. It accepts a comma-separated list of author ids.} @@ -40,15 +40,15 @@ An array containing the following fields: \item{state}{string, The state of the workflow. State is "running" if any execution is running, otherwise reflects most recent execution state.} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{timeZone}{string, The time zone of this workflow.} \item{nextExecutionAt}{string, The time of the next scheduled execution.} -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} \item{createdAt}{string, } \item{updatedAt}{string, } } diff --git a/man/workflows_list_git.Rd b/man/workflows_list_git.Rd index 70ef887d..a2b3a53c 100644 --- a/man/workflows_list_git.Rd +++ b/man/workflows_list_git.Rd @@ -7,7 +7,7 @@ workflows_list_git(id) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} } \value{ A list containing the following elements: diff --git a/man/workflows_list_git_commits.Rd b/man/workflows_list_git_commits.Rd index 3203a586..c3c7a829 100644 --- a/man/workflows_list_git_commits.Rd +++ b/man/workflows_list_git_commits.Rd @@ -7,7 +7,7 @@ workflows_list_git_commits(id) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} } \value{ A list containing the following elements: diff --git a/man/workflows_list_projects.Rd b/man/workflows_list_projects.Rd index 937aa892..474826b4 100644 --- a/man/workflows_list_projects.Rd +++ b/man/workflows_list_projects.Rd @@ -9,7 +9,7 @@ workflows_list_projects(id, hidden = NULL) \arguments{ \item{id}{integer required. The ID of the resource.} -\item{hidden}{boolean optional. If specified to be true, returns hidden objects. Defaults to false, returning non-hidden objects.} +\item{hidden}{boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.} } \value{ An array containing the following fields: @@ -23,7 +23,7 @@ An array containing the following fields: \item online boolean, Whether this user is online. }} \item{name}{string, The name of this project.} -\item{description}{string, A description of the project} +\item{description}{string, A description of the project.} \item{users}{array, An array containing the following fields: \itemize{ \item id integer, The ID of this user. @@ -35,7 +35,7 @@ An array containing the following fields: \item{autoShare}{boolean, } \item{createdAt}{string, } \item{updatedAt}{string, } -\item{archived}{string, The archival status of the requested object(s).} +\item{archived}{string, The archival status of the requested item(s).} } \description{ List the projects a Workflow::Workflow belongs to diff --git a/man/workflows_patch.Rd b/man/workflows_patch.Rd index 56f21595..e8edfed1 100644 --- a/man/workflows_patch.Rd +++ b/man/workflows_patch.Rd @@ -18,11 +18,11 @@ workflows_patch(id, name = NULL, description = NULL, definition = NULL, \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{time_zone}{string optional. The time zone of this workflow.} @@ -58,11 +58,11 @@ A list containing the following elements: \item{state}{string, The state of the workflow. State is "running" if any execution is running, otherwise reflects most recent execution state.} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{timeZone}{string, The time zone of this workflow.} \item{nextExecutionAt}{string, The time of the next scheduled execution.} @@ -76,8 +76,8 @@ A list containing the following elements: \item successOn boolean, If success email notifications are on \item failureOn boolean, If failure email notifications are on }} -\item{archived}{string, The archival status of the requested object(s).} -\item{hidden}{boolean, The hidden status of the object.} +\item{archived}{string, The archival status of the requested item(s).} +\item{hidden}{boolean, The hidden status of the item.} \item{createdAt}{string, } \item{updatedAt}{string, } } diff --git a/man/workflows_post.Rd b/man/workflows_post.Rd index 4c496578..7d610432 100644 --- a/man/workflows_post.Rd +++ b/man/workflows_post.Rd @@ -19,11 +19,11 @@ workflows_post(name, description = NULL, from_job_chain = NULL, \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{time_zone}{string optional. The time zone of this workflow.} @@ -39,7 +39,7 @@ workflows_post(name, description = NULL, from_job_chain = NULL, \item failureOn boolean, If failure email notifications are on }} -\item{hidden}{boolean optional. The hidden status of the object.} +\item{hidden}{boolean optional. The hidden status of the item.} } \value{ A list containing the following elements: @@ -61,11 +61,11 @@ A list containing the following elements: \item{state}{string, The state of the workflow. State is "running" if any execution is running, otherwise reflects most recent execution state.} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{timeZone}{string, The time zone of this workflow.} \item{nextExecutionAt}{string, The time of the next scheduled execution.} @@ -79,8 +79,8 @@ A list containing the following elements: \item successOn boolean, If success email notifications are on \item failureOn boolean, If failure email notifications are on }} -\item{archived}{string, The archival status of the requested object(s).} -\item{hidden}{boolean, The hidden status of the object.} +\item{archived}{string, The archival status of the requested item(s).} +\item{hidden}{boolean, The hidden status of the item.} \item{createdAt}{string, } \item{updatedAt}{string, } } diff --git a/man/workflows_post_clone.Rd b/man/workflows_post_clone.Rd index 7e192d5a..3412f944 100644 --- a/man/workflows_post_clone.Rd +++ b/man/workflows_post_clone.Rd @@ -33,11 +33,11 @@ A list containing the following elements: \item{state}{string, The state of the workflow. State is "running" if any execution is running, otherwise reflects most recent execution state.} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{timeZone}{string, The time zone of this workflow.} \item{nextExecutionAt}{string, The time of the next scheduled execution.} @@ -51,8 +51,8 @@ A list containing the following elements: \item successOn boolean, If success email notifications are on \item failureOn boolean, If failure email notifications are on }} -\item{archived}{string, The archival status of the requested object(s).} -\item{hidden}{boolean, The hidden status of the object.} +\item{archived}{string, The archival status of the requested item(s).} +\item{hidden}{boolean, The hidden status of the item.} \item{createdAt}{string, } \item{updatedAt}{string, } } diff --git a/man/workflows_post_executions.Rd b/man/workflows_post_executions.Rd index 740160d3..6fcfc003 100644 --- a/man/workflows_post_executions.Rd +++ b/man/workflows_post_executions.Rd @@ -12,7 +12,7 @@ workflows_post_executions(id, target_task = NULL, input = NULL, \item{target_task}{string optional. For a reverse workflow, the name of the task to target.} -\item{input}{list optional. The dictionary of name/value input pairs defined for this execution.} +\item{input}{list optional. Key-value pairs to send to this execution as inputs.} \item{included_tasks}{array optional. If specified, executes only the subset of workflow tasks included.} } @@ -31,7 +31,7 @@ A list containing the following elements: \item online boolean, Whether this user is online. }} \item{definition}{string, The definition of the workflow for this execution.} -\item{input}{list, The dictionary of name/value input pairs defined for this execution.} +\item{input}{list, Key-value pairs defined for this execution.} \item{includedTasks}{array, The subset of workflow tasks selected to execute.} \item{tasks}{array, An array containing the following fields: \itemize{ diff --git a/man/workflows_post_executions_cancel.Rd b/man/workflows_post_executions_cancel.Rd index 198b99a0..001d0664 100644 --- a/man/workflows_post_executions_cancel.Rd +++ b/man/workflows_post_executions_cancel.Rd @@ -26,7 +26,7 @@ A list containing the following elements: \item online boolean, Whether this user is online. }} \item{definition}{string, The definition of the workflow for this execution.} -\item{input}{list, The dictionary of name/value input pairs defined for this execution.} +\item{input}{list, Key-value pairs defined for this execution.} \item{includedTasks}{array, The subset of workflow tasks selected to execute.} \item{tasks}{array, An array containing the following fields: \itemize{ diff --git a/man/workflows_post_executions_resume.Rd b/man/workflows_post_executions_resume.Rd index 3f623e62..79fdddd0 100644 --- a/man/workflows_post_executions_resume.Rd +++ b/man/workflows_post_executions_resume.Rd @@ -26,7 +26,7 @@ A list containing the following elements: \item online boolean, Whether this user is online. }} \item{definition}{string, The definition of the workflow for this execution.} -\item{input}{list, The dictionary of name/value input pairs defined for this execution.} +\item{input}{list, Key-value pairs defined for this execution.} \item{includedTasks}{array, The subset of workflow tasks selected to execute.} \item{tasks}{array, An array containing the following fields: \itemize{ diff --git a/man/workflows_post_executions_retry.Rd b/man/workflows_post_executions_retry.Rd index 53c53cdf..64c9a0f7 100644 --- a/man/workflows_post_executions_retry.Rd +++ b/man/workflows_post_executions_retry.Rd @@ -28,7 +28,7 @@ A list containing the following elements: \item online boolean, Whether this user is online. }} \item{definition}{string, The definition of the workflow for this execution.} -\item{input}{list, The dictionary of name/value input pairs defined for this execution.} +\item{input}{list, Key-value pairs defined for this execution.} \item{includedTasks}{array, The subset of workflow tasks selected to execute.} \item{tasks}{array, An array containing the following fields: \itemize{ diff --git a/man/workflows_post_git_commits.Rd b/man/workflows_post_git_commits.Rd index 6ea4bc8f..3930e84b 100644 --- a/man/workflows_post_git_commits.Rd +++ b/man/workflows_post_git_commits.Rd @@ -7,7 +7,7 @@ workflows_post_git_commits(id, content, message, file_hash) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} \item{content}{string required. The contents to commit to the file.} diff --git a/man/workflows_put.Rd b/man/workflows_put.Rd index ba731728..fdd33fe3 100644 --- a/man/workflows_put.Rd +++ b/man/workflows_put.Rd @@ -18,11 +18,11 @@ workflows_put(id, name, description = NULL, definition = NULL, \item{schedule}{list optional. A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{time_zone}{string optional. The time zone of this workflow.} @@ -58,11 +58,11 @@ A list containing the following elements: \item{state}{string, The state of the workflow. State is "running" if any execution is running, otherwise reflects most recent execution state.} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{timeZone}{string, The time zone of this workflow.} \item{nextExecutionAt}{string, The time of the next scheduled execution.} @@ -76,8 +76,8 @@ A list containing the following elements: \item successOn boolean, If success email notifications are on \item failureOn boolean, If failure email notifications are on }} -\item{archived}{string, The archival status of the requested object(s).} -\item{hidden}{boolean, The hidden status of the object.} +\item{archived}{string, The archival status of the requested item(s).} +\item{hidden}{boolean, The hidden status of the item.} \item{createdAt}{string, } \item{updatedAt}{string, } } diff --git a/man/workflows_put_archive.Rd b/man/workflows_put_archive.Rd index 9d49ee3e..d6640c91 100644 --- a/man/workflows_put_archive.Rd +++ b/man/workflows_put_archive.Rd @@ -31,11 +31,11 @@ A list containing the following elements: \item{state}{string, The state of the workflow. State is "running" if any execution is running, otherwise reflects most recent execution state.} \item{schedule}{list, A list containing the following elements: \itemize{ -\item scheduled boolean, If the object is scheduled -\item scheduledDays array, Day based on numeric value starting at 0 for Sunday -\item scheduledHours array, Hours of the day it is scheduled on -\item scheduledMinutes array, Minutes of the day it is scheduled on -\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour +\item scheduled boolean, If the item is scheduled. +\item scheduledDays array, Day based on numeric value starting at 0 for Sunday. +\item scheduledHours array, Hours of the day it is scheduled on. +\item scheduledMinutes array, Minutes of the day it is scheduled on. +\item scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour. }} \item{timeZone}{string, The time zone of this workflow.} \item{nextExecutionAt}{string, The time of the next scheduled execution.} @@ -49,8 +49,8 @@ A list containing the following elements: \item successOn boolean, If success email notifications are on \item failureOn boolean, If failure email notifications are on }} -\item{archived}{string, The archival status of the requested object(s).} -\item{hidden}{boolean, The hidden status of the object.} +\item{archived}{string, The archival status of the requested item(s).} +\item{hidden}{boolean, The hidden status of the item.} \item{createdAt}{string, } \item{updatedAt}{string, } } diff --git a/man/workflows_put_git.Rd b/man/workflows_put_git.Rd index 30169372..78ccd100 100644 --- a/man/workflows_put_git.Rd +++ b/man/workflows_put_git.Rd @@ -8,7 +8,7 @@ workflows_put_git(id, git_ref = NULL, git_branch = NULL, git_path = NULL, git_repo_url = NULL) } \arguments{ -\item{id}{integer required. The ID of the object.} +\item{id}{integer required. The ID of the file.} \item{git_ref}{string optional. A git reference specifying an unambiguous version of the file. Can be a branch name, or the full or shortened SHA of a commit.} diff --git a/man/workflows_put_projects.Rd b/man/workflows_put_projects.Rd index af6c4e5c..40143c30 100644 --- a/man/workflows_put_projects.Rd +++ b/man/workflows_put_projects.Rd @@ -7,9 +7,9 @@ workflows_put_projects(id, project_id) } \arguments{ -\item{id}{integer required. ID of the resource} +\item{id}{integer required. The ID of the resource.} -\item{project_id}{integer required. The ID of the project} +\item{project_id}{integer required. The ID of the project.} } \value{ An empty HTTP response diff --git a/tools/generate_default_client.R b/tools/generate_default_client.R index bc485616..957c7872 100644 --- a/tools/generate_default_client.R +++ b/tools/generate_default_client.R @@ -1,16 +1,23 @@ # To generate a new client, save the default civis api spec locally # and pass the filename as an arg to this script. i.e. -# Rscript generate_default_client.R default_api_spec.json +# Rscript generate_default_client.R -source("../R/client_base.R") -source("../R/generate_client.R") -source("../R/utils.R") +library(civis) -args <- commandArgs(trailingOnly = TRUE) -api_spec <- jsonlite::fromJSON(args[1], simplifyVector=FALSE) +job <- scripts_post_custom(from_template_id = 9925) +run <- scripts_post_custom_runs(job$id) +await(scripts_get_custom_runs, id = job$id, run_id = run$id) +spec_id <- scripts_list_custom_runs_outputs(job$id, run$id)[[1]]$objectId +fn <- tempfile(fileext = ".json") +download_civis(spec_id, file = fn) + +Sys.setenv("R_CLIENT_DEV" = "") +Sys.setenv("CIVIS_API_KEY" = "") + +api_spec <- jsonlite::fromJSON(fn, simplifyVector = FALSE) # To pass R CMD CHECK, this has to be an 'R Data file' (rda) produced by save. save(api_spec, file = "../R/sysdata.rda") -client_str <- generate_client(api_spec) -write_client(client_str, FILENAME = paste0("../", FILENAME)) +client_str <- civis:::generate_client(api_spec) +civis:::write_client(client_str, FILENAME = paste0("../", civis:::FILENAME)) devtools::document()