diff --git a/R/utils-org.R b/R/utils-org.R index abef552e..2d8df5d8 100644 --- a/R/utils-org.R +++ b/R/utils-org.R @@ -503,11 +503,11 @@ sf_find_duplicates_by_id <- function(sf_id, #' @param victim_ids character; one or two Salesforce Ids of records to be merged into #' the master record. Up to three records can be merged in a single request, including #' the master record. This limit is the same as the limit enforced by the Salesforce user -#' interface. To merge more than 3 records, successively merge records by re-running -#' this \code{\link{sf_merge}} repeatedly. +#' interface. To merge more than 3 records, successively merge records by running +#' \code{\link{sf_merge}} repeatedly. #' @template object_name -#' @param master_fields \code{named vector}; a vector of field names and values in -#' to supersede the master record values. Otherwise, the field values on the master record +#' @param master_fields \code{named vector}; a vector of field names and values to +#' supersede the master record values. Otherwise, the field values on the master record #' will prevail. #' @template api_type #' @template control @@ -603,9 +603,9 @@ sf_merge <- function(master_id, #' @importFrom purrr map_df #' @importFrom readr type_convert cols #' @template object_name -#' @param start \code{date} or \code{datetime}; Starting datetime of the timespan +#' @param start \code{date} or \code{datetime}; starting datetime of the timespan #' for which to retrieve the data. -#' @param end \code{date} or \code{datetime}; Ending datetime of the timespan for +#' @param end \code{date} or \code{datetime}; ending datetime of the timespan for #' which to retrieve the data. #' @template verbose #' @examples @@ -673,9 +673,9 @@ sf_get_deleted <- function(object_name, #' @importFrom dplyr tibble #' @importFrom readr type_convert cols #' @template object_name -#' @param start \code{date} or \code{datetime}; Starting datetime of the timespan +#' @param start \code{date} or \code{datetime}; starting datetime of the timespan #' for which to retrieve the data. -#' @param end \code{date} or \code{datetime}; Ending datetime of the timespan for +#' @param end \code{date} or \code{datetime}; ending datetime of the timespan for #' which to retrieve the data. #' @template verbose #' @examples diff --git a/docs/articles/getting-started.html b/docs/articles/getting-started.html index b395fe34..31dde28b 100644 --- a/docs/articles/getting-started.html +++ b/docs/articles/getting-started.html @@ -134,10 +134,10 @@

2018-03-12

# it's a simple easy call to get started # and confirm a connection to the APIs user_info <- sf_user_info() -sprintf("User Id: %s", user_info$id) -#> character(0) -sprintf("User Active?: %s", user_info$isActive) -#> character(0) +sprintf("Organization Id: %s", user_info$organizationId) +#> [1] "Organization Id: 00D6A0000003dN3UAI" +sprintf("User Id: %s", user_info$userId) +#> [1] "User Id: 0056A000000MPRjQAO"

Create

@@ -150,8 +150,8 @@

#> # A tibble: 2 x 2 #> id success #> <chr> <lgl> -#> 1 0036A00000wzkdLQAQ TRUE -#> 2 0036A00000wzkdMQAQ TRUE

+#> 1 0036A00000wzl34QAA TRUE +#> 2 0036A00000wzl35QAA TRUE

@@ -164,8 +164,8 @@

#> # A tibble: 2 x 3 #> Id FirstName LastName #> <chr> <chr> <chr> -#> 1 0036A00000wzkdLQAQ Test Contact-Create-1 -#> 2 0036A00000wzkdMQAQ Test Contact-Create-2

+#> 1 0036A00000wzl34QAA Test Contact-Create-1 +#> 2 0036A00000wzl35QAA Test Contact-Create-2

@@ -184,8 +184,8 @@

#> # A tibble: 2 x 4 #> Id Account FirstName LastName #> <chr> <lgl> <chr> <chr> -#> 1 0036A00000wzkdLQAQ NA Test Contact-Create-1 -#> 2 0036A00000wzkdMQAQ NA Test Contact-Create-2

+#> 1 0036A00000wzl34QAA NA Test Contact-Create-1 +#> 2 0036A00000wzl35QAA NA Test Contact-Create-2

@@ -201,8 +201,8 @@

#> # A tibble: 2 x 2 #> id success #> <chr> <lgl> -#> 1 0036A00000wzkdLQAQ TRUE -#> 2 0036A00000wzkdMQAQ TRUE

+#> 1 0036A00000wzl34QAA TRUE +#> 2 0036A00000wzl35QAA TRUE

@@ -213,8 +213,8 @@

#> # A tibble: 2 x 3 #> id success errors #> <chr> <lgl> <list> -#> 1 0036A00000wzkdLQAQ TRUE <list [0]> -#> 2 0036A00000wzkdMQAQ TRUE <list [0]>

+#> 1 0036A00000wzl34QAA TRUE <list [0]> +#> 2 0036A00000wzl35QAA TRUE <list [0]>

@@ -241,9 +241,9 @@

#> # A tibble: 3 x 3 #> created id success #> <lgl> <chr> <lgl> -#> 1 FALSE 0036A00000wzkdQQAQ TRUE -#> 2 FALSE 0036A00000wzkdRQAQ TRUE -#> 3 TRUE 0036A00000wzkdVQAQ TRUE

+#> 1 FALSE 0036A00000wzl39QAA TRUE +#> 2 FALSE 0036A00000wzl3AQAQ TRUE +#> 3 TRUE 0036A00000wzl3EQAQ TRUE

diff --git a/docs/reference/sf_get_deleted.html b/docs/reference/sf_get_deleted.html index cdb40b6f..2d146e13 100644 --- a/docs/reference/sf_get_deleted.html +++ b/docs/reference/sf_get_deleted.html @@ -175,12 +175,12 @@

Arg start -

date or datetime; Starting datetime of the timespan +

date or datetime; starting datetime of the timespan for which to retrieve the data.

end -

date or datetime; Ending datetime of the timespan for +

date or datetime; ending datetime of the timespan for which to retrieve the data.

diff --git a/docs/reference/sf_get_updated.html b/docs/reference/sf_get_updated.html index 6aef0a00..5e056406 100644 --- a/docs/reference/sf_get_updated.html +++ b/docs/reference/sf_get_updated.html @@ -175,12 +175,12 @@

Arg start -

date or datetime; Starting datetime of the timespan +

date or datetime; starting datetime of the timespan for which to retrieve the data.

end -

date or datetime; Ending datetime of the timespan for +

date or datetime; ending datetime of the timespan for which to retrieve the data.

diff --git a/docs/reference/sf_merge.html b/docs/reference/sf_merge.html index c8792499..66a96c6f 100644 --- a/docs/reference/sf_merge.html +++ b/docs/reference/sf_merge.html @@ -184,8 +184,8 @@

Arg

character; one or two Salesforce Ids of records to be merged into the master record. Up to three records can be merged in a single request, including the master record. This limit is the same as the limit enforced by the Salesforce user -interface. To merge more than 3 records, successively merge records by re-running -this sf_merge repeatedly.

+interface. To merge more than 3 records, successively merge records by running +sf_merge repeatedly.

object_name @@ -194,8 +194,8 @@

Arg master_fields -

named vector; a vector of field names and values in -to supersede the master record values. Otherwise, the field values on the master record +

named vector; a vector of field names and values to +supersede the master record values. Otherwise, the field values on the master record will prevail.

diff --git a/man/sf_get_deleted.Rd b/man/sf_get_deleted.Rd index cb8179a5..776c9b1a 100644 --- a/man/sf_get_deleted.Rd +++ b/man/sf_get_deleted.Rd @@ -10,10 +10,10 @@ sf_get_deleted(object_name, start, end, verbose = FALSE) \item{object_name}{character; the name of one Salesforce objects that the function is operating against (e.g. "Account", "Contact", "CustomObject__c")} -\item{start}{\code{date} or \code{datetime}; Starting datetime of the timespan +\item{start}{\code{date} or \code{datetime}; starting datetime of the timespan for which to retrieve the data.} -\item{end}{\code{date} or \code{datetime}; Ending datetime of the timespan for +\item{end}{\code{date} or \code{datetime}; ending datetime of the timespan for which to retrieve the data.} \item{verbose}{logical; do you want informative messages?} diff --git a/man/sf_get_updated.Rd b/man/sf_get_updated.Rd index 304708d0..8920cc21 100644 --- a/man/sf_get_updated.Rd +++ b/man/sf_get_updated.Rd @@ -10,10 +10,10 @@ sf_get_updated(object_name, start, end, verbose = FALSE) \item{object_name}{character; the name of one Salesforce objects that the function is operating against (e.g. "Account", "Contact", "CustomObject__c")} -\item{start}{\code{date} or \code{datetime}; Starting datetime of the timespan +\item{start}{\code{date} or \code{datetime}; starting datetime of the timespan for which to retrieve the data.} -\item{end}{\code{date} or \code{datetime}; Ending datetime of the timespan for +\item{end}{\code{date} or \code{datetime}; ending datetime of the timespan for which to retrieve the data.} \item{verbose}{logical; do you want informative messages?} diff --git a/man/sf_merge.Rd b/man/sf_merge.Rd index 3a50157f..28f6d858 100644 --- a/man/sf_merge.Rd +++ b/man/sf_merge.Rd @@ -15,14 +15,14 @@ which is the record to which the victim records will be merged into} \item{victim_ids}{character; one or two Salesforce Ids of records to be merged into the master record. Up to three records can be merged in a single request, including the master record. This limit is the same as the limit enforced by the Salesforce user -interface. To merge more than 3 records, successively merge records by re-running -this \code{\link{sf_merge}} repeatedly.} +interface. To merge more than 3 records, successively merge records by running +\code{\link{sf_merge}} repeatedly.} \item{object_name}{character; the name of one Salesforce objects that the function is operating against (e.g. "Account", "Contact", "CustomObject__c")} -\item{master_fields}{\code{named vector}; a vector of field names and values in -to supersede the master record values. Otherwise, the field values on the master record +\item{master_fields}{\code{named vector}; a vector of field names and values to +supersede the master record values. Otherwise, the field values on the master record will prevail.} \item{api_type}{character; one of "REST", "SOAP", "Bulk 1.0", "Bulk 2.0", or diff --git a/vignettes/getting-started.R b/vignettes/getting-started.R index 46c593f2..fe4bdda3 100644 --- a/vignettes/getting-started.R +++ b/vignettes/getting-started.R @@ -30,8 +30,8 @@ suppressMessages(sf_auth(token = token_path, verbose = FALSE)) # it's a simple easy call to get started # and confirm a connection to the APIs user_info <- sf_user_info() -sprintf("User Id: %s", user_info$id) -sprintf("User Active?: %s", user_info$isActive) +sprintf("Organization Id: %s", user_info$organizationId) +sprintf("User Id: %s", user_info$userId) ## ------------------------------------------------------------------------ n <- 2 diff --git a/vignettes/getting-started.md b/vignettes/getting-started.md index 9e4c7096..07ed1af0 100644 --- a/vignettes/getting-started.md +++ b/vignettes/getting-started.md @@ -54,10 +54,10 @@ the information returned about the current user. It should be information about # it's a simple easy call to get started # and confirm a connection to the APIs user_info <- sf_user_info() -sprintf("User Id: %s", user_info$id) -#> character(0) -sprintf("User Active?: %s", user_info$isActive) -#> character(0) +sprintf("Organization Id: %s", user_info$organizationId) +#> [1] "Organization Id: 00D6A0000003dN3UAI" +sprintf("User Id: %s", user_info$userId) +#> [1] "User Id: 0056A000000MPRjQAO" ``` ### Create @@ -75,8 +75,8 @@ created_records #> # A tibble: 2 x 2 #> id success #> -#> 1 0036A00000wzh4VQAQ TRUE -#> 2 0036A00000wzh4WQAQ TRUE +#> 1 0036A00000wzkqeQAA TRUE +#> 2 0036A00000wzkqfQAA TRUE ``` ### Retrieve @@ -94,8 +94,8 @@ retrieved_records #> # A tibble: 2 x 3 #> Id FirstName LastName #> -#> 1 0036A00000wzh4VQAQ Test Contact-Create-1 -#> 2 0036A00000wzh4WQAQ Test Contact-Create-2 +#> 1 0036A00000wzkqeQAA Test Contact-Create-1 +#> 2 0036A00000wzkqfQAA Test Contact-Create-2 ``` ### Query @@ -123,8 +123,8 @@ queried_records #> # A tibble: 2 x 4 #> Id Account FirstName LastName #> -#> 1 0036A00000wzh4VQAQ NA Test Contact-Create-1 -#> 2 0036A00000wzh4WQAQ NA Test Contact-Create-2 +#> 1 0036A00000wzkqeQAA NA Test Contact-Create-1 +#> 2 0036A00000wzkqfQAA NA Test Contact-Create-2 ``` ### Update @@ -149,8 +149,8 @@ updated_records #> # A tibble: 2 x 2 #> id success #> -#> 1 0036A00000wzh4VQAQ TRUE -#> 2 0036A00000wzh4WQAQ TRUE +#> 1 0036A00000wzkqeQAA TRUE +#> 2 0036A00000wzkqfQAA TRUE ``` ### Delete @@ -165,8 +165,8 @@ deleted_records #> # A tibble: 2 x 3 #> id success errors #> -#> 1 0036A00000wzh4VQAQ TRUE -#> 2 0036A00000wzh4WQAQ TRUE +#> 1 0036A00000wzkqeQAA TRUE +#> 2 0036A00000wzkqfQAA TRUE ``` ### Upsert @@ -201,9 +201,9 @@ upserted_records #> # A tibble: 3 x 3 #> created id success #> -#> 1 FALSE 0036A00000wzh4XQAQ TRUE -#> 2 FALSE 0036A00000wzh4YQAQ TRUE -#> 3 TRUE 0036A00000wzh4aQAA TRUE +#> 1 FALSE 0036A00000wzkqjQAA TRUE +#> 2 FALSE 0036A00000wzkqkQAA TRUE +#> 3 TRUE 0036A00000wzkqoQAA TRUE ```