From dbcf2725707be7b01ee8dfcb15caeee5f2af40e3 Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sat, 3 Jul 2021 15:36:26 -0500 Subject: [PATCH 01/42] Remove RForcecom Dependency Remove RForcecom from roxygen documentation and from the Suggests packages. Later we may need to remove from vignettes. Closes #101 --- DESCRIPTION | 6 ++---- NEWS.md | 3 ++- R/compatibility.R | 22 +++++++++++----------- man-roxygen/session.R | 2 +- man/rforcecom.bulkAction.Rd | 2 +- man/rforcecom.bulkQuery.Rd | 4 ++-- man/rforcecom.create.Rd | 4 ++-- man/rforcecom.delete.Rd | 4 ++-- man/rforcecom.getObjectDescription.Rd | 4 ++-- man/rforcecom.getServerTimestamp.Rd | 4 ++-- man/rforcecom.login.Rd | 2 +- man/rforcecom.query.Rd | 4 ++-- man/rforcecom.retrieve.Rd | 4 ++-- man/rforcecom.search.Rd | 4 ++-- man/rforcecom.update.Rd | 4 ++-- man/rforcecom.upsert.Rd | 4 ++-- 16 files changed, 38 insertions(+), 39 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 40a279e9..202971f5 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: salesforcer Title: An Implementation of 'Salesforce' APIs Using Tidy Principles Version: 0.2.2.9000 -Date: 2020-09-12 +Date: 2021-07-03 Description: Functions connecting to the 'Salesforce' Platform APIs (REST, SOAP, Bulk 1.0, Bulk 2.0, Metadata, Reports and Dashboards) . @@ -52,13 +52,11 @@ Suggests: here, microbenchmark, ggplot2, - sessioninfo, - RForcecom + sessioninfo VignetteBuilder: knitr ByteCompile: true Encoding: UTF-8 Language: en-US -LazyData: true Roxygen: list(markdown = TRUE) RoxygenNote: 7.1.1 diff --git a/NEWS.md b/NEWS.md index 3733cbcb..275bfea7 100644 --- a/NEWS.md +++ b/NEWS.md @@ -2,7 +2,8 @@ ### Dependencies - * None yet. + * Remove references to RForcecom after it was removed from CRAN on 6/9/2021 (#101) + * Remove LazyData option in DESCRIPTION since `data()` is not utilized. ### Features diff --git a/R/compatibility.R b/R/compatibility.R index f5e6a865..467affa4 100644 --- a/R/compatibility.R +++ b/R/compatibility.R @@ -21,7 +21,7 @@ # limitations under the License. #' The \code{salesforcer} backwards compatible version of -#' \code{\link[RForcecom]{rforcecom.login}} +#' \code{RForcecom::rforcecom.login} #' #' @description #' `r lifecycle::badge("soft-deprecated")` @@ -61,7 +61,7 @@ rforcecom.login <- function(username, password, loginURL="https://login.salesfor } #' The \code{salesforcer} backwards compatible version of -#' \code{\link[RForcecom]{rforcecom.getServerTimestamp}} +#' \code{RForcecom::rforcecom.getServerTimestamp} #' #' @description #' `r lifecycle::badge("soft-deprecated")` @@ -79,7 +79,7 @@ rforcecom.getServerTimestamp <- function(session){ } #' The \code{salesforcer} backwards compatible version of -#' \code{\link[RForcecom]{rforcecom.getObjectDescription}} +#' \code{RForcecom::rforcecom.getObjectDescription} #' #' @description #' `r lifecycle::badge("soft-deprecated")` @@ -104,7 +104,7 @@ rforcecom.getObjectDescription <- function(session, objectName){ } #' The \code{salesforcer} backwards compatible version of -#' \code{\link[RForcecom]{rforcecom.create}} +#' \code{RForcecom::rforcecom.create} #' #' @description #' `r lifecycle::badge("soft-deprecated")` @@ -130,7 +130,7 @@ rforcecom.create <- function(session, objectName, fields){ } #' The \code{salesforcer} backwards compatible version of -#' \code{\link[RForcecom]{rforcecom.retrieve}} +#' \code{RForcecom::rforcecom.retrieve} #' #' @description #' `r lifecycle::badge("soft-deprecated")` @@ -195,7 +195,7 @@ rforcecom.retrieve <- function(session, objectName, } #' The \code{salesforcer} backwards compatible version of -#' \code{\link[RForcecom]{rforcecom.update}} +#' \code{RForcecom::rforcecom.update} #' #' @description #' `r lifecycle::badge("soft-deprecated")` @@ -218,7 +218,7 @@ rforcecom.update <- function(session, objectName, id, fields){ } #' The \code{salesforcer} backwards compatible version of -#' \code{\link[RForcecom]{rforcecom.delete}} +#' \code{RForcecom::rforcecom.delete} #' #' @description #' `r lifecycle::badge("soft-deprecated")` @@ -238,7 +238,7 @@ rforcecom.delete <- function(session, objectName, id){ } #' The \code{salesforcer} backwards compatible version of -#' \code{\link[RForcecom]{rforcecom.upsert}} +#' \code{RForcecom::rforcecom.upsert} #' #' @description #' `r lifecycle::badge("soft-deprecated")` @@ -266,7 +266,7 @@ rforcecom.upsert <- function(session, objectName, } #' The \code{salesforcer} backwards compatible version of -#' \code{\link[RForcecom]{rforcecom.search}} +#' \code{RForcecom::rforcecom.search} #' #' @description #' `r lifecycle::badge("soft-deprecated")` @@ -284,7 +284,7 @@ rforcecom.search <- function(session, queryString){ } #' The \code{salesforcer} backwards compatible version of -#' \code{\link[RForcecom]{rforcecom.query}} +#' \code{RForcecom::rforcecom.query} #' #' @description #' `r lifecycle::badge("soft-deprecated")` @@ -303,7 +303,7 @@ rforcecom.query <- function(session, soqlQuery, queryAll=FALSE){ } #' The \code{salesforcer} backwards compatible version of -#' \code{\link[RForcecom]{rforcecom.bulkQuery}} +#' \code{RForcecom::rforcecom.bulkQuery} #' #' @description #' `r lifecycle::badge("soft-deprecated")` diff --git a/man-roxygen/session.R b/man-roxygen/session.R index 9460c0b7..fa3a7d0d 100644 --- a/man-roxygen/session.R +++ b/man-roxygen/session.R @@ -1,6 +1,6 @@ #' @param session \code{list}; a list containing \code{"sessionID"}, #' \code{"instanceURL"}, and \code{"apiVersion"} as returned by -#' \code{\link[RForcecom]{rforcecom.login}}. This argument is ignored in all +#' \code{RForcecom::rforcecom.login}. This argument is ignored in all #' backward compatible calls because the authorization credentials are stored #' in an environment internal to the salesforcer package, so it is no longer #' necessary to pass the session in each function call. diff --git a/man/rforcecom.bulkAction.Rd b/man/rforcecom.bulkAction.Rd index d7509bc2..e9ff2067 100644 --- a/man/rforcecom.bulkAction.Rd +++ b/man/rforcecom.bulkAction.Rd @@ -21,7 +21,7 @@ rforcecom.bulkAction( \arguments{ \item{session}{\code{list}; a list containing \code{"sessionID"}, \code{"instanceURL"}, and \code{"apiVersion"} as returned by -\code{\link[RForcecom]{rforcecom.login}}. This argument is ignored in all +\code{RForcecom::rforcecom.login}. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer necessary to pass the session in each function call.} diff --git a/man/rforcecom.bulkQuery.Rd b/man/rforcecom.bulkQuery.Rd index e6c44ce9..329ac934 100644 --- a/man/rforcecom.bulkQuery.Rd +++ b/man/rforcecom.bulkQuery.Rd @@ -3,7 +3,7 @@ \name{rforcecom.bulkQuery} \alias{rforcecom.bulkQuery} \title{The \code{salesforcer} backwards compatible version of -\code{\link[RForcecom]{rforcecom.bulkQuery}}} +\code{RForcecom::rforcecom.bulkQuery}} \usage{ rforcecom.bulkQuery( session, @@ -17,7 +17,7 @@ rforcecom.bulkQuery( \arguments{ \item{session}{\code{list}; a list containing \code{"sessionID"}, \code{"instanceURL"}, and \code{"apiVersion"} as returned by -\code{\link[RForcecom]{rforcecom.login}}. This argument is ignored in all +\code{RForcecom::rforcecom.login}. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer necessary to pass the session in each function call.} diff --git a/man/rforcecom.create.Rd b/man/rforcecom.create.Rd index d39409bc..c26ea288 100644 --- a/man/rforcecom.create.Rd +++ b/man/rforcecom.create.Rd @@ -3,14 +3,14 @@ \name{rforcecom.create} \alias{rforcecom.create} \title{The \code{salesforcer} backwards compatible version of -\code{\link[RForcecom]{rforcecom.create}}} +\code{RForcecom::rforcecom.create}} \usage{ rforcecom.create(session, objectName, fields) } \arguments{ \item{session}{\code{list}; a list containing \code{"sessionID"}, \code{"instanceURL"}, and \code{"apiVersion"} as returned by -\code{\link[RForcecom]{rforcecom.login}}. This argument is ignored in all +\code{RForcecom::rforcecom.login}. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer necessary to pass the session in each function call.} diff --git a/man/rforcecom.delete.Rd b/man/rforcecom.delete.Rd index f5573023..085051ed 100644 --- a/man/rforcecom.delete.Rd +++ b/man/rforcecom.delete.Rd @@ -3,14 +3,14 @@ \name{rforcecom.delete} \alias{rforcecom.delete} \title{The \code{salesforcer} backwards compatible version of -\code{\link[RForcecom]{rforcecom.delete}}} +\code{RForcecom::rforcecom.delete}} \usage{ rforcecom.delete(session, objectName, id) } \arguments{ \item{session}{\code{list}; a list containing \code{"sessionID"}, \code{"instanceURL"}, and \code{"apiVersion"} as returned by -\code{\link[RForcecom]{rforcecom.login}}. This argument is ignored in all +\code{RForcecom::rforcecom.login}. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer necessary to pass the session in each function call.} diff --git a/man/rforcecom.getObjectDescription.Rd b/man/rforcecom.getObjectDescription.Rd index 764c83ca..c3b3c8c0 100644 --- a/man/rforcecom.getObjectDescription.Rd +++ b/man/rforcecom.getObjectDescription.Rd @@ -3,14 +3,14 @@ \name{rforcecom.getObjectDescription} \alias{rforcecom.getObjectDescription} \title{The \code{salesforcer} backwards compatible version of -\code{\link[RForcecom]{rforcecom.getObjectDescription}}} +\code{RForcecom::rforcecom.getObjectDescription}} \usage{ rforcecom.getObjectDescription(session, objectName) } \arguments{ \item{session}{\code{list}; a list containing \code{"sessionID"}, \code{"instanceURL"}, and \code{"apiVersion"} as returned by -\code{\link[RForcecom]{rforcecom.login}}. This argument is ignored in all +\code{RForcecom::rforcecom.login}. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer necessary to pass the session in each function call.} diff --git a/man/rforcecom.getServerTimestamp.Rd b/man/rforcecom.getServerTimestamp.Rd index 6cf504cd..efa72eec 100644 --- a/man/rforcecom.getServerTimestamp.Rd +++ b/man/rforcecom.getServerTimestamp.Rd @@ -3,14 +3,14 @@ \name{rforcecom.getServerTimestamp} \alias{rforcecom.getServerTimestamp} \title{The \code{salesforcer} backwards compatible version of -\code{\link[RForcecom]{rforcecom.getServerTimestamp}}} +\code{RForcecom::rforcecom.getServerTimestamp}} \usage{ rforcecom.getServerTimestamp(session) } \arguments{ \item{session}{\code{list}; a list containing \code{"sessionID"}, \code{"instanceURL"}, and \code{"apiVersion"} as returned by -\code{\link[RForcecom]{rforcecom.login}}. This argument is ignored in all +\code{RForcecom::rforcecom.login}. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer necessary to pass the session in each function call.} diff --git a/man/rforcecom.login.Rd b/man/rforcecom.login.Rd index 627667e2..a44360d6 100644 --- a/man/rforcecom.login.Rd +++ b/man/rforcecom.login.Rd @@ -3,7 +3,7 @@ \name{rforcecom.login} \alias{rforcecom.login} \title{The \code{salesforcer} backwards compatible version of -\code{\link[RForcecom]{rforcecom.login}}} +\code{RForcecom::rforcecom.login}} \usage{ rforcecom.login( username, diff --git a/man/rforcecom.query.Rd b/man/rforcecom.query.Rd index da499a38..18c42f0c 100644 --- a/man/rforcecom.query.Rd +++ b/man/rforcecom.query.Rd @@ -3,14 +3,14 @@ \name{rforcecom.query} \alias{rforcecom.query} \title{The \code{salesforcer} backwards compatible version of -\code{\link[RForcecom]{rforcecom.query}}} +\code{RForcecom::rforcecom.query}} \usage{ rforcecom.query(session, soqlQuery, queryAll = FALSE) } \arguments{ \item{session}{\code{list}; a list containing \code{"sessionID"}, \code{"instanceURL"}, and \code{"apiVersion"} as returned by -\code{\link[RForcecom]{rforcecom.login}}. This argument is ignored in all +\code{RForcecom::rforcecom.login}. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer necessary to pass the session in each function call.} diff --git a/man/rforcecom.retrieve.Rd b/man/rforcecom.retrieve.Rd index 732bcb09..701e2dc1 100644 --- a/man/rforcecom.retrieve.Rd +++ b/man/rforcecom.retrieve.Rd @@ -3,7 +3,7 @@ \name{rforcecom.retrieve} \alias{rforcecom.retrieve} \title{The \code{salesforcer} backwards compatible version of -\code{\link[RForcecom]{rforcecom.retrieve}}} +\code{RForcecom::rforcecom.retrieve}} \usage{ rforcecom.retrieve( session, @@ -20,7 +20,7 @@ rforcecom.retrieve( \arguments{ \item{session}{\code{list}; a list containing \code{"sessionID"}, \code{"instanceURL"}, and \code{"apiVersion"} as returned by -\code{\link[RForcecom]{rforcecom.login}}. This argument is ignored in all +\code{RForcecom::rforcecom.login}. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer necessary to pass the session in each function call.} diff --git a/man/rforcecom.search.Rd b/man/rforcecom.search.Rd index c97d9e56..8ab73500 100644 --- a/man/rforcecom.search.Rd +++ b/man/rforcecom.search.Rd @@ -3,14 +3,14 @@ \name{rforcecom.search} \alias{rforcecom.search} \title{The \code{salesforcer} backwards compatible version of -\code{\link[RForcecom]{rforcecom.search}}} +\code{RForcecom::rforcecom.search}} \usage{ rforcecom.search(session, queryString) } \arguments{ \item{session}{\code{list}; a list containing \code{"sessionID"}, \code{"instanceURL"}, and \code{"apiVersion"} as returned by -\code{\link[RForcecom]{rforcecom.login}}. This argument is ignored in all +\code{RForcecom::rforcecom.login}. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer necessary to pass the session in each function call.} diff --git a/man/rforcecom.update.Rd b/man/rforcecom.update.Rd index 0d96ad4e..778cf150 100644 --- a/man/rforcecom.update.Rd +++ b/man/rforcecom.update.Rd @@ -3,14 +3,14 @@ \name{rforcecom.update} \alias{rforcecom.update} \title{The \code{salesforcer} backwards compatible version of -\code{\link[RForcecom]{rforcecom.update}}} +\code{RForcecom::rforcecom.update}} \usage{ rforcecom.update(session, objectName, id, fields) } \arguments{ \item{session}{\code{list}; a list containing \code{"sessionID"}, \code{"instanceURL"}, and \code{"apiVersion"} as returned by -\code{\link[RForcecom]{rforcecom.login}}. This argument is ignored in all +\code{RForcecom::rforcecom.login}. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer necessary to pass the session in each function call.} diff --git a/man/rforcecom.upsert.Rd b/man/rforcecom.upsert.Rd index 0d866970..9ad6a809 100644 --- a/man/rforcecom.upsert.Rd +++ b/man/rforcecom.upsert.Rd @@ -3,14 +3,14 @@ \name{rforcecom.upsert} \alias{rforcecom.upsert} \title{The \code{salesforcer} backwards compatible version of -\code{\link[RForcecom]{rforcecom.upsert}}} +\code{RForcecom::rforcecom.upsert}} \usage{ rforcecom.upsert(session, objectName, externalIdField, externalId, fields) } \arguments{ \item{session}{\code{list}; a list containing \code{"sessionID"}, \code{"instanceURL"}, and \code{"apiVersion"} as returned by -\code{\link[RForcecom]{rforcecom.login}}. This argument is ignored in all +\code{RForcecom::rforcecom.login}. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer necessary to pass the session in each function call.} From bdb294168e4a850fb302549b61ffeb0ae28aac0e Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sat, 3 Jul 2021 15:38:26 -0500 Subject: [PATCH 02/42] Remove RForcecom Dependency Remove RForcecom from roxygen documentation and from the Suggests packages. Later we may need to remove from vignettes. Closes #97 --- NEWS.md | 3 ++- R/auth.R | 34 +++++++++++++++++++++++++++++----- man/sf_auth.Rd | 38 +++++++++++++++++++++++++++++++++----- 3 files changed, 64 insertions(+), 11 deletions(-) diff --git a/NEWS.md b/NEWS.md index 275bfea7..f1ecf10d 100644 --- a/NEWS.md +++ b/NEWS.md @@ -7,7 +7,8 @@ ### Features - * None yet. + * Improve documentation to retrieve the access token or session ID after + authentication (#97) ### Bug fixes diff --git a/R/auth.R b/R/auth.R index 8ee3091c..3d3d13f6 100644 --- a/R/auth.R +++ b/R/auth.R @@ -34,7 +34,7 @@ #' @description #' `r lifecycle::badge("stable")` #' -#' Log in using Basic (Username-Password) or OAuth 2.0 authenticaion. OAuth does +#' Log in using Basic (Username-Password) or OAuth 2.0 authentication. OAuth does #' not require sharing passwords, but will require authorizing \code{salesforcer} #' as a connected app to view and manage your organization. You will be directed to #' a web browser, asked to sign in to your Salesforce account, and to grant \code{salesforcer} @@ -58,6 +58,31 @@ #' @param cache \code{logical} or \code{character}; TRUE means to cache using #' the default cache file \code{.httr-oauth-salesforcer}, FALSE means do not #' cache. A string means use the specified path as the cache file. +#' @return \code{list} invisibly that contains 4 elements detailing the authentication state +#' @note The \code{link{sf_auth}} function invisibly returns the following +#' 4 pieces of information which can be reused in other operations: +#' \describe{ +#' \item{auth_method}{ +#' \code{character}; One of two options 'Basic' or 'OAuth'. If a username, +#' password, and security token were supplied, then this would result in +#' 'Basic' authentication. +#' } +#' \item{token}{ +#' \code{Token2.0}; The object returned by \code{\link[httr]{oauth2.0_token}}. +#' This value is \code{NULL} if \code{auth_method='Basic'}. +#' } +#' \item{session_id}{ +#' \code{character}; A unique ID associated with this user session. The session +#' ID is obtained from the X-SFDC-Session header fetched with SOAP API's login() +#' call. This value is \code{NULL} if \code{auth_method='OAuth'}. +#' } +#' \item{instance_url}{ +#' \code{character}; The domain address of the server that your Salesforce org +#' is on and where subsequent API calls will be directed to. For example, +#' \code{https://na21.salesforce.com} refers to an org located on the 'NA21' +#' server instance located in Chicago, USA / Washington DC, USA per this +#' Knowledge Article: \url{https://help.salesforce.com/articleView?id=000314281}. +#' } #' @template verbose #' @examples #' \dontrun{ @@ -66,15 +91,14 @@ #' password = "test_password", #' security_token = "test_token") #' -#' # log in using OAuth 2.0 -#' # Via brower or refresh of .httr-oauth-salesforcer +#' # log in using OAuth 2.0 (via browser or cached .httr-oauth-salesforcer) #' sf_auth() #' #' # log in to a Sandbox environment #' # Via brower or refresh of .httr-oauth-salesforcer #' sf_auth(login_url = "https://test.salesforce.com") #' -#' # Save token and log in using it +#' # Save token to disk and log in using it #' saveRDS(salesforcer_state()$token, "token.rds") #' sf_auth(token = "token.rds") #' } @@ -368,7 +392,7 @@ token_available <- function(verbose = TRUE) { #' @note This function is meant to be used internally. Only use when debugging. #' @keywords internal #' @export -sf_access_token <- function(verbose = FALSE) { +sf_access_token <- function(verbose = TRUE) { if (!token_available(verbose = verbose)) return(NULL) .state$token$credentials$access_token } diff --git a/man/sf_auth.Rd b/man/sf_auth.Rd index 5d1a03b5..8d206f7f 100644 --- a/man/sf_auth.Rd +++ b/man/sf_auth.Rd @@ -45,16 +45,45 @@ detail for each API call, which is useful for debugging. More specifically, when set to \code{TRUE} the URL, header, and body will be printed for each request, along with additional diagnostic information where available.} } +\value{ +\code{list} invisibly that contains 4 elements detailing the authentication state +} \description{ -\ifelse{html}{\out{Stable lifecycle}}{\strong{Stable}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#stable}{\figure{lifecycle-stable.svg}{options: alt='[Stable]'}}}{\strong{[Stable]}} -Log in using Basic (Username-Password) or OAuth 2.0 authenticaion. OAuth does +Log in using Basic (Username-Password) or OAuth 2.0 authentication. OAuth does not require sharing passwords, but will require authorizing \code{salesforcer} as a connected app to view and manage your organization. You will be directed to a web browser, asked to sign in to your Salesforce account, and to grant \code{salesforcer} permission to operate on your behalf. By default, these user credentials are cached in a file named \code{.httr-oauth-salesforcer} in the current working directory. } +\note{ +The \code{link{sf_auth}} function invisibly returns the following +4 pieces of information which can be reused in other operations: +\describe{ +\item{auth_method}{ +\code{character}; One of two options 'Basic' or 'OAuth'. If a username, +password, and security token were supplied, then this would result in +'Basic' authentication. +} +\item{token}{ +\code{Token2.0}; The object returned by \code{\link[httr]{oauth2.0_token}}. +This value is \code{NULL} if \code{auth_method='Basic'}. +} +\item{session_id}{ +\code{character}; A unique ID associated with this user session. The session +ID is obtained from the X-SFDC-Session header fetched with SOAP API's login() +call. This value is \code{NULL} if \code{auth_method='OAuth'}. +} +\item{instance_url}{ +\code{character}; The domain address of the server that your Salesforce org +is on and where subsequent API calls will be directed to. For example, +\code{https://na21.salesforce.com} refers to an org located on the 'NA21' +server instance located in Chicago, USA / Washington DC, USA per this +Knowledge Article: \url{https://help.salesforce.com/articleView?id=000314281}. +} +} \examples{ \dontrun{ # log in using basic authentication (username-password) @@ -62,15 +91,14 @@ sf_auth(username = "test@gmail.com", password = "test_password", security_token = "test_token") -# log in using OAuth 2.0 -# Via brower or refresh of .httr-oauth-salesforcer +# log in using OAuth 2.0 (via browser or cached .httr-oauth-salesforcer) sf_auth() # log in to a Sandbox environment # Via brower or refresh of .httr-oauth-salesforcer sf_auth(login_url = "https://test.salesforce.com") -# Save token and log in using it +# Save token to disk and log in using it saveRDS(salesforcer_state()$token, "token.rds") sf_auth(token = "token.rds") } From c0db731a82c854e9e19fd57816a8eee4438cff8f Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sat, 3 Jul 2021 15:39:53 -0500 Subject: [PATCH 03/42] Fix Bug in Parsing OwnerChangeOptions Closes #94 --- NEWS.md | 4 ++-- R/utils-xml.R | 26 ++++++++++++++++++++------ tests/testthat/test-soap.R | 11 ++++++++++- 3 files changed, 32 insertions(+), 9 deletions(-) diff --git a/NEWS.md b/NEWS.md index f1ecf10d..e29d0d1d 100644 --- a/NEWS.md +++ b/NEWS.md @@ -3,7 +3,7 @@ ### Dependencies * Remove references to RForcecom after it was removed from CRAN on 6/9/2021 (#101) - * Remove LazyData option in DESCRIPTION since `data()` is not utilized. + * Remove LazyData option in DESCRIPTION since `data()` is not utilized ### Features @@ -12,7 +12,7 @@ ### Bug fixes - * None yet. + * Fixed the format of the `OwnerChangeOptions` header so it is accepted (#94) --- diff --git a/R/utils-xml.R b/R/utils-xml.R index 12269d53..4d83c64c 100644 --- a/R/utils-xml.R +++ b/R/utils-xml.R @@ -138,12 +138,26 @@ make_soap_xml_skeleton <- function(soap_headers=list(), metadata_ns=FALSE){ if(length(soap_headers)>0){ for(i in 1:length(soap_headers)){ - opt_node <- newXMLNode(paste0(ns_prefix, ":", names(soap_headers)[i]), - parent=header_node) - for(j in 1:length(soap_headers[[i]])){ - this_node <- newXMLNode(paste0(ns_prefix, ":", names(soap_headers[[i]])[j]), - as.character(soap_headers[[i]][[j]]), - parent=opt_node) + option_name <- names(soap_headers)[i] + opt_node <- newXMLNode(paste0(ns_prefix, ":", option_name), parent=header_node) + # process OwnerChangeOptions differently because it can be a list of multiple + # different options all put under the OwnerChangeOptions node + if (option_name == "OwnerChangeOptions"){ + options_spec <- soap_headers[[i]]$options + for(j in 1:length(options_spec)){ + this_node <- newXMLNode(paste0(ns_prefix, ":", "options"), parent=opt_node) + for(k in 1:length(options_spec[[j]])){ + this_node2 <- newXMLNode(paste0(ns_prefix, ":", names(options_spec[[j]])[k]), + as.character(options_spec[[j]][[k]]), + parent=this_node) + } + } + } else { + for(j in 1:length(soap_headers[[i]])){ + this_node <- newXMLNode(paste0(ns_prefix, ":", names(soap_headers[[i]])[j]), + as.character(soap_headers[[i]][[j]]), + parent=opt_node) + } } } } diff --git a/tests/testthat/test-soap.R b/tests/testthat/test-soap.R index 82b4e89a..4fbc2b94 100644 --- a/tests/testthat/test-soap.R +++ b/tests/testthat/test-soap.R @@ -102,7 +102,16 @@ test_that("testing SOAP API Functionality", { mutate(FirstName = "TestTest") # sf_update ------------------------------------------------------------------ - updated_records <- sf_update(queried_records, object_name=object, api_type="SOAP") + updated_records <- sf_update( + queried_records, object_name=object, api_type="SOAP", + # test syntax for this control argument alongside the function + OwnerChangeOptions = list( + options = list( + list(execute = TRUE, type = "TransferNotesAndAttachments"), + list(execute = TRUE, type = "TransferOpenActivities") + ) + ), + ) expect_is(updated_records, "tbl_df") expect_equal(names(updated_records), c("id", "success")) expect_equal(nrow(updated_records), n) From 9cdbd2d1f672917956f87ae9fbc9b41ae504acde Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sat, 3 Jul 2021 15:40:41 -0500 Subject: [PATCH 04/42] Update Display of Lifecycle tags in Documentation --- man/rforcecom.bulkAction.Rd | 2 +- man/rforcecom.bulkQuery.Rd | 2 +- man/rforcecom.create.Rd | 2 +- man/rforcecom.delete.Rd | 2 +- man/rforcecom.getObjectDescription.Rd | 2 +- man/rforcecom.getServerTimestamp.Rd | 2 +- man/rforcecom.login.Rd | 2 +- man/rforcecom.query.Rd | 2 +- man/rforcecom.retrieve.Rd | 2 +- man/rforcecom.search.Rd | 2 +- man/rforcecom.update.Rd | 2 +- man/rforcecom.upsert.Rd | 2 +- man/sf_access_token.Rd | 2 +- man/sf_analytics_notification_create.Rd | 2 +- man/sf_analytics_notification_delete.Rd | 2 +- man/sf_analytics_notification_describe.Rd | 2 +- man/sf_analytics_notification_update.Rd | 2 +- man/sf_analytics_notifications_limits.Rd | 2 +- man/sf_analytics_notifications_list.Rd | 2 +- man/sf_convert_lead.Rd | 2 +- man/sf_copy_report.Rd | 2 +- man/sf_create.Rd | 2 +- man/sf_create_attachment.Rd | 2 +- man/sf_create_metadata.Rd | 2 +- man/sf_create_report.Rd | 2 +- man/sf_dashboard_components_describe.Rd | 2 +- man/sf_dashboard_copy.Rd | 2 +- man/sf_dashboard_delete.Rd | 2 +- man/sf_dashboard_describe.Rd | 2 +- man/sf_dashboard_filter_operators_list.Rd | 2 +- man/sf_dashboard_filter_options_analysis.Rd | 2 +- man/sf_dashboard_refresh.Rd | 2 +- man/sf_dashboard_results.Rd | 2 +- man/sf_dashboard_set_sticky_filter.Rd | 2 +- man/sf_dashboard_status.Rd | 2 +- man/sf_dashboard_update.Rd | 2 +- man/sf_dashboards_list.Rd | 2 +- man/sf_delete.Rd | 2 +- man/sf_delete_attachment.Rd | 2 +- man/sf_delete_metadata.Rd | 2 +- man/sf_delete_report.Rd | 2 +- man/sf_delete_report_instance.Rd | 2 +- man/sf_describe_metadata.Rd | 2 +- man/sf_describe_object_fields.Rd | 2 +- man/sf_describe_objects.Rd | 2 +- man/sf_describe_report.Rd | 2 +- man/sf_describe_report_type.Rd | 2 +- man/sf_download_attachment.Rd | 2 +- man/sf_empty_recycle_bin.Rd | 2 +- man/sf_execute_report.Rd | 2 +- man/sf_find_duplicates.Rd | 2 +- man/sf_find_duplicates_by_id.Rd | 2 +- man/sf_get_dashboard_data.Rd | 2 +- man/sf_get_deleted.Rd | 2 +- man/sf_get_report_instance_results.Rd | 2 +- man/sf_get_updated.Rd | 2 +- man/sf_list_api_limits.Rd | 2 +- man/sf_list_metadata.Rd | 2 +- man/sf_list_objects.Rd | 2 +- man/sf_list_report_fields.Rd | 2 +- man/sf_list_report_filter_operators.Rd | 2 +- man/sf_list_report_instances.Rd | 2 +- man/sf_list_report_types.Rd | 2 +- man/sf_list_reports.Rd | 2 +- man/sf_list_resources.Rd | 2 +- man/sf_list_rest_api_versions.Rd | 2 +- man/sf_merge.Rd | 2 +- man/sf_query.Rd | 2 +- man/sf_query_report.Rd | 2 +- man/sf_read_metadata.Rd | 2 +- man/sf_rename_metadata.Rd | 2 +- man/sf_report_folder_children.Rd | 2 +- man/sf_report_folder_create.Rd | 2 +- man/sf_report_folder_delete.Rd | 2 +- man/sf_report_folder_describe.Rd | 2 +- man/sf_report_folder_share_delete.Rd | 2 +- man/sf_report_folder_share_describe.Rd | 2 +- man/sf_report_folder_share_recipients.Rd | 2 +- man/sf_report_folder_share_update.Rd | 2 +- man/sf_report_folder_shares_add.Rd | 2 +- man/sf_report_folder_shares_list.Rd | 2 +- man/sf_report_folder_shares_update.Rd | 2 +- man/sf_report_folder_update.Rd | 2 +- man/sf_report_folders_list.Rd | 2 +- man/sf_reset_password.Rd | 2 +- man/sf_retrieve.Rd | 2 +- man/sf_retrieve_metadata.Rd | 2 +- man/sf_retrieve_metadata_check_status.Rd | 2 +- man/sf_run_bulk_operation.Rd | 2 +- man/sf_run_bulk_query.Rd | 2 +- man/sf_run_report.Rd | 2 +- man/sf_search.Rd | 2 +- man/sf_server_timestamp.Rd | 2 +- man/sf_set_password.Rd | 2 +- man/sf_undelete.Rd | 2 +- man/sf_update.Rd | 2 +- man/sf_update_attachment.Rd | 2 +- man/sf_update_metadata.Rd | 2 +- man/sf_update_report.Rd | 2 +- man/sf_upsert.Rd | 2 +- man/sf_upsert_metadata.Rd | 2 +- man/sf_user_info.Rd | 2 +- 102 files changed, 102 insertions(+), 102 deletions(-) diff --git a/man/rforcecom.bulkAction.Rd b/man/rforcecom.bulkAction.Rd index e9ff2067..9c1c3ea2 100644 --- a/man/rforcecom.bulkAction.Rd +++ b/man/rforcecom.bulkAction.Rd @@ -54,7 +54,7 @@ along with additional diagnostic information where available.} A \code{tbl_df} of the results of the bulk job } \description{ -\ifelse{html}{\figure{lifecycle-soft-deprecated.svg}{options: alt='Soft-deprecated lifecycle'}}{\strong{Soft-deprecated}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#soft-deprecated}{\figure{lifecycle-soft-deprecated.svg}{options: alt='[Soft-deprecated]'}}}{\strong{[Soft-deprecated]}} This function is a convenience wrapper for submitting bulk API jobs } diff --git a/man/rforcecom.bulkQuery.Rd b/man/rforcecom.bulkQuery.Rd index 329ac934..1e2450c4 100644 --- a/man/rforcecom.bulkQuery.Rd +++ b/man/rforcecom.bulkQuery.Rd @@ -41,5 +41,5 @@ along with additional diagnostic information where available.} A \code{data.frame} of the recordset returned by query } \description{ -\ifelse{html}{\figure{lifecycle-soft-deprecated.svg}{options: alt='Soft-deprecated lifecycle'}}{\strong{Soft-deprecated}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#soft-deprecated}{\figure{lifecycle-soft-deprecated.svg}{options: alt='[Soft-deprecated]'}}}{\strong{[Soft-deprecated]}} } diff --git a/man/rforcecom.create.Rd b/man/rforcecom.create.Rd index c26ea288..e0db5450 100644 --- a/man/rforcecom.create.Rd +++ b/man/rforcecom.create.Rd @@ -24,5 +24,5 @@ function is operating against (e.g. "Account", "Contact", "CustomObject__c").} \code{data.frame} containing the id and success indicator of the record creation process } \description{ -\ifelse{html}{\figure{lifecycle-soft-deprecated.svg}{options: alt='Soft-deprecated lifecycle'}}{\strong{Soft-deprecated}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#soft-deprecated}{\figure{lifecycle-soft-deprecated.svg}{options: alt='[Soft-deprecated]'}}}{\strong{[Soft-deprecated]}} } diff --git a/man/rforcecom.delete.Rd b/man/rforcecom.delete.Rd index 085051ed..031d365a 100644 --- a/man/rforcecom.delete.Rd +++ b/man/rforcecom.delete.Rd @@ -24,5 +24,5 @@ function is operating against (e.g. "Account", "Contact", "CustomObject__c").} \code{NULL} if successful otherwise the function errors out } \description{ -\ifelse{html}{\figure{lifecycle-soft-deprecated.svg}{options: alt='Soft-deprecated lifecycle'}}{\strong{Soft-deprecated}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#soft-deprecated}{\figure{lifecycle-soft-deprecated.svg}{options: alt='[Soft-deprecated]'}}}{\strong{[Soft-deprecated]}} } diff --git a/man/rforcecom.getObjectDescription.Rd b/man/rforcecom.getObjectDescription.Rd index c3b3c8c0..33628494 100644 --- a/man/rforcecom.getObjectDescription.Rd +++ b/man/rforcecom.getObjectDescription.Rd @@ -22,7 +22,7 @@ function is operating against (e.g. "Account", "Contact", "CustomObject__c").} Object descriptions } \description{ -\ifelse{html}{\figure{lifecycle-soft-deprecated.svg}{options: alt='Soft-deprecated lifecycle'}}{\strong{Soft-deprecated}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#soft-deprecated}{\figure{lifecycle-soft-deprecated.svg}{options: alt='[Soft-deprecated]'}}}{\strong{[Soft-deprecated]}} } \note{ This function returns a data.frame with one row per field for an object. diff --git a/man/rforcecom.getServerTimestamp.Rd b/man/rforcecom.getServerTimestamp.Rd index efa72eec..2cb5483b 100644 --- a/man/rforcecom.getServerTimestamp.Rd +++ b/man/rforcecom.getServerTimestamp.Rd @@ -16,5 +16,5 @@ in an environment internal to the salesforcer package, so it is no longer necessary to pass the session in each function call.} } \description{ -\ifelse{html}{\figure{lifecycle-soft-deprecated.svg}{options: alt='Soft-deprecated lifecycle'}}{\strong{Soft-deprecated}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#soft-deprecated}{\figure{lifecycle-soft-deprecated.svg}{options: alt='[Soft-deprecated]'}}}{\strong{[Soft-deprecated]}} } diff --git a/man/rforcecom.login.Rd b/man/rforcecom.login.Rd index a44360d6..0c063fde 100644 --- a/man/rforcecom.login.Rd +++ b/man/rforcecom.login.Rd @@ -27,5 +27,5 @@ rforcecom.login( \item{apiVersion}{API Version.} } \description{ -\ifelse{html}{\figure{lifecycle-soft-deprecated.svg}{options: alt='Soft-deprecated lifecycle'}}{\strong{Soft-deprecated}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#soft-deprecated}{\figure{lifecycle-soft-deprecated.svg}{options: alt='[Soft-deprecated]'}}}{\strong{[Soft-deprecated]}} } diff --git a/man/rforcecom.query.Rd b/man/rforcecom.query.Rd index 18c42f0c..1d199411 100644 --- a/man/rforcecom.query.Rd +++ b/man/rforcecom.query.Rd @@ -25,5 +25,5 @@ deleted and archived records (available only when querying Task and Event record Result dataset. } \description{ -\ifelse{html}{\figure{lifecycle-soft-deprecated.svg}{options: alt='Soft-deprecated lifecycle'}}{\strong{Soft-deprecated}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#soft-deprecated}{\figure{lifecycle-soft-deprecated.svg}{options: alt='[Soft-deprecated]'}}}{\strong{[Soft-deprecated]}} } diff --git a/man/rforcecom.retrieve.Rd b/man/rforcecom.retrieve.Rd index 701e2dc1..3538d336 100644 --- a/man/rforcecom.retrieve.Rd +++ b/man/rforcecom.retrieve.Rd @@ -48,5 +48,5 @@ list in first. This parameter works when order parameter has been set. (Default: FALSE)} } \description{ -\ifelse{html}{\figure{lifecycle-soft-deprecated.svg}{options: alt='Soft-deprecated lifecycle'}}{\strong{Soft-deprecated}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#soft-deprecated}{\figure{lifecycle-soft-deprecated.svg}{options: alt='[Soft-deprecated]'}}}{\strong{[Soft-deprecated]}} } diff --git a/man/rforcecom.search.Rd b/man/rforcecom.search.Rd index 8ab73500..53fa634e 100644 --- a/man/rforcecom.search.Rd +++ b/man/rforcecom.search.Rd @@ -18,5 +18,5 @@ necessary to pass the session in each function call.} \item{queryString}{Query strings to search. (ex: "United", "Electoronics")} } \description{ -\ifelse{html}{\figure{lifecycle-soft-deprecated.svg}{options: alt='Soft-deprecated lifecycle'}}{\strong{Soft-deprecated}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#soft-deprecated}{\figure{lifecycle-soft-deprecated.svg}{options: alt='[Soft-deprecated]'}}}{\strong{[Soft-deprecated]}} } diff --git a/man/rforcecom.update.Rd b/man/rforcecom.update.Rd index 778cf150..ed57d26c 100644 --- a/man/rforcecom.update.Rd +++ b/man/rforcecom.update.Rd @@ -26,5 +26,5 @@ function is operating against (e.g. "Account", "Contact", "CustomObject__c").} \code{NULL} if successful otherwise the function errors out } \description{ -\ifelse{html}{\figure{lifecycle-soft-deprecated.svg}{options: alt='Soft-deprecated lifecycle'}}{\strong{Soft-deprecated}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#soft-deprecated}{\figure{lifecycle-soft-deprecated.svg}{options: alt='[Soft-deprecated]'}}}{\strong{[Soft-deprecated]}} } diff --git a/man/rforcecom.upsert.Rd b/man/rforcecom.upsert.Rd index 9ad6a809..3f6129ba 100644 --- a/man/rforcecom.upsert.Rd +++ b/man/rforcecom.upsert.Rd @@ -28,5 +28,5 @@ function is operating against (e.g. "Account", "Contact", "CustomObject__c").} \code{NULL} if successful otherwise the function errors out } \description{ -\ifelse{html}{\figure{lifecycle-soft-deprecated.svg}{options: alt='Soft-deprecated lifecycle'}}{\strong{Soft-deprecated}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#soft-deprecated}{\figure{lifecycle-soft-deprecated.svg}{options: alt='[Soft-deprecated]'}}}{\strong{[Soft-deprecated]}} } diff --git a/man/sf_access_token.Rd b/man/sf_access_token.Rd index 6aca5a43..75c883c4 100644 --- a/man/sf_access_token.Rd +++ b/man/sf_access_token.Rd @@ -4,7 +4,7 @@ \alias{sf_access_token} \title{Return access_token attribute of OAuth 2.0 Token} \usage{ -sf_access_token(verbose = FALSE) +sf_access_token(verbose = TRUE) } \arguments{ \item{verbose}{\code{logical}; an indicator of whether to print additional diff --git a/man/sf_analytics_notification_create.Rd b/man/sf_analytics_notification_create.Rd index dff3fd6d..beb33c02 100644 --- a/man/sf_analytics_notification_create.Rd +++ b/man/sf_analytics_notification_create.Rd @@ -17,5 +17,5 @@ user-friendly format.} \code{list} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} } diff --git a/man/sf_analytics_notification_delete.Rd b/man/sf_analytics_notification_delete.Rd index f655f3d7..e2236ddc 100644 --- a/man/sf_analytics_notification_delete.Rd +++ b/man/sf_analytics_notification_delete.Rd @@ -14,5 +14,5 @@ analytics notification. It will start with \code{"0Au"}.} \code{logical} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} } diff --git a/man/sf_analytics_notification_describe.Rd b/man/sf_analytics_notification_describe.Rd index 1c1a18f5..e5355558 100644 --- a/man/sf_analytics_notification_describe.Rd +++ b/man/sf_analytics_notification_describe.Rd @@ -14,5 +14,5 @@ analytics notification. It will start with \code{"0Au"}.} \code{list} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} } diff --git a/man/sf_analytics_notification_update.Rd b/man/sf_analytics_notification_update.Rd index dc297efe..fa7c130d 100644 --- a/man/sf_analytics_notification_update.Rd +++ b/man/sf_analytics_notification_update.Rd @@ -20,5 +20,5 @@ user-friendly format.} \code{list} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} } diff --git a/man/sf_analytics_notifications_limits.Rd b/man/sf_analytics_notifications_limits.Rd index d79e5c3d..f62239b2 100644 --- a/man/sf_analytics_notifications_limits.Rd +++ b/man/sf_analytics_notifications_limits.Rd @@ -29,5 +29,5 @@ reference Ids start with "0FK").} \code{list} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} } diff --git a/man/sf_analytics_notifications_list.Rd b/man/sf_analytics_notifications_list.Rd index 4903c04c..8a21e9d8 100644 --- a/man/sf_analytics_notifications_list.Rd +++ b/man/sf_analytics_notifications_list.Rd @@ -34,5 +34,5 @@ reference Ids start with "0FK").} \code{list} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} } diff --git a/man/sf_convert_lead.Rd b/man/sf_convert_lead.Rd index e08c5234..73385b16 100644 --- a/man/sf_convert_lead.Rd +++ b/man/sf_convert_lead.Rd @@ -45,7 +45,7 @@ along with additional diagnostic information where available.} \code{tbl_df} with details of the converted record } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} Converts Leads each into an Account, Contact, as well as (optionally) an Opportunity. } diff --git a/man/sf_copy_report.Rd b/man/sf_copy_report.Rd index d54e9162..f8fee54d 100644 --- a/man/sf_copy_report.Rd +++ b/man/sf_copy_report.Rd @@ -32,7 +32,7 @@ joined metadata.} } } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} Creates a copy of a custom, standard, or public report by sending a POST request to the Report List resource. diff --git a/man/sf_create.Rd b/man/sf_create.Rd index a04043a3..80877562 100644 --- a/man/sf_create.Rd +++ b/man/sf_create.Rd @@ -54,7 +54,7 @@ along with additional diagnostic information where available.} \code{tbl_df} of records with success indicator } \description{ -\ifelse{html}{\out{Maturing lifecycle}}{\strong{Maturing}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#maturing}{\figure{lifecycle-maturing.svg}{options: alt='[Maturing]'}}}{\strong{[Maturing]}} Adds one or more new records to your organization’s data. } diff --git a/man/sf_create_attachment.Rd b/man/sf_create_attachment.Rd index 7fcae9ae..a223bfb8 100644 --- a/man/sf_create_attachment.Rd +++ b/man/sf_create_attachment.Rd @@ -45,7 +45,7 @@ along with additional diagnostic information where available.} \code{tbl_df} with details of the created records } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} This function will allow you to create attachments (and other blob data, such as Documents) by supplying file paths (absolute or relative) to media that you diff --git a/man/sf_create_metadata.Rd b/man/sf_create_metadata.Rd index a5f7fa33..48566488 100644 --- a/man/sf_create_metadata.Rd +++ b/man/sf_create_metadata.Rd @@ -37,7 +37,7 @@ along with additional diagnostic information where available.} A \code{tbl_df} containing the creation result for each submitted metadata component } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} This function takes a list of Metadata components and sends them to Salesforce for creation diff --git a/man/sf_create_report.Rd b/man/sf_create_report.Rd index cbce7fe3..d756095c 100644 --- a/man/sf_create_report.Rd +++ b/man/sf_create_report.Rd @@ -43,7 +43,7 @@ joined metadata.} } } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} Create a new report using a POST request. To create a report, you only have to specify a name and report type to create a new report; all other metadata properties diff --git a/man/sf_dashboard_components_describe.Rd b/man/sf_dashboard_components_describe.Rd index f6b0a7cc..a22dc9f2 100644 --- a/man/sf_dashboard_components_describe.Rd +++ b/man/sf_dashboard_components_describe.Rd @@ -17,5 +17,5 @@ dashboard component.} \code{list} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} } diff --git a/man/sf_dashboard_copy.Rd b/man/sf_dashboard_copy.Rd index cef8d2df..cefd7c68 100644 --- a/man/sf_dashboard_copy.Rd +++ b/man/sf_dashboard_copy.Rd @@ -17,5 +17,5 @@ analytics folder (it will start with "00l").} \code{list} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} } diff --git a/man/sf_dashboard_delete.Rd b/man/sf_dashboard_delete.Rd index dc262fab..f496e2be 100644 --- a/man/sf_dashboard_delete.Rd +++ b/man/sf_dashboard_delete.Rd @@ -14,5 +14,5 @@ dashboard. It will start with \code{"01Z"}.} \code{logical} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} } diff --git a/man/sf_dashboard_describe.Rd b/man/sf_dashboard_describe.Rd index 43ddc7c5..9abe8dd4 100644 --- a/man/sf_dashboard_describe.Rd +++ b/man/sf_dashboard_describe.Rd @@ -22,7 +22,7 @@ along with additional diagnostic information where available.} \code{list} or \code{tbl_df} depending on the value of argument \code{as_tbl} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} Returns metadata for the specified dashboard, including dashboard components, filters, layout, and the running user. diff --git a/man/sf_dashboard_filter_operators_list.Rd b/man/sf_dashboard_filter_operators_list.Rd index 6d90e41c..d77455e3 100644 --- a/man/sf_dashboard_filter_operators_list.Rd +++ b/man/sf_dashboard_filter_operators_list.Rd @@ -10,5 +10,5 @@ sf_dashboard_filter_operators_list() \code{list} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} } diff --git a/man/sf_dashboard_filter_options_analysis.Rd b/man/sf_dashboard_filter_options_analysis.Rd index 1ab3addb..56d97acf 100644 --- a/man/sf_dashboard_filter_options_analysis.Rd +++ b/man/sf_dashboard_filter_options_analysis.Rd @@ -25,5 +25,5 @@ Each object has these properties:...} \code{list} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} } diff --git a/man/sf_dashboard_refresh.Rd b/man/sf_dashboard_refresh.Rd index d1d4bb50..82d96b1d 100644 --- a/man/sf_dashboard_refresh.Rd +++ b/man/sf_dashboard_refresh.Rd @@ -19,5 +19,5 @@ from the dashboard metadata using \link{sf_dashboard_describe}.} \code{list} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} } diff --git a/man/sf_dashboard_results.Rd b/man/sf_dashboard_results.Rd index 095857e3..966eda55 100644 --- a/man/sf_dashboard_results.Rd +++ b/man/sf_dashboard_results.Rd @@ -28,7 +28,7 @@ from the dashboard metadata using \link{sf_dashboard_describe}.} \code{tbl_df} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} This function allows for pulling specific data from a dashboard. There is a convenience function (\link{sf_get_dashboard_data}) to get the dashboard data diff --git a/man/sf_dashboard_set_sticky_filter.Rd b/man/sf_dashboard_set_sticky_filter.Rd index ab830c82..9d1a164b 100644 --- a/man/sf_dashboard_set_sticky_filter.Rd +++ b/man/sf_dashboard_set_sticky_filter.Rd @@ -22,7 +22,7 @@ from the dashboard metadata using \link{sf_dashboard_describe}.} \code{list} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} Set a default filter value which gets applied to a dashboard when you open it. The default filter value you specify only applies to you (other people diff --git a/man/sf_dashboard_status.Rd b/man/sf_dashboard_status.Rd index ef54c353..49463da4 100644 --- a/man/sf_dashboard_status.Rd +++ b/man/sf_dashboard_status.Rd @@ -28,5 +28,5 @@ from the dashboard metadata using \link{sf_dashboard_describe}.} \code{list} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} } diff --git a/man/sf_dashboard_update.Rd b/man/sf_dashboard_update.Rd index e407a6b5..d9127908 100644 --- a/man/sf_dashboard_update.Rd +++ b/man/sf_dashboard_update.Rd @@ -20,5 +20,5 @@ user-friendly format.} \code{list} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} } diff --git a/man/sf_dashboards_list.Rd b/man/sf_dashboards_list.Rd index 1454dfff..17bf3ede 100644 --- a/man/sf_dashboards_list.Rd +++ b/man/sf_dashboards_list.Rd @@ -19,7 +19,7 @@ along with additional diagnostic information where available.} \code{list} or \code{tbl_df} depending on the value of argument \code{as_tbl} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} Returns a list of recently used dashboards } diff --git a/man/sf_delete.Rd b/man/sf_delete.Rd index 3781aba6..21b63d21 100644 --- a/man/sf_delete.Rd +++ b/man/sf_delete.Rd @@ -53,7 +53,7 @@ along with additional diagnostic information where available.} \code{tbl_df} of records with success indicator } \description{ -\ifelse{html}{\out{Maturing lifecycle}}{\strong{Maturing}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#maturing}{\figure{lifecycle-maturing.svg}{options: alt='[Maturing]'}}}{\strong{[Maturing]}} Deletes one or more records from your organization’s data. } diff --git a/man/sf_delete_attachment.Rd b/man/sf_delete_attachment.Rd index 0c55d148..ed8e2ca8 100644 --- a/man/sf_delete_attachment.Rd +++ b/man/sf_delete_attachment.Rd @@ -36,7 +36,7 @@ along with additional diagnostic information where available.} \code{tbl_df} with details of the deleted records } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} This function is a wrapper around \code{\link{sf_delete}} that accepts a list of Ids and assumes that they are in the Attachment object and should be deleted. diff --git a/man/sf_delete_metadata.Rd b/man/sf_delete_metadata.Rd index a87c0f6e..5bc61fb1 100644 --- a/man/sf_delete_metadata.Rd +++ b/man/sf_delete_metadata.Rd @@ -36,7 +36,7 @@ along with additional diagnostic information where available.} A \code{data.frame} containing the creation result for each submitted metadata component } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} This function takes a request of named elements in Salesforce and deletes them. } diff --git a/man/sf_delete_report.Rd b/man/sf_delete_report.Rd index 8987aab5..aaa2e6e0 100644 --- a/man/sf_delete_report.Rd +++ b/man/sf_delete_report.Rd @@ -20,7 +20,7 @@ along with additional diagnostic information where available.} will return \code{TRUE} if successful in deleting the report. } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} Delete a report by sending a DELETE request to the Report resource. Deleted reports are moved to the Recycle Bin. diff --git a/man/sf_delete_report_instance.Rd b/man/sf_delete_report_instance.Rd index 4cc8ee66..4d55f3fa 100644 --- a/man/sf_delete_report_instance.Rd +++ b/man/sf_delete_report_instance.Rd @@ -24,7 +24,7 @@ along with additional diagnostic information where available.} will return \code{TRUE} if successful in deleting the report instance. } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} If the given report instance has a status of \code{Success} or \code{Error}, delete the report instance. diff --git a/man/sf_describe_metadata.Rd b/man/sf_describe_metadata.Rd index 470af7c8..5eede609 100644 --- a/man/sf_describe_metadata.Rd +++ b/man/sf_describe_metadata.Rd @@ -16,7 +16,7 @@ along with additional diagnostic information where available.} A \code{tbl_df} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} This function returns details about the organization metadata } diff --git a/man/sf_describe_object_fields.Rd b/man/sf_describe_object_fields.Rd index 7eff2c3c..5879f1f5 100644 --- a/man/sf_describe_object_fields.Rd +++ b/man/sf_describe_object_fields.Rd @@ -14,7 +14,7 @@ function is operating against (e.g. "Account", "Contact", "CustomObject__c").} A \code{tbl_df} containing one row per field for the requested object. } \description{ -\ifelse{html}{\out{Maturing lifecycle}}{\strong{Maturing}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#maturing}{\figure{lifecycle-maturing.svg}{options: alt='[Maturing]'}}}{\strong{[Maturing]}} This function takes the name of an object in Salesforce and returns a description of the fields on that object by returning a tibble with one row per field. diff --git a/man/sf_describe_objects.Rd b/man/sf_describe_objects.Rd index acaed377..68083e0d 100644 --- a/man/sf_describe_objects.Rd +++ b/man/sf_describe_objects.Rd @@ -35,7 +35,7 @@ along with additional diagnostic information where available.} \code{list} } \description{ -\ifelse{html}{\out{Maturing lifecycle}}{\strong{Maturing}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#maturing}{\figure{lifecycle-maturing.svg}{options: alt='[Maturing]'}}}{\strong{[Maturing]}} Describes the individual metadata for the specified object. } diff --git a/man/sf_describe_report.Rd b/man/sf_describe_report.Rd index ee50d674..74134b7c 100644 --- a/man/sf_describe_report.Rd +++ b/man/sf_describe_report.Rd @@ -25,7 +25,7 @@ along with additional diagnostic information where available.} } } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} Retrieves report, report type, and related metadata for a tabular, summary, or matrix report. diff --git a/man/sf_describe_report_type.Rd b/man/sf_describe_report_type.Rd index 2206f4ba..8ab7dccb 100644 --- a/man/sf_describe_report_type.Rd +++ b/man/sf_describe_report_type.Rd @@ -30,7 +30,7 @@ joined metadata.} } } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} Return metadata about a report type. } diff --git a/man/sf_download_attachment.Rd b/man/sf_download_attachment.Rd index ca4bec25..6112f6ca 100644 --- a/man/sf_download_attachment.Rd +++ b/man/sf_download_attachment.Rd @@ -38,7 +38,7 @@ to the current directory.} content } \description{ -\ifelse{html}{\out{Maturing lifecycle}}{\strong{Maturing}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#maturing}{\figure{lifecycle-maturing.svg}{options: alt='[Maturing]'}}}{\strong{[Maturing]}} This function will allow you to download an attachment to disk based on the attachment body, file name, and path. diff --git a/man/sf_empty_recycle_bin.Rd b/man/sf_empty_recycle_bin.Rd index 486a7106..6c046b99 100644 --- a/man/sf_empty_recycle_bin.Rd +++ b/man/sf_empty_recycle_bin.Rd @@ -24,7 +24,7 @@ along with additional diagnostic information where available.} \code{tbl_df} of records with success indicator } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} Delete records from the recycle bin immediately and permanently. } diff --git a/man/sf_execute_report.Rd b/man/sf_execute_report.Rd index 46fa4c2f..ec260fc8 100644 --- a/man/sf_execute_report.Rd +++ b/man/sf_execute_report.Rd @@ -84,7 +84,7 @@ which means that the content from the API is converted from JSON to a list with no other post-processing. } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} Get summary data with or without details by running a report synchronously or asynchronously through the API. When you run a report, the API returns data diff --git a/man/sf_find_duplicates.Rd b/man/sf_find_duplicates.Rd index f50e3577..fb62865d 100644 --- a/man/sf_find_duplicates.Rd +++ b/man/sf_find_duplicates.Rd @@ -40,7 +40,7 @@ along with additional diagnostic information where available.} \code{tbl_df} of records found to be duplicates by the match rules } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} Performs rule-based searches for duplicate records. } diff --git a/man/sf_find_duplicates_by_id.Rd b/man/sf_find_duplicates_by_id.Rd index d8b825c2..6453eac6 100644 --- a/man/sf_find_duplicates_by_id.Rd +++ b/man/sf_find_duplicates_by_id.Rd @@ -36,7 +36,7 @@ along with additional diagnostic information where available.} \code{tbl_df} of records found to be duplicates by the match rules } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} Performs rule-based searches for duplicate records. } diff --git a/man/sf_get_dashboard_data.Rd b/man/sf_get_dashboard_data.Rd index a37a953f..5f6b4119 100644 --- a/man/sf_get_dashboard_data.Rd +++ b/man/sf_get_dashboard_data.Rd @@ -28,5 +28,5 @@ from the dashboard metadata using \link{sf_dashboard_describe}.} \code{tbl_df} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} } diff --git a/man/sf_get_deleted.Rd b/man/sf_get_deleted.Rd index eb972b8c..d01f4e6c 100644 --- a/man/sf_get_deleted.Rd +++ b/man/sf_get_deleted.Rd @@ -22,7 +22,7 @@ set to \code{TRUE} the URL, header, and body will be printed for each request, along with additional diagnostic information where available.} } \description{ -\ifelse{html}{\out{Maturing lifecycle}}{\strong{Maturing}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#maturing}{\figure{lifecycle-maturing.svg}{options: alt='[Maturing]'}}}{\strong{[Maturing]}} Retrieves the list of individual records that have been deleted within the given timespan for the specified object. diff --git a/man/sf_get_report_instance_results.Rd b/man/sf_get_report_instance_results.Rd index 5638dbee..8e6f456a 100644 --- a/man/sf_get_report_instance_results.Rd +++ b/man/sf_get_report_instance_results.Rd @@ -59,7 +59,7 @@ along with additional diagnostic information where available.} data from the "T!T" entry in the fact map. } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} Retrieves results for an instance of a report run asynchronously with or without filters. Depending on your asynchronous report run request, data can be at the diff --git a/man/sf_get_updated.Rd b/man/sf_get_updated.Rd index dcf11d29..f24182af 100644 --- a/man/sf_get_updated.Rd +++ b/man/sf_get_updated.Rd @@ -22,7 +22,7 @@ set to \code{TRUE} the URL, header, and body will be printed for each request, along with additional diagnostic information where available.} } \description{ -\ifelse{html}{\out{Maturing lifecycle}}{\strong{Maturing}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#maturing}{\figure{lifecycle-maturing.svg}{options: alt='[Maturing]'}}}{\strong{[Maturing]}} Retrieves the list of individual records that have been inserted or updated within the given timespan in the specified object. diff --git a/man/sf_list_api_limits.Rd b/man/sf_list_api_limits.Rd index dd20d898..cbbca56d 100644 --- a/man/sf_list_api_limits.Rd +++ b/man/sf_list_api_limits.Rd @@ -10,7 +10,7 @@ sf_list_api_limits() \code{list} } \description{ -\ifelse{html}{\out{Stable lifecycle}}{\strong{Stable}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#stable}{\figure{lifecycle-stable.svg}{options: alt='[Stable]'}}}{\strong{[Stable]}} Lists information about limits in your org. } diff --git a/man/sf_list_metadata.Rd b/man/sf_list_metadata.Rd index 6643b804..44507c5f 100644 --- a/man/sf_list_metadata.Rd +++ b/man/sf_list_metadata.Rd @@ -20,7 +20,7 @@ along with additional diagnostic information where available.} A \code{tbl_dfs} containing the queried metadata types } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} This function takes a query of metadata types and returns a summary of all objects in salesforce of the requested types diff --git a/man/sf_list_objects.Rd b/man/sf_list_objects.Rd index 59ee307d..bf7e7b41 100644 --- a/man/sf_list_objects.Rd +++ b/man/sf_list_objects.Rd @@ -10,7 +10,7 @@ sf_list_objects() \code{list} } \description{ -\ifelse{html}{\out{Stable lifecycle}}{\strong{Stable}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#stable}{\figure{lifecycle-stable.svg}{options: alt='[Stable]'}}}{\strong{[Stable]}} Lists the available objects and their metadata for your organization’s data. } diff --git a/man/sf_list_report_fields.Rd b/man/sf_list_report_fields.Rd index edf4fc29..111b0dc9 100644 --- a/man/sf_list_report_fields.Rd +++ b/man/sf_list_report_fields.Rd @@ -35,7 +35,7 @@ along with additional diagnostic information where available.} } } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} The Report Fields resource returns report fields available for specified reports. Use the resource to determine the best fields for use in dashboard filters by diff --git a/man/sf_list_report_filter_operators.Rd b/man/sf_list_report_filter_operators.Rd index 3948309b..e8921f69 100644 --- a/man/sf_list_report_filter_operators.Rd +++ b/man/sf_list_report_filter_operators.Rd @@ -20,7 +20,7 @@ along with additional diagnostic information where available.} argument \code{as_tbl} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} Use the Filter Operators API to get information about which filter operators are available for reports and dashboards. The Filter Operators API is available in diff --git a/man/sf_list_report_instances.Rd b/man/sf_list_report_instances.Rd index a6754401..29745559 100644 --- a/man/sf_list_report_instances.Rd +++ b/man/sf_list_report_instances.Rd @@ -23,7 +23,7 @@ along with additional diagnostic information where available.} argument \code{as_tbl} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} Returns a list of instances for a report that you requested to be run asynchronously. Each item in the list is treated as a separate instance of the report run with diff --git a/man/sf_list_report_types.Rd b/man/sf_list_report_types.Rd index 91c6bbb3..1f0bf9d0 100644 --- a/man/sf_list_report_types.Rd +++ b/man/sf_list_report_types.Rd @@ -20,7 +20,7 @@ along with additional diagnostic information where available.} argument \code{as_tbl} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} Return a list of report types. } diff --git a/man/sf_list_reports.Rd b/man/sf_list_reports.Rd index ab0dd086..1d85a29e 100644 --- a/man/sf_list_reports.Rd +++ b/man/sf_list_reports.Rd @@ -28,7 +28,7 @@ along with additional diagnostic information where available.} argument \code{as_tbl} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} Displays a list of full list of reports based on the \code{Report} object. If \code{recent} is up to 200 tabular, matrix, or summary reports that you diff --git a/man/sf_list_resources.Rd b/man/sf_list_resources.Rd index 524b3bf7..a7a02183 100644 --- a/man/sf_list_resources.Rd +++ b/man/sf_list_resources.Rd @@ -10,7 +10,7 @@ sf_list_resources() \code{list} } \description{ -\ifelse{html}{\out{Stable lifecycle}}{\strong{Stable}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#stable}{\figure{lifecycle-stable.svg}{options: alt='[Stable]'}}}{\strong{[Stable]}} Lists available resources for the specified API version, including resource name and URI. diff --git a/man/sf_list_rest_api_versions.Rd b/man/sf_list_rest_api_versions.Rd index dbdbe316..0398a742 100644 --- a/man/sf_list_rest_api_versions.Rd +++ b/man/sf_list_rest_api_versions.Rd @@ -10,7 +10,7 @@ sf_list_rest_api_versions() \code{list} } \description{ -\ifelse{html}{\out{Stable lifecycle}}{\strong{Stable}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#stable}{\figure{lifecycle-stable.svg}{options: alt='[Stable]'}}}{\strong{[Stable]}} Lists summary information about each Salesforce version currently available, including the version, label, and a link to each version\'s root diff --git a/man/sf_merge.Rd b/man/sf_merge.Rd index 4f7dc1cf..a97980c3 100644 --- a/man/sf_merge.Rd +++ b/man/sf_merge.Rd @@ -51,7 +51,7 @@ along with additional diagnostic information where available.} \code{tbl_df} of records with success indicator } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} This function combines records of the same object type into one of the records, known as the master record. The other records, known as the victim records, will diff --git a/man/sf_query.Rd b/man/sf_query.Rd index 47cd981d..b5c35d97 100644 --- a/man/sf_query.Rd +++ b/man/sf_query.Rd @@ -79,7 +79,7 @@ along with additional diagnostic information where available.} \code{tbl_df} of records } \description{ -\ifelse{html}{\out{Maturing lifecycle}}{\strong{Maturing}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#maturing}{\figure{lifecycle-maturing.svg}{options: alt='[Maturing]'}}}{\strong{[Maturing]}} Executes a query against the specified object and returns data that matches the specified criteria. diff --git a/man/sf_query_report.Rd b/man/sf_query_report.Rd index 7a4b68cd..2dbf7701 100644 --- a/man/sf_query_report.Rd +++ b/man/sf_query_report.Rd @@ -38,7 +38,7 @@ along with additional diagnostic information where available.} \code{tbl_df} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} Run a report without creating a new report or changing the existing one by making a POST request to the query resource. This allows you to get report data diff --git a/man/sf_read_metadata.Rd b/man/sf_read_metadata.Rd index ee3f44cf..e552b0c7 100644 --- a/man/sf_read_metadata.Rd +++ b/man/sf_read_metadata.Rd @@ -20,7 +20,7 @@ along with additional diagnostic information where available.} A \code{list} containing a response for each requested object } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} This function takes a request of named elements in Salesforce and returns their metadata diff --git a/man/sf_rename_metadata.Rd b/man/sf_rename_metadata.Rd index 95be4816..b28aeca1 100644 --- a/man/sf_rename_metadata.Rd +++ b/man/sf_rename_metadata.Rd @@ -24,7 +24,7 @@ along with additional diagnostic information where available.} A \code{data.frame} containing the creation result for each submitted metadata component } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} This function takes an old and new name for a metadata element in Salesforce and applies the new name diff --git a/man/sf_report_folder_children.Rd b/man/sf_report_folder_children.Rd index c212f621..96d14fa9 100644 --- a/man/sf_report_folder_children.Rd +++ b/man/sf_report_folder_children.Rd @@ -16,5 +16,5 @@ page returns. Default is 10.} \item{page}{\code{integer}; integer that indicates which page of results to return.} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} } diff --git a/man/sf_report_folder_create.Rd b/man/sf_report_folder_create.Rd index 351e635a..e33685fb 100644 --- a/man/sf_report_folder_create.Rd +++ b/man/sf_report_folder_create.Rd @@ -17,5 +17,5 @@ user-friendly format.} \code{list} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} } diff --git a/man/sf_report_folder_delete.Rd b/man/sf_report_folder_delete.Rd index de5882b5..107de64d 100644 --- a/man/sf_report_folder_delete.Rd +++ b/man/sf_report_folder_delete.Rd @@ -14,5 +14,5 @@ analytics folder (it will start with "00l").} \code{logical} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} } diff --git a/man/sf_report_folder_describe.Rd b/man/sf_report_folder_describe.Rd index e4914ec2..b7db38b3 100644 --- a/man/sf_report_folder_describe.Rd +++ b/man/sf_report_folder_describe.Rd @@ -14,5 +14,5 @@ analytics folder (it will start with "00l").} \code{list} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} } diff --git a/man/sf_report_folder_share_delete.Rd b/man/sf_report_folder_share_delete.Rd index 92c29093..87cac864 100644 --- a/man/sf_report_folder_share_delete.Rd +++ b/man/sf_report_folder_share_delete.Rd @@ -17,5 +17,5 @@ analytics folder share (it will start with "004").} \code{logical} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} } diff --git a/man/sf_report_folder_share_describe.Rd b/man/sf_report_folder_share_describe.Rd index 2f868fea..a5921d8a 100644 --- a/man/sf_report_folder_share_describe.Rd +++ b/man/sf_report_folder_share_describe.Rd @@ -17,5 +17,5 @@ analytics folder share (it will start with "004").} \code{list} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} } diff --git a/man/sf_report_folder_share_recipients.Rd b/man/sf_report_folder_share_recipients.Rd index f7ab2a04..272c00eb 100644 --- a/man/sf_report_folder_share_recipients.Rd +++ b/man/sf_report_folder_share_recipients.Rd @@ -27,5 +27,5 @@ Default is "" (no restriction).} \code{list} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} } diff --git a/man/sf_report_folder_share_update.Rd b/man/sf_report_folder_share_update.Rd index a5b6c49e..b8e4eb75 100644 --- a/man/sf_report_folder_share_update.Rd +++ b/man/sf_report_folder_share_update.Rd @@ -23,5 +23,5 @@ user-friendly format.} \code{list} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} } diff --git a/man/sf_report_folder_shares_add.Rd b/man/sf_report_folder_shares_add.Rd index 536cedec..b3bba886 100644 --- a/man/sf_report_folder_shares_add.Rd +++ b/man/sf_report_folder_shares_add.Rd @@ -20,7 +20,7 @@ user-friendly format.} \code{list} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} Creates new shares and appends them to the existing share list for the folder. } diff --git a/man/sf_report_folder_shares_list.Rd b/man/sf_report_folder_shares_list.Rd index 0ca1d15e..81180aee 100644 --- a/man/sf_report_folder_shares_list.Rd +++ b/man/sf_report_folder_shares_list.Rd @@ -14,5 +14,5 @@ analytics folder (it will start with "00l").} \code{list} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} } diff --git a/man/sf_report_folder_shares_update.Rd b/man/sf_report_folder_shares_update.Rd index 1cee7db0..6acfc6f2 100644 --- a/man/sf_report_folder_shares_update.Rd +++ b/man/sf_report_folder_shares_update.Rd @@ -20,7 +20,7 @@ user-friendly format.} \code{list} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} Creates new shares to replace the existing shares in the share list for the folder. } diff --git a/man/sf_report_folder_update.Rd b/man/sf_report_folder_update.Rd index e1fd6efe..1646f535 100644 --- a/man/sf_report_folder_update.Rd +++ b/man/sf_report_folder_update.Rd @@ -20,5 +20,5 @@ user-friendly format.} \code{list} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} } diff --git a/man/sf_report_folders_list.Rd b/man/sf_report_folders_list.Rd index 439a972f..bfe13f70 100644 --- a/man/sf_report_folders_list.Rd +++ b/man/sf_report_folders_list.Rd @@ -10,5 +10,5 @@ sf_report_folders_list() \code{list} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} } diff --git a/man/sf_reset_password.Rd b/man/sf_reset_password.Rd index 357f27e2..6a1c92c9 100644 --- a/man/sf_reset_password.Rd +++ b/man/sf_reset_password.Rd @@ -24,7 +24,7 @@ along with additional diagnostic information where available.} \code{list} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} Changes a user’s password to a temporary, system-generated value. } diff --git a/man/sf_retrieve.Rd b/man/sf_retrieve.Rd index a5a4ae95..9b3ca2f0 100644 --- a/man/sf_retrieve.Rd +++ b/man/sf_retrieve.Rd @@ -52,7 +52,7 @@ along with additional diagnostic information where available.} \code{tibble} } \description{ -\ifelse{html}{\out{Maturing lifecycle}}{\strong{Maturing}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#maturing}{\figure{lifecycle-maturing.svg}{options: alt='[Maturing]'}}}{\strong{[Maturing]}} Retrieves one or more new records to your organization’s data. } diff --git a/man/sf_retrieve_metadata.Rd b/man/sf_retrieve_metadata.Rd index d9216159..b40c9f6b 100644 --- a/man/sf_retrieve_metadata.Rd +++ b/man/sf_retrieve_metadata.Rd @@ -35,7 +35,7 @@ along with additional diagnostic information where available.} A \code{list} of details from the created retrieve request } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} This function makes a request to retrieve metadata as a package XML files that can be modified and later diff --git a/man/sf_retrieve_metadata_check_status.Rd b/man/sf_retrieve_metadata_check_status.Rd index 7edbb0bd..c7705d1f 100644 --- a/man/sf_retrieve_metadata_check_status.Rd +++ b/man/sf_retrieve_metadata_check_status.Rd @@ -30,7 +30,7 @@ along with additional diagnostic information where available.} A \code{list} of the response } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} This function returns details about an initiated retrieveMetadata request and saves the results into a zip file diff --git a/man/sf_run_bulk_operation.Rd b/man/sf_run_bulk_operation.Rd index b5e9f00b..2c9a271f 100644 --- a/man/sf_run_bulk_operation.Rd +++ b/man/sf_run_bulk_operation.Rd @@ -89,7 +89,7 @@ along with additional diagnostic information where available.} A \code{tbl_df} of the results of the bulk job } \description{ -\ifelse{html}{\out{Maturing lifecycle}}{\strong{Maturing}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#maturing}{\figure{lifecycle-maturing.svg}{options: alt='[Maturing]'}}}{\strong{[Maturing]}} This function is a convenience wrapper for submitting bulk API jobs } diff --git a/man/sf_run_bulk_query.Rd b/man/sf_run_bulk_query.Rd index 926069de..99c4d594 100644 --- a/man/sf_run_bulk_query.Rd +++ b/man/sf_run_bulk_query.Rd @@ -86,7 +86,7 @@ along with additional diagnostic information where available.} A \code{tbl_df} of the recordset returned by the query } \description{ -\ifelse{html}{\out{Maturing lifecycle}}{\strong{Maturing}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#maturing}{\figure{lifecycle-maturing.svg}{options: alt='[Maturing]'}}}{\strong{[Maturing]}} This function is a convenience wrapper for submitting and retrieving query API jobs from the Bulk 1.0 and Bulk 2.0 APIs. diff --git a/man/sf_run_report.Rd b/man/sf_run_report.Rd index 838a9a6b..f2aa2e1d 100644 --- a/man/sf_run_report.Rd +++ b/man/sf_run_report.Rd @@ -72,7 +72,7 @@ along with additional diagnostic information where available.} \code{tbl_df} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} This function is a convenience wrapper for retrieving the data from a report. By default, it executes an asynchronous report and waits for the detailed data diff --git a/man/sf_search.Rd b/man/sf_search.Rd index a5033aab..0a465683 100644 --- a/man/sf_search.Rd +++ b/man/sf_search.Rd @@ -47,7 +47,7 @@ if it is not supplied directly.} \code{tibble} } \description{ -\ifelse{html}{\out{Maturing lifecycle}}{\strong{Maturing}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#maturing}{\figure{lifecycle-maturing.svg}{options: alt='[Maturing]'}}}{\strong{[Maturing]}} Searches for records in your organization’s data. } diff --git a/man/sf_server_timestamp.Rd b/man/sf_server_timestamp.Rd index 2890b674..27a7d8df 100644 --- a/man/sf_server_timestamp.Rd +++ b/man/sf_server_timestamp.Rd @@ -10,7 +10,7 @@ sf_server_timestamp() \code{POSIXct} formatted timestamp } \description{ -\ifelse{html}{\out{Stable lifecycle}}{\strong{Stable}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#stable}{\figure{lifecycle-stable.svg}{options: alt='[Stable]'}}}{\strong{[Stable]}} Retrieves the current system timestamp from the API. } diff --git a/man/sf_set_password.Rd b/man/sf_set_password.Rd index e5145345..72327216 100644 --- a/man/sf_set_password.Rd +++ b/man/sf_set_password.Rd @@ -21,7 +21,7 @@ along with additional diagnostic information where available.} \code{list} } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} Sets the specified user’s password to the specified value. } diff --git a/man/sf_undelete.Rd b/man/sf_undelete.Rd index 25462f48..999e7023 100644 --- a/man/sf_undelete.Rd +++ b/man/sf_undelete.Rd @@ -36,7 +36,7 @@ along with additional diagnostic information where available.} \code{tbl_df} of records with success indicator } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} Undeletes records from the Recycle Bin. } diff --git a/man/sf_update.Rd b/man/sf_update.Rd index de92f3ad..177a9833 100644 --- a/man/sf_update.Rd +++ b/man/sf_update.Rd @@ -54,7 +54,7 @@ along with additional diagnostic information where available.} \code{tbl_df} of records with success indicator } \description{ -\ifelse{html}{\out{Maturing lifecycle}}{\strong{Maturing}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#maturing}{\figure{lifecycle-maturing.svg}{options: alt='[Maturing]'}}}{\strong{[Maturing]}} Updates one or more records to your organization’s data. } diff --git a/man/sf_update_attachment.Rd b/man/sf_update_attachment.Rd index b67adb64..b65cdafc 100644 --- a/man/sf_update_attachment.Rd +++ b/man/sf_update_attachment.Rd @@ -45,7 +45,7 @@ along with additional diagnostic information where available.} \code{tbl_df} with details of the created records } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} This function will allow you to update attachments (and other blob data, such as Documents) by providing the Id of the attachment record and the file paths diff --git a/man/sf_update_metadata.Rd b/man/sf_update_metadata.Rd index 3f22f5ed..3328140a 100644 --- a/man/sf_update_metadata.Rd +++ b/man/sf_update_metadata.Rd @@ -37,7 +37,7 @@ along with additional diagnostic information where available.} A \code{tbl_df} containing the creation result for each submitted metadata component } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} This function takes a list of Metadata components and sends them to Salesforce to update an object that already exists diff --git a/man/sf_update_report.Rd b/man/sf_update_report.Rd index 9ec1e8d9..2ae7751e 100644 --- a/man/sf_update_report.Rd +++ b/man/sf_update_report.Rd @@ -32,7 +32,7 @@ joined metadata.} } } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} Save changes to a report by sending a PATCH request to the Report resource. Note that saving a report deletes any running async report jobs because they diff --git a/man/sf_upsert.Rd b/man/sf_upsert.Rd index c2147f8c..a337a9b6 100644 --- a/man/sf_upsert.Rd +++ b/man/sf_upsert.Rd @@ -59,7 +59,7 @@ along with additional diagnostic information where available.} \code{tbl_df} of records with success indicator } \description{ -\ifelse{html}{\out{Maturing lifecycle}}{\strong{Maturing}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#maturing}{\figure{lifecycle-maturing.svg}{options: alt='[Maturing]'}}}{\strong{[Maturing]}} Upserts one or more new records to your organization’s data. } diff --git a/man/sf_upsert_metadata.Rd b/man/sf_upsert_metadata.Rd index d02f1114..eb216675 100644 --- a/man/sf_upsert_metadata.Rd +++ b/man/sf_upsert_metadata.Rd @@ -37,7 +37,7 @@ along with additional diagnostic information where available.} A \code{tbl_df} containing the creation result for each submitted metadata component } \description{ -\ifelse{html}{\out{Experimental lifecycle}}{\strong{Experimental}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} This function takes a list of Metadata components and sends them to Salesforce for creation or update if the object already exists diff --git a/man/sf_user_info.Rd b/man/sf_user_info.Rd index a79b5529..19f4e6a8 100644 --- a/man/sf_user_info.Rd +++ b/man/sf_user_info.Rd @@ -20,7 +20,7 @@ along with additional diagnostic information where available.} \code{list} } \description{ -\ifelse{html}{\out{Maturing lifecycle}}{\strong{Maturing}} +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#maturing}{\figure{lifecycle-maturing.svg}{options: alt='[Maturing]'}}}{\strong{[Maturing]}} Retrieves personal information for the user associated with the current session. } From f415b4938fa1a13fd68dd6cebab0f6ea79a0700d Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sat, 3 Jul 2021 16:30:01 -0500 Subject: [PATCH 05/42] Allow guess_types in sf_run_report and fix date and datetime column bug Salesforce returns dates and datetimes in UTC but sometimes as YYYY-MM-DD or MM/DD/YYYY in the case of reports, so we will convert using the anytime package rather than trusting type_convert()'s behavior. Allow users to pass guess_types directly to sf_run_report() in case they still want to do that and parse the character strings on their own Closes #93 --- DESCRIPTION | 1 + NAMESPACE | 3 +++ R/analytics-report.R | 13 ++++++++++++- R/utils-query.R | 28 ++++++++++++++++++++------- man/sf_guess_cols.Rd | 2 +- man/sf_run_report.Rd | 46 ++++++++++++++++++++++++++++++++++++++++++++ 6 files changed, 84 insertions(+), 9 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 202971f5..cefa6138 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -32,6 +32,7 @@ Imports: tibble (>= 3.0.3), readr (>= 1.3.1), lubridate (>= 1.7.8), + anytime (>= 0.3.9), rlang (>= 0.4.7), httr (>= 1.4.1), curl (>= 4.3), diff --git a/NAMESPACE b/NAMESPACE index e48f0f02..af1e28a1 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -282,6 +282,8 @@ importFrom(XML,xmlSApply) importFrom(XML,xmlSize) importFrom(XML,xmlToList) importFrom(XML,xmlValue) +importFrom(anytime,anydate) +importFrom(anytime,anytime) importFrom(base64enc,base64encode) importFrom(curl,form_data) importFrom(curl,form_file) @@ -359,6 +361,7 @@ importFrom(purrr,transpose) importFrom(readr,col_character) importFrom(readr,col_guess) importFrom(readr,cols) +importFrom(readr,locale) importFrom(readr,parse_datetime) importFrom(readr,read_csv) importFrom(readr,type_convert) diff --git a/R/analytics-report.R b/R/analytics-report.R index 408c8d8e..ddcdde73 100644 --- a/R/analytics-report.R +++ b/R/analytics-report.R @@ -962,6 +962,9 @@ sf_get_report_instance_results <- function(report_id, #' report finish running so that data can be obtained. Otherwise, return the #' report instance details which can be used to retrieve the results when the #' async report has finished. +#' @template guess_types +#' @template bind_using_character_cols +#' @template fact_map_key #' @template verbose #' @return \code{tbl_df} #' @family Report functions @@ -1017,6 +1020,9 @@ sf_run_report <- function(report_id, interval_seconds = 3, max_attempts = 200, wait_for_results = TRUE, + guess_types = TRUE, + bind_using_character_cols = FALSE, + fact_map_key = "T!T", verbose = FALSE){ # build out the body of the request based on the inputted arguments by starting @@ -1090,7 +1096,9 @@ sf_run_report <- function(report_id, results <- sf_execute_report(report_id, async = async, - report_metadata = request_body, + report_metadata = request_body, + guess_types = guess_types, + bind_using_character_cols = bind_using_character_cols, verbose = verbose) # request the report results (still wait if async is specified) @@ -1123,6 +1131,9 @@ sf_run_report <- function(report_id, } results <- sf_get_report_instance_results(report_id, results$id, + guess_types = guess_types, + bind_using_character_cols = bind_using_character_cols, + fact_map_key = "T!T", verbose = verbose) } } diff --git a/R/utils-query.R b/R/utils-query.R index 4acdb5ab..28e46ee0 100644 --- a/R/utils-query.R +++ b/R/utils-query.R @@ -733,12 +733,13 @@ sf_reorder_cols <- function(df){ contains(".")) } -#' Reorder resultset columns to prioritize \code{sObject} and \code{Id} +#' Parse resultset columns to a known datatype in R #' #' This function accepts a \code{tbl_df} with columns rearranged. #' #' @importFrom dplyr mutate across -#' @importFrom readr type_convert cols col_guess +#' @importFrom anytime anytime anydate +#' @importFrom readr type_convert cols col_guess locale #' @param df \code{tbl_df}; the data frame to rearrange columns in #' @return \code{tbl_df} the formatted data frame #' @note This function is meant to be used internally. Only use when debugging. @@ -746,19 +747,32 @@ sf_reorder_cols <- function(df){ #' @export sf_guess_cols <- function(df, guess_types=TRUE, dataType=NULL){ if(guess_types){ - if(is.null(dataType) || any(is.na(dataType)) || (length(dataType)== 0)){ + if(is.null(dataType) || any(is.na(dataType)) || (length(dataType) == 0)){ df <- df %>% - type_convert(col_types = cols(.default = col_guess())) + type_convert(col_types = cols(.default = col_guess()), locale=locale(tz="UTC")) } else { col_spec <- sf_build_cols_spec(dataType) - # if numeric but contains Salesforce "-" then preemptively change to NA + # if numeric Salesforce will flag N/A as "-" so we need to preemptively change to NA + # TODO: Does it use "-" for NA or zero? Or both? if(grepl('i|n', col_spec)){ numeric_col_idx <- which(strsplit(col_spec, split=character(0))[[1]] %in% c("i", "n")) df <- df %>% mutate(across(all_of(numeric_col_idx), ~ifelse(.x == "-", NA_character_, .x))) } - df <- df %>% - type_convert(col_types = col_spec) + # Salesforce returns dates and datetimes in UTC but sometimes as YYYY-MM-DD + # or MM/DD/YYYY in the case of reports, so we will convert using the + # anytime package rather than trusting type_convert's behavior + if(grepl('D', col_spec)){ + date_col_idx <- which(strsplit(col_spec, split=character(0))[[1]] == "D") + df <- df %>% + mutate(across(all_of(date_col_idx), ~as.character(anydate(.x, tz="UTC", asUTC=TRUE)))) + } + if(grepl('T', col_spec)){ + datetime_col_idx <- which(strsplit(col_spec, split=character(0))[[1]] == "T") + df <- df %>% + mutate(across(all_of(datetime_col_idx), ~as.character(anytime(.x, tz="UTC", asUTC=TRUE)))) + } + df <- df %>% type_convert(col_types = col_spec, locale=locale(tz="UTC")) } } return(df) diff --git a/man/sf_guess_cols.Rd b/man/sf_guess_cols.Rd index 61589fcd..b60d1ab6 100644 --- a/man/sf_guess_cols.Rd +++ b/man/sf_guess_cols.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/utils-query.R \name{sf_guess_cols} \alias{sf_guess_cols} -\title{Reorder resultset columns to prioritize \code{sObject} and \code{Id}} +\title{Parse resultset columns to a known datatype in R} \usage{ sf_guess_cols(df, guess_types = TRUE, dataType = NULL) } diff --git a/man/sf_run_report.Rd b/man/sf_run_report.Rd index f2aa2e1d..edfbfc14 100644 --- a/man/sf_run_report.Rd +++ b/man/sf_run_report.Rd @@ -15,6 +15,9 @@ sf_run_report( interval_seconds = 3, max_attempts = 200, wait_for_results = TRUE, + guess_types = TRUE, + bind_using_character_cols = FALSE, + fact_map_key = "T!T", verbose = FALSE ) } @@ -63,6 +66,26 @@ report finish running so that data can be obtained. Otherwise, return the report instance details which can be used to retrieve the results when the async report has finished.} +\item{guess_types}{\code{logical}; indicating whether or not to use \code{col_guess()} +to try and cast the data returned in the recordset. If \code{TRUE} then +\code{col_guess()} is used, if \code{FALSE} then all fields will be returned +as character. This is helpful when \code{col_guess()} will mangle field values +in Salesforce that you'd like to preserve during translation into a \code{tbl_df}, +like numeric looking values that must be preserved as strings ("48.0").} + +\item{bind_using_character_cols}{\code{logical}; an indicator of whether to +cast the data to all character columns to ensure that \code{\link[dplyr:bind]{bind_rows}} +does not fail because two paginated recordsets have differing datatypes for the +same column. Set this to \code{TRUE} rarely, typically only when having this +set to \code{FALSE} returns an error or you want all columns in the data to be +character.} + +\item{fact_map_key}{\code{character}; string providing an index into each +section of a fact map, from which you can access summary and detailed data. +The pattern for the fact map keys varies by report format so it is important +to know what the \code{reportFormat} property of the target report is. See the +note below for more details.} + \item{verbose}{\code{logical}; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to \code{TRUE} the URL, header, and body will be printed for each request, @@ -88,6 +111,29 @@ without total rows and given options to filter, and select the Top N as function arguments rather than forcing the user to create an entire list of \code{reportMetadata}. } +\note{ +Below are the fact map key patterns for three report types: +\describe{ +\item{TABULAR}{\code{T!T}: The grand total of a report. Both record data +values and the grand total are represented by this key.} +\item{SUMMARY}{\code{!T}: T refers to the row grand total.} +\item{MATRIX}{\code{!.}} +} + +Each item in a row or column grouping is numbered starting with 0. Here are +some examples of fact map keys: + +\describe{ +\item{0!T}{The first item in the first-level grouping.} +\item{1!T}{The second item in the first-level grouping.} +\item{0_0!T}{The first item in the first-level grouping and the first item +in the second-level grouping.} +\item{0_1!T}{The first item in the first-level grouping and the second item +in the second-level grouping.} +} +} \section{Salesforce Documentation}{ \itemize{ From 275c38f850a89854484ef71812f3597b62cc43c7 Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sat, 3 Jul 2021 17:15:20 -0500 Subject: [PATCH 06/42] Fix bug where datetime fields break Bulk 2.0 recordsets Fix the casting of all common columns between the different record sets by ensuring that only one class is selected after identifying it with the class() function. Allow users to specify the `combine_record_types` argument directly in higher level functions like `sf_upsert()` and have it passed through if the API is set to "Bulk 2.0" Closes #95 --- R/bulk-operation.R | 27 +++++++++++++++++++-------- R/utils-query.R | 4 ++-- man-roxygen/combine_record_types.R | 3 +++ man-roxygen/record_types.R | 2 ++ man/sf_get_job_records_bulk.Rd | 6 +++--- man/sf_run_bulk_operation.Rd | 11 +++++++++++ 6 files changed, 40 insertions(+), 13 deletions(-) create mode 100644 man-roxygen/combine_record_types.R create mode 100644 man-roxygen/record_types.R diff --git a/R/bulk-operation.R b/R/bulk-operation.R index c2ce0558..5c060501 100644 --- a/R/bulk-operation.R +++ b/R/bulk-operation.R @@ -1160,11 +1160,8 @@ sf_batch_details_bulk <- function(job_id, batch_id, #' #' @template job_id #' @template api_type -#' @param record_types \code{character}; one or more types of records to retrieve from -#' the results of running the specified job -#' @param combine_record_types \code{logical}; indicating for Bulk 2.0 jobs whether the -#' successfulResults, failedResults, and unprocessedRecords should be stacked -#' together by binding the rows. +#' @template record_types +#' @template combine_record_types #' @template verbose #' @return A \code{tbl_df} or \code{list} of \code{tbl_df}, formatted by Salesforce, #' with information containing the success or failure or certain rows in a submitted job @@ -1187,7 +1184,7 @@ sf_get_job_records_bulk <- function(job_id, record_types = c("successfulResults", "failedResults", "unprocessedRecords"), - combine_record_types = TRUE, + combine_record_types = TRUE, verbose = FALSE){ api_type <- match.arg(api_type) if(api_type == "Bulk 1.0"){ @@ -1256,11 +1253,13 @@ sf_get_job_records_bulk_v2 <- function(job_id, # First, determine the column datatypes from the data.frame with most rows base_class_df <- records[[head(which.max(sapply(records, nrow)), 1)]] # Second, convert the datatypes for any data.frames with zero rows + # From StackOverflow post here: https://stackoverflow.com/a/47800157/5258043 + # distributed under the CC BY-SA 3.0 license terms. for (i in 1:length(records)){ if(nrow(records[[i]]) == 0){ common <- names(records[[i]])[names(records[[i]]) %in% names(base_class_df)] records[[i]][common] <- lapply(common, function(x) { - match.fun(paste0("as.", class(base_class_df[[x]])))(records[[i]][[x]]) + match.fun(paste0("as.", class(base_class_df[[x]])[1]))(records[[i]][[x]]) }) } } @@ -1292,6 +1291,8 @@ sf_get_job_records_bulk_v2 <- function(job_id, #' @template max_attempts #' @param wait_for_results \code{logical}; indicating whether to wait for the operation to complete #' so that the batch results of individual records can be obtained +#' @template record_types +#' @template combine_record_types #' @template control #' @param ... other arguments passed on to \code{\link{sf_control}} or \code{\link{sf_create_job_bulk}} #' to specify the \code{content_type}, \code{concurrency_mode}, and/or \code{column_delimiter}. @@ -1322,6 +1323,10 @@ sf_run_bulk_operation <- function(input_data, interval_seconds = 3, max_attempts = 200, wait_for_results = TRUE, + record_types = c("successfulResults", + "failedResults", + "unprocessedRecords"), + combine_record_types = TRUE, control = list(...), ..., verbose = FALSE){ @@ -1392,7 +1397,13 @@ sf_run_bulk_operation <- function(input_data, message("Function's Time Limit Exceeded. Aborting Job Now") res <- sf_abort_job_bulk(job_info$id, api_type = api_type, verbose = verbose) } else { - res <- sf_get_job_records_bulk(job_info$id, api_type = api_type, verbose = verbose) + res <- sf_get_job_records_bulk( + job_info$id, + api_type = api_type, + record_types = record_types, + combine_record_types = combine_record_types, + verbose = verbose + ) # For Bulk 2.0 jobs -> INVALIDJOBSTATE: Closing already Completed Job not allowed if(api_type == "Bulk 1.0"){ close_job_info <- sf_close_job_bulk(job_info$id, api_type = api_type, verbose = verbose) diff --git a/R/utils-query.R b/R/utils-query.R index 28e46ee0..fe764204 100644 --- a/R/utils-query.R +++ b/R/utils-query.R @@ -759,8 +759,8 @@ sf_guess_cols <- function(df, guess_types=TRUE, dataType=NULL){ df <- df %>% mutate(across(all_of(numeric_col_idx), ~ifelse(.x == "-", NA_character_, .x))) } - # Salesforce returns dates and datetimes in UTC but sometimes as YYYY-MM-DD - # or MM/DD/YYYY in the case of reports, so we will convert using the + # Salesforce returns dates and datetimes in UTC but sometimes as YYYY-MM-DD + # or MM/DD/YYYY in the case of reports, so we will convert using the # anytime package rather than trusting type_convert's behavior if(grepl('D', col_spec)){ date_col_idx <- which(strsplit(col_spec, split=character(0))[[1]] == "D") diff --git a/man-roxygen/combine_record_types.R b/man-roxygen/combine_record_types.R new file mode 100644 index 00000000..276b3ba5 --- /dev/null +++ b/man-roxygen/combine_record_types.R @@ -0,0 +1,3 @@ +#' @param combine_record_types \code{logical}; indicating for Bulk 2.0 jobs whether the +#' successfulResults, failedResults, and unprocessedRecords should be stacked +#' together by binding the rows diff --git a/man-roxygen/record_types.R b/man-roxygen/record_types.R new file mode 100644 index 00000000..eab9f30c --- /dev/null +++ b/man-roxygen/record_types.R @@ -0,0 +1,2 @@ +#' @param record_types \code{character}; one or more types of records to retrieve +#' from the results of running the specified job diff --git a/man/sf_get_job_records_bulk.Rd b/man/sf_get_job_records_bulk.Rd index 8a7050a4..cfcd4fca 100644 --- a/man/sf_get_job_records_bulk.Rd +++ b/man/sf_get_job_records_bulk.Rd @@ -20,12 +20,12 @@ returned by \link{sf_create_job_bulk}. It will start with \code{"750"}.} \code{"Bulk 1.0"}, or \code{"Bulk 2.0"} indicating which API to use when making the request.} -\item{record_types}{\code{character}; one or more types of records to retrieve from -the results of running the specified job} +\item{record_types}{\code{character}; one or more types of records to retrieve +from the results of running the specified job} \item{combine_record_types}{\code{logical}; indicating for Bulk 2.0 jobs whether the successfulResults, failedResults, and unprocessedRecords should be stacked -together by binding the rows.} +together by binding the rows} \item{verbose}{\code{logical}; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when diff --git a/man/sf_run_bulk_operation.Rd b/man/sf_run_bulk_operation.Rd index 2c9a271f..d9567cd5 100644 --- a/man/sf_run_bulk_operation.Rd +++ b/man/sf_run_bulk_operation.Rd @@ -16,6 +16,8 @@ sf_run_bulk_operation( interval_seconds = 3, max_attempts = 200, wait_for_results = TRUE, + record_types = c("successfulResults", "failedResults", "unprocessedRecords"), + combine_record_types = TRUE, control = list(...), ..., verbose = FALSE @@ -32,6 +34,8 @@ sf_bulk_operation( interval_seconds = 3, max_attempts = 200, wait_for_results = TRUE, + record_types = c("successfulResults", "failedResults", "unprocessedRecords"), + combine_record_types = TRUE, control = list(...), ..., verbose = FALSE @@ -73,6 +77,13 @@ completion before stopping.} \item{wait_for_results}{\code{logical}; indicating whether to wait for the operation to complete so that the batch results of individual records can be obtained} +\item{record_types}{\code{character}; one or more types of records to retrieve +from the results of running the specified job} + +\item{combine_record_types}{\code{logical}; indicating for Bulk 2.0 jobs whether the +successfulResults, failedResults, and unprocessedRecords should be stacked +together by binding the rows} + \item{control}{\code{list}; a list of parameters for controlling the behavior of the API call being used. For more information of what parameters are available look at the documentation for \code{\link{sf_control}}.} From f6c5a51c71e8f6f57a93f0fbc84968852dce8cbd Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sat, 3 Jul 2021 17:20:53 -0500 Subject: [PATCH 07/42] Update NEWS.md with new bug fixes --- NEWS.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/NEWS.md b/NEWS.md index e29d0d1d..199750b4 100644 --- a/NEWS.md +++ b/NEWS.md @@ -12,7 +12,11 @@ ### Bug fixes - * Fixed the format of the `OwnerChangeOptions` header so it is accepted (#94) + * Generalize the date and datetime parsing mechanism, such that, reports with + date and datetime fields are not returned as NA (#93) + * Fix the format of the `OwnerChangeOptions` header so it is accepted (#94) + * Fix bug that caused Bulk 2.0 calls to crash when the results had datetime + fields in the recordset (#95) --- From dbd9a096a9a8a72a22a34bb42003189ce3a66a48 Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sat, 3 Jul 2021 17:25:44 -0500 Subject: [PATCH 08/42] Fix roxygen syntax error in in sf_auth documentation --- R/auth.R | 5 +++-- man/sf_auth.Rd | 1 + 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/R/auth.R b/R/auth.R index 3d3d13f6..2071f64c 100644 --- a/R/auth.R +++ b/R/auth.R @@ -58,9 +58,10 @@ #' @param cache \code{logical} or \code{character}; TRUE means to cache using #' the default cache file \code{.httr-oauth-salesforcer}, FALSE means do not #' cache. A string means use the specified path as the cache file. +#' @template verbose #' @return \code{list} invisibly that contains 4 elements detailing the authentication state #' @note The \code{link{sf_auth}} function invisibly returns the following -#' 4 pieces of information which can be reused in other operations: +#' 4 pieces of information which can be reused in other operations: #' \describe{ #' \item{auth_method}{ #' \code{character}; One of two options 'Basic' or 'OAuth'. If a username, @@ -83,7 +84,7 @@ #' server instance located in Chicago, USA / Washington DC, USA per this #' Knowledge Article: \url{https://help.salesforce.com/articleView?id=000314281}. #' } -#' @template verbose +#' } #' @examples #' \dontrun{ #' # log in using basic authentication (username-password) diff --git a/man/sf_auth.Rd b/man/sf_auth.Rd index 8d206f7f..4efd7285 100644 --- a/man/sf_auth.Rd +++ b/man/sf_auth.Rd @@ -84,6 +84,7 @@ server instance located in Chicago, USA / Washington DC, USA per this Knowledge Article: \url{https://help.salesforce.com/articleView?id=000314281}. } } +} \examples{ \dontrun{ # log in using basic authentication (username-password) From 7c7e5e55b2a6c702fd921436a659caf6afcdedf7 Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sat, 3 Jul 2021 18:17:30 -0500 Subject: [PATCH 09/42] Further remove RForcecom references to pass build --- tests/testthat.R | 1 - tests/testthat/test-compatibility.R | 2 + vignettes/transitioning-from-RForcecom.Rmd | 64 +++++++++++----------- 3 files changed, 33 insertions(+), 34 deletions(-) diff --git a/tests/testthat.R b/tests/testthat.R index 255168ea..7ce48f5b 100644 --- a/tests/testthat.R +++ b/tests/testthat.R @@ -1,5 +1,4 @@ library(testthat) -library(RForcecom) library(dplyr) library(salesforcer) diff --git a/tests/testthat/test-compatibility.R b/tests/testthat/test-compatibility.R index 97f89f86..92706c97 100644 --- a/tests/testthat/test-compatibility.R +++ b/tests/testthat/test-compatibility.R @@ -2,6 +2,8 @@ context("RForcecom Compatibility") setup(options(lifecycle_verbosity = "quiet")) +skip("Not running due to RForcecom being pulled from CRAN.") + test_that("testing rforcecom.login compatibility", { username <- Sys.getenv("SALESFORCER_USERNAME") diff --git a/vignettes/transitioning-from-RForcecom.Rmd b/vignettes/transitioning-from-RForcecom.Rmd index bbdf4b94..2f33fdf8 100644 --- a/vignettes/transitioning-from-RForcecom.Rmd +++ b/vignettes/transitioning-from-RForcecom.Rmd @@ -1,7 +1,7 @@ --- title: "Transitioning from RForcecom" author: "Steven M. Mortimer" -date: "2018-03-12" +date: "2021-07-03" output: rmarkdown::html_vignette: toc: true @@ -25,11 +25,18 @@ options(tibble.print_min = 5L, tibble.print_max = 5L) ``` While writing the {salesforcer} package we were keenly aware that many folks -are already using the {RForcecom} package to connect to Salesforce. In order +were already using the {RForcecom} package to connect to Salesforce. In order to foster adoption and switching between the packages {salesforcer} replicates the functionality of many {RForcecom} functions so that you will only need to swap -out `library(RForcecom)` for `library(salesforcer)` and still have your production -tested scripts perform as usual. +out `library(RForcecom)` for `library(salesforcer)` and still have +production scripts perform as expected. + +## RForcecom removed from CRAN + +As of June 9, 2021, the {RForcecom} package was removed from CRAN. You can still +use by installing from the archive, but we strongly recommend using +{salesforcer}. All of the functions in {RForcecom} have been further optimized +within {salesforcer}. ## Authentication @@ -53,11 +60,8 @@ sf_auth(username = username, ```{r, warning=FALSE} # the RForcecom way -session1 <- RForcecom::rforcecom.login(username, paste0(password, security_token), - apiVersion=getOption("salesforcer.api_version")) -session1['sessionID'] <- "{MASKED}" -session1 - +# RForcecom::rforcecom.login(username, paste0(password, security_token), +# apiVersion=getOption("salesforcer.api_version")) # replicated in salesforcer package session2 <- salesforcer::rforcecom.login(username, paste0(password, security_token), @@ -92,12 +96,11 @@ object <- "Contact" fields <- c(FirstName="Test", LastName="Contact-Create-Compatibility") # the RForcecom way -result1 <- RForcecom::rforcecom.create(session, objectName=object, fields) -result1 +# RForcecom::rforcecom.create(session, objectName=object, fields) # replicated in salesforcer package -result2 <- salesforcer::rforcecom.create(session, objectName=object, fields) -result2 +result <- salesforcer::rforcecom.create(session, objectName=object, fields) +result ``` Here is an example showing the reduction in code of using {salesforcer} if you @@ -108,15 +111,14 @@ n <- 2 new_contacts <- tibble(FirstName = rep("Test", n), LastName = paste0("Contact-Create-", 1:n)) -# the RForcecom way -rforcecom_results <- NULL -for(i in 1:nrow(new_contacts)){ - temp <- RForcecom::rforcecom.create(session, - objectName = "Contact", - fields = unlist(slice(new_contacts,i))) - rforcecom_results <- bind_rows(rforcecom_results, temp) -} -rforcecom_results +# the RForcecom way (requires a loop) +# rforcecom_results <- NULL +# for(i in 1:nrow(new_contacts)){ +# temp <- RForcecom::rforcecom.create(session, +# objectName = "Contact", +# fields = unlist(slice(new_contacts,i))) +# rforcecom_results <- bind_rows(rforcecom_results, temp) +# } # the better way in salesforcer to do multiple records salesforcer_results <- sf_create(new_contacts, object_name="Contact") @@ -132,12 +134,11 @@ result thanks to features of the {readr} package. this_soql <- "SELECT Id, Email FROM Contact LIMIT 5" # the RForcecom way -result1 <- RForcecom::rforcecom.query(session, soqlQuery = this_soql) -result1 +# RForcecom::rforcecom.query(session, soqlQuery = this_soql) # replicated in salesforcer package -result2 <- salesforcer::rforcecom.query(session, soqlQuery = this_soql) -result2 +result <- salesforcer::rforcecom.query(session, soqlQuery = this_soql) +result # the better way in salesforcer to query salesforcer_results <- sf_query(this_soql) @@ -153,15 +154,12 @@ better printing and datatype casting by using tibbles. ```{r, warning=FALSE} # the RForcecom way -result1 <- RForcecom::rforcecom.getObjectDescription(session, objectName='Account') +# RForcecom::rforcecom.getObjectDescription(session, objectName='Account') # backwards compatible in the salesforcer package -result2 <- salesforcer::rforcecom.getObjectDescription(session, objectName='Account') +result <- salesforcer::rforcecom.getObjectDescription(session, objectName='Account') # the better way in salesforcer to get object fields -result3 <- salesforcer::sf_describe_object_fields('Account') -result3 +result2 <- salesforcer::sf_describe_object_fields('Account') +result2 ``` - -In the future more features will be migrated from {RForcecom} to make the -transition as seamless as possible. From 24d82728859eca4736011eb2baec7447fd56e694 Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sat, 3 Jul 2021 22:14:23 -0500 Subject: [PATCH 10/42] In Bulk APIs use all values in column to guess type --- R/bulk-operation.R | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/R/bulk-operation.R b/R/bulk-operation.R index 5c060501..18af2d9a 100644 --- a/R/bulk-operation.R +++ b/R/bulk-operation.R @@ -1088,7 +1088,7 @@ sf_batch_status_bulk <- function(job_id, batch_id, #' This function returns detailed (row-by-row) information on an existing batch #' which has already been submitted to Bulk API Job #' -#' @importFrom readr read_csv +#' @importFrom readr read_csv type_convert cols col_character #' @importFrom httr content #' @importFrom XML xmlToList #' @importFrom dplyr as_tibble @@ -1127,7 +1127,9 @@ sf_batch_details_bulk <- function(job_id, batch_id, content_type <- httr_response$headers$`content-type` if(content_type == 'text/csv' | content_type == 'zip/csv'){ response_text <- content(httr_response, as="text", encoding="UTF-8") - res <- read_csv(response_text) + # required to guess column types by all values in the column, not just first N + res <- read_csv(response_text, col_types = cols(.default = col_character())) + res <- type_convert(res, col_types = cols()) } else if(content_type == 'zip/xml'){ response_parsed <- content(httr_response, as="parsed", type="text/xml", encoding="UTF-8") res <- response_parsed %>% @@ -1214,7 +1216,7 @@ sf_get_job_records_bulk_v1 <- function(job_id, verbose = FALSE){ return(resultset) } -#' @importFrom readr read_csv +#' @importFrom readr read_csv type_convert cols col_character #' @importFrom httr content sf_get_job_records_bulk_v2 <- function(job_id, record_types = c("successfulResults", @@ -1237,7 +1239,9 @@ sf_get_job_records_bulk_v2 <- function(job_id, response_text <- content(httr_response, as="text", encoding="UTF-8") content_type <- httr_response$headers$`content-type` if(grepl('text/csv', content_type)) { - res <- read_csv(response_text) + # required to guess column types by all values in the column, not just first N + res <- read_csv(response_text, col_types = cols(.default = col_character())) + res <- type_convert(res, col_types = cols()) } else { message(sprintf("Unhandled content-type: %s", content_type)) res <- content(httr_response, as="parsed", encoding="UTF-8") From 6b8442fa50b8cae716e3c2924aec6d65b3586e20 Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sat, 3 Jul 2021 22:14:39 -0500 Subject: [PATCH 11/42] Fix deprecated argument name in write_csv --- R/utils.R | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/R/utils.R b/R/utils.R index b9889d23..aa95694b 100644 --- a/R/utils.R +++ b/R/utils.R @@ -84,8 +84,8 @@ merge_null_to_na <- function(x){ #' @note This function is meant to be used internally. Only use when debugging. #' @keywords internal #' @export -sf_write_csv <- function(x, path){ - write_csv(x=x, path=path, na="#N/A") +sf_write_csv <- function(x, file){ + write_csv(x=x, file=path, na="#N/A") } #' Remove NA Columns Created by Empty Related Entity Values From 4377e0bd8fe1cad0715e766c34070460ae6d2bda Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sat, 3 Jul 2021 22:14:53 -0500 Subject: [PATCH 12/42] Update possible versions list in tests --- tests/testthat/test-org-utils.R | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/testthat/test-org-utils.R b/tests/testthat/test-org-utils.R index bb235c1d..c5e18e40 100644 --- a/tests/testthat/test-org-utils.R +++ b/tests/testthat/test-org-utils.R @@ -27,7 +27,7 @@ test_that("testing sf_list_rest_api_versions()", { res <- sf_list_rest_api_versions() versions <- sapply(res, function(x){as.integer(x$version)}) expect_is(res, "list") - expect_true(all(20:46 %in% versions)) + expect_true(all(21:52 %in% versions)) }) test_that("testing sf_list_resources()", { From 5e948b920968fe77b0be117397a20cc43f97ff9a Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sat, 3 Jul 2021 22:15:22 -0500 Subject: [PATCH 13/42] Update Bulk 2.0 grandparent query test --- tests/testthat/test-query.R | 24 +++++++++++------------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/tests/testthat/test-query.R b/tests/testthat/test-query.R index 1dd82c8f..09da794b 100644 --- a/tests/testthat/test-query.R +++ b/tests/testthat/test-query.R @@ -108,8 +108,7 @@ test_that("testing simple SELECT query", { simple_select_soql_wo_compound <- sprintf("SELECT %s FROM Contact", paste0(contact_fields_to_test_wo_compound, collapse=", ")) - bulk2_queried_records <- sf_query(simple_select_soql_wo_compound, - api_type="Bulk 2.0") + bulk2_queried_records <- sf_query(simple_select_soql_wo_compound, api_type="Bulk 2.0") expect_is(bulk2_queried_records, "tbl_df") expect_gt(nrow(bulk2_queried_records), 0) expect_equal(sort(names(bulk2_queried_records)), @@ -171,42 +170,41 @@ test_that("testing child-to-parent-grandparent relationship lookup query", { expect_equal(sort(names(bulk1_queried_records)), sort(relationship_fields)) # Bulk 2.0 API --------------------------------------------------------------- - expect_error(sf_query(relationship_soql, api_type="Bulk 2.0"), - paste0("Failure during batch processing: FeatureNotEnabled : ", - "Cannot serialize value for 'Owner' in CSV format")) + bulk2_queried_records <- sf_query(relationship_soql, api_type="Bulk 2.0") + expect_is(bulk2_queried_records, "tbl_df") + expect_gt(nrow(bulk2_queried_records), 0) + expect_equal(sort(names(bulk2_queried_records)), sort(relationship_fields)) }) test_that("testing parent-to-child nested relationship query", { - nested_soql <- "SELECT Id, - (SELECT Id FROM Contacts) - FROM Account" + relationship_soql <- "SELECT Id, (SELECT Id FROM Contacts) FROM Account" # SOAP API ------------------------------------------------------------------- - soap_queried_records <- sf_query(nested_soql, api_type="SOAP") + soap_queried_records <- sf_query(relationship_soql, api_type="SOAP") expect_is(soap_queried_records, "tbl_df") expect_gt(nrow(soap_queried_records), 0) expect_named(soap_queried_records, c("Id", "Contact.Id")) # REST API ------------------------------------------------------------------- - rest_queried_records <- sf_query(nested_soql, api_type="REST") + rest_queried_records <- sf_query(relationship_soql, api_type="REST") expect_is(rest_queried_records, "tbl_df") expect_gt(nrow(rest_queried_records), 0) expect_named(soap_queried_records, c("Id", "Contact.Id")) # Bulk 1.0 API --------------------------------------------------------------- - expect_error(sf_query(nested_soql, object_name=object, api_type="Bulk 1.0"), + expect_error(sf_query(relationship_soql, object_name=object, api_type="Bulk 1.0"), paste0("INVALID_TYPE_FOR_OPERATION: The root entity of the requested ", "query (Account) does not match the entity of the requested ", "Bulk API Job (Contact)"), fixed=TRUE) - expect_error(sf_query(nested_soql, object_name="Account", api_type="Bulk 1.0"), + expect_error(sf_query(relationship_soql, object_name="Account", api_type="Bulk 1.0"), paste0("FeatureNotEnabled : Aggregate Relationships not supported ", "in Bulk Query with CSV content type")) # Bulk 2.0 API --------------------------------------------------------------- - expect_error(sf_query(nested_soql, api_type="Bulk 2.0"), + expect_error(sf_query(relationship_soql, api_type="Bulk 2.0"), paste0("API_ERROR: Aggregate Relationships not supported ", "in Bulk V2 Query with CSV content type")) }) From f2cf235b7b485976a75fa55d8e1cf8f58fa7b3ac Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sat, 3 Jul 2021 22:20:54 -0500 Subject: [PATCH 14/42] Document changes because of readr --- NEWS.md | 6 +++++- man/sf_write_csv.Rd | 2 +- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/NEWS.md b/NEWS.md index 199750b4..74f0082f 100644 --- a/NEWS.md +++ b/NEWS.md @@ -2,13 +2,17 @@ ### Dependencies - * Remove references to RForcecom after it was removed from CRAN on 6/9/2021 (#101) + * Remove uses of {RForcecom} after it was removed from CRAN on 6/9/2021 (#101) * Remove LazyData option in DESCRIPTION since `data()` is not utilized + * Change argument in `sf_write_csv()` from `path` to `file` as was done in + {readr} v1.4.0 ### Features * Improve documentation to retrieve the access token or session ID after authentication (#97) + * Improve parsing of Bulk API query recordsets from CSV where all values + in the column will be used to guess the type instead of the first 1000. ### Bug fixes diff --git a/man/sf_write_csv.Rd b/man/sf_write_csv.Rd index 997b697d..ce452757 100644 --- a/man/sf_write_csv.Rd +++ b/man/sf_write_csv.Rd @@ -4,7 +4,7 @@ \alias{sf_write_csv} \title{Write a CSV file in format acceptable to Salesforce APIs} \usage{ -sf_write_csv(x, path) +sf_write_csv(x, file) } \description{ Write a CSV file in format acceptable to Salesforce APIs From 5efa10053e86892ae9a45b2a940b5245eb12469a Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sat, 3 Jul 2021 22:33:35 -0500 Subject: [PATCH 15/42] Fix bug after write_csv change --- R/utils.R | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/R/utils.R b/R/utils.R index aa95694b..e6d569e5 100644 --- a/R/utils.R +++ b/R/utils.R @@ -85,7 +85,7 @@ merge_null_to_na <- function(x){ #' @keywords internal #' @export sf_write_csv <- function(x, file){ - write_csv(x=x, file=path, na="#N/A") + write_csv(x=x, file=file, na="#N/A") } #' Remove NA Columns Created by Empty Related Entity Values From c5ce7823ab5bd7e28c849cb84e59daac2cf2c85d Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sat, 3 Jul 2021 23:20:31 -0500 Subject: [PATCH 16/42] Bump version --- DESCRIPTION | 25 ++++++++++++++++++------- NEWS.md | 2 +- 2 files changed, 19 insertions(+), 8 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index cefa6138..0baf0cc2 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: salesforcer Title: An Implementation of 'Salesforce' APIs Using Tidy Principles -Version: 0.2.2.9000 +Version: 0.2.3 Date: 2021-07-03 Description: Functions connecting to the 'Salesforce' Platform APIs (REST, SOAP, Bulk 1.0, Bulk 2.0, Metadata, Reports and Dashboards) @@ -11,12 +11,23 @@ Description: Functions connecting to the 'Salesforce' Platform APIs (REST, SOAP, API documentation and this package's website for more information, documentation, and examples. -Authors@R: c( - person(c("Steven", "M."), "Mortimer", , "mortimer.steven.m@gmail.com", c("aut", "cre")), - person("Takekatsu", "Hiramura", , "thira@plavox.info", c("ctb")), - person("Jennifer", "Bryan", , "jenny@rstudio.com", c("ctb", "cph")), - person("Joanna", "Zhao", , "joanna.zhao@alumni.ubc.ca", c("ctb", "cph")) - ) +Authors@R: + c(person(given = c("Steven", "M."), + family = "Mortimer", + role = c("aut", "cre"), + email = "mortimer.steven.m@gmail.com"), + person(given = "Takekatsu", + family = "Hiramura", + role = "ctb", + email = "thira@plavox.info"), + person(given = "Jennifer", + family = "Bryan", + role = c("ctb", "cph"), + email = "jenny@rstudio.com"), + person(given = "Joanna", + family = "Zhao", + role = c("ctb", "cph"), + email = "joanna.zhao@alumni.ubc.ca")) License: MIT + file LICENSE URL: https://github.com/StevenMMortimer/salesforcer BugReports: https://github.com/StevenMMortimer/salesforcer/issues diff --git a/NEWS.md b/NEWS.md index 74f0082f..959d9bff 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,4 @@ -## salesforcer 0.2.2.9000 +## salesforcer 0.2.3 ### Dependencies From 484bbf1ef609ca979ced68b3f18e9f2e38eea976 Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sat, 3 Jul 2021 23:23:59 -0500 Subject: [PATCH 17/42] Bump version in READMEs --- README.Rmd | 2 +- README.md | 2 +- index.Rmd | 2 +- index.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.Rmd b/README.Rmd index 642000ca..c942f15b 100644 --- a/README.Rmd +++ b/README.Rmd @@ -69,7 +69,7 @@ Package features include: ## Installation ```{r, eval = FALSE} -# install the current CRAN version (0.2.2) +# install the current CRAN version (0.2.3) install.packages("salesforcer") # or get the development version on GitHub diff --git a/README.md b/README.md index 1da63b18..3bd6cc53 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,7 @@ Package features include: ## Installation ``` r -# install the current CRAN version (0.2.2) +# install the current CRAN version (0.2.3) install.packages("salesforcer") # or get the development version on GitHub diff --git a/index.Rmd b/index.Rmd index 47ff2ddb..6a1d3fbd 100644 --- a/index.Rmd +++ b/index.Rmd @@ -70,7 +70,7 @@ Package features include: ## Installation ```{r, eval = FALSE} -# install the current CRAN version (0.2.2) +# install the current CRAN version (0.2.3) install.packages("salesforcer") # or get the development version on GitHub diff --git a/index.md b/index.md index cad9fcf8..34709960 100644 --- a/index.md +++ b/index.md @@ -70,7 +70,7 @@ Package features include: ## Installation ``` r -# install the current CRAN version (0.2.2) +# install the current CRAN version (0.2.3) install.packages("salesforcer") # or get the development version on GitHub From b5da775078af7acf1053cdddf70d43aa3cb1d031 Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sun, 4 Jul 2021 08:25:59 -0500 Subject: [PATCH 18/42] Fix notes from win-builder --- R/attachments.R | 2 +- R/bulk-operation.R | 12 +++---- R/bulk-query.R | 10 +++--- R/create.R | 2 +- R/delete.R | 2 +- R/describe.R | 2 +- R/endpoints-bulk.R | 2 +- R/query.R | 2 +- R/read-metadata.R | 2 +- R/retrieve.R | 2 +- R/search.R | 2 +- R/update.R | 2 +- R/upsert.R | 2 +- R/utils-datatypes.R | 8 ++--- R/utils-org.R | 6 ++-- README.Rmd | 4 +-- README.md | 4 +-- cran-comments.md | 34 +++++++++++-------- docs/articles/supported-queries.html | 4 +-- docs/index.html | 4 +-- docs/reference/sf_auth.html | 2 +- docs/reference/sf_create.html | 2 +- docs/reference/sf_delete.html | 2 +- docs/reference/sf_describe_object_fields.html | 2 +- docs/reference/sf_describe_objects.html | 2 +- docs/reference/sf_download_attachment.html | 2 +- docs/reference/sf_format_date.html | 2 +- docs/reference/sf_format_datetime.html | 2 +- docs/reference/sf_format_time.data.frame.html | 2 +- docs/reference/sf_format_time.list.html | 2 +- docs/reference/sf_get_all_jobs_bulk.html | 4 +-- .../reference/sf_get_all_query_jobs_bulk.html | 4 +-- docs/reference/sf_get_deleted.html | 2 +- docs/reference/sf_get_updated.html | 2 +- docs/reference/sf_list_api_limits.html | 2 +- docs/reference/sf_list_objects.html | 2 +- docs/reference/sf_list_resources.html | 2 +- docs/reference/sf_list_rest_api_versions.html | 2 +- docs/reference/sf_query.html | 2 +- docs/reference/sf_query_bulk_v2.html | 2 +- docs/reference/sf_query_result_bulk.html | 2 +- docs/reference/sf_query_result_bulk_v2.html | 2 +- docs/reference/sf_retrieve.html | 2 +- docs/reference/sf_run_bulk_operation.html | 2 +- docs/reference/sf_run_bulk_query.html | 4 +-- docs/reference/sf_search.html | 2 +- docs/reference/sf_server_timestamp.html | 2 +- docs/reference/sf_update.html | 2 +- docs/reference/sf_upsert.html | 2 +- docs/reference/sf_user_info.html | 2 +- .../validate_get_all_jobs_params.html | 2 +- index.Rmd | 4 +-- index.md | 4 +-- inst/WORDLIST | 1 + man/sf_create.Rd | 2 +- man/sf_delete.Rd | 2 +- man/sf_describe_object_fields.Rd | 2 +- man/sf_describe_objects.Rd | 2 +- man/sf_download_attachment.Rd | 2 +- man/sf_format_date.Rd | 2 +- man/sf_format_datetime.Rd | 2 +- man/sf_format_time.data.frame.Rd | 2 +- man/sf_format_time.list.Rd | 2 +- man/sf_get_all_jobs_bulk.Rd | 4 +-- man/sf_get_all_query_jobs_bulk.Rd | 4 +-- man/sf_get_deleted.Rd | 2 +- man/sf_get_updated.Rd | 2 +- man/sf_query.Rd | 2 +- man/sf_query_bulk_v2.Rd | 2 +- man/sf_query_result_bulk.Rd | 2 +- man/sf_query_result_bulk_v2.Rd | 2 +- man/sf_retrieve.Rd | 2 +- man/sf_run_bulk_operation.Rd | 2 +- man/sf_run_bulk_query.Rd | 4 +-- man/sf_search.Rd | 2 +- man/sf_update.Rd | 2 +- man/sf_upsert.Rd | 2 +- man/sf_user_info.Rd | 2 +- man/validate_get_all_jobs_params.Rd | 2 +- vignettes/supported-queries.Rmd | 4 +-- 80 files changed, 125 insertions(+), 120 deletions(-) diff --git a/R/attachments.R b/R/attachments.R index 52019d5b..65e24d7c 100644 --- a/R/attachments.R +++ b/R/attachments.R @@ -1,7 +1,7 @@ #' Download an Attachment #' #' @description -#' `r lifecycle::badge("maturing")` +#' `r lifecycle::badge("stable")` #' #' This function will allow you to download an attachment to disk based on the #' attachment body, file name, and path. diff --git a/R/bulk-operation.R b/R/bulk-operation.R index 18af2d9a..bd10159e 100644 --- a/R/bulk-operation.R +++ b/R/bulk-operation.R @@ -370,13 +370,13 @@ sf_get_job_bulk <- function(job_id, #' of the URL query string (i.e. after a question mark ("?") so that the result #' only returns information about jobs that meet that specific criteria. For #' more information, read the note below and/or the Salesforce documentation -#' \href{https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/get_all_jobs.htm}{here}. +#' \href{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/get_all_jobs.htm}{here}. #' @param next_records_url character (leave as NULL); a string used internally #' by the function to paginate through to more records until complete #' @template api_type #' @template verbose #' @return A \code{tbl_df} of parameters defining the details of all bulk jobs -#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/get_all_jobs.htm} +#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/get_all_jobs.htm} #' @note parameterized_search_list elements that can be set to filter the results: #' \itemize{ #' \item{isPkChunkingEnabled}{A logical either TRUE or FALSE. TRUE only returns @@ -448,13 +448,13 @@ sf_get_all_jobs_bulk <- function(parameterized_search_list = #' of the URL query string (i.e. after a question mark ("?") so that the result #' only returns information about jobs that meet that specific criteria. For #' more information, read the note below and/or the Salesforce documentation -#' \href{https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/query_get_all_jobs.htm}{here}. +#' \href{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/query_get_all_jobs.htm}{here}. #' @param next_records_url character (leave as NULL); a string used internally #' by the function to paginate through to more records until complete #' @template api_type #' @template verbose #' @return A \code{tbl_df} of parameters defining the details of all bulk jobs -#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/get_all_jobs.htm} +#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/get_all_jobs.htm} #' @note parameterized_search_list elements that can be set to filter the results: #' \itemize{ #' \item{isPkChunkingEnabled}{A logical either TRUE or FALSE. TRUE only returns @@ -925,7 +925,7 @@ sf_create_batches_bulk_v2 <- function(job_id, # encoded content. When job data is uploaded, it is converted to base64. This # conversion can increase the data size by approximately 50%. To account for # the base64 conversion increase, upload data that does not exceed 100 MB. - # https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/upload_job_data.htm + # https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/upload_job_data.htm if(is.null(batch_size)){ data_size <- object.size(input_data) numb_batches <- ceiling((as.numeric(data_size)/(1024^2))/100) # 100MB / (size converted to MB) @@ -1278,7 +1278,7 @@ sf_get_job_records_bulk_v2 <- function(job_id, #' Run Bulk Operation #' #' @description -#' `r lifecycle::badge("maturing")` +#' `r lifecycle::badge("stable")` #' #' This function is a convenience wrapper for submitting bulk API jobs #' diff --git a/R/bulk-query.R b/R/bulk-query.R index e5945782..85294b25 100644 --- a/R/bulk-query.R +++ b/R/bulk-query.R @@ -75,7 +75,7 @@ sf_submit_query_bulk <- function(job_id, #' @template api_type #' @template verbose #' @return \code{tbl_df}, formatted by Salesforce, containing query results -#' @references \href{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_bulk_query_intro.htm}{Bulk 1.0 documentation} and \href{https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/queries.htm}{Bulk 2.0 documentation} +#' @references \href{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_bulk_query_intro.htm}{Bulk 1.0 documentation} and \href{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/queries.htm}{Bulk 2.0 documentation} #' @examples #' \dontrun{ #' my_query <- "SELECT Id, Name FROM Account LIMIT 1000" @@ -217,7 +217,7 @@ sf_query_result_bulk_v1 <- function(job_id, #' @template api_type #' @template verbose #' @return \code{tbl_df}, formatted by Salesforce, containing query results -#' @references \href{https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/queries.htm}{Bulk 2.0 documentation} +#' @references \href{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/queries.htm}{Bulk 2.0 documentation} #' @examples #' \dontrun{ #' my_query <- "SELECT Id, Name FROM Account LIMIT 1000" @@ -449,7 +449,7 @@ sf_query_bulk_v1 <- function(soql, #' @template api_type #' @template verbose #' @return A \code{tbl_df} of the recordset returned by the query -#' @references \href{https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/queries.htm}{Bulk 2.0 documentation} +#' @references \href{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/queries.htm}{Bulk 2.0 documentation} #' @examples #' \dontrun{ #' # select all Ids from Account object (up to 1000) @@ -550,7 +550,7 @@ sf_query_bulk_v2 <- function(soql, #' Run bulk query #' #' @description -#' `r lifecycle::badge("maturing")` +#' `r lifecycle::badge("stable")` #' #' This function is a convenience wrapper for submitting and retrieving #' query API jobs from the Bulk 1.0 and Bulk 2.0 APIs. @@ -569,7 +569,7 @@ sf_query_bulk_v2 <- function(soql, #' @template api_type #' @template verbose #' @return A \code{tbl_df} of the recordset returned by the query -#' @references \href{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_bulk_query_intro.htm}{Bulk 1.0 documentation} and \href{https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/queries.htm}{Bulk 2.0 documentation} +#' @references \href{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_bulk_query_intro.htm}{Bulk 1.0 documentation} and \href{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/queries.htm}{Bulk 2.0 documentation} #' @examples #' \dontrun{ #' # select all Ids from Account object (up to 1000) diff --git a/R/create.R b/R/create.R index ae74bad3..ad740c1f 100644 --- a/R/create.R +++ b/R/create.R @@ -1,7 +1,7 @@ #' Create Records #' #' @description -#' `r lifecycle::badge("maturing")` +#' `r lifecycle::badge("stable")` #' #' Adds one or more new records to your organization’s data. #' diff --git a/R/delete.R b/R/delete.R index b994562e..6cb5de5e 100644 --- a/R/delete.R +++ b/R/delete.R @@ -1,7 +1,7 @@ #' Delete Records #' #' @description -#' `r lifecycle::badge("maturing")` +#' `r lifecycle::badge("stable")` #' #' Deletes one or more records from your organization’s data. #' diff --git a/R/describe.R b/R/describe.R index b828a0aa..e601d778 100644 --- a/R/describe.R +++ b/R/describe.R @@ -1,7 +1,7 @@ #' SObject Basic Information #' #' @description -#' `r lifecycle::badge("maturing")` +#' `r lifecycle::badge("stable")` #' #' Describes the individual metadata for the specified object. #' diff --git a/R/endpoints-bulk.R b/R/endpoints-bulk.R index de51af2a..72fcb653 100644 --- a/R/endpoints-bulk.R +++ b/R/endpoints-bulk.R @@ -129,7 +129,7 @@ make_bulk_get_all_query_jobs_url <- function(parameterized_search_list = list(is #' #' @note This function is meant to be used internally. Only use when debugging. #' @keywords internal -#' @seealso \url{https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/query_get_all_jobs.htm} +#' @seealso \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/query_get_all_jobs.htm} #' @export validate_get_all_jobs_params <- function(parameterized_search_list, type="all"){ for (n in names(parameterized_search_list)){ diff --git a/R/query.R b/R/query.R index 30cedcf2..cb0b0a76 100644 --- a/R/query.R +++ b/R/query.R @@ -1,7 +1,7 @@ #' Perform SOQL Query #' #' @description -#' `r lifecycle::badge("maturing")` +#' `r lifecycle::badge("stable")` #' #' Executes a query against the specified object and returns data that matches #' the specified criteria. diff --git a/R/read-metadata.R b/R/read-metadata.R index 3616ea4c..bb5e9ed9 100644 --- a/R/read-metadata.R +++ b/R/read-metadata.R @@ -75,7 +75,7 @@ sf_read_metadata <- function(metadata_type, object_names, verbose=FALSE){ #' Describe Object Fields #' #' @description -#' `r lifecycle::badge("maturing")` +#' `r lifecycle::badge("stable")` #' #' This function takes the name of an object in Salesforce and returns a description #' of the fields on that object by returning a tibble with one row per field. diff --git a/R/retrieve.R b/R/retrieve.R index 60ef1149..2f7e019f 100644 --- a/R/retrieve.R +++ b/R/retrieve.R @@ -1,7 +1,7 @@ #' Retrieve Records By Id #' #' @description -#' `r lifecycle::badge("maturing")` +#' `r lifecycle::badge("stable")` #' #' Retrieves one or more new records to your organization’s data. #' diff --git a/R/search.R b/R/search.R index 134ba2bb..7073b4e2 100644 --- a/R/search.R +++ b/R/search.R @@ -1,7 +1,7 @@ #' Perform SOSL Search #' #' @description -#' `r lifecycle::badge("maturing")` +#' `r lifecycle::badge("stable")` #' #' Searches for records in your organization’s data. #' diff --git a/R/update.R b/R/update.R index 8d8c41a1..ea7dde07 100644 --- a/R/update.R +++ b/R/update.R @@ -1,7 +1,7 @@ #' Update Records #' #' @description -#' `r lifecycle::badge("maturing")` +#' `r lifecycle::badge("stable")` #' #' Updates one or more records to your organization’s data. #' diff --git a/R/upsert.R b/R/upsert.R index f1b857b3..0bb44a0a 100644 --- a/R/upsert.R +++ b/R/upsert.R @@ -1,7 +1,7 @@ #' Upsert Records #' #' @description -#' `r lifecycle::badge("maturing")` +#' `r lifecycle::badge("stable")` #' #' Upserts one or more new records to your organization’s data. #' diff --git a/R/utils-datatypes.R b/R/utils-datatypes.R index f9f9e7bd..87981cc8 100644 --- a/R/utils-datatypes.R +++ b/R/utils-datatypes.R @@ -3,7 +3,7 @@ #' @note This function is meant to be used internally. Only use when debugging. #' @importFrom lubridate as_datetime #' @keywords internal -#' @seealso \url{https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/datafiles_date_format.htm} +#' @seealso \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_date_format.htm} #' @export sf_format_datetime <- function(x){ format(as_datetime(x), "%Y-%m-%dT%H:%M:%SZ") @@ -13,7 +13,7 @@ sf_format_datetime <- function(x){ #' #' @note This function is meant to be used internally. Only use when debugging. #' @keywords internal -#' @seealso \url{https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/datafiles_date_format.htm} +#' @seealso \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_date_format.htm} #' @export sf_format_date <- function(x){ x <- as_datetime(format(x, "%Y-%m-%d 00:00:00"), tz=Sys.timezone()) @@ -30,7 +30,7 @@ sf_format_time <- function (x, ...) { #' @importFrom dplyr mutate_if #' @importFrom lubridate is.POSIXct is.POSIXlt is.POSIXt is.Date #' @keywords internal -#' @seealso \url{https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/datafiles_date_format.htm} +#' @seealso \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_date_format.htm} #' @export sf_format_time.list <- function(x){ lapply(x, FUN=function(xx){ @@ -48,7 +48,7 @@ sf_format_time.list <- function(x){ #' @importFrom dplyr mutate_if #' @importFrom lubridate is.POSIXct is.POSIXlt is.POSIXt is.Date #' @keywords internal -#' @seealso \url{https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/datafiles_date_format.htm} +#' @seealso \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_date_format.htm} #' @export sf_format_time.data.frame <- function(x){ x %>% diff --git a/R/utils-org.R b/R/utils-org.R index 1b6038cf..9ef5419b 100644 --- a/R/utils-org.R +++ b/R/utils-org.R @@ -1,7 +1,7 @@ #' Return Current User Info #' #' @description -#' `r lifecycle::badge("maturing")` +#' `r lifecycle::badge("stable")` #' #' Retrieves personal information for the user associated with the current session. #' @@ -775,7 +775,7 @@ sf_merge <- function(master_id, #' Get Deleted Records from a Timeframe #' #' @description -#' `r lifecycle::badge("maturing")` +#' `r lifecycle::badge("stable")` #' #' Retrieves the list of individual records that have been deleted within the given #' timespan for the specified object. @@ -847,7 +847,7 @@ sf_get_deleted <- function(object_name, #' Get Updated Records from a Timeframe #' #' @description -#' `r lifecycle::badge("maturing")` +#' `r lifecycle::badge("stable")` #' #' Retrieves the list of individual records that have been inserted or updated #' within the given timespan in the specified object. diff --git a/README.Rmd b/README.Rmd index c942f15b..a750c302 100644 --- a/README.Rmd +++ b/README.Rmd @@ -18,7 +18,7 @@ options(tibble.print_min = 5L, tibble.print_max = 5L) [![R Build Status](https://github.com/stevenmmortimer/salesforcer/workflows/R-CMD-check/badge.svg)](https://github.com/stevenmmortimer/salesforcer/actions?workflow=R-CMD-check) [![CRAN Status](https://www.r-pkg.org/badges/version/salesforcer)](https://cran.r-project.org/package=salesforcer) -[![Lifecycle: Maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://www.tidyverse.org/lifecycle/#maturing) +[![Lifecycle: Stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable) [![Monthly Downloads](https://cranlogs.r-pkg.org/badges/last-month/salesforcer)](https://cran.r-project.org/package=salesforcer) [![Coverage Status](https://codecov.io/gh/stevenmmortimer/salesforcer/branch/main/graph/badge.svg)](https://codecov.io/gh/stevenmmortimer/salesforcer?branch=main) @@ -221,7 +221,7 @@ deleted_records For really large operations (inserts, updates, upserts, deletes, and queries) Salesforce provides the [Bulk 1.0](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_intro.htm) -and [Bulk 2.0](https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/introduction_bulk_api_2.htm) +and [Bulk 2.0](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/introduction_bulk_api_2.htm) APIs. In order to use the Bulk APIs in {salesforcer} you can just add `api_type = "Bulk 1.0"` or `api_type = "Bulk 2.0"` to your functions and the operation will be executed using the Bulk APIs. It's that simple. diff --git a/README.md b/README.md index 3bd6cc53..3404484a 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Status](https://github.com/stevenmmortimer/salesforcer/workflows/R-CMD-check/bad [![CRAN Status](https://www.r-pkg.org/badges/version/salesforcer)](https://cran.r-project.org/package=salesforcer) [![Lifecycle: -Maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://www.tidyverse.org/lifecycle/#maturing) +Stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable) [![Monthly Downloads](https://cranlogs.r-pkg.org/badges/last-month/salesforcer)](https://cran.r-project.org/package=salesforcer) [![Coverage @@ -242,7 +242,7 @@ For really large operations (inserts, updates, upserts, deletes, and queries) Salesforce provides the [Bulk 1.0](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_intro.htm) and -[Bulk 2.0](https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/introduction_bulk_api_2.htm) +[Bulk 2.0](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/introduction_bulk_api_2.htm) APIs. In order to use the Bulk APIs in {salesforcer} you can just add `api_type = "Bulk 1.0"` or `api_type = "Bulk 2.0"` to your functions and the operation will be executed using the Bulk APIs. It’s that simple. diff --git a/cran-comments.md b/cran-comments.md index 9581d606..121c3c3f 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -2,21 +2,28 @@ ## Test environments -* local mac OS install, R-release 4.0.2 -* ubuntu 16.04 (on github actions), R-release, R 4.0.2 -* mac OS 10.15.5 (on github actions) R-release, R 4.0.2 -* Microsoft Windows Server 2019 10.0.17763 (on github actions) R-release, R 4.0.2 -* win-builder (R-devel) +* Local Mac OS install, R-release 4.0.2 +* Ubuntu 16.04 (on GitHub Actions), R-release, R 4.0.2 +* Mac OS 10.15.5 (on GitHub Actions) R-release, R 4.0.2 +* Microsoft Windows Server 2019 10.0.17763 (on GitHub Actions) R-release, R 4.0.2 +* win-builder (R-release 4.1.0) ## R CMD check results -checking CRAN incoming feasibility ... NOTE - Maintainer: 'Steven M. Mortimer ' +* checking CRAN incoming feasibility ... NOTE +Maintainer: 'Steven M. Mortimer ' -New maintainer: - Steven M. Mortimer -Old maintainer(s): - Steven M. Mortimer +New submission + +Package was archived on CRAN + +Possibly mis-spelled words in DESCRIPTION: + APIs (2:42, 5:64, 9:16) + JSON (9:59) + +CRAN repository db overrides: + X-CRAN-Comment: Archived on 2021-06-23 as check problems were not + corrected in time. 0 errors v | 0 warnings v | 1 note x @@ -24,7 +31,4 @@ Old maintainer(s): ## revdepcheck results -We checked 0 reverse dependencies, comparing R CMD check results across CRAN and dev versions of this package. - - * We saw 0 new problems - * We failed to check 0 packages +Not done for this version because the prior version was removed from CRAN. diff --git a/docs/articles/supported-queries.html b/docs/articles/supported-queries.html index 551218be..74dd3528 100644 --- a/docs/articles/supported-queries.html +++ b/docs/articles/supported-queries.html @@ -164,7 +164,7 @@

  • Async SOQL
  • Overview of queries in Bulk 1.0 API
  • -
  • Overview of queries in Bulk 2.0 API
  • +
  • Overview of queries in Bulk 2.0 API

  • @@ -488,7 +488,7 @@

  • Do you need a parent-to-child nested relationship query or will a child-to-parent lookup suffice?

  • -
  • Check out Salesforce’s Workbench tool to see how it builds out queries.

  • +
  • Check out Salesforce’s Workbench tool to see how it builds out queries.

  • Double check Salesforce’s SOQL reference guide to see whether your query is supported or limited in some way.

  • Review query unit tests at: https://github.com/StevenMMortimer/salesforcer/blob/main/tests/testthat/test-query.R. These unit tests were written to cover a variety of use cases and to track any changes made between newly released versions of the Salesforce API (typically 4 each year). These tests are an excellent source of examples that may be helpful in troubleshooting your own query.

  • diff --git a/docs/index.html b/docs/index.html index ef4cc8d7..35371273 100644 --- a/docs/index.html +++ b/docs/index.html @@ -304,7 +304,7 @@

    Bulk Operations

    -

    For really large operations (inserts, updates, upserts, deletes, and queries) Salesforce provides the Bulk 1.0 and Bulk 2.0 APIs. In order to use the Bulk APIs in {salesforcer} you can just add api_type = "Bulk 1.0" or api_type = "Bulk 2.0" to your functions and the operation will be executed using the Bulk APIs. It’s that simple.

    +

    For really large operations (inserts, updates, upserts, deletes, and queries) Salesforce provides the Bulk 1.0 and Bulk 2.0 APIs. In order to use the Bulk APIs in {salesforcer} you can just add api_type = "Bulk 1.0" or api_type = "Bulk 2.0" to your functions and the operation will be executed using the Bulk APIs. It’s that simple.

    The benefits of using the Bulk API for larger datasets is that the operation will reduce the number of individual API calls (organization usually have a limit on total calls) and batching the requests in bulk is usually quicker than running thousands of individuals calls when your data is large. Note: the Bulk 2.0 API does NOT guarantee the order of the data submitted is preserved in the output. This means that you must join on other data columns to match up the Ids that are returned in the output with the data you submitted. For this reason, Bulk 2.0 may not be a good solution for creating, updating, or upserting records where you need to keep track of the created Ids. The Bulk 2.0 API would be fine for deleting records where you only need to know which Ids were successfully deleted.

    # create contacts using the Bulk API
     n <- 2
    @@ -483,7 +483,7 @@ 

    Dev status

    • R Build Status
    • CRAN Status
    • -
    • Lifecycle: Maturing
    • +
    • Lifecycle: Stable
    • Monthly Downloads
    • Coverage Status
    diff --git a/docs/reference/sf_auth.html b/docs/reference/sf_auth.html index 3459aed7..39d85bc6 100644 --- a/docs/reference/sf_auth.html +++ b/docs/reference/sf_auth.html @@ -191,7 +191,7 @@

    Log in to Salesforce

    -

    Stable lifecycle

    +

    Stable lifecycle

    Log in using Basic (Username-Password) or OAuth 2.0 authenticaion. OAuth does not require sharing passwords, but will require authorizing salesforcer as a connected app to view and manage your organization. You will be directed to diff --git a/docs/reference/sf_create.html b/docs/reference/sf_create.html index a096d5a4..d7ca8a15 100644 --- a/docs/reference/sf_create.html +++ b/docs/reference/sf_create.html @@ -186,7 +186,7 @@

    Create Records

    -

    Maturing lifecycle

    +

    Stable lifecycle

    Adds one or more new records to your organization’s data.

    diff --git a/docs/reference/sf_delete.html b/docs/reference/sf_delete.html index 45cdf8f3..15c7bd38 100644 --- a/docs/reference/sf_delete.html +++ b/docs/reference/sf_delete.html @@ -186,7 +186,7 @@

    Delete Records

    -

    Maturing lifecycle

    +

    Stable lifecycle

    Deletes one or more records from your organization’s data.

    diff --git a/docs/reference/sf_describe_object_fields.html b/docs/reference/sf_describe_object_fields.html index 7f2739a8..d8b73d16 100644 --- a/docs/reference/sf_describe_object_fields.html +++ b/docs/reference/sf_describe_object_fields.html @@ -187,7 +187,7 @@

    Describe Object Fields

    -

    Maturing lifecycle

    +

    Stable lifecycle

    This function takes the name of an object in Salesforce and returns a description of the fields on that object by returning a tibble with one row per field.

    diff --git a/docs/reference/sf_describe_objects.html b/docs/reference/sf_describe_objects.html index a348fd8b..bd084ebc 100644 --- a/docs/reference/sf_describe_objects.html +++ b/docs/reference/sf_describe_objects.html @@ -186,7 +186,7 @@

    SObject Basic Information

    -

    Maturing lifecycle

    +

    Stable lifecycle

    Describes the individual metadata for the specified object.

    diff --git a/docs/reference/sf_download_attachment.html b/docs/reference/sf_download_attachment.html index e7107651..09879c7b 100644 --- a/docs/reference/sf_download_attachment.html +++ b/docs/reference/sf_download_attachment.html @@ -187,7 +187,7 @@

    Download an Attachment

    -

    Maturing lifecycle

    +

    Stable lifecycle

    This function will allow you to download an attachment to disk based on the attachment body, file name, and path.

    diff --git a/docs/reference/sf_format_date.html b/docs/reference/sf_format_date.html index fc1d608d..bc2b1f80 100644 --- a/docs/reference/sf_format_date.html +++ b/docs/reference/sf_format_date.html @@ -196,7 +196,7 @@

    Note

    This function is meant to be used internally. Only use when debugging.

    See also

    - +
    -

    Stable lifecycle

    +

    Stable lifecycle

    Lists information about limits in your org.

    diff --git a/docs/reference/sf_list_objects.html b/docs/reference/sf_list_objects.html index 1cb249dc..b871b686 100644 --- a/docs/reference/sf_list_objects.html +++ b/docs/reference/sf_list_objects.html @@ -186,7 +186,7 @@

    List Organization Objects and their Metadata

    -

    Stable lifecycle

    +

    Stable lifecycle

    Lists the available objects and their metadata for your organization’s data.

    diff --git a/docs/reference/sf_list_resources.html b/docs/reference/sf_list_resources.html index a9611def..413b941f 100644 --- a/docs/reference/sf_list_resources.html +++ b/docs/reference/sf_list_resources.html @@ -187,7 +187,7 @@

    List the Resources for an API

    -

    Stable lifecycle

    +

    Stable lifecycle

    Lists available resources for the specified API version, including resource name and URI.

    diff --git a/docs/reference/sf_list_rest_api_versions.html b/docs/reference/sf_list_rest_api_versions.html index 3f94c89c..5923711b 100644 --- a/docs/reference/sf_list_rest_api_versions.html +++ b/docs/reference/sf_list_rest_api_versions.html @@ -187,7 +187,7 @@

    List REST API Versions

    -

    Stable lifecycle

    +

    Stable lifecycle

    Lists summary information about each Salesforce version currently available, including the version, label, and a link to each version\'s root

    diff --git a/docs/reference/sf_query.html b/docs/reference/sf_query.html index 253f9b5e..a339aacb 100644 --- a/docs/reference/sf_query.html +++ b/docs/reference/sf_query.html @@ -187,7 +187,7 @@

    Perform SOQL Query

    -

    Maturing lifecycle

    +

    Stable lifecycle

    Executes a query against the specified object and returns data that matches the specified criteria.

    diff --git a/docs/reference/sf_query_bulk_v2.html b/docs/reference/sf_query_bulk_v2.html index 85646a12..78954c5b 100644 --- a/docs/reference/sf_query_bulk_v2.html +++ b/docs/reference/sf_query_bulk_v2.html @@ -283,7 +283,7 @@

    Value

    A tbl_df of the recordset returned by the query

    References

    -

    Bulk 2.0 documentation

    +

    Bulk 2.0 documentation

    Examples

    if (FALSE) { diff --git a/docs/reference/sf_query_result_bulk.html b/docs/reference/sf_query_result_bulk.html index 13ef4a3f..09ae3976 100644 --- a/docs/reference/sf_query_result_bulk.html +++ b/docs/reference/sf_query_result_bulk.html @@ -263,7 +263,7 @@

    Value

    tbl_df, formatted by Salesforce, containing query results

    References

    -

    Bulk 1.0 documentation and Bulk 2.0 documentation

    +

    Bulk 1.0 documentation and Bulk 2.0 documentation

    Examples

    if (FALSE) { diff --git a/docs/reference/sf_query_result_bulk_v2.html b/docs/reference/sf_query_result_bulk_v2.html index 70a57d00..5d4967db 100644 --- a/docs/reference/sf_query_result_bulk_v2.html +++ b/docs/reference/sf_query_result_bulk_v2.html @@ -260,7 +260,7 @@

    Value

    tbl_df, formatted by Salesforce, containing query results

    References

    -

    Bulk 2.0 documentation

    +

    Bulk 2.0 documentation

    Examples

    if (FALSE) { diff --git a/docs/reference/sf_retrieve.html b/docs/reference/sf_retrieve.html index def240de..62a2d930 100644 --- a/docs/reference/sf_retrieve.html +++ b/docs/reference/sf_retrieve.html @@ -186,7 +186,7 @@

    Retrieve Records By Id

    -

    Maturing lifecycle

    +

    Stable lifecycle

    Retrieves one or more new records to your organization’s data.

    diff --git a/docs/reference/sf_run_bulk_operation.html b/docs/reference/sf_run_bulk_operation.html index a9aa4af1..5cc60765 100644 --- a/docs/reference/sf_run_bulk_operation.html +++ b/docs/reference/sf_run_bulk_operation.html @@ -186,7 +186,7 @@

    Run Bulk Operation

    -

    Maturing lifecycle

    +

    Stable lifecycle

    This function is a convenience wrapper for submitting bulk API jobs

    diff --git a/docs/reference/sf_run_bulk_query.html b/docs/reference/sf_run_bulk_query.html index 8602dd2f..238ca89b 100644 --- a/docs/reference/sf_run_bulk_query.html +++ b/docs/reference/sf_run_bulk_query.html @@ -187,7 +187,7 @@

    Run bulk query

    -

    Maturing lifecycle

    +

    Stable lifecycle

    This function is a convenience wrapper for submitting and retrieving query API jobs from the Bulk 1.0 and Bulk 2.0 APIs.

    @@ -300,7 +300,7 @@

    Value

    A tbl_df of the recordset returned by the query

    References

    -

    Bulk 1.0 documentation and Bulk 2.0 documentation

    +

    Bulk 1.0 documentation and Bulk 2.0 documentation

    Examples

    if (FALSE) { diff --git a/docs/reference/sf_search.html b/docs/reference/sf_search.html index 375a353f..9bba0e7b 100644 --- a/docs/reference/sf_search.html +++ b/docs/reference/sf_search.html @@ -186,7 +186,7 @@

    Perform SOSL Search

    -

    Maturing lifecycle

    +

    Stable lifecycle

    Searches for records in your organization’s data.

    diff --git a/docs/reference/sf_server_timestamp.html b/docs/reference/sf_server_timestamp.html index 7f27aea0..40c304bf 100644 --- a/docs/reference/sf_server_timestamp.html +++ b/docs/reference/sf_server_timestamp.html @@ -186,7 +186,7 @@

    Salesforce Server Timestamp

    -

    Stable lifecycle

    +

    Stable lifecycle

    Retrieves the current system timestamp from the API.

    diff --git a/docs/reference/sf_update.html b/docs/reference/sf_update.html index ff0b7aa5..6d4b757e 100644 --- a/docs/reference/sf_update.html +++ b/docs/reference/sf_update.html @@ -186,7 +186,7 @@

    Update Records

    -

    Maturing lifecycle

    +

    Stable lifecycle

    Updates one or more records to your organization’s data.

    diff --git a/docs/reference/sf_upsert.html b/docs/reference/sf_upsert.html index 8273f869..524caddd 100644 --- a/docs/reference/sf_upsert.html +++ b/docs/reference/sf_upsert.html @@ -186,7 +186,7 @@

    Upsert Records

    -

    Maturing lifecycle

    +

    Stable lifecycle

    Upserts one or more new records to your organization’s data.

    diff --git a/docs/reference/sf_user_info.html b/docs/reference/sf_user_info.html index bd1c61bf..551b1267 100644 --- a/docs/reference/sf_user_info.html +++ b/docs/reference/sf_user_info.html @@ -186,7 +186,7 @@

    Return Current User Info

    -

    Maturing lifecycle

    +

    Stable lifecycle

    Retrieves personal information for the user associated with the current session.

    diff --git a/docs/reference/validate_get_all_jobs_params.html b/docs/reference/validate_get_all_jobs_params.html index 0c282575..2e678a58 100644 --- a/docs/reference/validate_get_all_jobs_params.html +++ b/docs/reference/validate_get_all_jobs_params.html @@ -196,7 +196,7 @@

    Note

    This function is meant to be used internally. Only use when debugging.

    See also

    - + @@ -103,7 +103,7 @@
    • -CAUTION: This release requires {dplyr 1.0.0} because {dplyr 1.0.1} introduced a bug in bind_rows() with how it binds lists where the list elements have differing lengths. This is documented in tidyverse/dplyr#5417 and r-lib/vctrs#1073. The timeline for a fix is unknown as of Aug 16, 2020. You can install the older version of {dplyr} using the following command:
    • +CAUTION: This release requires {dplyr 1.0.0} because {dplyr 1.0.1} introduced a bug in bind_rows() with how it binds lists where the list elements have differing lengths. This is documented in tidyverse/dplyr#5417 and r-lib/vctrs#1073. The timeline for a fix is unknown as of Aug 16, 2020. You can install the older version of {dplyr} using the following command:
    -
    remotes::install_version("dplyr", "1.0.0")
    +
    +
    +remotes::install_version("dplyr", "1.0.0")
    -
    +

    -Features

    +Features
    • Add support for the defaultLimit argument in sf_search() to be able to restrict the number of records from each individual object when searching across one or more objects.
    • Add support for updating attachments with the sf_update_attachments() function (#79).
    • Add support for downloading attachments just by its Id. In addition, the sf_download_attachment() function returns the file path of the downloaded content instead of a logical indicating success.
    -
    +

    -Bug fixes

    +Bug fixes
    • Fix bug introduced in {salesforcer 0.2.0} which could not stack records with errors longer than length 1. The new solution is to always return the errors column as a list, which is coerced to length 1 for the record (#66).
    • Fix bug in sf_search() that was passing "true"/"false" instead of actual boolean value for the spellCorrection parameter in the POST body.
    • @@ -231,16 +288,16 @@

      salesforcer 0.2.0 release

      -
      +

      -Dependencies

      +Dependencies
      • CAUTION: This release only has automated test coverage on R 4.0.0 or greater. Users should still be able to install and run using R (>= 3.6.0). However, it is recommended to upgrade to R 4.0.0 or greater.
      -
      +

      -Features

      +Features
      • Add experimental support for the Reports and Dashboards REST API.

      • Add support for Bulk 2.0 queries that was added in Salesforce version 47.0 (Winter ’20). CAUTION: The Bulk 2.0 API is now the default API when using sf_query_bulk() or sf_run_bulk_query(). Please test prior to upgrading in a production environment where you are running bulk queries.

      • @@ -281,9 +338,9 @@

      • Remove dependency on {data.table} which does not have a build for R-devel. This should only affect sf_read_metadata().

      -
      +

      -Bug Fixes

      +Bug Fixes
      • Fix bug that prevented enabling PKChunking in Bulk 1.0 queries. Users can now specify using TRUE/FALSE or details like chunkSize that imply TRUE. The results are then parsed appropriately by waiting for all individual batches to finish. (#46)

      • Fix bugs in REST and SOAP API queries to prevent infinite looping and mangling results of relationship queries, specifically parent-to-child nested queries. (#19, #35, #38, #54)

      • @@ -296,9 +353,9 @@

        salesforcer 0.1.4 release

        -
        +

        -Features

        +Features
        • Rebuilt package against R 4.0 (no issues observed with 3.6.3, 4.0.0, 4.0.1) (#53)

        • Upgrade to Salesforce version 48.0 (Spring ’20) from version 46.0 (Summer ’19)

        • @@ -310,9 +367,9 @@

        • Add Attachment and Metadata vignettes along with updated Bulk vignette.

        -
        +

        -Bug Fixes

        +Bug Fixes
        • Fix issue where REST query was not correctly passing and honoring the batch size control argument to paginate results

        • Fix issue in results of REST query pagination where the function was looping infinitely because of a bug in the implementation that would continue using the same next_records_url that was previously passed into the function (#54)

        • @@ -328,9 +385,9 @@

          salesforcer 0.1.3 release

          -
          +

          -Features

          +Features
          • Upgrade to version 46.0 (Summer ’19) from version 45.0 (Spring ’19)

          • Add RForcecom backward compatible version of rforcecom.getObjectDescription()

          • @@ -347,9 +404,9 @@

          • Add new function sf_merge() which combines up to 3 records of the same type into 1 record (#22)

          -
          +

          -Bug Fixes

          +Bug Fixes
          @@ -108,7 +108,7 @@

          Arguments

          @@ -232,7 +232,7 @@

          Contents

          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/make_analytics_folder_child_operations_url.html b/docs/reference/make_analytics_folder_child_operations_url.html index 0866506f..56bc2ad6 100644 --- a/docs/reference/make_analytics_folder_child_operations_url.html +++ b/docs/reference/make_analytics_folder_child_operations_url.html @@ -96,7 +96,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -104,7 +104,7 @@
          @@ -219,7 +219,7 @@

          Contents

          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/make_rest_objects_url.html b/docs/reference/make_rest_objects_url.html index 2497d099..68cc845e 100644 --- a/docs/reference/make_rest_objects_url.html +++ b/docs/reference/make_rest_objects_url.html @@ -96,7 +96,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -104,7 +104,7 @@
          @@ -241,7 +241,7 @@

          Contents

          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/make_verbose_httr_message.html b/docs/reference/make_verbose_httr_message.html index 322c51f7..4effb402 100644 --- a/docs/reference/make_verbose_httr_message.html +++ b/docs/reference/make_verbose_httr_message.html @@ -96,7 +96,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -104,7 +104,7 @@
          @@ -232,7 +232,7 @@

          Contents

          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/merge_null_to_na.html b/docs/reference/merge_null_to_na.html index 5d92cfd5..916ea86f 100644 --- a/docs/reference/merge_null_to_na.html +++ b/docs/reference/merge_null_to_na.html @@ -96,7 +96,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -104,7 +104,7 @@
          @@ -228,7 +228,7 @@

          Contents

          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/metadata_type_validator.html b/docs/reference/metadata_type_validator.html index bd32365d..28d5c40d 100644 --- a/docs/reference/metadata_type_validator.html +++ b/docs/reference/metadata_type_validator.html @@ -97,7 +97,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -105,7 +105,7 @@
          @@ -213,7 +213,7 @@

          Value

          Details

          AccessMapping

          -

          Salesforce Documentation for AccessMapping

          +
          accessLevel

          a character

          object

          a character

          objectField

          a character

          @@ -222,7 +222,7 @@

          Details

          AccountSettings

          -

          Salesforce Documentation for AccountSettings

          +
          fullName

          a character (inherited from Metadata)

          enableAccountOwnerReport

          a character either 'true' or 'false'

          enableAccountTeams

          a character either 'true' or 'false'

          @@ -231,7 +231,7 @@

          Details

          AccountSharingRuleSettings

          -

          Salesforce Documentation for AccountSharingRuleSettings

          +
          caseAccessLevel

          a character

          contactAccessLevel

          a character

          opportunityAccessLevel

          a character

          @@ -239,7 +239,7 @@

          Details

          ActionLinkGroupTemplate

          -

          Salesforce Documentation for ActionLinkGroupTemplate

          +
          fullName

          a character (inherited from Metadata)

          actionLinkTemplates

          a ActionLinkTemplate

          category

          a PlatformActionGroupCategory - which is a character taking one of the following values: @@ -253,14 +253,14 @@

          Details
        • OncePerUser

        • Unlimited

        • -
          hoursUntilExpiration

          a integer

          +
          hoursUntilExpiration

          an integer

          isPublished

          a character either 'true' or 'false'

          name

          a character

          ActionLinkTemplate

          -

          Salesforce Documentation for ActionLinkTemplate

          +
          actionUrl

          a character

          headers

          a character

          isConfirmationRequired

          a character either 'true' or 'false'

          @@ -283,7 +283,7 @@

          Details
        • HttpPost

        • HttpPut

        • -
          position

          a integer

          +
          position

          an integer

          requestBody

          a character

          userAlias

          a character

          userVisibility

          a ActionLinkUserVisibility - which is a character taking one of the following values: @@ -299,7 +299,7 @@

          Details

          ActionOverride

          -

          Salesforce Documentation for ActionOverride

          +
          actionName

          a character

          comment

          a character

          content

          a character

          @@ -323,7 +323,7 @@

          Details

          ActivitiesSettings

          -

          Salesforce Documentation for ActivitiesSettings

          +
          fullName

          a character (inherited from Metadata)

          allowUsersToRelateMultipleContactsToTasksAndEvents

          a character either 'true' or 'false'

          autoRelateEventAttendees

          a character either 'true' or 'false'

          @@ -349,57 +349,57 @@

          Details

          AddressSettings

          -

          Salesforce Documentation for AddressSettings

          +
          fullName

          a character (inherited from Metadata)

          countriesAndStates

          a CountriesAndStates

          AdjustmentsSettings

          -

          Salesforce Documentation for AdjustmentsSettings

          +
          enableAdjustments

          a character either 'true' or 'false'

          enableOwnerAdjustments

          a character either 'true' or 'false'

          AgentConfigAssignments

          -

          Salesforce Documentation for AgentConfigAssignments

          +
          profiles

          a AgentConfigProfileAssignments

          users

          a AgentConfigUserAssignments

          AgentConfigButtons

          -

          Salesforce Documentation for AgentConfigButtons

          +
          button

          a character

          AgentConfigProfileAssignments

          -

          Salesforce Documentation for AgentConfigProfileAssignments

          +
          profile

          a character

          AgentConfigSkills

          -

          Salesforce Documentation for AgentConfigSkills

          +
          skill

          a character

          AgentConfigUserAssignments

          -

          Salesforce Documentation for AgentConfigUserAssignments

          +
          user

          a character

          AnalyticsCloudComponentLayoutItem

          -

          Salesforce Documentation for AnalyticsCloudComponentLayoutItem

          +
          assetType

          a character

          devName

          a character

          error

          a character

          filter

          a character

          -
          height

          a integer

          +
          height

          an integer

          hideOnError

          a character either 'true' or 'false'

          showHeader

          a character either 'true' or 'false'

          showSharing

          a character either 'true' or 'false'

          @@ -409,7 +409,7 @@

          Details

          AnalyticSnapshot

          -

          Salesforce Documentation for AnalyticSnapshot

          +
          fullName

          a character (inherited from Metadata)

          description

          a character

          groupColumn

          a character

          @@ -422,7 +422,7 @@

          Details

          AnalyticSnapshotMapping

          -

          Salesforce Documentation for AnalyticSnapshotMapping

          +
          aggregateType

          a ReportSummaryType - which is a character taking one of the following values:

          • Sum

          • @@ -443,8 +443,8 @@

            Details

          ApexClass

          -

          Salesforce Documentation for ApexClass

          -
          content

          a character formed using RCurl::base64Encode (inherited from MetadataWithContent)

          +
          +
          content

          a character formed using base64encode (inherited from MetadataWithContent)

          apiVersion

          a numeric

          packageVersions

          a PackageVersion

          status

          a ApexCodeUnitStatus - which is a character taking one of the following values: @@ -457,8 +457,8 @@

          Details

          ApexComponent

          -

          Salesforce Documentation for ApexComponent

          -
          content

          a character formed using RCurl::base64Encode (inherited from MetadataWithContent)

          +
          +
          content

          a character formed using base64encode (inherited from MetadataWithContent)

          apiVersion

          a numeric

          description

          a character

          label

          a character

          @@ -467,8 +467,8 @@

          Details

          ApexPage

          -

          Salesforce Documentation for ApexPage

          -
          content

          a character formed using RCurl::base64Encode (inherited from MetadataWithContent)

          +
          +
          content

          a character formed using base64encode (inherited from MetadataWithContent)

          apiVersion

          a numeric

          availableInTouch

          a character either 'true' or 'false'

          confirmationTokenRequired

          a character either 'true' or 'false'

          @@ -479,15 +479,15 @@

          Details

          ApexTestSuite

          -

          Salesforce Documentation for ApexTestSuite

          +
          fullName

          a character (inherited from Metadata)

          testClassName

          a character

          ApexTrigger

          -

          Salesforce Documentation for ApexTrigger

          -
          content

          a character formed using RCurl::base64Encode (inherited from MetadataWithContent)

          +
          +
          content

          a character formed using base64encode (inherited from MetadataWithContent)

          apiVersion

          a numeric

          packageVersions

          a PackageVersion

          status

          a ApexCodeUnitStatus - which is a character taking one of the following values: @@ -500,7 +500,7 @@

          Details

          AppActionOverride

          -

          Salesforce Documentation for AppActionOverride

          +
          actionName

          a character (inherited from ActionOverride)

          comment

          a character (inherited from ActionOverride)

          content

          a character (inherited from ActionOverride)

          @@ -512,38 +512,38 @@

          Details

          AppBrand

          -

          Salesforce Documentation for AppBrand

          +
          footerColor

          a character

          headerColor

          a character

          logo

          a character

          -
          logoVersion

          a integer

          +
          logoVersion

          an integer

          shouldOverrideOrgTheme

          a character either 'true' or 'false'

          AppComponentList

          -

          Salesforce Documentation for AppComponentList

          +
          alignment

          a character

          components

          a character

          AppMenu

          -

          Salesforce Documentation for AppMenu

          +
          fullName

          a character (inherited from Metadata)

          appMenuItems

          a AppMenuItem

          AppMenuItem

          -

          Salesforce Documentation for AppMenuItem

          +
          name

          a character

          type

          a character

          AppPreferences

          -

          Salesforce Documentation for AppPreferences

          +
          enableCustomizeMyTabs

          a character either 'true' or 'false'

          enableKeyboardShortcuts

          a character either 'true' or 'false'

          enableListViewHover

          a character either 'true' or 'false'

          @@ -557,7 +557,7 @@

          Details

          AppProfileActionOverride

          -

          Salesforce Documentation for AppProfileActionOverride

          +
          actionName

          a character (inherited from ProfileActionOverride)

          content

          a character (inherited from ProfileActionOverride)

          formFactor

          a FormFactor (inherited from ProfileActionOverride)

          @@ -569,13 +569,13 @@

          Details

          ApprovalAction

          -

          Salesforce Documentation for ApprovalAction

          +
          action

          a WorkflowActionReference

          ApprovalEntryCriteria

          -

          Salesforce Documentation for ApprovalEntryCriteria

          +
          booleanFilter

          a character

          criteriaItems

          a FilterItem

          formula

          a character

          @@ -583,13 +583,13 @@

          Details

          ApprovalPageField

          -

          Salesforce Documentation for ApprovalPageField

          +
          field

          a character

          ApprovalProcess

          -

          Salesforce Documentation for ApprovalProcess

          +
          fullName

          a character (inherited from Metadata)

          active

          a character either 'true' or 'false'

          allowRecall

          a character either 'true' or 'false'

          @@ -619,7 +619,7 @@

          Details

          ApprovalStep

          -

          Salesforce Documentation for ApprovalStep

          +
          allowDelegate

          a character either 'true' or 'false'

          approvalActions

          a ApprovalAction

          assignedApprover

          a ApprovalStepApprover

          @@ -639,7 +639,7 @@

          Details

          ApprovalStepApprover

          -

          Salesforce Documentation for ApprovalStepApprover

          +
          approver

          a Approver

          whenMultipleApprovers

          a RoutingType - which is a character taking one of the following values:

            @@ -650,7 +650,7 @@

            Details

          ApprovalStepRejectBehavior

          -

          Salesforce Documentation for ApprovalStepRejectBehavior

          +
          type

          a StepRejectBehaviorType - which is a character taking one of the following values:

          • RejectRequest

          • @@ -660,7 +660,7 @@

            Details

          ApprovalSubmitter

          -

          Salesforce Documentation for ApprovalSubmitter

          +
          submitter

          a character

          type

          a ProcessSubmitterType - which is a character taking one of the following values:

            @@ -681,7 +681,7 @@

            Details

          Approver

          -

          Salesforce Documentation for Approver

          +
          name

          a character

          type

          a NextOwnerType - which is a character taking one of the following values:

            @@ -695,19 +695,19 @@

            Details

          AppWorkspaceConfig

          -

          Salesforce Documentation for AppWorkspaceConfig

          +
          mappings

          a WorkspaceMapping

          ArticleTypeChannelDisplay

          -

          Salesforce Documentation for ArticleTypeChannelDisplay

          +
          articleTypeTemplates

          a ArticleTypeTemplate

          ArticleTypeTemplate

          -

          Salesforce Documentation for ArticleTypeTemplate

          +
          channel

          a Channel - which is a character taking one of the following values:

          • AllChannels

          • @@ -727,7 +727,7 @@

            Details

          AssignmentRule

          -

          Salesforce Documentation for AssignmentRule

          +
          fullName

          a character (inherited from Metadata)

          active

          a character either 'true' or 'false'

          ruleEntry

          a RuleEntry

          @@ -735,14 +735,14 @@

          Details

          AssignmentRules

          -

          Salesforce Documentation for AssignmentRules

          +
          fullName

          a character (inherited from Metadata)

          assignmentRule

          a AssignmentRule

          AssistantRecommendationType

          -

          Salesforce Documentation for AssistantRecommendationType

          +
          fullName

          a character (inherited from Metadata)

          description

          a character

          masterLabel

          a character

          @@ -753,28 +753,28 @@

          Details

          Attachment

          -

          Salesforce Documentation for Attachment

          -
          content

          a character formed using RCurl::base64Encode

          +
          +
          content

          a character formed using base64encode

          name

          a character

          AuraDefinitionBundle

          -

          Salesforce Documentation for AuraDefinitionBundle

          +
          fullName

          a character (inherited from Metadata)

          -
          SVGContent

          a character formed using RCurl::base64Encode

          +
          SVGContent

          a character formed using base64encode

          apiVersion

          a numeric

          -
          controllerContent

          a character formed using RCurl::base64Encode

          +
          controllerContent

          a character formed using base64encode

          description

          a character

          -
          designContent

          a character formed using RCurl::base64Encode

          -
          documentationContent

          a character formed using RCurl::base64Encode

          -
          helperContent

          a character formed using RCurl::base64Encode

          -
          markup

          a character formed using RCurl::base64Encode

          -
          modelContent

          a character formed using RCurl::base64Encode

          +
          designContent

          a character formed using base64encode

          +
          documentationContent

          a character formed using base64encode

          +
          helperContent

          a character formed using base64encode

          +
          markup

          a character formed using base64encode

          +
          modelContent

          a character formed using base64encode

          packageVersions

          a PackageVersion

          -
          rendererContent

          a character formed using RCurl::base64Encode

          -
          styleContent

          a character formed using RCurl::base64Encode

          -
          testsuiteContent

          a character formed using RCurl::base64Encode

          +
          rendererContent

          a character formed using base64encode

          +
          styleContent

          a character formed using base64encode

          +
          testsuiteContent

          a character formed using base64encode

          type

          a AuraBundleType - which is a character taking one of the following values:

          • Application

          • @@ -787,7 +787,7 @@

            Details

          AuthProvider

          -

          Salesforce Documentation for AuthProvider

          +
          fullName

          a character (inherited from Metadata)

          authorizeUrl

          a character

          consumerKey

          a character

          @@ -825,7 +825,7 @@

          Details

          AutoResponseRule

          -

          Salesforce Documentation for AutoResponseRule

          +
          fullName

          a character (inherited from Metadata)

          active

          a character either 'true' or 'false'

          ruleEntry

          a RuleEntry

          @@ -833,14 +833,14 @@

          Details

          AutoResponseRules

          -

          Salesforce Documentation for AutoResponseRules

          +
          fullName

          a character (inherited from Metadata)

          autoResponseRule

          a AutoResponseRule

          BrandingSet

          -

          Salesforce Documentation for BrandingSet

          +
          fullName

          a character (inherited from Metadata)

          brandingSetProperty

          a BrandingSetProperty

          description

          a character

          @@ -850,14 +850,14 @@

          Details

          BrandingSetProperty

          -

          Salesforce Documentation for BrandingSetProperty

          +
          propertyName

          a character

          propertyValue

          a character

          BusinessHoursEntry

          -

          Salesforce Documentation for BusinessHoursEntry

          +
          fullName

          a character (inherited from Metadata)

          active

          a character either 'true' or 'false'

          default

          a character either 'true' or 'false'

          @@ -881,7 +881,7 @@

          Details

          BusinessHoursSettings

          -

          Salesforce Documentation for BusinessHoursSettings

          +
          fullName

          a character (inherited from Metadata)

          businessHours

          a BusinessHoursEntry

          holidays

          a Holiday

          @@ -889,7 +889,7 @@

          Details

          BusinessProcess

          -

          Salesforce Documentation for BusinessProcess

          +
          fullName

          a character (inherited from Metadata)

          description

          a character

          isActive

          a character either 'true' or 'false'

          @@ -898,7 +898,7 @@

          Details

          CallCenter

          -

          Salesforce Documentation for CallCenter

          +
          fullName

          a character (inherited from Metadata)

          adapterUrl

          a character

          customSettings

          a character

          @@ -911,7 +911,7 @@

          Details

          CallCenterItem

          -

          Salesforce Documentation for CallCenterItem

          +
          label

          a character

          name

          a character

          value

          a character

          @@ -919,7 +919,7 @@

          Details

          CallCenterSection

          -

          Salesforce Documentation for CallCenterSection

          +
          items

          a CallCenterItem

          label

          a character

          name

          a character

          @@ -927,7 +927,7 @@

          Details

          CampaignInfluenceModel

          -

          Salesforce Documentation for CampaignInfluenceModel

          +
          fullName

          a character (inherited from Metadata)

          isActive

          a character either 'true' or 'false'

          isDefaultModel

          a character either 'true' or 'false'

          @@ -939,7 +939,7 @@

          Details

          CaseSettings

          -

          Salesforce Documentation for CaseSettings

          +
          fullName

          a character (inherited from Metadata)

          caseAssignNotificationTemplate

          a character

          caseCloseNotificationTemplate

          a character

          @@ -975,9 +975,9 @@

          Details

          CaseSubjectParticle

          -

          Salesforce Documentation for CaseSubjectParticle

          +
          fullName

          a character (inherited from Metadata)

          -
          index

          a integer

          +
          index

          an integer

          textField

          a character

          type

          a CaseSubjectParticleType - which is a character taking one of the following values:

            @@ -997,19 +997,19 @@

            Details

          Certificate

          -

          Salesforce Documentation for Certificate

          -
          content

          a character formed using RCurl::base64Encode (inherited from MetadataWithContent)

          +
          +
          content

          a character formed using base64encode (inherited from MetadataWithContent)

          caSigned

          a character either 'true' or 'false'

          encryptedWithPlatformEncryption

          a character either 'true' or 'false'

          expirationDate

          a character formatted as 'yyyy-mm-ddThh:mm:ssZ'

          -
          keySize

          a integer

          +
          keySize

          an integer

          masterLabel

          a character

          privateKeyExportable

          a character either 'true' or 'false'

          ChannelLayout

          -

          Salesforce Documentation for ChannelLayout

          +
          fullName

          a character (inherited from Metadata)

          enabledChannels

          a character

          label

          a character

          @@ -1019,13 +1019,13 @@

          Details

          ChannelLayoutItem

          -

          Salesforce Documentation for ChannelLayoutItem

          +
          field

          a character

          ChartSummary

          -

          Salesforce Documentation for ChartSummary

          +
          aggregate

          a ReportSummaryType - which is a character taking one of the following values:

          • Sum

          • @@ -1046,14 +1046,14 @@

            Details

          ChatterAnswersReputationLevel

          -

          Salesforce Documentation for ChatterAnswersReputationLevel

          +
          name

          a character

          -
          value

          a integer

          +
          value

          an integer

          ChatterAnswersSettings

          -

          Salesforce Documentation for ChatterAnswersSettings

          +
          fullName

          a character (inherited from Metadata)

          emailFollowersOnBestAnswer

          a character either 'true' or 'false'

          emailFollowersOnReply

          a character either 'true' or 'false'

          @@ -1071,7 +1071,7 @@

          Details

          ChatterExtension

          -

          Salesforce Documentation for ChatterExtension

          +
          fullName

          a character (inherited from Metadata)

          compositionComponent

          a character

          description

          a character

          @@ -1090,13 +1090,13 @@

          Details

          ChatterMobileSettings

          -

          Salesforce Documentation for ChatterMobileSettings

          +
          enablePushNotifications

          a character either 'true' or 'false'

          CleanDataService

          -

          Salesforce Documentation for CleanDataService

          +
          fullName

          a character (inherited from Metadata)

          cleanRules

          a CleanRule

          description

          a character

          @@ -1106,7 +1106,7 @@

          Details

          CleanRule

          -

          Salesforce Documentation for CleanRule

          +
          bulkEnabled

          a character either 'true' or 'false'

          bypassTriggers

          a character either 'true' or 'false'

          bypassWorkflow

          a character either 'true' or 'false'

          @@ -1126,16 +1126,16 @@

          Details

          CodeLocation

          -

          Salesforce Documentation for CodeLocation

          -
          column

          a integer

          -
          line

          a integer

          -
          numExecutions

          a integer

          +
          +
          column

          an integer

          +
          line

          an integer

          +
          numExecutions

          an integer

          time

          a numeric

          Community

          -

          Salesforce Documentation for Community

          +
          fullName

          a character (inherited from Metadata)

          active

          a character either 'true' or 'false'

          chatterAnswersFacebookSsoUrl

          a character

          @@ -1156,14 +1156,14 @@

          Details

          CommunityCustomThemeLayoutType

          -

          Salesforce Documentation for CommunityCustomThemeLayoutType

          +
          description

          a character

          label

          a character

          CommunityRoles

          -

          Salesforce Documentation for CommunityRoles

          +
          customerUserRole

          a character

          employeeUserRole

          a character

          partnerUserRole

          a character

          @@ -1171,10 +1171,10 @@

          Details

          CommunityTemplateBundleInfo

          -

          Salesforce Documentation for CommunityTemplateBundleInfo

          +
          description

          a character

          image

          a character

          -
          order

          a integer

          +
          order

          an integer

          title

          a character

          type

          a CommunityTemplateBundleInfoType - which is a character taking one of the following values:

            @@ -1185,7 +1185,7 @@

            Details

          CommunityTemplateDefinition

          -

          Salesforce Documentation for CommunityTemplateDefinition

          +
          fullName

          a character (inherited from Metadata)

          baseTemplate

          a CommunityBaseTemplate - which is a character taking one of the following values:

            @@ -1210,14 +1210,14 @@

            Details

          CommunityTemplatePageSetting

          -

          Salesforce Documentation for CommunityTemplatePageSetting

          +
          page

          a character

          themeLayout

          a character

          CommunityThemeDefinition

          -

          Salesforce Documentation for CommunityThemeDefinition

          +
          fullName

          a character (inherited from Metadata)

          customThemeLayoutType

          a CommunityCustomThemeLayoutType

          description

          a character

          @@ -1228,7 +1228,7 @@

          Details

          CommunityThemeSetting

          -

          Salesforce Documentation for CommunityThemeSetting

          +
          customThemeLayoutType

          a character

          themeLayout

          a character

          themeLayoutType

          a CommunityThemeLayoutType - which is a character taking one of the following values: @@ -1241,7 +1241,7 @@

          Details

          CompactLayout

          -

          Salesforce Documentation for CompactLayout

          +
          fullName

          a character (inherited from Metadata)

          fields

          a character

          label

          a character

          @@ -1249,14 +1249,14 @@

          Details

          CompanySettings

          -

          Salesforce Documentation for CompanySettings

          +
          fullName

          a character (inherited from Metadata)

          fiscalYear

          a FiscalYearSettings

          ComponentInstance

          -

          Salesforce Documentation for ComponentInstance

          +
          componentInstanceProperties

          a ComponentInstanceProperty

          componentName

          a character

          visibilityRule

          a UiFormulaRule

          @@ -1264,7 +1264,7 @@

          Details

          ComponentInstanceProperty

          -

          Salesforce Documentation for ComponentInstanceProperty

          +
          name

          a character

          type

          a ComponentInstancePropertyTypeEnum - which is a character taking one of the following values:

            @@ -1275,7 +1275,7 @@

            Details

          ConnectedApp

          -

          Salesforce Documentation for ConnectedApp

          +
          fullName

          a character (inherited from Metadata)

          attributes

          a ConnectedAppAttribute

          canvasConfig

          a ConnectedAppCanvasConfig

          @@ -1297,14 +1297,14 @@

          Details

          ConnectedAppAttribute

          -

          Salesforce Documentation for ConnectedAppAttribute

          +
          formula

          a character

          key

          a character

          ConnectedAppCanvasConfig

          -

          Salesforce Documentation for ConnectedAppCanvasConfig

          +
          accessMethod

          a AccessMethod - which is a character taking one of the following values:

          • Get

          • @@ -1343,7 +1343,7 @@

            Details

          ConnectedAppIpRange

          -

          Salesforce Documentation for ConnectedAppIpRange

          +
          description

          a character

          end

          a character

          start

          a character

          @@ -1351,11 +1351,11 @@

          Details

          ConnectedAppMobileDetailConfig

          -

          Salesforce Documentation for ConnectedAppMobileDetailConfig

          -
          applicationBinaryFile

          a character formed using RCurl::base64Encode

          +
          +
          applicationBinaryFile

          a character formed using base64encode

          applicationBinaryFileName

          a character

          applicationBundleIdentifier

          a character

          -
          applicationFileLength

          a integer

          +
          applicationFileLength

          an integer

          applicationIconFile

          a character

          applicationIconFileName

          a character

          applicationInstallUrl

          a character

          @@ -1377,7 +1377,7 @@

          Details

          ConnectedAppOauthConfig

          -

          Salesforce Documentation for ConnectedAppOauthConfig

          +
          callbackUrl

          a character

          certificate

          a character

          consumerKey

          a character

          @@ -1406,7 +1406,7 @@

          Details

          ConnectedAppSamlConfig

          -

          Salesforce Documentation for ConnectedAppSamlConfig

          +
          acsUrl

          a character

          certificate

          a character

          encryptionCertificate

          a character

          @@ -1445,20 +1445,20 @@

          Details

          Container

          -

          Salesforce Documentation for Container

          -
          height

          a integer

          +
          +
          height

          an integer

          isContainerAutoSizeEnabled

          a character either 'true' or 'false'

          region

          a character

          sidebarComponents

          a SidebarComponent

          style

          a character

          unit

          a character

          -
          width

          a integer

          +
          width

          an integer

          ContentAsset

          -

          Salesforce Documentation for ContentAsset

          -
          content

          a character formed using RCurl::base64Encode (inherited from MetadataWithContent)

          +
          +
          content

          a character formed using base64encode (inherited from MetadataWithContent)

          format

          a ContentAssetFormat - which is a character taking one of the following values:

          • Original

          • @@ -1473,7 +1473,7 @@

            Details

          ContentAssetLink

          -

          Salesforce Documentation for ContentAssetLink

          +
          access

          a ContentAssetAccess - which is a character taking one of the following values:

          • VIEWER

          • @@ -1486,7 +1486,7 @@

            Details

          ContentAssetRelationships

          -

          Salesforce Documentation for ContentAssetRelationships

          +
          insightsApplication

          a ContentAssetLink

          network

          a ContentAssetLink

          organization

          a ContentAssetLink

          @@ -1495,7 +1495,7 @@

          Details

          ContentAssetVersion

          -

          Salesforce Documentation for ContentAssetVersion

          +
          number

          a character

          pathOnClient

          a character

          zipEntry

          a character

          @@ -1503,13 +1503,13 @@

          Details

          ContentAssetVersions

          -

          Salesforce Documentation for ContentAssetVersions

          +
          version

          a ContentAssetVersion

          ContractSettings

          -

          Salesforce Documentation for ContractSettings

          +
          fullName

          a character (inherited from Metadata)

          autoCalculateEndDate

          a character either 'true' or 'false'

          autoExpirationDelay

          a character

          @@ -1521,20 +1521,20 @@

          Details

          CorsWhitelistOrigin

          -

          Salesforce Documentation for CorsWhitelistOrigin

          +
          fullName

          a character (inherited from Metadata)

          urlPattern

          a character

          CountriesAndStates

          -

          Salesforce Documentation for CountriesAndStates

          +
          countries

          a Country

          Country

          -

          Salesforce Documentation for Country

          +
          active

          a character either 'true' or 'false'

          integrationValue

          a character

          isoCode

          a character

          @@ -1547,7 +1547,7 @@

          Details

          CspTrustedSite

          -

          Salesforce Documentation for CspTrustedSite

          +
          fullName

          a character (inherited from Metadata)

          description

          a character

          endpointUrl

          a character

          @@ -1556,7 +1556,7 @@

          Details

          CustomApplication

          -

          Salesforce Documentation for CustomApplication

          +
          fullName

          a character (inherited from Metadata)

          actionOverrides

          a AppActionOverride

          brand

          a AppBrand

          @@ -1593,37 +1593,37 @@

          Details

          CustomApplicationComponent

          -

          Salesforce Documentation for CustomApplicationComponent

          +
          fullName

          a character (inherited from Metadata)

          buttonIconUrl

          a character

          buttonStyle

          a character

          buttonText

          a character

          -
          buttonWidth

          a integer

          -
          height

          a integer

          +
          buttonWidth

          an integer

          +
          height

          an integer

          isHeightFixed

          a character either 'true' or 'false'

          isHidden

          a character either 'true' or 'false'

          isWidthFixed

          a character either 'true' or 'false'

          visualforcePage

          a character

          -
          width

          a integer

          +
          width

          an integer

          CustomApplicationTranslation

          -

          Salesforce Documentation for CustomApplicationTranslation

          +
          label

          a character

          name

          a character

          CustomConsoleComponents

          -

          Salesforce Documentation for CustomConsoleComponents

          +
          primaryTabComponents

          a PrimaryTabComponents

          subtabComponents

          a SubtabComponents

          CustomDataType

          -

          Salesforce Documentation for CustomDataType

          +
          fullName

          a character (inherited from Metadata)

          customDataTypeComponents

          a CustomDataTypeComponent

          description

          a character

          @@ -1636,19 +1636,19 @@

          Details

          CustomDataTypeComponent

          -

          Salesforce Documentation for CustomDataTypeComponent

          +
          developerSuffix

          a character

          enforceFieldRequiredness

          a character either 'true' or 'false'

          label

          a character

          -
          length

          a integer

          -
          precision

          a integer

          -
          scale

          a integer

          +
          length

          an integer

          +
          precision

          an integer

          +
          scale

          an integer

          sortOrder

          a SortOrder - which is a character taking one of the following values:

          • Asc

          • Desc

          -
          sortPriority

          a integer

          +
          sortPriority

          an integer

          type

          a FieldType - which is a character taking one of the following values:

          • AutoNumber

          • @@ -1684,14 +1684,14 @@

            Details

          CustomDataTypeComponentTranslation

          -

          Salesforce Documentation for CustomDataTypeComponentTranslation

          +
          developerSuffix

          a character

          label

          a character

          CustomDataTypeTranslation

          -

          Salesforce Documentation for CustomDataTypeTranslation

          +
          components

          a CustomDataTypeComponentTranslation

          customDataTypeName

          a character

          description

          a character

          @@ -1700,7 +1700,7 @@

          Details

          CustomExperience

          -

          Salesforce Documentation for CustomExperience

          +
          fullName

          a character (inherited from Metadata)

          allowInternalUserLogin

          a character either 'true' or 'false'

          branding

          a CustomExperienceBranding

          @@ -1723,7 +1723,7 @@

          Details

          CustomExperienceBranding

          -

          Salesforce Documentation for CustomExperienceBranding

          +
          loginFooterText

          a character

          loginLogo

          a character

          pageFooter

          a character

          @@ -1741,7 +1741,7 @@

          Details

          CustomExperienceTabSet

          -

          Salesforce Documentation for CustomExperienceTabSet

          +
          customTab

          a character

          defaultTab

          a character

          standardTab

          a character

          @@ -1749,7 +1749,7 @@

          Details

          CustomFeedFilter

          -

          Salesforce Documentation for CustomFeedFilter

          +
          fullName

          a character (inherited from Metadata)

          criteria

          a FeedFilterCriterion

          description

          a character

          @@ -1759,7 +1759,7 @@

          Details

          CustomField

          -

          Salesforce Documentation for CustomField

          +
          fullName

          a character (inherited from Metadata)

          businessOwnerGroup

          a character

          businessOwnerUser

          a character

          @@ -1798,7 +1798,7 @@

          Details
          isNameField

          a character either 'true' or 'false'

          isSortingDisabled

          a character either 'true' or 'false'

          label

          a character

          -
          length

          a integer

          +
          length

          an integer

          lookupFilter

          a LookupFilter

          maskChar

          a EncryptedFieldMaskChar - which is a character taking one of the following values:

            @@ -1816,16 +1816,16 @@

            Details

          metadataRelationshipControllingField

          a character

          populateExistingRows

          a character either 'true' or 'false'

          -
          precision

          a integer

          +
          precision

          an integer

          referenceTargetField

          a character

          referenceTo

          a character

          relationshipLabel

          a character

          relationshipName

          a character

          -
          relationshipOrder

          a integer

          +
          relationshipOrder

          an integer

          reparentableMasterDetail

          a character either 'true' or 'false'

          required

          a character either 'true' or 'false'

          restrictedAdminField

          a character either 'true' or 'false'

          -
          scale

          a integer

          +
          scale

          an integer

          securityClassification

          a SecurityClassification - which is a character taking one of the following values:

          • AccountInformation

          • @@ -1835,7 +1835,7 @@

            Details
          • AssociativeBusinessOrPersonalData

          • AuthenticationData

          -
          startingNumber

          a integer

          +
          startingNumber

          an integer

          stripMarkup

          a character either 'true' or 'false'

          summarizedField

          a character

          summaryFilterItems

          a FilterItem

          @@ -1883,13 +1883,13 @@

          Details

          unique

          a character either 'true' or 'false'

          valueSet

          a ValueSet

          -
          visibleLines

          a integer

          +
          visibleLines

          an integer

          writeRequiresMasterRead

          a character either 'true' or 'false'

          CustomFieldTranslation

          -

          Salesforce Documentation for CustomFieldTranslation

          +
          caseValues

          a ObjectNameCaseValue

          gender

          a Gender - which is a character taking one of the following values:

            @@ -1914,7 +1914,7 @@

            Details

          CustomLabel

          -

          Salesforce Documentation for CustomLabel

          +
          fullName

          a character (inherited from Metadata)

          categories

          a character

          language

          a character

          @@ -1925,21 +1925,21 @@

          Details

          CustomLabels

          -

          Salesforce Documentation for CustomLabels

          +
          fullName

          a character (inherited from Metadata)

          labels

          a CustomLabel

          CustomLabelTranslation

          -

          Salesforce Documentation for CustomLabelTranslation

          +
          label

          a character

          name

          a character

          CustomMetadata

          -

          Salesforce Documentation for CustomMetadata

          +
          fullName

          a character (inherited from Metadata)

          description

          a character

          label

          a character

          @@ -1949,14 +1949,14 @@

          Details

          CustomMetadataValue

          -

          Salesforce Documentation for CustomMetadataValue

          +
          field

          a character

          value

          a character that appears similar to any of the other accepted types (integer, numeric, date, datetime, boolean)

          CustomNotificationType

          -

          Salesforce Documentation for CustomNotificationType

          +
          fullName

          a character (inherited from Metadata)

          customNotifTypeName

          a character

          description

          a character

          @@ -1968,7 +1968,7 @@

          Details

          CustomObject

          -

          Salesforce Documentation for CustomObject

          +
          fullName

          a character (inherited from Metadata)

          actionOverrides

          a ActionOverride

          allowInChatterGroups

          a character either 'true' or 'false'

          @@ -2070,7 +2070,7 @@

          Details

          CustomObjectTranslation

          -

          Salesforce Documentation for CustomObjectTranslation

          +
          fullName

          a character (inherited from Metadata)

          caseValues

          a ObjectNameCaseValue

          fieldSets

          a FieldSetTranslation

          @@ -2101,7 +2101,7 @@

          Details

          CustomPageWebLink

          -

          Salesforce Documentation for CustomPageWebLink

          +
          fullName

          a character (inherited from Metadata)

          availability

          a WebLinkAvailability - which is a character taking one of the following values:

            @@ -2131,7 +2131,7 @@

            Details
            hasMenubar

            a character either 'true' or 'false'

            hasScrollbars

            a character either 'true' or 'false'

            hasToolbar

            a character either 'true' or 'false'

            -
            height

            a integer

            +
            height

            an integer

            isResizable

            a character either 'true' or 'false'

            linkType

            a WebLinkType - which is a character taking one of the following values:

              @@ -2163,19 +2163,19 @@

              Details
              showsLocation

              a character either 'true' or 'false'

              showsStatus

              a character either 'true' or 'false'

              url

              a character

              -
              width

              a integer

              +
              width

              an integer

          CustomPageWebLinkTranslation

          -

          Salesforce Documentation for CustomPageWebLinkTranslation

          +
          label

          a character

          name

          a character

          CustomPermission

          -

          Salesforce Documentation for CustomPermission

          +
          fullName

          a character (inherited from Metadata)

          connectedApp

          a character

          description

          a character

          @@ -2185,14 +2185,14 @@

          Details

          CustomPermissionDependencyRequired

          -

          Salesforce Documentation for CustomPermissionDependencyRequired

          +
          customPermission

          a character

          dependency

          a character either 'true' or 'false'

          CustomShortcut

          -

          Salesforce Documentation for CustomShortcut

          +
          action

          a character (inherited from DefaultShortcut)

          active

          a character either 'true' or 'false' (inherited from DefaultShortcut)

          keyCommand

          a character (inherited from DefaultShortcut)

          @@ -2202,7 +2202,7 @@

          Details

          CustomSite

          -

          Salesforce Documentation for CustomSite

          +
          fullName

          a character (inherited from Metadata)

          active

          a character either 'true' or 'false'

          allowHomePage

          a character either 'true' or 'false'

          @@ -2264,14 +2264,14 @@

          Details

          CustomTab

          -

          Salesforce Documentation for CustomTab

          +
          fullName

          a character (inherited from Metadata)

          actionOverrides

          a ActionOverride

          auraComponent

          a character

          customObject

          a character either 'true' or 'false'

          description

          a character

          flexiPage

          a character

          -
          frameHeight

          a integer

          +
          frameHeight

          an integer

          hasSidebar

          a character either 'true' or 'false'

          icon

          a character

          label

          a character

          @@ -2298,14 +2298,14 @@

          Details

          CustomTabTranslation

          -

          Salesforce Documentation for CustomTabTranslation

          +
          label

          a character

          name

          a character

          CustomValue

          -

          Salesforce Documentation for CustomValue

          +
          fullName

          a character (inherited from Metadata)

          color

          a character

          default

          a character either 'true' or 'false'

          @@ -2316,7 +2316,7 @@

          Details

          Dashboard

          -

          Salesforce Documentation for Dashboard

          +
          fullName

          a character (inherited from Metadata)

          backgroundEndColor

          a character

          backgroundFadeDirection

          a ChartBackgroundDirection - which is a character taking one of the following values: @@ -2391,18 +2391,18 @@

          Details
          isGridLayout

          a character either 'true' or 'false'

          leftSection

          a DashboardComponentSection

          middleSection

          a DashboardComponentSection

          -
          numSubscriptions

          a integer

          +
          numSubscriptions

          an integer

          rightSection

          a DashboardComponentSection

          runningUser

          a character

          textColor

          a character

          title

          a character

          titleColor

          a character

          -
          titleSize

          a integer

          +
          titleSize

          an integer

          DashboardComponent

          -

          Salesforce Documentation for DashboardComponent

          +
          autoselectColumnsFromReport

          a character either 'true' or 'false'

          chartAxisRange

          a ChartRangeType - which is a character taking one of the following values:

            @@ -2481,13 +2481,13 @@

            Details
          • Bottom

          • OnChart

          -
          maxValuesDisplayed

          a integer

          +
          maxValuesDisplayed

          an integer

          metricLabel

          a character

          page

          a character

          -
          pageHeightInPixels

          a integer

          +
          pageHeightInPixels

          an integer

          report

          a character

          scontrol

          a character

          -
          scontrolHeightInPixels

          a integer

          +
          scontrolHeightInPixels

          an integer

          showPercentage

          a character either 'true' or 'false'

          showPicturesOnCharts

          a character either 'true' or 'false'

          showPicturesOnTables

          a character either 'true' or 'false'

          @@ -2507,13 +2507,13 @@

          Details

          DashboardComponentColumn

          -

          Salesforce Documentation for DashboardComponentColumn

          +
          breakPoint1

          a numeric

          breakPoint2

          a numeric

          -
          breakPointOrder

          a integer

          -
          highRangeColor

          a integer

          -
          lowRangeColor

          a integer

          -
          midRangeColor

          a integer

          +
          breakPointOrder

          an integer

          +
          highRangeColor

          an integer

          +
          lowRangeColor

          an integer

          +
          midRangeColor

          an integer

          reportColumn

          a character

          showTotal

          a character either 'true' or 'false'

          type

          a DashboardComponentColumnType - which is a character taking one of the following values: @@ -2524,7 +2524,7 @@

          Details

          DashboardComponentSection

          -

          Salesforce Documentation for DashboardComponentSection

          +
          columnSize

          a DashboardComponentSize - which is a character taking one of the following values:

          • Narrow

          • @@ -2536,27 +2536,27 @@

            Details

          DashboardComponentSortInfo

          -

          Salesforce Documentation for DashboardComponentSortInfo

          +
          sortColumn

          a character

          sortOrder

          a character

          DashboardFilter

          -

          Salesforce Documentation for DashboardFilter

          +
          dashboardFilterOptions

          a DashboardFilterOption

          name

          a character

          DashboardFilterColumn

          -

          Salesforce Documentation for DashboardFilterColumn

          +
          column

          a character

          DashboardFilterOption

          -

          Salesforce Documentation for DashboardFilterOption

          +
          operator

          a DashboardFilterOperation - which is a character taking one of the following values:

          • equals

          • @@ -2577,7 +2577,7 @@

            Details

          DashboardFlexTableComponentProperties

          -

          Salesforce Documentation for DashboardFlexTableComponentProperties

          +
          flexTableColumn

          a DashboardComponentColumn

          flexTableSortInfo

          a DashboardComponentSortInfo

          hideChatterPhotos

          a character either 'true' or 'false'

          @@ -2585,7 +2585,7 @@

          Details

          DashboardFolder

          -

          Salesforce Documentation for DashboardFolder

          +
          accessType

          a FolderAccessTypes (inherited from Folder)

          folderShares

          a FolderShare (inherited from Folder)

          name

          a character (inherited from Folder)

          @@ -2595,31 +2595,31 @@

          Details

          DashboardGridComponent

          -

          Salesforce Documentation for DashboardGridComponent

          -
          colSpan

          a integer

          -
          columnIndex

          a integer

          +
          +
          colSpan

          an integer

          +
          columnIndex

          an integer

          dashboardComponent

          a DashboardComponent

          -
          rowIndex

          a integer

          -
          rowSpan

          a integer

          +
          rowIndex

          an integer

          +
          rowSpan

          an integer

          DashboardGridLayout

          -

          Salesforce Documentation for DashboardGridLayout

          +
          dashboardGridComponents

          a DashboardGridComponent

          -
          numberOfColumns

          a integer

          -
          rowHeight

          a integer

          +
          numberOfColumns

          an integer

          +
          rowHeight

          an integer

          DashboardMobileSettings

          -

          Salesforce Documentation for DashboardMobileSettings

          +
          enableDashboardIPadApp

          a character either 'true' or 'false'

          DashboardTableColumn

          -

          Salesforce Documentation for DashboardTableColumn

          +
          aggregateType

          a ReportSummaryType - which is a character taking one of the following values:

          • Sum

          • @@ -2630,7 +2630,7 @@

            Details

          calculatePercent

          a character either 'true' or 'false'

          column

          a character

          -
          decimalPlaces

          a integer

          +
          decimalPlaces

          an integer

          showTotal

          a character either 'true' or 'false'

          sortBy

          a DashboardComponentFilter - which is a character taking one of the following values:

            @@ -2643,7 +2643,7 @@

            Details

          DataCategory

          -

          Salesforce Documentation for DataCategory

          +
          dataCategory

          a DataCategory

          label

          a character

          name

          a character

          @@ -2651,7 +2651,7 @@

          Details

          DataCategoryGroup

          -

          Salesforce Documentation for DataCategoryGroup

          +
          fullName

          a character (inherited from Metadata)

          active

          a character either 'true' or 'false'

          dataCategory

          a DataCategory

          @@ -2662,8 +2662,8 @@

          Details

          DataPipeline

          -

          Salesforce Documentation for DataPipeline

          -
          content

          a character formed using RCurl::base64Encode (inherited from MetadataWithContent)

          +
          +
          content

          a character formed using base64encode (inherited from MetadataWithContent)

          apiVersion

          a numeric

          label

          a character

          scriptType

          a DataPipelineType - which is a character taking one of the following values: @@ -2674,7 +2674,7 @@

          Details

          DefaultShortcut

          -

          Salesforce Documentation for DefaultShortcut

          +
          action

          a character

          active

          a character either 'true' or 'false'

          keyCommand

          a character

          @@ -2682,7 +2682,7 @@

          Details

          DelegateGroup

          -

          Salesforce Documentation for DelegateGroup

          +
          fullName

          a character (inherited from Metadata)

          customObjects

          a character

          groups

          a character

          @@ -2695,7 +2695,7 @@

          Details

          DeployDetails

          -

          Salesforce Documentation for DeployDetails

          +
          componentFailures

          a DeployMessage

          componentSuccesses

          a DeployMessage

          retrieveResult

          a RetrieveResult

          @@ -2704,7 +2704,7 @@

          Details

          DeployOptions

          -

          Salesforce Documentation for DeployOptions

          +
          allowMissingFiles

          a character either 'true' or 'false'

          autoUpdatePackage

          a character either 'true' or 'false'

          checkOnly

          a character either 'true' or 'false'

          @@ -2725,7 +2725,7 @@

          Details

          DescribeMetadataObject

          -

          Salesforce Documentation for DescribeMetadataObject

          +
          childXmlNames

          a character

          directoryName

          a character

          inFolder

          a character either 'true' or 'false'

          @@ -2736,8 +2736,8 @@

          Details

          Document

          -

          Salesforce Documentation for Document

          -
          content

          a character formed using RCurl::base64Encode (inherited from MetadataWithContent)

          +
          +
          content

          a character formed using base64encode (inherited from MetadataWithContent)

          description

          a character

          internalUseOnly

          a character either 'true' or 'false'

          keywords

          a character

          @@ -2747,7 +2747,7 @@

          Details

          DocumentFolder

          -

          Salesforce Documentation for DocumentFolder

          +
          accessType

          a FolderAccessTypes (inherited from Folder)

          folderShares

          a FolderShare (inherited from Folder)

          name

          a character (inherited from Folder)

          @@ -2757,7 +2757,7 @@

          Details

          DuplicateRule

          -

          Salesforce Documentation for DuplicateRule

          +
          fullName

          a character (inherited from Metadata)

          actionOnInsert

          a DupeActionType - which is a character taking one of the following values:

            @@ -2782,30 +2782,30 @@

            Details
          • EnforceSharingRules

          • BypassSharingRules

          -
          sortOrder

          a integer

          +
          sortOrder

          an integer

          DuplicateRuleFilter

          -

          Salesforce Documentation for DuplicateRuleFilter

          +
          booleanFilter

          a character

          duplicateRuleFilterItems

          a DuplicateRuleFilterItem

          DuplicateRuleFilterItem

          -

          Salesforce Documentation for DuplicateRuleFilterItem

          +
          field

          a character (inherited from FilterItem)

          operation

          a FilterOperation (inherited from FilterItem)

          value

          a character (inherited from FilterItem)

          valueField

          a character (inherited from FilterItem)

          -
          sortOrder

          a integer

          +
          sortOrder

          an integer

          table

          a character

          DuplicateRuleMatchRule

          -

          Salesforce Documentation for DuplicateRuleMatchRule

          +
          matchRuleSObjectType

          a character

          matchingRule

          a character

          objectMapping

          a ObjectMapping

          @@ -2813,15 +2813,15 @@

          Details

          EclairGeoData

          -

          Salesforce Documentation for EclairGeoData

          -
          content

          a character formed using RCurl::base64Encode (inherited from MetadataWithContent)

          +
          +
          content

          a character formed using base64encode (inherited from MetadataWithContent)

          maps

          a EclairMap

          masterLabel

          a character

          EclairMap

          -

          Salesforce Documentation for EclairMap

          +
          boundingBoxBottom

          a numeric

          boundingBoxLeft

          a numeric

          boundingBoxRight

          a numeric

          @@ -2833,7 +2833,7 @@

          Details

          EmailFolder

          -

          Salesforce Documentation for EmailFolder

          +
          accessType

          a FolderAccessTypes (inherited from Folder)

          folderShares

          a FolderShare (inherited from Folder)

          name

          a character (inherited from Folder)

          @@ -2843,7 +2843,7 @@

          Details

          EmailServicesAddress

          -

          Salesforce Documentation for EmailServicesAddress

          +
          authorizedSenders

          a character

          developerName

          a character

          isActive

          a character either 'true' or 'false'

          @@ -2853,7 +2853,7 @@

          Details

          EmailServicesFunction

          -

          Salesforce Documentation for EmailServicesFunction

          +
          fullName

          a character (inherited from Metadata)

          apexClass

          a character

          attachmentOption

          a EmailServicesAttOptions - which is a character taking one of the following values: @@ -2905,8 +2905,8 @@

          Details

          EmailTemplate

          -

          Salesforce Documentation for EmailTemplate

          -
          content

          a character formed using RCurl::base64Encode (inherited from MetadataWithContent)

          +
          +
          content

          a character formed using base64encode (inherited from MetadataWithContent)

          apiVersion

          a numeric

          attachedDocuments

          a character

          attachments

          a Attachment

          @@ -2958,7 +2958,7 @@

          Details

          EmailToCaseRoutingAddress

          -

          Salesforce Documentation for EmailToCaseRoutingAddress

          +
          addressType

          a EmailToCaseRoutingAddressType - which is a character taking one of the following values:

          • EmailToCase

          • @@ -2980,7 +2980,7 @@

            Details

          EmailToCaseSettings

          -

          Salesforce Documentation for EmailToCaseSettings

          +
          enableE2CSourceTracking

          a character either 'true' or 'false'

          enableEmailToCase

          a character either 'true' or 'false'

          enableHtmlEmail

          a character either 'true' or 'false'

          @@ -3006,7 +3006,7 @@

          Details

          EmbeddedServiceBranding

          -

          Salesforce Documentation for EmbeddedServiceBranding

          +
          fullName

          a character (inherited from Metadata)

          contrastInvertedColor

          a character

          contrastPrimaryColor

          a character

          @@ -3020,7 +3020,7 @@

          Details

          EmbeddedServiceConfig

          -

          Salesforce Documentation for EmbeddedServiceConfig

          +
          fullName

          a character (inherited from Metadata)

          masterLabel

          a character

          site

          a character

          @@ -3028,7 +3028,7 @@

          Details

          EmbeddedServiceFieldService

          -

          Salesforce Documentation for EmbeddedServiceFieldService

          +
          fullName

          a character (inherited from Metadata)

          appointmentBookingFlowName

          a character

          cancelApptBookingFlowName

          a character

          @@ -3045,7 +3045,7 @@

          Details

          EmbeddedServiceLiveAgent

          -

          Salesforce Documentation for EmbeddedServiceLiveAgent

          +
          fullName

          a character (inherited from Metadata)

          avatarImg

          a character

          customPrechatComponent

          a character

          @@ -3079,15 +3079,15 @@

          Details

          EmbeddedServiceQuickAction

          -

          Salesforce Documentation for EmbeddedServiceQuickAction

          +
          embeddedServiceLiveAgent

          a character

          -
          order

          a integer

          +
          order

          an integer

          quickActionDefinition

          a character

          EntitlementProcess

          -

          Salesforce Documentation for EntitlementProcess

          +
          fullName

          a character (inherited from Metadata)

          SObjectType

          a character

          active

          a character either 'true' or 'false'

          @@ -3104,19 +3104,19 @@

          Details
          recordType

          a character

          versionMaster

          a character

          versionNotes

          a character

          -
          versionNumber

          a integer

          +
          versionNumber

          an integer

          EntitlementProcessMilestoneItem

          -

          Salesforce Documentation for EntitlementProcessMilestoneItem

          +
          businessHours

          a character

          criteriaBooleanFilter

          a character

          milestoneCriteriaFilterItems

          a FilterItem

          milestoneCriteriaFormula

          a character

          milestoneName

          a character

          minutesCustomClass

          a character

          -
          minutesToComplete

          a integer

          +
          minutesToComplete

          an integer

          successActions

          a WorkflowActionReference

          timeTriggers

          a EntitlementProcessMilestoneTimeTrigger

          useCriteriaStartTime

          a character either 'true' or 'false'

          @@ -3124,9 +3124,9 @@

          Details

          EntitlementProcessMilestoneTimeTrigger

          -

          Salesforce Documentation for EntitlementProcessMilestoneTimeTrigger

          +
          actions

          a WorkflowActionReference

          -
          timeLength

          a integer

          +
          timeLength

          an integer

          workflowTimeTriggerUnit

          a MilestoneTimeUnits - which is a character taking one of the following values:

          • Minutes

          • @@ -3137,7 +3137,7 @@

            Details

          EntitlementSettings

          -

          Salesforce Documentation for EntitlementSettings

          +
          fullName

          a character (inherited from Metadata)

          assetLookupLimitedToActiveEntitlementsOnAccount

          a character either 'true' or 'false'

          assetLookupLimitedToActiveEntitlementsOnContact

          a character either 'true' or 'false'

          @@ -3153,19 +3153,19 @@

          Details

          EntitlementTemplate

          -

          Salesforce Documentation for EntitlementTemplate

          +
          fullName

          a character (inherited from Metadata)

          businessHours

          a character

          -
          casesPerEntitlement

          a integer

          +
          casesPerEntitlement

          an integer

          entitlementProcess

          a character

          isPerIncident

          a character either 'true' or 'false'

          -
          term

          a integer

          +
          term

          an integer

          type

          a character

          EscalationAction

          -

          Salesforce Documentation for EscalationAction

          +
          assignedTo

          a character

          assignedToTemplate

          a character

          assignedToType

          a AssignToLookupValueType - which is a character taking one of the following values: @@ -3173,7 +3173,7 @@

          Details
        • User

        • Queue

        • -
          minutesToEscalation

          a integer

          +
          minutesToEscalation

          an integer

          notifyCaseOwner

          a character either 'true' or 'false'

          notifyEmail

          a character

          notifyTo

          a character

          @@ -3182,7 +3182,7 @@

          Details

          EscalationRule

          -

          Salesforce Documentation for EscalationRule

          +
          fullName

          a character (inherited from Metadata)

          active

          a character either 'true' or 'false'

          ruleEntry

          a RuleEntry

          @@ -3190,14 +3190,14 @@

          Details

          EscalationRules

          -

          Salesforce Documentation for EscalationRules

          +
          fullName

          a character (inherited from Metadata)

          escalationRule

          a EscalationRule

          EventDelivery

          -

          Salesforce Documentation for EventDelivery

          +
          fullName

          a character (inherited from Metadata)

          eventParameters

          a EventParameterMap

          eventSubscription

          a character

          @@ -3211,14 +3211,14 @@

          Details

          EventParameterMap

          -

          Salesforce Documentation for EventParameterMap

          +
          parameterName

          a character

          parameterValue

          a character

          EventSubscription

          -

          Salesforce Documentation for EventSubscription

          +
          fullName

          a character (inherited from Metadata)

          active

          a character either 'true' or 'false'

          eventParameters

          a EventParameterMap

          @@ -3228,7 +3228,7 @@

          Details

          ExtendedErrorDetails

          -

          Salesforce Documentation for ExtendedErrorDetails

          +
          extendedErrorCode

          a ExtendedErrorCode - which is a character taking one of the following values:

          • ACTIONCALL_DUPLICATE_INPUT_PARAM - Errors with this extended error code have the following properties: @@ -3746,7 +3746,7 @@

            Details

          ExternalDataSource

          -

          Salesforce Documentation for ExternalDataSource

          +
          fullName

          a character (inherited from Metadata)

          authProvider

          a character

          certificate

          a character

          @@ -3791,7 +3791,7 @@

          Details

          ExternalServiceRegistration

          -

          Salesforce Documentation for ExternalServiceRegistration

          +
          fullName

          a character (inherited from Metadata)

          description

          a character

          label

          a character

          @@ -3804,7 +3804,7 @@

          Details

          FeedFilterCriterion

          -

          Salesforce Documentation for FeedFilterCriterion

          +
          feedItemType

          a FeedItemType - which is a character taking one of the following values:

          • TrackedChange

          • @@ -3847,8 +3847,8 @@

            Details

          FeedItemSettings

          -

          Salesforce Documentation for FeedItemSettings

          -
          characterLimit

          a integer

          +
          +
          characterLimit

          an integer

          collapseThread

          a character either 'true' or 'false'

          displayFormat

          a FeedItemDisplayFormat - which is a character taking one of the following values:

            @@ -3891,7 +3891,7 @@

            Details

          FeedLayout

          -

          Salesforce Documentation for FeedLayout

          +
          autocollapsePublisher

          a character either 'true' or 'false'

          compactFeed

          a character either 'true' or 'false'

          feedFilterPosition

          a FeedLayoutFilterPosition - which is a character taking one of the following values: @@ -3911,7 +3911,7 @@

          Details

          FeedLayoutComponent

          -

          Salesforce Documentation for FeedLayoutComponent

          +
          componentType

          a FeedLayoutComponentType - which is a character taking one of the following values:

          • HelpAndToolLinks

          • @@ -3924,13 +3924,13 @@

            Details
          • CaseUnifiedFiles

          • Visualforce

          -
          height

          a integer

          +
          height

          an integer

          page

          a character

          FeedLayoutFilter

          -

          Salesforce Documentation for FeedLayoutFilter

          +
          feedFilterName

          a character

          feedFilterType

          a FeedLayoutFilterType - which is a character taking one of the following values:

            @@ -3974,7 +3974,7 @@

            Details

          FieldMapping

          -

          Salesforce Documentation for FieldMapping

          +
          SObjectType

          a character

          developerName

          a character

          fieldMappingRows

          a FieldMappingRow

          @@ -3983,15 +3983,15 @@

          Details

          FieldMappingField

          -

          Salesforce Documentation for FieldMappingField

          +
          dataServiceField

          a character

          dataServiceObjectName

          a character

          -
          priority

          a integer

          +
          priority

          an integer

          FieldMappingRow

          -

          Salesforce Documentation for FieldMappingRow

          +
          SObjectType

          a character

          fieldMappingFields

          a FieldMappingField

          fieldName

          a character

          @@ -4004,7 +4004,7 @@

          Details

          FieldOverride

          -

          Salesforce Documentation for FieldOverride

          +
          field

          a character

          formula

          a character

          literalValue

          a character

          @@ -4012,18 +4012,18 @@

          Details

          FieldServiceSettings

          -

          Salesforce Documentation for FieldServiceSettings

          +
          fullName

          a character (inherited from Metadata)

          fieldServiceNotificationsOrgPref

          a character either 'true' or 'false'

          fieldServiceOrgPref

          a character either 'true' or 'false'

          -
          serviceAppointmentsDueDateOffsetOrgValue

          a integer

          +
          serviceAppointmentsDueDateOffsetOrgValue

          an integer

          workOrderLineItemSearchFields

          a character

          workOrderSearchFields

          a character

          FieldSet

          -

          Salesforce Documentation for FieldSet

          +
          fullName

          a character (inherited from Metadata)

          availableFields

          a FieldSetItem

          description

          a character

          @@ -4033,7 +4033,7 @@

          Details

          FieldSetItem

          -

          Salesforce Documentation for FieldSetItem

          +
          field

          a character

          isFieldManaged

          a character either 'true' or 'false'

          isRequired

          a character either 'true' or 'false'

          @@ -4041,21 +4041,21 @@

          Details

          FieldSetTranslation

          -

          Salesforce Documentation for FieldSetTranslation

          +
          label

          a character

          name

          a character

          FieldValue

          -

          Salesforce Documentation for FieldValue

          +
          name

          a character

          value

          a character that appears similar to any of the other accepted types (integer, numeric, date, datetime, boolean)

          FileProperties

          -

          Salesforce Documentation for FileProperties

          +
          createdById

          a character

          createdByName

          a character

          createdDate

          a character formatted as 'yyyy-mm-ddThh:mm:ssZ'

          @@ -4080,7 +4080,7 @@

          Details

          FileTypeDispositionAssignmentBean

          -

          Salesforce Documentation for FileTypeDispositionAssignmentBean

          +
          behavior

          a FileDownloadBehavior - which is a character taking one of the following values:

          • DOWNLOAD

          • @@ -4206,7 +4206,7 @@

            Details

          FileUploadAndDownloadSecuritySettings

          -

          Salesforce Documentation for FileUploadAndDownloadSecuritySettings

          +
          fullName

          a character (inherited from Metadata)

          dispositions

          a FileTypeDispositionAssignmentBean

          noHtmlUploadAsAttachment

          a character either 'true' or 'false'

          @@ -4214,7 +4214,7 @@

          Details

          FilterItem

          -

          Salesforce Documentation for FilterItem

          +
          field

          a character

          operation

          a FilterOperation - which is a character taking one of the following values:

            @@ -4237,21 +4237,21 @@

            Details

          FindSimilarOppFilter

          -

          Salesforce Documentation for FindSimilarOppFilter

          +
          similarOpportunitiesDisplayColumns

          a character

          similarOpportunitiesMatchFields

          a character

          FiscalYearSettings

          -

          Salesforce Documentation for FiscalYearSettings

          +
          fiscalYearNameBasedOn

          a character

          startMonth

          a character

          FlexiPage

          -

          Salesforce Documentation for FlexiPage

          +
          fullName

          a character (inherited from Metadata)

          description

          a character

          flexiPageRegions

          a FlexiPageRegion

          @@ -4286,7 +4286,7 @@

          Details

          FlexiPageRegion

          -

          Salesforce Documentation for FlexiPageRegion

          +
          appendable

          a RegionFlagStatus - which is a character taking one of the following values:

          • disabled

          • @@ -4319,14 +4319,14 @@

            Details

          FlexiPageTemplateInstance

          -

          Salesforce Documentation for FlexiPageTemplateInstance

          +
          name

          a character

          properties

          a ComponentInstanceProperty

          Flow

          -

          Salesforce Documentation for Flow

          +
          fullName

          a character (inherited from Metadata)

          actionCalls

          a FlowActionCall

          apexPluginCalls

          a FlowApexPluginCall

          @@ -4374,10 +4374,10 @@

          Details

          FlowActionCall

          -

          Salesforce Documentation for FlowActionCall

          +
          label

          a character (inherited from FlowNode)

          -
          locationX

          a integer (inherited from FlowNode)

          -
          locationY

          a integer (inherited from FlowNode)

          +
          locationX

          an integer (inherited from FlowNode)

          +
          locationY

          an integer (inherited from FlowNode)

          actionName

          a character

          actionType

          a InvocableActionType - which is a character taking one of the following values:

            @@ -4412,7 +4412,7 @@

            Details

          FlowActionCallInputParameter

          -

          Salesforce Documentation for FlowActionCallInputParameter

          +
          processMetadataValues

          a FlowMetadataValue (inherited from FlowBaseElement)

          name

          a character

          value

          a FlowElementReferenceOrValue

          @@ -4420,7 +4420,7 @@

          Details

          FlowActionCallOutputParameter

          -

          Salesforce Documentation for FlowActionCallOutputParameter

          +
          processMetadataValues

          a FlowMetadataValue (inherited from FlowBaseElement)

          assignToReference

          a character

          name

          a character

          @@ -4428,10 +4428,10 @@

          Details

          FlowApexPluginCall

          -

          Salesforce Documentation for FlowApexPluginCall

          +
          label

          a character (inherited from FlowNode)

          -
          locationX

          a integer (inherited from FlowNode)

          -
          locationY

          a integer (inherited from FlowNode)

          +
          locationX

          an integer (inherited from FlowNode)

          +
          locationY

          an integer (inherited from FlowNode)

          apexClass

          a character

          connector

          a FlowConnector

          faultConnector

          a FlowConnector

          @@ -4441,7 +4441,7 @@

          Details

          FlowApexPluginCallInputParameter

          -

          Salesforce Documentation for FlowApexPluginCallInputParameter

          +
          processMetadataValues

          a FlowMetadataValue (inherited from FlowBaseElement)

          name

          a character

          value

          a FlowElementReferenceOrValue

          @@ -4449,7 +4449,7 @@

          Details

          FlowApexPluginCallOutputParameter

          -

          Salesforce Documentation for FlowApexPluginCallOutputParameter

          +
          processMetadataValues

          a FlowMetadataValue (inherited from FlowBaseElement)

          assignToReference

          a character

          name

          a character

          @@ -4457,17 +4457,17 @@

          Details

          FlowAssignment

          -

          Salesforce Documentation for FlowAssignment

          +
          label

          a character (inherited from FlowNode)

          -
          locationX

          a integer (inherited from FlowNode)

          -
          locationY

          a integer (inherited from FlowNode)

          +
          locationX

          an integer (inherited from FlowNode)

          +
          locationY

          an integer (inherited from FlowNode)

          assignmentItems

          a FlowAssignmentItem

          connector

          a FlowConnector

          FlowAssignmentItem

          -

          Salesforce Documentation for FlowAssignmentItem

          +
          processMetadataValues

          a FlowMetadataValue (inherited from FlowBaseElement)

          assignToReference

          a character

          operator

          a FlowAssignmentOperator - which is a character taking one of the following values: @@ -4482,13 +4482,13 @@

          Details

          FlowBaseElement

          -

          Salesforce Documentation for FlowBaseElement

          +
          processMetadataValues

          a FlowMetadataValue

          FlowCategory

          -

          Salesforce Documentation for FlowCategory

          +
          fullName

          a character (inherited from Metadata)

          description

          a character

          flowCategoryItems

          a FlowCategoryItems

          @@ -4497,13 +4497,13 @@

          Details

          FlowCategoryItems

          -

          Salesforce Documentation for FlowCategoryItems

          +
          flow

          a character

          FlowChoice

          -

          Salesforce Documentation for FlowChoice

          +
          description

          a character (inherited from FlowElement)

          name

          a character (inherited from FlowElement)

          choiceText

          a character

          @@ -4525,7 +4525,7 @@

          Details

          FlowChoiceTranslation

          -

          Salesforce Documentation for FlowChoiceTranslation

          +
          choiceText

          a character

          name

          a character

          userInput

          a FlowChoiceUserInputTranslation

          @@ -4533,7 +4533,7 @@

          Details

          FlowChoiceUserInput

          -

          Salesforce Documentation for FlowChoiceUserInput

          +
          processMetadataValues

          a FlowMetadataValue (inherited from FlowBaseElement)

          isRequired

          a character either 'true' or 'false'

          promptText

          a character

          @@ -4542,14 +4542,14 @@

          Details

          FlowChoiceUserInputTranslation

          -

          Salesforce Documentation for FlowChoiceUserInputTranslation

          +
          promptText

          a character

          validationRule

          a FlowInputValidationRuleTranslation

          FlowCondition

          -

          Salesforce Documentation for FlowCondition

          +
          processMetadataValues

          a FlowMetadataValue (inherited from FlowBaseElement)

          leftValueReference

          a character

          operator

          a FlowComparisonOperator - which is a character taking one of the following values: @@ -4573,14 +4573,14 @@

          Details

          FlowConnector

          -

          Salesforce Documentation for FlowConnector

          +
          processMetadataValues

          a FlowMetadataValue (inherited from FlowBaseElement)

          targetReference

          a character

          FlowConstant

          -

          Salesforce Documentation for FlowConstant

          +
          description

          a character (inherited from FlowElement)

          name

          a character (inherited from FlowElement)

          dataType

          a FlowDataType - which is a character taking one of the following values: @@ -4600,10 +4600,10 @@

          Details

          FlowDecision

          -

          Salesforce Documentation for FlowDecision

          +
          label

          a character (inherited from FlowNode)

          -
          locationX

          a integer (inherited from FlowNode)

          -
          locationY

          a integer (inherited from FlowNode)

          +
          locationX

          an integer (inherited from FlowNode)

          +
          locationY

          an integer (inherited from FlowNode)

          defaultConnector

          a FlowConnector

          defaultConnectorLabel

          a character

          rules

          a FlowRule

          @@ -4611,16 +4611,16 @@

          Details

          FlowDefinition

          -

          Salesforce Documentation for FlowDefinition

          +
          fullName

          a character (inherited from Metadata)

          -
          activeVersionNumber

          a integer

          +
          activeVersionNumber

          an integer

          description

          a character

          masterLabel

          a character

          FlowDefinitionTranslation

          -

          Salesforce Documentation for FlowDefinitionTranslation

          +
          flows

          a FlowTranslation

          fullName

          a character

          label

          a character

          @@ -4628,7 +4628,7 @@

          Details

          FlowDynamicChoiceSet

          -

          Salesforce Documentation for FlowDynamicChoiceSet

          +
          description

          a character (inherited from FlowElement)

          name

          a character (inherited from FlowElement)

          dataType

          a FlowDataType - which is a character taking one of the following values: @@ -4645,7 +4645,7 @@

          Details

          displayField

          a character

          filters

          a FlowRecordFilter

          -
          limit

          a integer

          +
          limit

          an integer

          object

          a character

          outputAssignments

          a FlowOutputFieldAssignment

          picklistField

          a character

          @@ -4661,7 +4661,7 @@

          Details

          FlowElement

          -

          Salesforce Documentation for FlowElement

          +
          processMetadataValues

          a FlowMetadataValue (inherited from FlowBaseElement)

          description

          a character

          name

          a character

          @@ -4669,7 +4669,7 @@

          Details

          FlowElementReferenceOrValue

          -

          Salesforce Documentation for FlowElementReferenceOrValue

          +
          booleanValue

          a character either 'true' or 'false'

          dateTimeValue

          a character formatted as 'yyyy-mm-ddThh:mm:ssZ'

          dateValue

          a character formatted as 'yyyy-mm-dd'

          @@ -4680,7 +4680,7 @@

          Details

          FlowFormula

          -

          Salesforce Documentation for FlowFormula

          +
          description

          a character (inherited from FlowElement)

          name

          a character (inherited from FlowElement)

          dataType

          a FlowDataType - which is a character taking one of the following values: @@ -4696,12 +4696,12 @@

          Details
        • Multipicklist

        • expression

          a character

          -
          scale

          a integer

          +
          scale

          an integer

          FlowInputFieldAssignment

          -

          Salesforce Documentation for FlowInputFieldAssignment

          +
          processMetadataValues

          a FlowMetadataValue (inherited from FlowBaseElement)

          field

          a character

          value

          a FlowElementReferenceOrValue

          @@ -4709,23 +4709,23 @@

          Details

          FlowInputValidationRule

          -

          Salesforce Documentation for FlowInputValidationRule

          +
          errorMessage

          a character

          formulaExpression

          a character

          FlowInputValidationRuleTranslation

          -

          Salesforce Documentation for FlowInputValidationRuleTranslation

          +
          errorMessage

          a character

          FlowLoop

          -

          Salesforce Documentation for FlowLoop

          +
          label

          a character (inherited from FlowNode)

          -
          locationX

          a integer (inherited from FlowNode)

          -
          locationY

          a integer (inherited from FlowNode)

          +
          locationX

          an integer (inherited from FlowNode)

          +
          locationY

          an integer (inherited from FlowNode)

          assignNextValueToReference

          a character

          collectionReference

          a character

          iterationOrder

          a IterationOrder - which is a character taking one of the following values: @@ -4739,24 +4739,24 @@

          Details

          FlowMetadataValue

          -

          Salesforce Documentation for FlowMetadataValue

          +
          name

          a character

          value

          a FlowElementReferenceOrValue

          FlowNode

          -

          Salesforce Documentation for FlowNode

          +
          description

          a character (inherited from FlowElement)

          name

          a character (inherited from FlowElement)

          label

          a character

          -
          locationX

          a integer

          -
          locationY

          a integer

          +
          locationX

          an integer

          +
          locationY

          an integer

          FlowOutputFieldAssignment

          -

          Salesforce Documentation for FlowOutputFieldAssignment

          +
          processMetadataValues

          a FlowMetadataValue (inherited from FlowBaseElement)

          assignToReference

          a character

          field

          a character

          @@ -4764,10 +4764,10 @@

          Details

          FlowRecordCreate

          -

          Salesforce Documentation for FlowRecordCreate

          +
          label

          a character (inherited from FlowNode)

          -
          locationX

          a integer (inherited from FlowNode)

          -
          locationY

          a integer (inherited from FlowNode)

          +
          locationX

          an integer (inherited from FlowNode)

          +
          locationY

          an integer (inherited from FlowNode)

          assignRecordIdToReference

          a character

          connector

          a FlowConnector

          faultConnector

          a FlowConnector

          @@ -4778,10 +4778,10 @@

          Details

          FlowRecordDelete

          -

          Salesforce Documentation for FlowRecordDelete

          +
          label

          a character (inherited from FlowNode)

          -
          locationX

          a integer (inherited from FlowNode)

          -
          locationY

          a integer (inherited from FlowNode)

          +
          locationX

          an integer (inherited from FlowNode)

          +
          locationY

          an integer (inherited from FlowNode)

          connector

          a FlowConnector

          faultConnector

          a FlowConnector

          filters

          a FlowRecordFilter

          @@ -4791,7 +4791,7 @@

          Details

          FlowRecordFilter

          -

          Salesforce Documentation for FlowRecordFilter

          +
          processMetadataValues

          a FlowMetadataValue (inherited from FlowBaseElement)

          field

          a character

          operator

          a FlowRecordFilterOperator - which is a character taking one of the following values: @@ -4812,10 +4812,10 @@

          Details

          FlowRecordLookup

          -

          Salesforce Documentation for FlowRecordLookup

          +
          label

          a character (inherited from FlowNode)

          -
          locationX

          a integer (inherited from FlowNode)

          -
          locationY

          a integer (inherited from FlowNode)

          +
          locationX

          an integer (inherited from FlowNode)

          +
          locationY

          an integer (inherited from FlowNode)

          assignNullValuesIfNoRecordsFound

          a character either 'true' or 'false'

          connector

          a FlowConnector

          faultConnector

          a FlowConnector

          @@ -4834,10 +4834,10 @@

          Details

          FlowRecordUpdate

          -

          Salesforce Documentation for FlowRecordUpdate

          +
          label

          a character (inherited from FlowNode)

          -
          locationX

          a integer (inherited from FlowNode)

          -
          locationY

          a integer (inherited from FlowNode)

          +
          locationX

          an integer (inherited from FlowNode)

          +
          locationY

          an integer (inherited from FlowNode)

          connector

          a FlowConnector

          faultConnector

          a FlowConnector

          filters

          a FlowRecordFilter

          @@ -4848,7 +4848,7 @@

          Details

          FlowRule

          -

          Salesforce Documentation for FlowRule

          +
          description

          a character (inherited from FlowElement)

          name

          a character (inherited from FlowElement)

          conditionLogic

          a character

          @@ -4859,10 +4859,10 @@

          Details

          FlowScreen

          -

          Salesforce Documentation for FlowScreen

          +
          label

          a character (inherited from FlowNode)

          -
          locationX

          a integer (inherited from FlowNode)

          -
          locationY

          a integer (inherited from FlowNode)

          +
          locationX

          an integer (inherited from FlowNode)

          +
          locationY

          an integer (inherited from FlowNode)

          allowBack

          a character either 'true' or 'false'

          allowFinish

          a character either 'true' or 'false'

          allowPause

          a character either 'true' or 'false'

          @@ -4877,7 +4877,7 @@

          Details

          FlowScreenField

          -

          Salesforce Documentation for FlowScreenField

          +
          description

          a character (inherited from FlowElement)

          name

          a character (inherited from FlowElement)

          choiceReferences

          a character

          @@ -4914,13 +4914,13 @@

          Details
          isRequired

          a character either 'true' or 'false'

          isVisible

          a character either 'true' or 'false'

          outputParameters

          a FlowScreenFieldOutputParameter

          -
          scale

          a integer

          +
          scale

          an integer

          validationRule

          a FlowInputValidationRule

          FlowScreenFieldInputParameter

          -

          Salesforce Documentation for FlowScreenFieldInputParameter

          +
          processMetadataValues

          a FlowMetadataValue (inherited from FlowBaseElement)

          name

          a character

          value

          a FlowElementReferenceOrValue

          @@ -4928,7 +4928,7 @@

          Details

          FlowScreenFieldOutputParameter

          -

          Salesforce Documentation for FlowScreenFieldOutputParameter

          +
          processMetadataValues

          a FlowMetadataValue (inherited from FlowBaseElement)

          assignToReference

          a character

          name

          a character

          @@ -4936,7 +4936,7 @@

          Details

          FlowScreenFieldTranslation

          -

          Salesforce Documentation for FlowScreenFieldTranslation

          +
          fieldText

          a character

          helpText

          a character

          name

          a character

          @@ -4945,7 +4945,7 @@

          Details

          FlowScreenRule

          -

          Salesforce Documentation for FlowScreenRule

          +
          processMetadataValues

          a FlowMetadataValue (inherited from FlowBaseElement)

          conditionLogic

          a character

          conditions

          a FlowCondition

          @@ -4955,7 +4955,7 @@

          Details

          FlowScreenRuleAction

          -

          Salesforce Documentation for FlowScreenRuleAction

          +
          processMetadataValues

          a FlowMetadataValue (inherited from FlowBaseElement)

          attribute

          a character

          fieldReference

          a character

          @@ -4964,7 +4964,7 @@

          Details

          FlowScreenTranslation

          -

          Salesforce Documentation for FlowScreenTranslation

          +
          fields

          a FlowScreenFieldTranslation

          helpText

          a character

          name

          a character

          @@ -4973,29 +4973,29 @@

          Details

          FlowStage

          -

          Salesforce Documentation for FlowStage

          +
          description

          a character (inherited from FlowElement)

          name

          a character (inherited from FlowElement)

          isActive

          a character either 'true' or 'false'

          label

          a character

          -
          stageOrder

          a integer

          +
          stageOrder

          an integer

          FlowStep

          -

          Salesforce Documentation for FlowStep

          +
          label

          a character (inherited from FlowNode)

          -
          locationX

          a integer (inherited from FlowNode)

          -
          locationY

          a integer (inherited from FlowNode)

          +
          locationX

          an integer (inherited from FlowNode)

          +
          locationY

          an integer (inherited from FlowNode)

          connectors

          a FlowConnector

          FlowSubflow

          -

          Salesforce Documentation for FlowSubflow

          +
          label

          a character (inherited from FlowNode)

          -
          locationX

          a integer (inherited from FlowNode)

          -
          locationY

          a integer (inherited from FlowNode)

          +
          locationX

          an integer (inherited from FlowNode)

          +
          locationY

          an integer (inherited from FlowNode)

          connector

          a FlowConnector

          flowName

          a character

          inputAssignments

          a FlowSubflowInputAssignment

          @@ -5004,7 +5004,7 @@

          Details

          FlowSubflowInputAssignment

          -

          Salesforce Documentation for FlowSubflowInputAssignment

          +
          processMetadataValues

          a FlowMetadataValue (inherited from FlowBaseElement)

          name

          a character

          value

          a FlowElementReferenceOrValue

          @@ -5012,7 +5012,7 @@

          Details

          FlowSubflowOutputAssignment

          -

          Salesforce Documentation for FlowSubflowOutputAssignment

          +
          processMetadataValues

          a FlowMetadataValue (inherited from FlowBaseElement)

          assignToReference

          a character

          name

          a character

          @@ -5020,7 +5020,7 @@

          Details

          FlowTextTemplate

          -

          Salesforce Documentation for FlowTextTemplate

          +
          description

          a character (inherited from FlowElement)

          name

          a character (inherited from FlowElement)

          text

          a character

          @@ -5028,7 +5028,7 @@

          Details

          FlowTranslation

          -

          Salesforce Documentation for FlowTranslation

          +
          choices

          a FlowChoiceTranslation

          fullName

          a character

          label

          a character

          @@ -5037,7 +5037,7 @@

          Details

          FlowVariable

          -

          Salesforce Documentation for FlowVariable

          +
          description

          a character (inherited from FlowElement)

          name

          a character (inherited from FlowElement)

          dataType

          a FlowDataType - which is a character taking one of the following values: @@ -5056,16 +5056,16 @@

          Details
          isInput

          a character either 'true' or 'false'

          isOutput

          a character either 'true' or 'false'

          objectType

          a character

          -
          scale

          a integer

          +
          scale

          an integer

          value

          a FlowElementReferenceOrValue

          FlowWait

          -

          Salesforce Documentation for FlowWait

          +
          label

          a character (inherited from FlowNode)

          -
          locationX

          a integer (inherited from FlowNode)

          -
          locationY

          a integer (inherited from FlowNode)

          +
          locationX

          an integer (inherited from FlowNode)

          +
          locationY

          an integer (inherited from FlowNode)

          defaultConnector

          a FlowConnector

          defaultConnectorLabel

          a character

          faultConnector

          a FlowConnector

          @@ -5074,7 +5074,7 @@

          Details

          FlowWaitEvent

          -

          Salesforce Documentation for FlowWaitEvent

          +
          description

          a character (inherited from FlowElement)

          name

          a character (inherited from FlowElement)

          conditionLogic

          a character

          @@ -5088,7 +5088,7 @@

          Details

          FlowWaitEventInputParameter

          -

          Salesforce Documentation for FlowWaitEventInputParameter

          +
          processMetadataValues

          a FlowMetadataValue (inherited from FlowBaseElement)

          name

          a character

          value

          a FlowElementReferenceOrValue

          @@ -5096,7 +5096,7 @@

          Details

          FlowWaitEventOutputParameter

          -

          Salesforce Documentation for FlowWaitEventOutputParameter

          +
          processMetadataValues

          a FlowMetadataValue (inherited from FlowBaseElement)

          assignToReference

          a character

          name

          a character

          @@ -5104,7 +5104,7 @@

          Details

          Folder

          -

          Salesforce Documentation for Folder

          +
          fullName

          a character (inherited from Metadata)

          accessType

          a FolderAccessTypes - which is a character taking one of the following values:

            @@ -5125,7 +5125,7 @@

            Details

          FolderShare

          -

          Salesforce Documentation for FolderShare

          +
          accessLevel

          a FolderShareAccessLevel - which is a character taking one of the following values:

          • View

          • @@ -5157,20 +5157,20 @@

            Details

          ForecastingCategoryMapping

          -

          Salesforce Documentation for ForecastingCategoryMapping

          +
          forecastingItemCategoryApiName

          a character

          weightedSourceCategories

          a WeightedSourceCategory

          ForecastingDisplayedFamilySettings

          -

          Salesforce Documentation for ForecastingDisplayedFamilySettings

          +
          productFamily

          a character

          ForecastingSettings

          -

          Salesforce Documentation for ForecastingSettings

          +
          fullName

          a character (inherited from Metadata)

          displayCurrency

          a DisplayCurrency - which is a character taking one of the following values:

            @@ -5185,7 +5185,7 @@

            Details

          ForecastingTypeSettings

          -

          Salesforce Documentation for ForecastingTypeSettings

          +
          active

          a character either 'true' or 'false'

          adjustmentsSettings

          a AdjustmentsSettings

          displayedCategoryApiNames

          a character

          @@ -5215,9 +5215,9 @@

          Details

          ForecastRangeSettings

          -

          Salesforce Documentation for ForecastRangeSettings

          -
          beginning

          a integer

          -
          displaying

          a integer

          +
          +
          beginning

          an integer

          +
          displaying

          an integer

          periodType

          a PeriodTypes - which is a character taking one of the following values:

          • Month

          • @@ -5229,7 +5229,7 @@

            Details

          GlobalPicklistValue

          -

          Salesforce Documentation for GlobalPicklistValue

          +
          fullName

          a character (inherited from Metadata)

          color

          a character

          default

          a character either 'true' or 'false'

          @@ -5239,14 +5239,14 @@

          Details

          GlobalQuickActionTranslation

          -

          Salesforce Documentation for GlobalQuickActionTranslation

          +
          label

          a character

          name

          a character

          GlobalValueSet

          -

          Salesforce Documentation for GlobalValueSet

          +
          fullName

          a character (inherited from Metadata)

          customValue

          a CustomValue

          description

          a character

          @@ -5256,14 +5256,14 @@

          Details

          GlobalValueSetTranslation

          -

          Salesforce Documentation for GlobalValueSetTranslation

          +
          fullName

          a character (inherited from Metadata)

          valueTranslation

          a ValueTranslation

          Group

          -

          Salesforce Documentation for Group

          +
          fullName

          a character (inherited from Metadata)

          doesIncludeBosses

          a character either 'true' or 'false'

          name

          a character

          @@ -5271,27 +5271,27 @@

          Details

          HistoryRetentionPolicy

          -

          Salesforce Documentation for HistoryRetentionPolicy

          -
          archiveAfterMonths

          a integer

          -
          archiveRetentionYears

          a integer

          +
          +
          archiveAfterMonths

          an integer

          +
          archiveRetentionYears

          an integer

          description

          a character

          Holiday

          -

          Salesforce Documentation for Holiday

          +
          activityDate

          a character formatted as 'yyyy-mm-dd'

          businessHours

          a character

          description

          a character

          endTime

          a character formatted as 'hh:mm:ssZ

          isRecurring

          a character either 'true' or 'false'

          name

          a character

          -
          recurrenceDayOfMonth

          a integer

          +
          recurrenceDayOfMonth

          an integer

          recurrenceDayOfWeek

          a character

          -
          recurrenceDayOfWeekMask

          a integer

          +
          recurrenceDayOfWeekMask

          an integer

          recurrenceEndDate

          a character formatted as 'yyyy-mm-dd'

          recurrenceInstance

          a character

          -
          recurrenceInterval

          a integer

          +
          recurrenceInterval

          an integer

          recurrenceMonthOfYear

          a character

          recurrenceStartDate

          a character formatted as 'yyyy-mm-dd'

          recurrenceType

          a character

          @@ -5300,10 +5300,10 @@

          Details

          HomePageComponent

          -

          Salesforce Documentation for HomePageComponent

          +
          fullName

          a character (inherited from Metadata)

          body

          a character

          -
          height

          a integer

          +
          height

          an integer

          links

          a character

          page

          a character

          pageComponentType

          a PageComponentType - which is a character taking one of the following values: @@ -5324,7 +5324,7 @@

          Details

          HomePageLayout

          -

          Salesforce Documentation for HomePageLayout

          +
          fullName

          a character (inherited from Metadata)

          narrowComponents

          a character

          wideComponents

          a character

          @@ -5332,14 +5332,14 @@

          Details

          IdeaReputationLevel

          -

          Salesforce Documentation for IdeaReputationLevel

          +
          name

          a character

          -
          value

          a integer

          +
          value

          an integer

          IdeasSettings

          -

          Salesforce Documentation for IdeasSettings

          +
          fullName

          a character (inherited from Metadata)

          enableChatterProfile

          a character either 'true' or 'false'

          enableIdeaThemes

          a character either 'true' or 'false'

          @@ -5351,7 +5351,7 @@

          Details

          Index

          -

          Salesforce Documentation for Index

          +
          fullName

          a character (inherited from Metadata)

          fields

          a IndexField

          label

          a character

          @@ -5359,14 +5359,14 @@

          Details

          IndexField

          -

          Salesforce Documentation for IndexField

          +
          name

          a character

          sortDirection

          a character

          InsightType

          -

          Salesforce Documentation for InsightType

          +
          fullName

          a character (inherited from Metadata)

          defaultTrendType

          a InsightTrendType - which is a character taking one of the following values:

            @@ -5388,7 +5388,7 @@

            Details

          InstalledPackage

          -

          Salesforce Documentation for InstalledPackage

          +
          fullName

          a character (inherited from Metadata)

          password

          a character

          versionNumber

          a character

          @@ -5396,7 +5396,7 @@

          Details

          IntegrationHubSettings

          -

          Salesforce Documentation for IntegrationHubSettings

          +
          fullName

          a character (inherited from Metadata)

          canonicalName

          a character

          canonicalNameBindingChar

          a character

          @@ -5410,14 +5410,14 @@

          Details
          setupSimpleName

          a character

          uUID

          a character

          version

          a character

          -
          versionBuild

          a integer

          -
          versionMajor

          a integer

          -
          versionMinor

          a integer

          +
          versionBuild

          an integer

          +
          versionMajor

          an integer

          +
          versionMinor

          an integer

          IntegrationHubSettingsType

          -

          Salesforce Documentation for IntegrationHubSettingsType

          +
          fullName

          a character (inherited from Metadata)

          canonicalName

          a character

          canonicalNameBindingChar

          a character

          @@ -5429,14 +5429,14 @@

          Details
          setupSimpleName

          a character

          uUID

          a character

          version

          a character

          -
          versionBuild

          a integer

          -
          versionMajor

          a integer

          -
          versionMinor

          a integer

          +
          versionBuild

          an integer

          +
          versionMajor

          an integer

          +
          versionMinor

          an integer

          IpRange

          -

          Salesforce Documentation for IpRange

          +
          description

          a character

          end

          a character

          start

          a character

          @@ -5444,20 +5444,20 @@

          Details

          KeyboardShortcuts

          -

          Salesforce Documentation for KeyboardShortcuts

          +
          customShortcuts

          a CustomShortcut

          defaultShortcuts

          a DefaultShortcut

          Keyword

          -

          Salesforce Documentation for Keyword

          +
          keyword

          a character

          KeywordList

          -

          Salesforce Documentation for KeywordList

          +
          fullName

          a character (inherited from Metadata)

          description

          a character

          keywords

          a Keyword

          @@ -5466,7 +5466,7 @@

          Details

          KnowledgeAnswerSettings

          -

          Salesforce Documentation for KnowledgeAnswerSettings

          +
          assignTo

          a character

          defaultArticleType

          a character

          enableArticleCreation

          a character either 'true' or 'false'

          @@ -5474,19 +5474,19 @@

          Details

          KnowledgeCaseField

          -

          Salesforce Documentation for KnowledgeCaseField

          +
          name

          a character

          KnowledgeCaseFieldsSettings

          -

          Salesforce Documentation for KnowledgeCaseFieldsSettings

          +
          field

          a KnowledgeCaseField

          KnowledgeCaseSettings

          -

          Salesforce Documentation for KnowledgeCaseSettings

          +
          articlePDFCreationProfile

          a character

          articlePublicSharingCommunities

          a KnowledgeCommunitiesSettings

          articlePublicSharingSites

          a KnowledgeSitesSettings

          @@ -5507,13 +5507,13 @@

          Details

          KnowledgeCommunitiesSettings

          -

          Salesforce Documentation for KnowledgeCommunitiesSettings

          +
          community

          a character

          KnowledgeLanguage

          -

          Salesforce Documentation for KnowledgeLanguage

          +
          active

          a character either 'true' or 'false'

          defaultAssignee

          a character

          defaultAssigneeType

          a KnowledgeLanguageLookupValueType - which is a character taking one of the following values: @@ -5532,13 +5532,13 @@

          Details

          KnowledgeLanguageSettings

          -

          Salesforce Documentation for KnowledgeLanguageSettings

          +
          language

          a KnowledgeLanguage

          KnowledgeSettings

          -

          Salesforce Documentation for KnowledgeSettings

          +
          fullName

          a character (inherited from Metadata)

          answers

          a KnowledgeAnswerSettings

          cases

          a KnowledgeCaseSettings

          @@ -5558,13 +5558,13 @@

          Details

          KnowledgeSitesSettings

          -

          Salesforce Documentation for KnowledgeSitesSettings

          +
          site

          a character

          KnowledgeSuggestedArticlesSettings

          -

          Salesforce Documentation for KnowledgeSuggestedArticlesSettings

          +
          caseFields

          a KnowledgeCaseFieldsSettings

          useSuggestedArticlesForCase

          a character either 'true' or 'false'

          workOrderFields

          a KnowledgeWorkOrderFieldsSettings

          @@ -5573,31 +5573,31 @@

          Details

          KnowledgeWorkOrderField

          -

          Salesforce Documentation for KnowledgeWorkOrderField

          +
          name

          a character

          KnowledgeWorkOrderFieldsSettings

          -

          Salesforce Documentation for KnowledgeWorkOrderFieldsSettings

          +
          field

          a KnowledgeWorkOrderField

          KnowledgeWorkOrderLineItemField

          -

          Salesforce Documentation for KnowledgeWorkOrderLineItemField

          +
          name

          a character

          KnowledgeWorkOrderLineItemFieldsSettings

          -

          Salesforce Documentation for KnowledgeWorkOrderLineItemFieldsSettings

          +
          field

          a KnowledgeWorkOrderLineItemField

          Layout

          -

          Salesforce Documentation for Layout

          +
          fullName

          a character (inherited from Metadata)

          customButtons

          a character

          customConsoleComponents

          a CustomConsoleComponents

          @@ -5630,14 +5630,14 @@

          Details

          LayoutColumn

          -

          Salesforce Documentation for LayoutColumn

          +
          layoutItems

          a LayoutItem

          reserved

          a character

          LayoutItem

          -

          Salesforce Documentation for LayoutItem

          +
          analyticsCloudComponent

          a AnalyticsCloudComponentLayoutItem

          behavior

          a UiBehavior - which is a character taking one of the following values:

            @@ -5650,7 +5650,7 @@

            Details
            customLink

            a character

            emptySpace

            a character either 'true' or 'false'

            field

            a character

            -
            height

            a integer

            +
            height

            an integer

            page

            a character

            reportChartComponent

            a ReportChartComponentLayoutItem

            scontrol

            a character

            @@ -5661,7 +5661,7 @@

            Details

          LayoutSection

          -

          Salesforce Documentation for LayoutSection

          +
          customLabel

          a character either 'true' or 'false'

          detailHeading

          a character either 'true' or 'false'

          editHeading

          a character either 'true' or 'false'

          @@ -5678,14 +5678,14 @@

          Details

          LayoutSectionTranslation

          -

          Salesforce Documentation for LayoutSectionTranslation

          +
          label

          a character

          section

          a character

          LayoutTranslation

          -

          Salesforce Documentation for LayoutTranslation

          +
          layout

          a character

          layoutType

          a character

          sections

          a LayoutSectionTranslation

          @@ -5693,7 +5693,7 @@

          Details

          LeadConvertSettings

          -

          Salesforce Documentation for LeadConvertSettings

          +
          fullName

          a character (inherited from Metadata)

          allowOwnerChange

          a character either 'true' or 'false'

          objectMapping

          a ObjectMapping

          @@ -5707,7 +5707,7 @@

          Details

          Letterhead

          -

          Salesforce Documentation for Letterhead

          +
          fullName

          a character (inherited from Metadata)

          available

          a character either 'true' or 'false'

          backgroundColor

          a character

          @@ -5723,9 +5723,9 @@

          Details

          LetterheadHeaderFooter

          -

          Salesforce Documentation for LetterheadHeaderFooter

          +
          backgroundColor

          a character

          -
          height

          a integer

          +
          height

          an integer

          horizontalAlignment

          a LetterheadHorizontalAlignment - which is a character taking one of the following values:

          • None

          • @@ -5745,21 +5745,21 @@

            Details

          LetterheadLine

          -

          Salesforce Documentation for LetterheadLine

          +
          color

          a character

          -
          height

          a integer

          +
          height

          an integer

          LicensedCustomPermissions

          -

          Salesforce Documentation for LicensedCustomPermissions

          +
          customPermission

          a character

          licenseDefinition

          a character

          LicenseDefinition

          -

          Salesforce Documentation for LicenseDefinition

          +
          fullName

          a character (inherited from Metadata)

          aggregationGroup

          a character

          description

          a character

          @@ -5768,16 +5768,16 @@

          Details
          licensedCustomPermissions

          a LicensedCustomPermissions

          licensingAuthority

          a character

          licensingAuthorityProvider

          a character

          -
          minPlatformVersion

          a integer

          +
          minPlatformVersion

          an integer

          origin

          a character

          -
          revision

          a integer

          -
          trialLicenseDuration

          a integer

          -
          trialLicenseQuantity

          a integer

          +
          revision

          an integer

          +
          trialLicenseDuration

          an integer

          +
          trialLicenseQuantity

          an integer

          LightningBolt

          -

          Salesforce Documentation for LightningBolt

          +
          fullName

          a character (inherited from Metadata)

          category

          a LightningBoltCategory - which is a character taking one of the following values:

            @@ -5796,29 +5796,29 @@

            Details

          LightningBoltFeatures

          -

          Salesforce Documentation for LightningBoltFeatures

          +
          description

          a character

          -
          order

          a integer

          +
          order

          an integer

          title

          a character

          LightningBoltImages

          -

          Salesforce Documentation for LightningBoltImages

          +
          image

          a character

          -
          order

          a integer

          +
          order

          an integer

          LightningBoltItems

          -

          Salesforce Documentation for LightningBoltItems

          +
          name

          a character

          type

          a character

          LightningComponentBundle

          -

          Salesforce Documentation for LightningComponentBundle

          +
          fullName

          a character (inherited from Metadata)

          apiVersion

          a numeric

          isExposed

          a character either 'true' or 'false'

          @@ -5826,7 +5826,7 @@

          Details

          LightningExperienceTheme

          -

          Salesforce Documentation for LightningExperienceTheme

          +
          fullName

          a character (inherited from Metadata)

          defaultBrandingSet

          a character

          description

          a character

          @@ -5836,23 +5836,23 @@

          Details

          ListMetadataQuery

          -

          Salesforce Documentation for ListMetadataQuery

          +
          folder

          a character

          type

          a character

          ListPlacement

          -

          Salesforce Documentation for ListPlacement

          -
          height

          a integer

          +
          +
          height

          an integer

          location

          a character

          units

          a character

          -
          width

          a integer

          +
          width

          an integer

          ListView

          -

          Salesforce Documentation for ListView

          +
          fullName

          a character (inherited from Metadata)

          booleanFilter

          a character

          columns

          a character

          @@ -5998,7 +5998,7 @@

          Details

          ListViewFilter

          -

          Salesforce Documentation for ListViewFilter

          +
          field

          a character

          operation

          a FilterOperation - which is a character taking one of the following values:

            @@ -6020,7 +6020,7 @@

            Details

          LiveAgentConfig

          -

          Salesforce Documentation for LiveAgentConfig

          +
          enableLiveChat

          a character either 'true' or 'false'

          openNewAccountSubtab

          a character either 'true' or 'false'

          openNewCaseSubtab

          a character either 'true' or 'false'

          @@ -6033,19 +6033,19 @@

          Details

          LiveAgentSettings

          -

          Salesforce Documentation for LiveAgentSettings

          +
          fullName

          a character (inherited from Metadata)

          enableLiveAgent

          a character either 'true' or 'false'

          LiveChatAgentConfig

          -

          Salesforce Documentation for LiveChatAgentConfig

          +
          fullName

          a character (inherited from Metadata)

          assignments

          a AgentConfigAssignments

          autoGreeting

          a character

          -
          capacity

          a integer

          -
          criticalWaitTime

          a integer

          +
          capacity

          an integer

          +
          criticalWaitTime

          an integer

          customAgentName

          a character

          enableAgentFileTransfer

          a character either 'true' or 'false'

          enableAgentSneakPeek

          a character either 'true' or 'false'

          @@ -6079,7 +6079,7 @@

          Details

          LiveChatButton

          -

          Salesforce Documentation for LiveChatButton

          +
          fullName

          a character (inherited from Metadata)

          animation

          a LiveChatButtonPresentation - which is a character taking one of the following values:

            @@ -6089,8 +6089,8 @@

            Details
          • Custom

          autoGreeting

          a character

          -
          chasitorIdleTimeout

          a integer

          -
          chasitorIdleTimeoutWarning

          a integer

          +
          chasitorIdleTimeout

          an integer

          +
          chasitorIdleTimeoutWarning

          an integer

          chatPage

          a character

          customAgentName

          a character

          deployments

          a LiveChatButtonDeployments

          @@ -6129,7 +6129,7 @@

          Details

          isActive

          a character either 'true' or 'false'

          label

          a character

          -
          numberOfReroutingAttempts

          a integer

          +
          numberOfReroutingAttempts

          an integer

          offlineImage

          a character

          onlineImage

          a character

          optionsCustomRoutingIsEnabled

          a character either 'true' or 'false'

          @@ -6139,13 +6139,13 @@

          Details
          optionsHasRerouteDeclinedRequest

          a character either 'true' or 'false'

          optionsIsAutoAccept

          a character either 'true' or 'false'

          optionsIsInviteAutoRemove

          a character either 'true' or 'false'

          -
          overallQueueLength

          a integer

          -
          perAgentQueueLength

          a integer

          +
          overallQueueLength

          an integer

          +
          perAgentQueueLength

          an integer

          postChatPage

          a character

          postChatUrl

          a character

          preChatFormPage

          a character

          preChatFormUrl

          a character

          -
          pushTimeOut

          a integer

          +
          pushTimeOut

          an integer

          routingType

          a LiveChatButtonRoutingType - which is a character taking one of the following values:

          • Choice

          • @@ -6154,7 +6154,7 @@

            Details

          site

          a character

          skills

          a LiveChatButtonSkills

          -
          timeToRemoveInvite

          a integer

          +
          timeToRemoveInvite

          an integer

          type

          a LiveChatButtonType - which is a character taking one of the following values:

          • Standard

          • @@ -6286,23 +6286,23 @@

            Details

          LiveChatButtonDeployments

          -

          Salesforce Documentation for LiveChatButtonDeployments

          +
          deployment

          a character

          LiveChatButtonSkills

          -

          Salesforce Documentation for LiveChatButtonSkills

          +
          skill

          a character

          LiveChatDeployment

          -

          Salesforce Documentation for LiveChatDeployment

          +
          fullName

          a character (inherited from Metadata)

          brandingImage

          a character

          -
          connectionTimeoutDuration

          a integer

          -
          connectionWarningDuration

          a integer

          +
          connectionTimeoutDuration

          an integer

          +
          connectionWarningDuration

          an integer

          displayQueuePosition

          a character either 'true' or 'false'

          domainWhiteList

          a LiveChatDeploymentDomainWhitelist

          enablePrechatApi

          a character either 'true' or 'false'

          @@ -6315,13 +6315,13 @@

          Details

          LiveChatDeploymentDomainWhitelist

          -

          Salesforce Documentation for LiveChatDeploymentDomainWhitelist

          +
          domain

          a character

          LiveChatSensitiveDataRule

          -

          Salesforce Documentation for LiveChatSensitiveDataRule

          +
          fullName

          a character (inherited from Metadata)

          actionType

          a SensitiveDataActionType - which is a character taking one of the following values:

            @@ -6329,7 +6329,7 @@

            Details
          • Replace

          description

          a character

          -
          enforceOn

          a integer

          +
          enforceOn

          an integer

          isEnabled

          a character either 'true' or 'false'

          pattern

          a character

          replacement

          a character

          @@ -6337,14 +6337,14 @@

          Details

          LiveMessageSettings

          -

          Salesforce Documentation for LiveMessageSettings

          +
          fullName

          a character (inherited from Metadata)

          enableLiveMessage

          a character either 'true' or 'false'

          LogInfo

          -

          Salesforce Documentation for LogInfo

          +
          category

          a LogCategory - which is a character taking one of the following values:

          • Db

          • @@ -6373,7 +6373,7 @@

            Details

          LookupFilter

          -

          Salesforce Documentation for LookupFilter

          +
          active

          a character either 'true' or 'false'

          booleanFilter

          a character

          description

          a character

          @@ -6385,46 +6385,46 @@

          Details

          LookupFilterTranslation

          -

          Salesforce Documentation for LookupFilterTranslation

          +
          errorMessage

          a character

          informationalMessage

          a character

          MacroSettings

          -

          Salesforce Documentation for MacroSettings

          +
          fullName

          a character (inherited from Metadata)

          enableAdvancedSearch

          a character either 'true' or 'false'

          ManagedTopic

          -

          Salesforce Documentation for ManagedTopic

          +
          fullName

          a character (inherited from Metadata)

          managedTopicType

          a character

          name

          a character

          parentName

          a character

          -
          position

          a integer

          +
          position

          an integer

          topicDescription

          a character

          ManagedTopics

          -

          Salesforce Documentation for ManagedTopics

          +
          fullName

          a character (inherited from Metadata)

          managedTopic

          a ManagedTopic

          MarketingActionSettings

          -

          Salesforce Documentation for MarketingActionSettings

          +
          fullName

          a character (inherited from Metadata)

          enableMarketingAction

          a character either 'true' or 'false'

          MarketingResourceType

          -

          Salesforce Documentation for MarketingResourceType

          +
          fullName

          a character (inherited from Metadata)

          description

          a character

          masterLabel

          a character

          @@ -6434,7 +6434,7 @@

          Details

          MatchingRule

          -

          Salesforce Documentation for MatchingRule

          +
          fullName

          a character (inherited from Metadata)

          booleanFilter

          a character

          description

          a character

          @@ -6453,7 +6453,7 @@

          Details

          MatchingRuleItem

          -

          Salesforce Documentation for MatchingRuleItem

          +
          blankValueBehavior

          a BlankValueBehavior - which is a character taking one of the following values:

          • MatchBlanks

          • @@ -6476,27 +6476,27 @@

            Details

          MatchingRules

          -

          Salesforce Documentation for MatchingRules

          +
          fullName

          a character (inherited from Metadata)

          matchingRules

          a MatchingRule

          Metadata

          -

          Salesforce Documentation for Metadata

          +
          fullName

          a character

          MetadataWithContent

          -

          Salesforce Documentation for MetadataWithContent

          +
          fullName

          a character (inherited from Metadata)

          -
          content

          a character formed using RCurl::base64Encode

          +
          content

          a character formed using base64encode

          MilestoneType

          -

          Salesforce Documentation for MilestoneType

          +
          fullName

          a character (inherited from Metadata)

          description

          a character

          recurrenceType

          a MilestoneTypeRecurrenceType - which is a character taking one of the following values: @@ -6509,14 +6509,14 @@

          Details

          MiniLayout

          -

          Salesforce Documentation for MiniLayout

          +
          fields

          a character

          relatedLists

          a RelatedListItem

          MobileSettings

          -

          Salesforce Documentation for MobileSettings

          +
          fullName

          a character (inherited from Metadata)

          chatterMobile

          a ChatterMobileSettings

          dashboardMobile

          a DashboardMobileSettings

          @@ -6526,7 +6526,7 @@

          Details

          ModeratedEntityField

          -

          Salesforce Documentation for ModeratedEntityField

          +
          entityName

          a character

          fieldName

          a character

          keywordList

          a character

          @@ -6534,7 +6534,7 @@

          Details

          ModerationRule

          -

          Salesforce Documentation for ModerationRule

          +
          fullName

          a character (inherited from Metadata)

          action

          a ModerationRuleAction - which is a character taking one of the following values:

            @@ -6544,12 +6544,12 @@

            Details
          • Replace

          • Flag

          -
          actionLimit

          a integer

          +
          actionLimit

          an integer

          active

          a character either 'true' or 'false'

          description

          a character

          entitiesAndFields

          a ModeratedEntityField

          masterLabel

          a character

          -
          notifyLimit

          a integer

          +
          notifyLimit

          an integer

          timePeriod

          a RateLimitTimePeriod - which is a character taking one of the following values:

          • Short

          • @@ -6566,7 +6566,7 @@

            Details

          NamedCredential

          -

          Salesforce Documentation for NamedCredential

          +
          fullName

          a character (inherited from Metadata)

          allowMergeFieldsInBody

          a character either 'true' or 'false'

          allowMergeFieldsInHeader

          a character either 'true' or 'false'

          @@ -6596,7 +6596,7 @@

          Details

          NameSettings

          -

          Salesforce Documentation for NameSettings

          +
          fullName

          a character (inherited from Metadata)

          enableMiddleName

          a character either 'true' or 'false'

          enableNameSuffix

          a character either 'true' or 'false'

          @@ -6604,16 +6604,16 @@

          Details

          NavigationLinkSet

          -

          Salesforce Documentation for NavigationLinkSet

          +
          navigationMenuItem

          a NavigationMenuItem

          NavigationMenuItem

          -

          Salesforce Documentation for NavigationMenuItem

          +
          defaultListViewId

          a character

          label

          a character

          -
          position

          a integer

          +
          position

          an integer

          publiclyAvailable

          a character either 'true' or 'false'

          subMenu

          a NavigationSubMenu

          target

          a character

          @@ -6623,13 +6623,13 @@

          Details

          NavigationSubMenu

          -

          Salesforce Documentation for NavigationSubMenu

          +
          navigationMenuItem

          a NavigationMenuItem

          Network

          -

          Salesforce Documentation for Network

          +
          fullName

          a character (inherited from Metadata)

          allowInternalUserLogin

          a character either 'true' or 'false'

          allowMembersToFlag

          a character either 'true' or 'false'

          @@ -6662,7 +6662,7 @@

          Details
          forgotPasswordTemplate

          a character

          gatherCustomerSentimentData

          a character either 'true' or 'false'

          logoutUrl

          a character

          -
          maxFileSizeKb

          a integer

          +
          maxFileSizeKb

          an integer

          navigationLinkSet

          a NavigationLinkSet

          networkMemberGroups

          a NetworkMemberGroup

          networkPageOverrides

          a NetworkPageOverride

          @@ -6689,14 +6689,14 @@

          Details

          NetworkAccess

          -

          Salesforce Documentation for NetworkAccess

          +
          ipRanges

          a IpRange

          NetworkBranding

          -

          Salesforce Documentation for NetworkBranding

          -
          content

          a character formed using RCurl::base64Encode (inherited from MetadataWithContent)

          +
          +
          content

          a character formed using base64encode (inherited from MetadataWithContent)

          loginFooterText

          a character

          loginLogo

          a character

          loginLogoName

          a character

          @@ -6720,14 +6720,14 @@

          Details

          NetworkMemberGroup

          -

          Salesforce Documentation for NetworkMemberGroup

          +
          permissionSet

          a character

          profile

          a character

          NetworkPageOverride

          -

          Salesforce Documentation for NetworkPageOverride

          +
          changePasswordPageOverrideSetting

          a NetworkPageOverrideSetting - which is a character taking one of the following values:

          • Designer

          • @@ -6762,7 +6762,7 @@

            Details

          NetworkTabSet

          -

          Salesforce Documentation for NetworkTabSet

          +
          customTab

          a character

          defaultTab

          a character

          standardTab

          a character

          @@ -6770,14 +6770,14 @@

          Details

          NextAutomatedApprover

          -

          Salesforce Documentation for NextAutomatedApprover

          +
          useApproverFieldOfRecordOwner

          a character either 'true' or 'false'

          userHierarchyField

          a character

          ObjectMapping

          -

          Salesforce Documentation for ObjectMapping

          +
          inputObject

          a character

          mappingFields

          a ObjectMappingField

          outputObject

          a character

          @@ -6785,14 +6785,14 @@

          Details

          ObjectMappingField

          -

          Salesforce Documentation for ObjectMappingField

          +
          inputField

          a character

          outputField

          a character

          ObjectNameCaseValue

          -

          Salesforce Documentation for ObjectNameCaseValue

          +
          article

          a Article - which is a character taking one of the following values:

          • None

          • @@ -6844,7 +6844,7 @@

            Details

          ObjectRelationship

          -

          Salesforce Documentation for ObjectRelationship

          +
          join

          a ObjectRelationship

          outerJoin

          a character either 'true' or 'false'

          relationship

          a character

          @@ -6852,41 +6852,41 @@

          Details

          ObjectSearchSetting

          -

          Salesforce Documentation for ObjectSearchSetting

          +
          enhancedLookupEnabled

          a character either 'true' or 'false'

          lookupAutoCompleteEnabled

          a character either 'true' or 'false'

          name

          a character

          -
          resultsPerPageCount

          a integer

          +
          resultsPerPageCount

          an integer

          ObjectUsage

          -

          Salesforce Documentation for ObjectUsage

          +
          object

          a character

          OpportunityListFieldsLabelMapping

          -

          Salesforce Documentation for OpportunityListFieldsLabelMapping

          +
          field

          a character

          label

          a character

          OpportunityListFieldsSelectedSettings

          -

          Salesforce Documentation for OpportunityListFieldsSelectedSettings

          +
          field

          a character

          OpportunityListFieldsUnselectedSettings

          -

          Salesforce Documentation for OpportunityListFieldsUnselectedSettings

          +
          field

          a character

          OpportunitySettings

          -

          Salesforce Documentation for OpportunitySettings

          +
          fullName

          a character (inherited from Metadata)

          autoActivateNewReminders

          a character either 'true' or 'false'

          enableFindSimilarOpportunities

          a character either 'true' or 'false'

          @@ -6898,15 +6898,15 @@

          Details

          Orchestration

          -

          Salesforce Documentation for Orchestration

          -
          content

          a character formed using RCurl::base64Encode (inherited from MetadataWithContent)

          +
          +
          content

          a character formed using base64encode (inherited from MetadataWithContent)

          context

          a character

          masterLabel

          a character

          OrchestrationContext

          -

          Salesforce Documentation for OrchestrationContext

          +
          fullName

          a character (inherited from Metadata)

          description

          a character

          events

          a OrchestrationContextEvent

          @@ -6918,7 +6918,7 @@

          Details

          OrchestrationContextEvent

          -

          Salesforce Documentation for OrchestrationContextEvent

          +
          eventType

          a character

          orchestrationEvent

          a character

          platformEvent

          a character

          @@ -6927,7 +6927,7 @@

          Details

          OrderSettings

          -

          Salesforce Documentation for OrderSettings

          +
          fullName

          a character (inherited from Metadata)

          enableNegativeQuantity

          a character either 'true' or 'false'

          enableOrders

          a character either 'true' or 'false'

          @@ -6937,21 +6937,21 @@

          Details

          OrganizationSettingsDetail

          -

          Salesforce Documentation for OrganizationSettingsDetail

          +
          settingName

          a character

          settingValue

          a character either 'true' or 'false'

          OrgPreferenceSettings

          -

          Salesforce Documentation for OrgPreferenceSettings

          +
          fullName

          a character (inherited from Metadata)

          preferences

          a OrganizationSettingsDetail

          Package

          -

          Salesforce Documentation for Package

          +
          fullName

          a character (inherited from Metadata)

          apiAccessLevel

          a APIAccessLevel - which is a character taking one of the following values:

            @@ -6971,22 +6971,22 @@

            Details

          PackageTypeMembers

          -

          Salesforce Documentation for PackageTypeMembers

          +
          members

          a character

          name

          a character

          PackageVersion

          -

          Salesforce Documentation for PackageVersion

          -
          majorNumber

          a integer

          -
          minorNumber

          a integer

          +
          +
          majorNumber

          an integer

          +
          minorNumber

          an integer

          namespace

          a character

          PasswordPolicies

          -

          Salesforce Documentation for PasswordPolicies

          +
          apiOnlyUserHomePageURL

          a character

          complexity

          a Complexity - which is a character taking one of the following values:

            @@ -7034,7 +7034,7 @@

            Details

          PathAssistant

          -

          Salesforce Documentation for PathAssistant

          +
          fullName

          a character (inherited from Metadata)

          active

          a character either 'true' or 'false'

          entityName

          a character

          @@ -7046,14 +7046,14 @@

          Details

          PathAssistantSettings

          -

          Salesforce Documentation for PathAssistantSettings

          +
          fullName

          a character (inherited from Metadata)

          pathAssistantEnabled

          a character either 'true' or 'false'

          PathAssistantStep

          -

          Salesforce Documentation for PathAssistantStep

          +
          fieldNames

          a character

          info

          a character

          picklistValueName

          a character

          @@ -7061,7 +7061,7 @@

          Details

          PermissionSet

          -

          Salesforce Documentation for PermissionSet

          +
          fullName

          a character (inherited from Metadata)

          applicationVisibilities

          a PermissionSetApplicationVisibility

          classAccesses

          a PermissionSetApexClassAccess

          @@ -7081,42 +7081,42 @@

          Details

          PermissionSetApexClassAccess

          -

          Salesforce Documentation for PermissionSetApexClassAccess

          +
          apexClass

          a character

          enabled

          a character either 'true' or 'false'

          PermissionSetApexPageAccess

          -

          Salesforce Documentation for PermissionSetApexPageAccess

          +
          apexPage

          a character

          enabled

          a character either 'true' or 'false'

          PermissionSetApplicationVisibility

          -

          Salesforce Documentation for PermissionSetApplicationVisibility

          +
          application

          a character

          visible

          a character either 'true' or 'false'

          PermissionSetCustomPermissions

          -

          Salesforce Documentation for PermissionSetCustomPermissions

          +
          enabled

          a character either 'true' or 'false'

          name

          a character

          PermissionSetExternalDataSourceAccess

          -

          Salesforce Documentation for PermissionSetExternalDataSourceAccess

          +
          enabled

          a character either 'true' or 'false'

          externalDataSource

          a character

          PermissionSetFieldPermissions

          -

          Salesforce Documentation for PermissionSetFieldPermissions

          +
          editable

          a character either 'true' or 'false'

          field

          a character

          readable

          a character either 'true' or 'false'

          @@ -7124,7 +7124,7 @@

          Details

          PermissionSetGroup

          -

          Salesforce Documentation for PermissionSetGroup

          +
          fullName

          a character (inherited from Metadata)

          description

          a character

          isCalculatingChanges

          a character either 'true' or 'false'

          @@ -7134,7 +7134,7 @@

          Details

          PermissionSetObjectPermissions

          -

          Salesforce Documentation for PermissionSetObjectPermissions

          +
          allowCreate

          a character either 'true' or 'false'

          allowDelete

          a character either 'true' or 'false'

          allowEdit

          a character either 'true' or 'false'

          @@ -7146,14 +7146,14 @@

          Details

          PermissionSetRecordTypeVisibility

          -

          Salesforce Documentation for PermissionSetRecordTypeVisibility

          +
          recordType

          a character

          visible

          a character either 'true' or 'false'

          PermissionSetTabSetting

          -

          Salesforce Documentation for PermissionSetTabSetting

          +
          tab

          a character

          visibility

          a PermissionSetTabVisibility - which is a character taking one of the following values:

            @@ -7165,28 +7165,28 @@

            Details

          PermissionSetUserPermission

          -

          Salesforce Documentation for PermissionSetUserPermission

          +
          enabled

          a character either 'true' or 'false'

          name

          a character

          PersonalJourneySettings

          -

          Salesforce Documentation for PersonalJourneySettings

          +
          fullName

          a character (inherited from Metadata)

          enableExactTargetForSalesforceApps

          a character either 'true' or 'false'

          PersonListSettings

          -

          Salesforce Documentation for PersonListSettings

          +
          fullName

          a character (inherited from Metadata)

          enablePersonList

          a character either 'true' or 'false'

          PicklistEntry

          -

          Salesforce Documentation for PicklistEntry

          +
          active

          a character either 'true' or 'false'

          defaultValue

          a character either 'true' or 'false'

          label

          a character

          @@ -7196,7 +7196,7 @@

          Details

          PicklistValue

          -

          Salesforce Documentation for PicklistValue

          +
          color

          a character (inherited from GlobalPicklistValue)

          default

          a character either 'true' or 'false' (inherited from GlobalPicklistValue)

          description

          a character (inherited from GlobalPicklistValue)

          @@ -7215,7 +7215,7 @@

          Details
        • Closed

        • highPriority

          a character either 'true' or 'false'

          -
          probability

          a integer

          +
          probability

          an integer

          reverseRole

          a character

          reviewed

          a character either 'true' or 'false'

          won

          a character either 'true' or 'false'

          @@ -7223,14 +7223,14 @@

          Details

          PicklistValueTranslation

          -

          Salesforce Documentation for PicklistValueTranslation

          +
          masterLabel

          a character

          translation

          a character

          PlatformActionList

          -

          Salesforce Documentation for PlatformActionList

          +
          fullName

          a character (inherited from Metadata)

          actionListContext

          a PlatformActionListContext - which is a character taking one of the following values:

            @@ -7260,7 +7260,7 @@

            Details

          PlatformActionListItem

          -

          Salesforce Documentation for PlatformActionListItem

          +
          actionName

          a character

          actionType

          a PlatformActionType - which is a character taking one of the following values:

            @@ -7271,13 +7271,13 @@

            Details
          • ActionLink

          • InvocableAction

          -
          sortOrder

          a integer

          +
          sortOrder

          an integer

          subtype

          a character

          PlatformCachePartition

          -

          Salesforce Documentation for PlatformCachePartition

          +
          fullName

          a character (inherited from Metadata)

          description

          a character

          isDefaultPartition

          a character either 'true' or 'false'

          @@ -7287,10 +7287,10 @@

          Details

          PlatformCachePartitionType

          -

          Salesforce Documentation for PlatformCachePartitionType

          -
          allocatedCapacity

          a integer

          -
          allocatedPurchasedCapacity

          a integer

          -
          allocatedTrialCapacity

          a integer

          +
          +
          allocatedCapacity

          an integer

          +
          allocatedPurchasedCapacity

          an integer

          +
          allocatedTrialCapacity

          an integer

          cacheType

          a PlatformCacheType - which is a character taking one of the following values:

          • Session

          • @@ -7300,7 +7300,7 @@

            Details

          Portal

          -

          Salesforce Documentation for Portal

          +
          fullName

          a character (inherited from Metadata)

          active

          a character either 'true' or 'false'

          admin

          a character

          @@ -7342,7 +7342,7 @@

          Details

          PostTemplate

          -

          Salesforce Documentation for PostTemplate

          +
          fullName

          a character (inherited from Metadata)

          default

          a character either 'true' or 'false'

          description

          a character

          @@ -7352,13 +7352,13 @@

          Details

          PrimaryTabComponents

          -

          Salesforce Documentation for PrimaryTabComponents

          +
          containers

          a Container

          ProductSettings

          -

          Salesforce Documentation for ProductSettings

          +
          fullName

          a character (inherited from Metadata)

          enableCascadeActivateToRelatedPrices

          a character either 'true' or 'false'

          enableQuantitySchedule

          a character either 'true' or 'false'

          @@ -7367,7 +7367,7 @@

          Details

          Profile

          -

          Salesforce Documentation for Profile

          +
          fullName

          a character (inherited from Metadata)

          applicationVisibilities

          a ProfileApplicationVisibility

          categoryGroupVisibilities

          a ProfileCategoryGroupVisibility

          @@ -7391,7 +7391,7 @@

          Details

          ProfileActionOverride

          -

          Salesforce Documentation for ProfileActionOverride

          +
          actionName

          a character

          content

          a character

          formFactor

          a FormFactor - which is a character taking one of the following values: @@ -7415,21 +7415,21 @@

          Details

          ProfileApexClassAccess

          -

          Salesforce Documentation for ProfileApexClassAccess

          +
          apexClass

          a character

          enabled

          a character either 'true' or 'false'

          ProfileApexPageAccess

          -

          Salesforce Documentation for ProfileApexPageAccess

          +
          apexPage

          a character

          enabled

          a character either 'true' or 'false'

          ProfileApplicationVisibility

          -

          Salesforce Documentation for ProfileApplicationVisibility

          +
          application

          a character

          default

          a character either 'true' or 'false'

          visible

          a character either 'true' or 'false'

          @@ -7437,7 +7437,7 @@

          Details

          ProfileCategoryGroupVisibility

          -

          Salesforce Documentation for ProfileCategoryGroupVisibility

          +
          dataCategories

          a character

          dataCategoryGroup

          a character

          visibility

          a CategoryGroupVisibility - which is a character taking one of the following values: @@ -7450,21 +7450,21 @@

          Details

          ProfileCustomPermissions

          -

          Salesforce Documentation for ProfileCustomPermissions

          +
          enabled

          a character either 'true' or 'false'

          name

          a character

          ProfileExternalDataSourceAccess

          -

          Salesforce Documentation for ProfileExternalDataSourceAccess

          +
          enabled

          a character either 'true' or 'false'

          externalDataSource

          a character

          ProfileFieldLevelSecurity

          -

          Salesforce Documentation for ProfileFieldLevelSecurity

          +
          editable

          a character either 'true' or 'false'

          field

          a character

          readable

          a character either 'true' or 'false'

          @@ -7472,14 +7472,14 @@

          Details

          ProfileLayoutAssignment

          -

          Salesforce Documentation for ProfileLayoutAssignment

          +
          layout

          a character

          recordType

          a character

          ProfileLoginHours

          -

          Salesforce Documentation for ProfileLoginHours

          +
          fridayEnd

          a character

          fridayStart

          a character

          mondayEnd

          a character

          @@ -7498,7 +7498,7 @@

          Details

          ProfileLoginIpRange

          -

          Salesforce Documentation for ProfileLoginIpRange

          +
          description

          a character

          endAddress

          a character

          startAddress

          a character

          @@ -7506,7 +7506,7 @@

          Details

          ProfileObjectPermissions

          -

          Salesforce Documentation for ProfileObjectPermissions

          +
          allowCreate

          a character either 'true' or 'false'

          allowDelete

          a character either 'true' or 'false'

          allowEdit

          a character either 'true' or 'false'

          @@ -7518,23 +7518,23 @@

          Details

          ProfilePasswordPolicy

          -

          Salesforce Documentation for ProfilePasswordPolicy

          +
          fullName

          a character (inherited from Metadata)

          -
          lockoutInterval

          a integer

          -
          maxLoginAttempts

          a integer

          -
          minimumPasswordLength

          a integer

          +
          lockoutInterval

          an integer

          +
          maxLoginAttempts

          an integer

          +
          minimumPasswordLength

          an integer

          minimumPasswordLifetime

          a character either 'true' or 'false'

          obscure

          a character either 'true' or 'false'

          -
          passwordComplexity

          a integer

          -
          passwordExpiration

          a integer

          -
          passwordHistory

          a integer

          -
          passwordQuestion

          a integer

          +
          passwordComplexity

          an integer

          +
          passwordExpiration

          an integer

          +
          passwordHistory

          an integer

          +
          passwordQuestion

          an integer

          profile

          a character

          ProfileRecordTypeVisibility

          -

          Salesforce Documentation for ProfileRecordTypeVisibility

          +
          default

          a character either 'true' or 'false'

          personAccountDefault

          a character either 'true' or 'false'

          recordType

          a character

          @@ -7543,7 +7543,7 @@

          Details

          ProfileSessionSetting

          -

          Salesforce Documentation for ProfileSessionSetting

          +
          fullName

          a character (inherited from Metadata)

          externalCommunityUserIdentityVerif

          a character either 'true' or 'false'

          forceLogout

          a character either 'true' or 'false'

          @@ -7555,13 +7555,13 @@

          Details
        • HIGH_ASSURANCE

        • sessionPersistence

          a character either 'true' or 'false'

          -
          sessionTimeout

          a integer

          +
          sessionTimeout

          an integer

          sessionTimeoutWarning

          a character either 'true' or 'false'

          ProfileTabVisibility

          -

          Salesforce Documentation for ProfileTabVisibility

          +
          tab

          a character

          visibility

          a TabVisibility - which is a character taking one of the following values:

            @@ -7573,27 +7573,27 @@

            Details

          ProfileUserPermission

          -

          Salesforce Documentation for ProfileUserPermission

          +
          enabled

          a character either 'true' or 'false'

          name

          a character

          PublicGroups

          -

          Salesforce Documentation for PublicGroups

          +
          publicGroup

          a character

          PushNotification

          -

          Salesforce Documentation for PushNotification

          +
          fieldNames

          a character

          objectName

          a character

          Queue

          -

          Salesforce Documentation for Queue

          +
          fullName

          a character (inherited from Metadata)

          doesSendEmailToMembers

          a character either 'true' or 'false'

          email

          a character

          @@ -7605,7 +7605,7 @@

          Details

          QueueMembers

          -

          Salesforce Documentation for QueueMembers

          +
          publicGroups

          a PublicGroups

          roleAndSubordinates

          a RoleAndSubordinates

          roleAndSubordinatesInternal

          a RoleAndSubordinatesInternal

          @@ -7615,19 +7615,19 @@

          Details

          QueueSobject

          -

          Salesforce Documentation for QueueSobject

          +
          sobjectType

          a character

          QuickAction

          -

          Salesforce Documentation for QuickAction

          +
          fullName

          a character (inherited from Metadata)

          canvas

          a character

          description

          a character

          fieldOverrides

          a FieldOverride

          flowDefinition

          a character

          -
          height

          a integer

          +
          height

          an integer

          icon

          a character

          isProtected

          a character either 'true' or 'false'

          label

          a character

          @@ -7683,12 +7683,12 @@

          Details
        • LightningComponent

        • Flow

        • -
          width

          a integer

          +
          width

          an integer

          QuickActionLayout

          -

          Salesforce Documentation for QuickActionLayout

          +
          layoutSectionStyle

          a LayoutSectionStyle - which is a character taking one of the following values:

          • TwoColumnsTopToBottom

          • @@ -7701,13 +7701,13 @@

            Details

          QuickActionLayoutColumn

          -

          Salesforce Documentation for QuickActionLayoutColumn

          +
          quickActionLayoutItems

          a QuickActionLayoutItem

          QuickActionLayoutItem

          -

          Salesforce Documentation for QuickActionLayoutItem

          +
          emptySpace

          a character either 'true' or 'false'

          field

          a character

          uiBehavior

          a UiBehavior - which is a character taking one of the following values: @@ -7720,52 +7720,52 @@

          Details

          QuickActionList

          -

          Salesforce Documentation for QuickActionList

          +
          quickActionListItems

          a QuickActionListItem

          QuickActionListItem

          -

          Salesforce Documentation for QuickActionListItem

          +
          quickActionName

          a character

          QuickActionSendEmailOptions

          -

          Salesforce Documentation for QuickActionSendEmailOptions

          +
          defaultEmailTemplateName

          a character

          ignoreDefaultEmailTemplateSubject

          a character either 'true' or 'false'

          QuickActionTranslation

          -

          Salesforce Documentation for QuickActionTranslation

          +
          label

          a character

          name

          a character

          QuotasSettings

          -

          Salesforce Documentation for QuotasSettings

          +
          showQuotas

          a character either 'true' or 'false'

          QuoteSettings

          -

          Salesforce Documentation for QuoteSettings

          +
          fullName

          a character (inherited from Metadata)

          enableQuote

          a character either 'true' or 'false'

          RecommendationAudience

          -

          Salesforce Documentation for RecommendationAudience

          +
          recommendationAudienceDetails

          a RecommendationAudienceDetail

          RecommendationAudienceDetail

          -

          Salesforce Documentation for RecommendationAudienceDetail

          +
          audienceCriteriaType

          a AudienceCriteriaType - which is a character taking one of the following values:

          • CustomList

          • @@ -7777,13 +7777,13 @@

            Details

          RecommendationDefinition

          -

          Salesforce Documentation for RecommendationDefinition

          +
          recommendationDefinitionDetails

          a RecommendationDefinitionDetail

          RecommendationDefinitionDetail

          -

          Salesforce Documentation for RecommendationDefinitionDetail

          +
          actionUrl

          a character

          description

          a character

          linkText

          a character

          @@ -7794,7 +7794,7 @@

          Details

          RecommendationStrategy

          -

          Salesforce Documentation for RecommendationStrategy

          +
          fullName

          a character (inherited from Metadata)

          description

          a character

          masterLabel

          a character

          @@ -7804,7 +7804,7 @@

          Details

          RecordType

          -

          Salesforce Documentation for RecordType

          +
          fullName

          a character (inherited from Metadata)

          active

          a character either 'true' or 'false'

          businessProcess

          a character

          @@ -7816,14 +7816,14 @@

          Details

          RecordTypePicklistValue

          -

          Salesforce Documentation for RecordTypePicklistValue

          +
          picklist

          a character

          values

          a PicklistValue

          RecordTypeTranslation

          -

          Salesforce Documentation for RecordTypeTranslation

          +
          description

          a character

          label

          a character

          name

          a character

          @@ -7831,26 +7831,26 @@

          Details

          RelatedContent

          -

          Salesforce Documentation for RelatedContent

          +
          relatedContentItems

          a RelatedContentItem

          RelatedContentItem

          -

          Salesforce Documentation for RelatedContentItem

          +
          layoutItem

          a LayoutItem

          RelatedList

          -

          Salesforce Documentation for RelatedList

          +
          hideOnDetail

          a character either 'true' or 'false'

          name

          a character

          RelatedListItem

          -

          Salesforce Documentation for RelatedListItem

          +
          customButtons

          a character

          excludeButtons

          a character

          fields

          a character

          @@ -7865,7 +7865,7 @@

          Details

          RemoteSiteSetting

          -

          Salesforce Documentation for RemoteSiteSetting

          +
          fullName

          a character (inherited from Metadata)

          description

          a character

          disableProtocolSecurity

          a character either 'true' or 'false'

          @@ -7875,7 +7875,7 @@

          Details

          Report

          -

          Salesforce Documentation for Report

          +
          fullName

          a character (inherited from Metadata)

          aggregates

          a ReportAggregate

          block

          a Report

          @@ -8111,11 +8111,11 @@

          Details
          groupingsDown

          a ReportGrouping

          historicalSelector

          a ReportHistoricalSelector

          name

          a character

          -
          numSubscriptions

          a integer

          +
          numSubscriptions

          an integer

          params

          a ReportParam

          reportType

          a character

          roleHierarchyFilter

          a character

          -
          rowLimit

          a integer

          +
          rowLimit

          an integer

          scope

          a character

          showCurrentDate

          a character either 'true' or 'false'

          showDetails

          a character either 'true' or 'false'

          @@ -8132,7 +8132,7 @@

          Details

          ReportAggregate

          -

          Salesforce Documentation for ReportAggregate

          +
          acrossGroupingContext

          a character

          calculatedFormula

          a character

          datatype

          a ReportAggregateDatatype - which is a character taking one of the following values: @@ -8148,18 +8148,18 @@

          Details
          isCrossBlock

          a character either 'true' or 'false'

          masterLabel

          a character

          reportType

          a character

          -
          scale

          a integer

          +
          scale

          an integer

          ReportAggregateReference

          -

          Salesforce Documentation for ReportAggregateReference

          +
          aggregate

          a character

          ReportBlockInfo

          -

          Salesforce Documentation for ReportBlockInfo

          +
          aggregateReferences

          a ReportAggregateReference

          blockId

          a character

          joinTable

          a character

          @@ -8167,7 +8167,7 @@

          Details

          ReportBucketField

          -

          Salesforce Documentation for ReportBucketField

          +
          bucketType

          a ReportBucketFieldType - which is a character taking one of the following values:

          • text

          • @@ -8189,7 +8189,7 @@

            Details

          ReportBucketFieldSourceValue

          -

          Salesforce Documentation for ReportBucketFieldSourceValue

          +
          from

          a character

          sourceValue

          a character

          to

          a character

          @@ -8197,14 +8197,14 @@

          Details

          ReportBucketFieldValue

          -

          Salesforce Documentation for ReportBucketFieldValue

          +
          sourceValues

          a ReportBucketFieldSourceValue

          value

          a character

          ReportChart

          -

          Salesforce Documentation for ReportChart

          +
          backgroundColor1

          a character

          backgroundColor2

          a character

          backgroundFadeDir

          a ChartBackgroundDirection - which is a character taking one of the following values: @@ -8276,15 +8276,15 @@

          Details
        • Manual

        • textColor

          a character

          -
          textSize

          a integer

          +
          textSize

          an integer

          title

          a character

          titleColor

          a character

          -
          titleSize

          a integer

          +
          titleSize

          an integer

          ReportChartComponentLayoutItem

          -

          Salesforce Documentation for ReportChartComponentLayoutItem

          +
          cacheData

          a character either 'true' or 'false'

          contextFilterableField

          a character

          error

          a character

          @@ -8302,7 +8302,7 @@

          Details

          ReportColorRange

          -

          Salesforce Documentation for ReportColorRange

          +
          aggregate

          a ReportSummaryType - which is a character taking one of the following values:

          • Sum

          • @@ -8321,7 +8321,7 @@

            Details

          ReportColumn

          -

          Salesforce Documentation for ReportColumn

          +
          aggregateTypes

          a ReportSummaryType - which is a character taking one of the following values:

          • Sum

          • @@ -8337,7 +8337,7 @@

            Details

          ReportCrossFilter

          -

          Salesforce Documentation for ReportCrossFilter

          +
          criteriaItems

          a ReportFilterItem

          operation

          a ObjectFilterOperator - which is a character taking one of the following values:

            @@ -8351,7 +8351,7 @@

            Details

          ReportDataCategoryFilter

          -

          Salesforce Documentation for ReportDataCategoryFilter

          +
          dataCategory

          a character

          dataCategoryGroup

          a character

          operator

          a DataCategoryFilterOperation - which is a character taking one of the following values: @@ -8365,7 +8365,7 @@

          Details

          ReportFilter

          -

          Salesforce Documentation for ReportFilter

          +
          booleanFilter

          a character

          criteriaItems

          a ReportFilterItem

          language

          a Language - which is a character taking one of the following values: @@ -8494,7 +8494,7 @@

          Details

          ReportFilterItem

          -

          Salesforce Documentation for ReportFilterItem

          +
          column

          a character

          columnToColumn

          a character either 'true' or 'false'

          isUnlocked

          a character either 'true' or 'false'

          @@ -8519,7 +8519,7 @@

          Details

          ReportFolder

          -

          Salesforce Documentation for ReportFolder

          +
          accessType

          a FolderAccessTypes (inherited from Folder)

          folderShares

          a FolderShare (inherited from Folder)

          name

          a character (inherited from Folder)

          @@ -8529,7 +8529,7 @@

          Details

          ReportGrouping

          -

          Salesforce Documentation for ReportGrouping

          +
          aggregateType

          a ReportAggrType - which is a character taking one of the following values:

          • Sum

          • @@ -8570,27 +8570,27 @@

            Details

          ReportHistoricalSelector

          -

          Salesforce Documentation for ReportHistoricalSelector

          +
          snapshot

          a character

          ReportLayoutSection

          -

          Salesforce Documentation for ReportLayoutSection

          +
          columns

          a ReportTypeColumn

          masterLabel

          a character

          ReportParam

          -

          Salesforce Documentation for ReportParam

          +
          name

          a character

          value

          a character

          ReportTimeFrameFilter

          -

          Salesforce Documentation for ReportTimeFrameFilter

          +
          dateColumn

          a character

          endDate

          a character formatted as 'yyyy-mm-dd'

          interval

          a UserDateInterval - which is a character taking one of the following values: @@ -8665,7 +8665,7 @@

          Details

          ReportType

          -

          Salesforce Documentation for ReportType

          +
          fullName

          a character (inherited from Metadata)

          autogenerated

          a character either 'true' or 'false'

          baseObject

          a character

          @@ -8698,7 +8698,7 @@

          Details

          ReportTypeColumn

          -

          Salesforce Documentation for ReportTypeColumn

          +
          checkedByDefault

          a character either 'true' or 'false'

          displayNameOverride

          a character

          field

          a character

          @@ -8707,14 +8707,14 @@

          Details

          ReportTypeColumnTranslation

          -

          Salesforce Documentation for ReportTypeColumnTranslation

          +
          label

          a character

          name

          a character

          ReportTypeSectionTranslation

          -

          Salesforce Documentation for ReportTypeSectionTranslation

          +
          columns

          a ReportTypeColumnTranslation

          label

          a character

          name

          a character

          @@ -8722,7 +8722,7 @@

          Details

          ReportTypeTranslation

          -

          Salesforce Documentation for ReportTypeTranslation

          +
          description

          a character

          label

          a character

          name

          a character

          @@ -8731,13 +8731,13 @@

          Details

          ReputationBranding

          -

          Salesforce Documentation for ReputationBranding

          +
          smallImage

          a character

          ReputationLevel

          -

          Salesforce Documentation for ReputationLevel

          +
          branding

          a ReputationBranding

          label

          a character

          lowerThreshold

          a numeric

          @@ -8745,33 +8745,33 @@

          Details

          ReputationLevelDefinitions

          -

          Salesforce Documentation for ReputationLevelDefinitions

          +
          level

          a ReputationLevel

          ReputationLevels

          -

          Salesforce Documentation for ReputationLevels

          +
          chatterAnswersReputationLevels

          a ChatterAnswersReputationLevel

          ideaReputationLevels

          a IdeaReputationLevel

          ReputationPointsRule

          -

          Salesforce Documentation for ReputationPointsRule

          +
          eventType

          a character

          -
          points

          a integer

          +
          points

          an integer

          ReputationPointsRules

          -

          Salesforce Documentation for ReputationPointsRules

          +
          pointsRule

          a ReputationPointsRule

          RetrieveRequest

          -

          Salesforce Documentation for RetrieveRequest

          +
          apiVersion

          a numeric

          packageNames

          a character

          singlePackage

          a character either 'true' or 'false'

          @@ -8781,7 +8781,7 @@

          Details

          Role

          -

          Salesforce Documentation for Role

          +
          caseAccessLevel

          a character (inherited from RoleOrTerritory)

          contactAccessLevel

          a character (inherited from RoleOrTerritory)

          description

          a character (inherited from RoleOrTerritory)

          @@ -8793,19 +8793,19 @@

          Details

          RoleAndSubordinates

          -

          Salesforce Documentation for RoleAndSubordinates

          +
          roleAndSubordinate

          a character

          RoleAndSubordinatesInternal

          -

          Salesforce Documentation for RoleAndSubordinatesInternal

          +
          roleAndSubordinateInternal

          a character

          RoleOrTerritory

          -

          Salesforce Documentation for RoleOrTerritory

          +
          fullName

          a character (inherited from Metadata)

          caseAccessLevel

          a character

          contactAccessLevel

          a character

          @@ -8817,13 +8817,13 @@

          Details

          Roles

          -

          Salesforce Documentation for Roles

          +
          role

          a character

          RuleEntry

          -

          Salesforce Documentation for RuleEntry

          +
          assignedTo

          a character

          assignedToType

          a AssignToLookupValueType - which is a character taking one of the following values:

            @@ -8858,7 +8858,7 @@

            Details

          SamlSsoConfig

          -

          Salesforce Documentation for SamlSsoConfig

          +
          fullName

          a character (inherited from Metadata)

          attributeName

          a character

          attributeNameIdFormat

          a character

          @@ -8904,13 +8904,13 @@

          Details

          ScheduledRecommendation

          -

          Salesforce Documentation for ScheduledRecommendation

          +
          scheduledRecommendationDetails

          a ScheduledRecommendationDetail

          ScheduledRecommendationDetail

          -

          Salesforce Documentation for ScheduledRecommendationDetail

          +
          channel

          a RecommendationChannel - which is a character taking one of the following values:

          • DefaultChannel

          • @@ -8921,14 +8921,14 @@

            Details
          • CustomChannel5

          enabled

          a character either 'true' or 'false'

          -
          rank

          a integer

          +
          rank

          an integer

          recommendationAudience

          a character

          Scontrol

          -

          Salesforce Documentation for Scontrol

          -
          content

          a character formed using RCurl::base64Encode (inherited from MetadataWithContent)

          +
          +
          content

          a character formed using base64encode (inherited from MetadataWithContent)

          contentSource

          a SControlContentSource - which is a character taking one of the following values:

          • HTML

          • @@ -8949,7 +8949,7 @@

            Details
          • Big5-HKSCS

          • x-SJIS_0213

          -
          fileContent

          a character formed using RCurl::base64Encode

          +
          fileContent

          a character formed using base64encode

          fileName

          a character

          name

          a character

          supportsCaching

          a character either 'true' or 'false'

          @@ -8957,14 +8957,14 @@

          Details

          ScontrolTranslation

          -

          Salesforce Documentation for ScontrolTranslation

          +
          label

          a character

          name

          a character

          SearchLayouts

          -

          Salesforce Documentation for SearchLayouts

          +
          customTabListAdditionalFields

          a character

          excludedStandardButtons

          a character

          listViewButtons

          a character

          @@ -8978,7 +8978,7 @@

          Details

          SearchSettings

          -

          Salesforce Documentation for SearchSettings

          +
          fullName

          a character (inherited from Metadata)

          documentContentSearchEnabled

          a character either 'true' or 'false'

          optimizeSearchForCJKEnabled

          a character either 'true' or 'false'

          @@ -8993,13 +8993,13 @@

          Details

          SearchSettingsByObject

          -

          Salesforce Documentation for SearchSettingsByObject

          +
          searchSettingsByObject

          a ObjectSearchSetting

          SecuritySettings

          -

          Salesforce Documentation for SecuritySettings

          +
          fullName

          a character (inherited from Metadata)

          networkAccess

          a NetworkAccess

          passwordPolicies

          a PasswordPolicies

          @@ -9008,7 +9008,7 @@

          Details

          ServiceCloudConsoleConfig

          -

          Salesforce Documentation for ServiceCloudConsoleConfig

          +
          componentList

          a AppComponentList

          detailPageRefreshMethod

          a character

          footerColor

          a character

          @@ -9025,7 +9025,7 @@

          Details

          SessionSettings

          -

          Salesforce Documentation for SessionSettings

          +
          disableTimeoutWarning

          a character either 'true' or 'false'

          enableCSPOnEmail

          a character either 'true' or 'false'

          enableCSRFOnGet

          a character either 'true' or 'false'

          @@ -9069,14 +9069,14 @@

          Details

          SFDCMobileSettings

          -

          Salesforce Documentation for SFDCMobileSettings

          +
          enableMobileLite

          a character either 'true' or 'false'

          enableUserToDeviceLinking

          a character either 'true' or 'false'

          SharedTo

          -

          Salesforce Documentation for SharedTo

          +
          allCustomerPortalUsers

          a character

          allInternalUsers

          a character

          allPartnerUsers

          a character

          @@ -9102,7 +9102,7 @@

          Details

          SharingBaseRule

          -

          Salesforce Documentation for SharingBaseRule

          +
          fullName

          a character (inherited from Metadata)

          accessLevel

          a character

          accountSettings

          a AccountSharingRuleSettings

          @@ -9113,7 +9113,7 @@

          Details

          SharingCriteriaRule

          -

          Salesforce Documentation for SharingCriteriaRule

          +
          accessLevel

          a character (inherited from SharingBaseRule)

          accountSettings

          a AccountSharingRuleSettings (inherited from SharingBaseRule)

          description

          a character (inherited from SharingBaseRule)

          @@ -9125,7 +9125,7 @@

          Details

          SharingOwnerRule

          -

          Salesforce Documentation for SharingOwnerRule

          +
          accessLevel

          a character (inherited from SharingBaseRule)

          accountSettings

          a AccountSharingRuleSettings (inherited from SharingBaseRule)

          description

          a character (inherited from SharingBaseRule)

          @@ -9136,27 +9136,27 @@

          Details

          SharingReason

          -

          Salesforce Documentation for SharingReason

          +
          fullName

          a character (inherited from Metadata)

          label

          a character

          SharingReasonTranslation

          -

          Salesforce Documentation for SharingReasonTranslation

          +
          label

          a character

          name

          a character

          SharingRecalculation

          -

          Salesforce Documentation for SharingRecalculation

          +
          className

          a character

          SharingRules

          -

          Salesforce Documentation for SharingRules

          +
          fullName

          a character (inherited from Metadata)

          sharingCriteriaRules

          a SharingCriteriaRule

          sharingOwnerRules

          a SharingOwnerRule

          @@ -9165,7 +9165,7 @@

          Details

          SharingSet

          -

          Salesforce Documentation for SharingSet

          +
          fullName

          a character (inherited from Metadata)

          accessMappings

          a AccessMapping

          description

          a character

          @@ -9175,30 +9175,30 @@

          Details

          SharingTerritoryRule

          -

          Salesforce Documentation for SharingTerritoryRule

          +
          sharedFrom

          a SharedTo (inherited from SharingOwnerRule)

          SidebarComponent

          -

          Salesforce Documentation for SidebarComponent

          +
          componentType

          a character

          createAction

          a character

          enableLinking

          a character either 'true' or 'false'

          -
          height

          a integer

          +
          height

          an integer

          label

          a character

          lookup

          a character

          page

          a character

          relatedLists

          a RelatedList

          unit

          a character

          updateAction

          a character

          -
          width

          a integer

          +
          width

          an integer

          SiteDotCom

          -

          Salesforce Documentation for SiteDotCom

          -
          content

          a character formed using RCurl::base64Encode (inherited from MetadataWithContent)

          +
          +
          content

          a character formed using base64encode (inherited from MetadataWithContent)

          label

          a character

          siteType

          a SiteType - which is a character taking one of the following values:

            @@ -9210,7 +9210,7 @@

            Details

          SiteRedirectMapping

          -

          Salesforce Documentation for SiteRedirectMapping

          +
          action

          a SiteRedirect - which is a character taking one of the following values:

          • Permanent

          • @@ -9223,7 +9223,7 @@

            Details

          SiteWebAddress

          -

          Salesforce Documentation for SiteWebAddress

          +
          certificate

          a character

          domainName

          a character

          primary

          a character either 'true' or 'false'

          @@ -9231,7 +9231,7 @@

          Details

          Skill

          -

          Salesforce Documentation for Skill

          +
          fullName

          a character (inherited from Metadata)

          assignments

          a SkillAssignments

          description

          a character

          @@ -9240,26 +9240,26 @@

          Details

          SkillAssignments

          -

          Salesforce Documentation for SkillAssignments

          +
          profiles

          a SkillProfileAssignments

          users

          a SkillUserAssignments

          SkillProfileAssignments

          -

          Salesforce Documentation for SkillProfileAssignments

          +
          profile

          a character

          SkillUserAssignments

          -

          Salesforce Documentation for SkillUserAssignments

          +
          user

          a character

          SocialCustomerServiceSettings

          -

          Salesforce Documentation for SocialCustomerServiceSettings

          +
          fullName

          a character (inherited from Metadata)

          caseSubjectOption

          a CaseSubjectOption - which is a character taking one of the following values:

            @@ -9271,14 +9271,14 @@

            Details

          StandardFieldTranslation

          -

          Salesforce Documentation for StandardFieldTranslation

          +
          label

          a character

          name

          a character

          StandardValue

          -

          Salesforce Documentation for StandardValue

          +
          color

          a character (inherited from CustomValue)

          default

          a character either 'true' or 'false' (inherited from CustomValue)

          description

          a character (inherited from CustomValue)

          @@ -9298,7 +9298,7 @@

          Details

          groupingString

          a character

          highPriority

          a character either 'true' or 'false'

          -
          probability

          a integer

          +
          probability

          an integer

          reverseRole

          a character

          reviewed

          a character either 'true' or 'false'

          won

          a character either 'true' or 'false'

          @@ -9306,7 +9306,7 @@

          Details

          StandardValueSet

          -

          Salesforce Documentation for StandardValueSet

          +
          fullName

          a character (inherited from Metadata)

          groupingStringEnum

          a character

          sorted

          a character either 'true' or 'false'

          @@ -9315,14 +9315,14 @@

          Details

          StandardValueSetTranslation

          -

          Salesforce Documentation for StandardValueSetTranslation

          +
          fullName

          a character (inherited from Metadata)

          valueTranslation

          a ValueTranslation

          State

          -

          Salesforce Documentation for State

          +
          active

          a character either 'true' or 'false'

          integrationValue

          a character

          isoCode

          a character

          @@ -9333,8 +9333,8 @@

          Details

          StaticResource

          -

          Salesforce Documentation for StaticResource

          -
          content

          a character formed using RCurl::base64Encode (inherited from MetadataWithContent)

          +
          +
          content

          a character formed using base64encode (inherited from MetadataWithContent)

          cacheControl

          a StaticResourceCacheControl - which is a character taking one of the following values:

          • Private

          • @@ -9346,27 +9346,27 @@

            Details

          StrategyNode

          -

          Salesforce Documentation for StrategyNode

          +
          definition

          a character

          description

          a character

          name

          a character

          parentNode

          a character

          -
          type

          a integer

          +
          type

          an integer

          SubtabComponents

          -

          Salesforce Documentation for SubtabComponents

          +
          containers

          a Container

          SummaryLayout

          -

          Salesforce Documentation for SummaryLayout

          +
          masterLabel

          a character

          -
          sizeX

          a integer

          -
          sizeY

          a integer

          -
          sizeZ

          a integer

          +
          sizeX

          an integer

          +
          sizeY

          an integer

          +
          sizeZ

          an integer

          summaryLayoutItems

          a SummaryLayoutItem

          summaryLayoutStyle

          a SummaryLayoutStyle - which is a character taking one of the following values:

            @@ -9385,23 +9385,23 @@

            Details

          SummaryLayoutItem

          -

          Salesforce Documentation for SummaryLayoutItem

          +
          customLink

          a character

          field

          a character

          -
          posX

          a integer

          -
          posY

          a integer

          -
          posZ

          a integer

          +
          posX

          an integer

          +
          posY

          an integer

          +
          posZ

          an integer

          SupervisorAgentConfigSkills

          -

          Salesforce Documentation for SupervisorAgentConfigSkills

          +
          skill

          a character

          SynonymDictionary

          -

          Salesforce Documentation for SynonymDictionary

          +
          fullName

          a character (inherited from Metadata)

          groups

          a SynonymGroup

          isProtected

          a character either 'true' or 'false'

          @@ -9410,7 +9410,7 @@

          Details

          SynonymGroup

          -

          Salesforce Documentation for SynonymGroup

          +
          languages

          a Language - which is a character taking one of the following values:

          • en_US

          • @@ -9538,14 +9538,14 @@

            Details

          TabLimitConfig

          -

          Salesforce Documentation for TabLimitConfig

          +
          maxNumberOfPrimaryTabs

          a character

          maxNumberOfSubTabs

          a character

          Territory

          -

          Salesforce Documentation for Territory

          +
          caseAccessLevel

          a character (inherited from RoleOrTerritory)

          contactAccessLevel

          a character (inherited from RoleOrTerritory)

          description

          a character (inherited from RoleOrTerritory)

          @@ -9558,7 +9558,7 @@

          Details

          Territory2

          -

          Salesforce Documentation for Territory2

          +
          fullName

          a character (inherited from Metadata)

          accountAccessLevel

          a character

          caseAccessLevel

          a character

          @@ -9574,7 +9574,7 @@

          Details

          Territory2Model

          -

          Salesforce Documentation for Territory2Model

          +
          fullName

          a character (inherited from Metadata)

          customFields

          a FieldValue

          description

          a character

          @@ -9583,7 +9583,7 @@

          Details

          Territory2Rule

          -

          Salesforce Documentation for Territory2Rule

          +
          fullName

          a character (inherited from Metadata)

          active

          a character either 'true' or 'false'

          booleanFilter

          a character

          @@ -9594,14 +9594,14 @@

          Details

          Territory2RuleAssociation

          -

          Salesforce Documentation for Territory2RuleAssociation

          +
          inherited

          a character either 'true' or 'false'

          ruleName

          a character

          Territory2RuleItem

          -

          Salesforce Documentation for Territory2RuleItem

          +
          field

          a character

          operation

          a FilterOperation - which is a character taking one of the following values:

            @@ -9623,7 +9623,7 @@

            Details

          Territory2Settings

          -

          Salesforce Documentation for Territory2Settings

          +
          fullName

          a character (inherited from Metadata)

          defaultAccountAccessLevel

          a character

          defaultCaseAccessLevel

          a character

          @@ -9634,7 +9634,7 @@

          Details

          Territory2SettingsOpportunityFilter

          -

          Salesforce Documentation for Territory2SettingsOpportunityFilter

          +
          apexClassName

          a character

          enableFilter

          a character either 'true' or 'false'

          runOnCreate

          a character either 'true' or 'false'

          @@ -9642,16 +9642,16 @@

          Details

          Territory2Type

          -

          Salesforce Documentation for Territory2Type

          +
          fullName

          a character (inherited from Metadata)

          description

          a character

          name

          a character

          -
          priority

          a integer

          +
          priority

          an integer

          TopicsForObjects

          -

          Salesforce Documentation for TopicsForObjects

          +
          fullName

          a character (inherited from Metadata)

          enableTopics

          a character either 'true' or 'false'

          entityApiName

          a character

          @@ -9659,7 +9659,7 @@

          Details

          TouchMobileSettings

          -

          Salesforce Documentation for TouchMobileSettings

          +
          enableTouchAppIPad

          a character either 'true' or 'false'

          enableTouchAppIPhone

          a character either 'true' or 'false'

          enableTouchBrowserIPad

          a character either 'true' or 'false'

          @@ -9669,7 +9669,7 @@

          Details

          TransactionSecurityAction

          -

          Salesforce Documentation for TransactionSecurityAction

          +
          block

          a character either 'true' or 'false'

          endSession

          a character either 'true' or 'false'

          freezeUser

          a character either 'true' or 'false'

          @@ -9679,7 +9679,7 @@

          Details

          TransactionSecurityNotification

          -

          Salesforce Documentation for TransactionSecurityNotification

          +
          inApp

          a character either 'true' or 'false'

          sendEmail

          a character either 'true' or 'false'

          user

          a character

          @@ -9687,7 +9687,7 @@

          Details

          TransactionSecurityPolicy

          -

          Salesforce Documentation for TransactionSecurityPolicy

          +
          fullName

          a character (inherited from Metadata)

          action

          a TransactionSecurityAction

          active

          a character either 'true' or 'false'

          @@ -9722,7 +9722,7 @@

          Details

          Translations

          -

          Salesforce Documentation for Translations

          +
          fullName

          a character (inherited from Metadata)

          customApplications

          a CustomApplicationTranslation

          customDataTypeTranslations

          a CustomDataTypeTranslation

          @@ -9737,7 +9737,7 @@

          Details

          UiFormulaCriterion

          -

          Salesforce Documentation for UiFormulaCriterion

          +
          leftValue

          a character

          operator

          a character

          rightValue

          a character

          @@ -9745,15 +9745,15 @@

          Details

          UiFormulaRule

          -

          Salesforce Documentation for UiFormulaRule

          +
          booleanFilter

          a character

          criteria

          a UiFormulaCriterion

          UiPlugin

          -

          Salesforce Documentation for UiPlugin

          -
          content

          a character formed using RCurl::base64Encode (inherited from MetadataWithContent)

          +
          +
          content

          a character formed using base64encode (inherited from MetadataWithContent)

          description

          a character

          extensionPointIdentifier

          a character

          isEnabled

          a character either 'true' or 'false'

          @@ -9763,11 +9763,11 @@

          Details

          UserCriteria

          -

          Salesforce Documentation for UserCriteria

          +
          fullName

          a character (inherited from Metadata)

          -
          creationAgeInSeconds

          a integer

          +
          creationAgeInSeconds

          an integer

          description

          a character

          -
          lastChatterActivityAgeInSeconds

          a integer

          +
          lastChatterActivityAgeInSeconds

          an integer

          masterLabel

          a character

          profiles

          a character

          userTypes

          a NetworkUserType - which is a character taking one of the following values: @@ -9780,13 +9780,13 @@

          Details

          Users

          -

          Salesforce Documentation for Users

          +
          user

          a character

          ValidationRule

          -

          Salesforce Documentation for ValidationRule

          +
          fullName

          a character (inherited from Metadata)

          active

          a character either 'true' or 'false'

          description

          a character

          @@ -9797,14 +9797,14 @@

          Details

          ValidationRuleTranslation

          -

          Salesforce Documentation for ValidationRuleTranslation

          +
          errorMessage

          a character

          name

          a character

          ValueSet

          -

          Salesforce Documentation for ValueSet

          +
          controllingField

          a character

          restricted

          a character either 'true' or 'false'

          valueSetDefinition

          a ValueSetValuesDefinition

          @@ -9814,33 +9814,33 @@

          Details

          ValueSettings

          -

          Salesforce Documentation for ValueSettings

          +
          controllingFieldValue

          a character

          valueName

          a character

          ValueSetValuesDefinition

          -

          Salesforce Documentation for ValueSetValuesDefinition

          +
          sorted

          a character either 'true' or 'false'

          value

          a CustomValue

          ValueTranslation

          -

          Salesforce Documentation for ValueTranslation

          +
          masterLabel

          a character

          translation

          a character

          ValueTypeField

          -

          Salesforce Documentation for ValueTypeField

          +
          fields

          a ValueTypeField

          foreignKeyDomain

          a character

          isForeignKey

          a character either 'true' or 'false'

          isNameField

          a character either 'true' or 'false'

          -
          minOccurs

          a integer

          +
          minOccurs

          an integer

          name

          a character

          picklistValues

          a PicklistEntry

          soapType

          a character

          @@ -9849,7 +9849,7 @@

          Details

          VisualizationPlugin

          -

          Salesforce Documentation for VisualizationPlugin

          +
          fullName

          a character (inherited from Metadata)

          description

          a character

          developerName

          a character

          @@ -9861,10 +9861,10 @@

          Details

          VisualizationResource

          -

          Salesforce Documentation for VisualizationResource

          +
          description

          a character

          file

          a character

          -
          rank

          a integer

          +
          rank

          an integer

          type

          a VisualizationResourceType - which is a character taking one of the following values:

          • js

          • @@ -9874,7 +9874,7 @@

            Details

          VisualizationType

          -

          Salesforce Documentation for VisualizationType

          +
          description

          a character

          developerName

          a character

          icon

          a character

          @@ -9884,7 +9884,7 @@

          Details

          WaveApplication

          -

          Salesforce Documentation for WaveApplication

          +
          fullName

          a character (inherited from Metadata)

          assetIcon

          a character

          description

          a character

          @@ -9897,8 +9897,8 @@

          Details

          WaveDashboard

          -

          Salesforce Documentation for WaveDashboard

          -
          content

          a character formed using RCurl::base64Encode (inherited from MetadataWithContent)

          +
          +
          content

          a character formed using base64encode (inherited from MetadataWithContent)

          application

          a character

          description

          a character

          masterLabel

          a character

          @@ -9907,8 +9907,8 @@

          Details

          WaveDataflow

          -

          Salesforce Documentation for WaveDataflow

          -
          content

          a character formed using RCurl::base64Encode (inherited from MetadataWithContent)

          +
          +
          content

          a character formed using base64encode (inherited from MetadataWithContent)

          dataflowType

          a character

          description

          a character

          masterLabel

          a character

          @@ -9916,7 +9916,7 @@

          Details

          WaveDataset

          -

          Salesforce Documentation for WaveDataset

          +
          fullName

          a character (inherited from Metadata)

          application

          a character

          description

          a character

          @@ -9926,8 +9926,8 @@

          Details

          WaveLens

          -

          Salesforce Documentation for WaveLens

          -
          content

          a character formed using RCurl::base64Encode (inherited from MetadataWithContent)

          +
          +
          content

          a character formed using base64encode (inherited from MetadataWithContent)

          application

          a character

          datasets

          a character

          description

          a character

          @@ -9938,8 +9938,8 @@

          Details

          WaveRecipe

          -

          Salesforce Documentation for WaveRecipe

          -
          content

          a character formed using RCurl::base64Encode (inherited from MetadataWithContent)

          +
          +
          content

          a character formed using base64encode (inherited from MetadataWithContent)

          dataflow

          a character

          masterLabel

          a character

          securityPredicate

          a character

          @@ -9948,7 +9948,7 @@

          Details

          WaveTemplateBundle

          -

          Salesforce Documentation for WaveTemplateBundle

          +
          fullName

          a character (inherited from Metadata)

          assetIcon

          a character

          assetVersion

          a numeric

          @@ -9961,7 +9961,7 @@

          Details

          WaveXmd

          -

          Salesforce Documentation for WaveXmd

          +
          fullName

          a character (inherited from Metadata)

          application

          a character

          dataset

          a character

          @@ -9978,7 +9978,7 @@

          Details

          WaveXmdDate

          -

          Salesforce Documentation for WaveXmdDate

          +
          alias

          a character

          compact

          a character either 'true' or 'false'

          dateFieldDay

          a character

          @@ -9997,17 +9997,17 @@

          Details
          dateFieldWeek

          a character

          dateFieldYear

          a character

          description

          a character

          -
          firstDayOfWeek

          a integer

          -
          fiscalMonthOffset

          a integer

          +
          firstDayOfWeek

          an integer

          +
          fiscalMonthOffset

          an integer

          isYearEndFiscalYear

          a character either 'true' or 'false'

          label

          a character

          showInExplorer

          a character either 'true' or 'false'

          -
          sortIndex

          a integer

          +
          sortIndex

          an integer

          WaveXmdDimension

          -

          Salesforce Documentation for WaveXmdDimension

          +
          customActions

          a WaveXmdDimensionCustomAction

          customActionsEnabled

          a character either 'true' or 'false'

          dateFormat

          a character

          @@ -10028,19 +10028,19 @@

          Details
          recordOrganizationIdField

          a character

          salesforceActions

          a WaveXmdDimensionSalesforceAction

          salesforceActionsEnabled

          a character either 'true' or 'false'

          -
          showDetailsDefaultFieldIndex

          a integer

          +
          showDetailsDefaultFieldIndex

          an integer

          showInExplorer

          a character either 'true' or 'false'

          -
          sortIndex

          a integer

          +
          sortIndex

          an integer

          WaveXmdDimensionCustomAction

          -

          Salesforce Documentation for WaveXmdDimensionCustomAction

          +
          customActionName

          a character

          enabled

          a character either 'true' or 'false'

          icon

          a character

          method

          a character

          -
          sortIndex

          a integer

          +
          sortIndex

          an integer

          target

          a character

          tooltip

          a character

          url

          a character

          @@ -10048,29 +10048,29 @@

          Details

          WaveXmdDimensionMember

          -

          Salesforce Documentation for WaveXmdDimensionMember

          +
          color

          a character

          label

          a character

          member

          a character

          -
          sortIndex

          a integer

          +
          sortIndex

          an integer

          WaveXmdDimensionSalesforceAction

          -

          Salesforce Documentation for WaveXmdDimensionSalesforceAction

          +
          enabled

          a character either 'true' or 'false'

          salesforceActionName

          a character

          -
          sortIndex

          a integer

          +
          sortIndex

          an integer

          WaveXmdMeasure

          -

          Salesforce Documentation for WaveXmdMeasure

          +
          dateFormat

          a character

          description

          a character

          field

          a character

          formatCustomFormat

          a character

          -
          formatDecimalDigits

          a integer

          +
          formatDecimalDigits

          an integer

          formatIsNegativeParens

          a character either 'true' or 'false'

          formatPrefix

          a character

          formatSuffix

          a character

          @@ -10080,29 +10080,29 @@

          Details
          isDerived

          a character either 'true' or 'false'

          label

          a character

          origin

          a character

          -
          showDetailsDefaultFieldIndex

          a integer

          +
          showDetailsDefaultFieldIndex

          an integer

          showInExplorer

          a character either 'true' or 'false'

          -
          sortIndex

          a integer

          +
          sortIndex

          an integer

          WaveXmdOrganization

          -

          Salesforce Documentation for WaveXmdOrganization

          +
          instanceUrl

          a character

          label

          a character

          organizationIdentifier

          a character

          -
          sortIndex

          a integer

          +
          sortIndex

          an integer

          WaveXmdRecordDisplayLookup

          -

          Salesforce Documentation for WaveXmdRecordDisplayLookup

          +
          recordDisplayField

          a character

          WebLink

          -

          Salesforce Documentation for WebLink

          +
          fullName

          a character (inherited from Metadata)

          availability

          a WebLinkAvailability - which is a character taking one of the following values:

            @@ -10132,7 +10132,7 @@

            Details
            hasMenubar

            a character either 'true' or 'false'

            hasScrollbars

            a character either 'true' or 'false'

            hasToolbar

            a character either 'true' or 'false'

            -
            height

            a integer

            +
            height

            an integer

            isResizable

            a character either 'true' or 'false'

            linkType

            a WebLinkType - which is a character taking one of the following values:

              @@ -10164,19 +10164,19 @@

              Details
              showsLocation

              a character either 'true' or 'false'

              showsStatus

              a character either 'true' or 'false'

              url

              a character

              -
              width

              a integer

              +
              width

              an integer

          WebLinkTranslation

          -

          Salesforce Documentation for WebLinkTranslation

          +
          label

          a character

          name

          a character

          WebToCaseSettings

          -

          Salesforce Documentation for WebToCaseSettings

          +
          caseOrigin

          a character

          defaultResponseTemplate

          a character

          enableWebToCase

          a character either 'true' or 'false'

          @@ -10184,14 +10184,14 @@

          Details

          WeightedSourceCategory

          -

          Salesforce Documentation for WeightedSourceCategory

          +
          sourceCategoryApiName

          a character

          weight

          a numeric

          Workflow

          -

          Salesforce Documentation for Workflow

          +
          fullName

          a character (inherited from Metadata)

          alerts

          a WorkflowAlert

          fieldUpdates

          a WorkflowFieldUpdate

          @@ -10205,13 +10205,13 @@

          Details

          WorkflowAction

          -

          Salesforce Documentation for WorkflowAction

          +
          fullName

          a character (inherited from Metadata)

          WorkflowActionReference

          -

          Salesforce Documentation for WorkflowActionReference

          +
          name

          a character

          type

          a WorkflowActionType - which is a character taking one of the following values:

            @@ -10227,7 +10227,7 @@

            Details

          WorkflowAlert

          -

          Salesforce Documentation for WorkflowAlert

          +
          extends WorkflowAction

          see documentation for WorkflowAction

          ccEmails

          a character

          description

          a character

          @@ -10245,7 +10245,7 @@

          Details

          WorkflowEmailRecipient

          -

          Salesforce Documentation for WorkflowEmailRecipient

          +
          field

          a character

          recipient

          a character

          type

          a ActionEmailRecipientTypes - which is a character taking one of the following values: @@ -10274,7 +10274,7 @@

          Details

          WorkflowFieldUpdate

          -

          Salesforce Documentation for WorkflowFieldUpdate

          +
          extends WorkflowAction

          see documentation for WorkflowAction

          description

          a character

          field

          a character

          @@ -10305,7 +10305,7 @@

          Details

          WorkflowFlowAction

          -

          Salesforce Documentation for WorkflowFlowAction

          +
          extends WorkflowAction

          see documentation for WorkflowAction

          description

          a character

          flow

          a character

          @@ -10317,14 +10317,14 @@

          Details

          WorkflowFlowActionParameter

          -

          Salesforce Documentation for WorkflowFlowActionParameter

          +
          name

          a character

          value

          a character

          WorkflowKnowledgePublish

          -

          Salesforce Documentation for WorkflowKnowledgePublish

          +
          extends WorkflowAction

          see documentation for WorkflowAction

          action

          a KnowledgeWorkflowAction - which is a character taking one of the following values:

            @@ -10339,7 +10339,7 @@

            Details

          WorkflowRule

          -

          Salesforce Documentation for WorkflowRule

          +
          fullName

          a character (inherited from Metadata)

          actions

          a WorkflowActionReference

          active

          a character either 'true' or 'false'

          @@ -10359,7 +10359,7 @@

          Details

          WorkflowSend

          -

          Salesforce Documentation for WorkflowSend

          +
          extends WorkflowAction

          see documentation for WorkflowAction

          action

          a SendAction - which is a character taking one of the following values:

            @@ -10373,7 +10373,7 @@

            Details

          WorkflowTask

          -

          Salesforce Documentation for WorkflowTask

          +
          extends WorkflowAction

          see documentation for WorkflowAction

          assignedTo

          a character

          assignedToType

          a ActionTaskAssignedToTypes - which is a character taking one of the following values: @@ -10390,7 +10390,7 @@

          Details
        • portalRole

        • description

          a character

          -
          dueDateOffset

          a integer

          +
          dueDateOffset

          an integer

          notifyAssignee

          a character either 'true' or 'false'

          offsetFromField

          a character

          priority

          a character

          @@ -10401,7 +10401,7 @@

          Details

          WorkflowTaskTranslation

          -

          Salesforce Documentation for WorkflowTaskTranslation

          +
          description

          a character

          name

          a character

          subject

          a character

          @@ -10409,7 +10409,7 @@

          Details

          WorkflowTimeTrigger

          -

          Salesforce Documentation for WorkflowTimeTrigger

          +
          actions

          a WorkflowActionReference

          offsetFromField

          a character

          timeLength

          a character

          @@ -10422,7 +10422,7 @@

          Details

          WorkspaceMapping

          -

          Salesforce Documentation for WorkspaceMapping

          +
          fieldName

          a character

          tab

          a character

          @@ -10444,7 +10444,7 @@

          Contents

          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/parameterized_search_control.html b/docs/reference/parameterized_search_control.html index 8e5932e3..a8c0d431 100644 --- a/docs/reference/parameterized_search_control.html +++ b/docs/reference/parameterized_search_control.html @@ -97,7 +97,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -105,7 +105,7 @@
          @@ -244,15 +244,16 @@

          R

          https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search_parameterized.htm#resources_search_parameterized

          Examples

          -
          if (FALSE) { +
          if (FALSE) { # free text search only on Contact record Phone fields # this will improve the performance of the search -my_phone_search <- "(336)" -search_result <- sf_search(my_phone_search, - objects = c("Contact", "Lead"), - fields_scope = "PHONE", - fields = c("Id", "FirstName", "LastName")) -}
          +my_phone_search <- "(336)" +search_result <- sf_search(my_phone_search, + objects = c("Contact", "Lead"), + fields_scope = "PHONE", + fields = c("Id", "FirstName", "LastName")) +} +
          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/parse_error_code_and_message.html b/docs/reference/parse_error_code_and_message.html index 83c331c7..28b3b843 100644 --- a/docs/reference/parse_error_code_and_message.html +++ b/docs/reference/parse_error_code_and_message.html @@ -96,7 +96,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -104,7 +104,7 @@
          @@ -252,7 +252,7 @@

          Value

          and the columns represent the detail columns.

          Note

          -

          Below are the fact map key patterns for three report types:

          +

          Below are the fact map key patterns for three report types:

          TABULAR

          T!T: The grand total of a report. Both record data values and the grand total are represented by this key.

          SUMMARY

          <First level row grouping_second level row grouping_third @@ -264,7 +264,7 @@

          Note

          Each item in a row or column grouping is numbered starting with 0. Here are some examples of fact map keys:

          - +
          0!T

          The first item in the first-level grouping.

          1!T

          The second item in the first-level grouping.

          0_0!T

          The first item in the first-level grouping and the first item @@ -291,7 +291,7 @@

          Contents

          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/patched_tempdir.html b/docs/reference/patched_tempdir.html index dca26a50..5f91bac4 100644 --- a/docs/reference/patched_tempdir.html +++ b/docs/reference/patched_tempdir.html @@ -98,7 +98,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -106,7 +106,7 @@
          @@ -238,7 +238,7 @@

          Contents

          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/remove_empty_linked_object_cols.html b/docs/reference/remove_empty_linked_object_cols.html index 35aca586..58a05ee4 100644 --- a/docs/reference/remove_empty_linked_object_cols.html +++ b/docs/reference/remove_empty_linked_object_cols.html @@ -98,7 +98,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -106,7 +106,7 @@
          @@ -225,7 +225,7 @@

          Contents

          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/return_matching_controls.html b/docs/reference/return_matching_controls.html index 3cbd40ae..3abe02f9 100644 --- a/docs/reference/return_matching_controls.html +++ b/docs/reference/return_matching_controls.html @@ -96,7 +96,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -104,7 +104,7 @@
          @@ -213,7 +213,7 @@

          Arg

          @@ -270,13 +270,14 @@

          R

          https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/

          Examples

          -
          if (FALSE) { +
          if (FALSE) { # update Account object -updates <- rforcecom.bulkAction(session, - operation = 'update', - data = my_data, - object = 'Account') -}
          +updates <- rforcecom.bulkAction(session, + operation = 'update', + data = my_data, + object = 'Account') +} +
          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/rforcecom.bulkQuery.html b/docs/reference/rforcecom.bulkQuery.html index cd0f1c9a..00807db8 100644 --- a/docs/reference/rforcecom.bulkQuery.html +++ b/docs/reference/rforcecom.bulkQuery.html @@ -6,8 +6,8 @@ -The <code>salesforcer</code> backwards compatible version of -<code><a href='https://rdrr.io/pkg/RForcecom/man/rforcecom.bulkQuery.html'>rforcecom.bulkQuery</a></code> — rforcecom.bulkQuery • salesforcer +The salesforcer backwards compatible version of +RForcecom::rforcecom.bulkQuery — rforcecom.bulkQuery • salesforcer @@ -53,8 +53,8 @@ - + @@ -98,7 +98,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -106,7 +106,7 @@
          session

          list; a list containing "sessionID", "instanceURL", and "apiVersion" as returned by -rforcecom.login. This argument is ignored in all +RForcecom::rforcecom.login. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer necessary to pass the session in each function call.

          @@ -207,7 +207,7 @@

          Arg

          @@ -258,7 +258,7 @@

          Contents

          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/rforcecom.create.html b/docs/reference/rforcecom.create.html index a7a94aab..30628722 100644 --- a/docs/reference/rforcecom.create.html +++ b/docs/reference/rforcecom.create.html @@ -6,8 +6,8 @@ -The <code>salesforcer</code> backwards compatible version of -<code><a href='https://rdrr.io/pkg/RForcecom/man/rforcecom.create.html'>rforcecom.create</a></code> — rforcecom.create • salesforcer +The salesforcer backwards compatible version of +RForcecom::rforcecom.create — rforcecom.create • salesforcer @@ -53,8 +53,8 @@ - + @@ -98,7 +98,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -106,7 +106,7 @@
          session

          list; a list containing "sessionID", "instanceURL", and "apiVersion" as returned by -rforcecom.login. This argument is ignored in all +RForcecom::rforcecom.login. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer necessary to pass the session in each function call.

          @@ -200,7 +200,7 @@

          Arg

          @@ -235,7 +235,7 @@

          Contents

          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/rforcecom.delete.html b/docs/reference/rforcecom.delete.html index 754154ad..ef83f45c 100644 --- a/docs/reference/rforcecom.delete.html +++ b/docs/reference/rforcecom.delete.html @@ -6,8 +6,8 @@ -The <code>salesforcer</code> backwards compatible version of -<code><a href='https://rdrr.io/pkg/RForcecom/man/rforcecom.delete.html'>rforcecom.delete</a></code> — rforcecom.delete • salesforcer +The salesforcer backwards compatible version of +RForcecom::rforcecom.delete — rforcecom.delete • salesforcer @@ -53,8 +53,8 @@ - + @@ -98,7 +98,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -106,7 +106,7 @@
          session

          list; a list containing "sessionID", "instanceURL", and "apiVersion" as returned by -rforcecom.login. This argument is ignored in all +RForcecom::rforcecom.login. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer necessary to pass the session in each function call.

          @@ -200,7 +200,7 @@

          Arg

          @@ -235,7 +235,7 @@

          Contents

          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/rforcecom.getObjectDescription.html b/docs/reference/rforcecom.getObjectDescription.html index f73bf8e7..c7e019a5 100644 --- a/docs/reference/rforcecom.getObjectDescription.html +++ b/docs/reference/rforcecom.getObjectDescription.html @@ -6,8 +6,8 @@ -The <code>salesforcer</code> backwards compatible version of -<code><a href='https://rdrr.io/pkg/RForcecom/man/rforcecom.getObjectDescription.html'>rforcecom.getObjectDescription</a></code> — rforcecom.getObjectDescription • salesforcer +The salesforcer backwards compatible version of +RForcecom::rforcecom.getObjectDescription — rforcecom.getObjectDescription • salesforcer @@ -53,8 +53,8 @@ - + @@ -98,7 +98,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -106,7 +106,7 @@
          session

          list; a list containing "sessionID", "instanceURL", and "apiVersion" as returned by -rforcecom.login. This argument is ignored in all +RForcecom::rforcecom.login. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer necessary to pass the session in each function call.

          @@ -200,7 +200,7 @@

          Arg

          @@ -234,7 +234,7 @@

          Contents

          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/rforcecom.getServerTimestamp.html b/docs/reference/rforcecom.getServerTimestamp.html index 0df3c9ea..d311578b 100644 --- a/docs/reference/rforcecom.getServerTimestamp.html +++ b/docs/reference/rforcecom.getServerTimestamp.html @@ -6,8 +6,8 @@ -The <code>salesforcer</code> backwards compatible version of -<code><a href='https://rdrr.io/pkg/RForcecom/man/rforcecom.getServerTimestamp.html'>rforcecom.getServerTimestamp</a></code> — rforcecom.getServerTimestamp • salesforcer +The salesforcer backwards compatible version of +RForcecom::rforcecom.getServerTimestamp — rforcecom.getServerTimestamp • salesforcer @@ -53,8 +53,8 @@ - + @@ -98,7 +98,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -106,7 +106,7 @@
          session

          list; a list containing "sessionID", "instanceURL", and "apiVersion" as returned by -rforcecom.login. This argument is ignored in all +RForcecom::rforcecom.login. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer necessary to pass the session in each function call.

          @@ -200,7 +200,7 @@

          Arg

          @@ -223,7 +223,7 @@

          Contents

          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/rforcecom.login.html b/docs/reference/rforcecom.login.html index 7ec1d48f..57f68630 100644 --- a/docs/reference/rforcecom.login.html +++ b/docs/reference/rforcecom.login.html @@ -6,8 +6,8 @@ -The <code>salesforcer</code> backwards compatible version of -<code><a href='https://rdrr.io/pkg/RForcecom/man/rforcecom.login.html'>rforcecom.login</a></code> — rforcecom.login • salesforcer +The salesforcer backwards compatible version of +RForcecom::rforcecom.login — rforcecom.login • salesforcer @@ -53,8 +53,8 @@ - + @@ -98,7 +98,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -106,7 +106,7 @@
          session

          list; a list containing "sessionID", "instanceURL", and "apiVersion" as returned by -rforcecom.login. This argument is ignored in all +RForcecom::rforcecom.login. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer necessary to pass the session in each function call.

          @@ -243,7 +243,7 @@

          Contents

          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/rforcecom.query.html b/docs/reference/rforcecom.query.html index f4fd0e5e..f89d8b82 100644 --- a/docs/reference/rforcecom.query.html +++ b/docs/reference/rforcecom.query.html @@ -6,8 +6,8 @@ -The <code>salesforcer</code> backwards compatible version of -<code><a href='https://rdrr.io/pkg/RForcecom/man/rforcecom.query.html'>rforcecom.query</a></code> — rforcecom.query • salesforcer +The salesforcer backwards compatible version of +RForcecom::rforcecom.query — rforcecom.query • salesforcer @@ -53,8 +53,8 @@ - + @@ -98,7 +98,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -106,7 +106,7 @@
          @@ -200,7 +200,7 @@

          Arg

          @@ -236,7 +236,7 @@

          Contents

          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/rforcecom.retrieve.html b/docs/reference/rforcecom.retrieve.html index 00755e0f..de98d344 100644 --- a/docs/reference/rforcecom.retrieve.html +++ b/docs/reference/rforcecom.retrieve.html @@ -6,8 +6,8 @@ -The <code>salesforcer</code> backwards compatible version of -<code><a href='https://rdrr.io/pkg/RForcecom/man/rforcecom.retrieve.html'>rforcecom.retrieve</a></code> — rforcecom.retrieve • salesforcer +The salesforcer backwards compatible version of +RForcecom::rforcecom.retrieve — rforcecom.retrieve • salesforcer @@ -53,8 +53,8 @@ - + @@ -98,7 +98,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -106,7 +106,7 @@
          session

          list; a list containing "sessionID", "instanceURL", and "apiVersion" as returned by -rforcecom.login. This argument is ignored in all +RForcecom::rforcecom.login. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer necessary to pass the session in each function call.

          @@ -210,7 +210,7 @@

          Arg

          @@ -271,7 +271,7 @@

          Contents

          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/rforcecom.search.html b/docs/reference/rforcecom.search.html index ad88bf4e..211a9d42 100644 --- a/docs/reference/rforcecom.search.html +++ b/docs/reference/rforcecom.search.html @@ -6,8 +6,8 @@ -The <code>salesforcer</code> backwards compatible version of -<code><a href='https://rdrr.io/pkg/RForcecom/man/rforcecom.search.html'>rforcecom.search</a></code> — rforcecom.search • salesforcer +The salesforcer backwards compatible version of +RForcecom::rforcecom.search — rforcecom.search • salesforcer @@ -53,8 +53,8 @@ - + @@ -98,7 +98,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -106,7 +106,7 @@
          session

          list; a list containing "sessionID", "instanceURL", and "apiVersion" as returned by -rforcecom.login. This argument is ignored in all +RForcecom::rforcecom.login. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer necessary to pass the session in each function call.

          @@ -200,7 +200,7 @@

          Arg

          @@ -227,7 +227,7 @@

          Contents

          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/rforcecom.update.html b/docs/reference/rforcecom.update.html index c7ae3e59..828b0540 100644 --- a/docs/reference/rforcecom.update.html +++ b/docs/reference/rforcecom.update.html @@ -6,8 +6,8 @@ -The <code>salesforcer</code> backwards compatible version of -<code><a href='https://rdrr.io/pkg/RForcecom/man/rforcecom.update.html'>rforcecom.update</a></code> — rforcecom.update • salesforcer +The salesforcer backwards compatible version of +RForcecom::rforcecom.update — rforcecom.update • salesforcer @@ -53,8 +53,8 @@ - + @@ -98,7 +98,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -106,7 +106,7 @@
          session

          list; a list containing "sessionID", "instanceURL", and "apiVersion" as returned by -rforcecom.login. This argument is ignored in all +RForcecom::rforcecom.login. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer necessary to pass the session in each function call.

          @@ -200,7 +200,7 @@

          Arg

          @@ -239,7 +239,7 @@

          Contents

          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/rforcecom.upsert.html b/docs/reference/rforcecom.upsert.html index 2b0a2362..45475005 100644 --- a/docs/reference/rforcecom.upsert.html +++ b/docs/reference/rforcecom.upsert.html @@ -6,8 +6,8 @@ -The <code>salesforcer</code> backwards compatible version of -<code><a href='https://rdrr.io/pkg/RForcecom/man/rforcecom.upsert.html'>rforcecom.upsert</a></code> — rforcecom.upsert • salesforcer +The salesforcer backwards compatible version of +RForcecom::rforcecom.upsert — rforcecom.upsert • salesforcer @@ -53,8 +53,8 @@ - + @@ -98,7 +98,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -106,7 +106,7 @@
          session

          list; a list containing "sessionID", "instanceURL", and "apiVersion" as returned by -rforcecom.login. This argument is ignored in all +RForcecom::rforcecom.login. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer necessary to pass the session in each function call.

          @@ -200,7 +200,7 @@

          Arg

          @@ -243,7 +243,7 @@

          Contents

          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/safe_bind_rows.html b/docs/reference/safe_bind_rows.html index d9852462..b8e1cbda 100644 --- a/docs/reference/safe_bind_rows.html +++ b/docs/reference/safe_bind_rows.html @@ -98,7 +98,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -106,7 +106,7 @@
          session

          list; a list containing "sessionID", "instanceURL", and "apiVersion" as returned by -rforcecom.login. This argument is ignored in all +RForcecom::rforcecom.login. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer necessary to pass the session in each function call.

          @@ -242,7 +242,7 @@

          Contents

          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/salesforcer-package.html b/docs/reference/salesforcer-package.html index 952db766..a5aa388d 100644 --- a/docs/reference/salesforcer-package.html +++ b/docs/reference/salesforcer-package.html @@ -6,7 +6,7 @@ -<code>salesforcer</code> package — salesforcer-package • salesforcer +salesforcer package — salesforcer-package • salesforcer @@ -52,7 +52,7 @@ - + @@ -96,7 +96,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -104,7 +104,7 @@
          @@ -225,7 +225,7 @@

          Contents

          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/set_null_elements_to_na_recursively.html b/docs/reference/set_null_elements_to_na_recursively.html index de8b31a2..f01e0710 100644 --- a/docs/reference/set_null_elements_to_na_recursively.html +++ b/docs/reference/set_null_elements_to_na_recursively.html @@ -97,7 +97,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -105,7 +105,7 @@
          @@ -223,7 +223,7 @@

          Contents

          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/sf_abort_job_bulk.html b/docs/reference/sf_abort_job_bulk.html index 0ac2e05f..2ed182c6 100644 --- a/docs/reference/sf_abort_job_bulk.html +++ b/docs/reference/sf_abort_job_bulk.html @@ -96,7 +96,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -104,7 +104,7 @@
          @@ -225,10 +225,11 @@

          R

          https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/

          Examples

          -
          if (FALSE) { -job_info <- sf_create_job_bulk('insert', 'Account') -sf_abort_job_bulk(job_info$id) -}
          +
          if (FALSE) { +job_info <- sf_create_job_bulk('insert', 'Account') +sf_abort_job_bulk(job_info$id) +} +
          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/sf_access_token.html b/docs/reference/sf_access_token.html index ca181180..aa2dcca3 100644 --- a/docs/reference/sf_access_token.html +++ b/docs/reference/sf_access_token.html @@ -96,7 +96,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -104,7 +104,7 @@
          @@ -225,7 +225,7 @@

          Contents

          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/sf_analytics_notification_create.html b/docs/reference/sf_analytics_notification_create.html index 561aece5..28f8725c 100644 --- a/docs/reference/sf_analytics_notification_create.html +++ b/docs/reference/sf_analytics_notification_create.html @@ -96,7 +96,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -104,7 +104,7 @@
          @@ -222,7 +222,7 @@

          Contents

          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/sf_analytics_notification_delete.html b/docs/reference/sf_analytics_notification_delete.html index 58c13c44..9da53bbb 100644 --- a/docs/reference/sf_analytics_notification_delete.html +++ b/docs/reference/sf_analytics_notification_delete.html @@ -96,7 +96,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -104,7 +104,7 @@
          @@ -219,7 +219,7 @@

          Contents

          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/sf_analytics_notification_describe.html b/docs/reference/sf_analytics_notification_describe.html index 5f101680..2028b8be 100644 --- a/docs/reference/sf_analytics_notification_describe.html +++ b/docs/reference/sf_analytics_notification_describe.html @@ -96,7 +96,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -104,7 +104,7 @@
          @@ -219,7 +219,7 @@

          Contents

          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/sf_analytics_notification_update.html b/docs/reference/sf_analytics_notification_update.html index 714ddde5..fd95459f 100644 --- a/docs/reference/sf_analytics_notification_update.html +++ b/docs/reference/sf_analytics_notification_update.html @@ -96,7 +96,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -104,7 +104,7 @@
          @@ -227,7 +227,7 @@

          Contents

          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/sf_analytics_notifications_limits.html b/docs/reference/sf_analytics_notifications_limits.html index 46fc89c9..7255f603 100644 --- a/docs/reference/sf_analytics_notifications_limits.html +++ b/docs/reference/sf_analytics_notifications_limits.html @@ -96,7 +96,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -104,7 +104,7 @@
          @@ -200,7 +200,7 @@

          Arg

          source

          character; a vector of character to specify what type of -analytics notification to return. Valid values are:

          +analytics notification to return. Valid values are:

          lightningDashboardSubscribe

          Dashboard subscriptions

          lightningReportSubscribe

          Report subscriptions

          waveNotification

          Einstein Analytics notifications

          @@ -235,7 +235,7 @@

          Contents

          -

          Site built with pkgdown 1.5.1.

          +

          Site built with pkgdown 1.6.1.

          diff --git a/docs/reference/sf_analytics_notifications_list.html b/docs/reference/sf_analytics_notifications_list.html index f59a4f8b..0350eadb 100644 --- a/docs/reference/sf_analytics_notifications_list.html +++ b/docs/reference/sf_analytics_notifications_list.html @@ -96,7 +96,7 @@ salesforcer - 0.2.2 + 1.0.0 @@ -104,7 +104,7 @@