4
4
<!-- badges: start -->
5
5
6
6
[ ![ R Build
7
- Status] ( https://github.com/StevenMMortimer /salesforcer/workflows/R-CMD-check/badge.svg )] ( https://github.com/StevenMMortimer /salesforcer/actions?workflow=R-CMD-check )
7
+ Status] ( https://github.com/stevenmmortimer /salesforcer/workflows/R-CMD-check/badge.svg )] ( https://github.com/stevenmmortimer /salesforcer/actions?workflow=R-CMD-check )
8
8
[ ![ CRAN
9
9
Status] ( https://www.r-pkg.org/badges/version/salesforcer )] ( https://cran.r-project.org/package=salesforcer )
10
10
[ ![ Lifecycle:
11
11
Maturing] ( https://img.shields.io/badge/lifecycle-maturing-blue.svg )] ( https://www.tidyverse.org/lifecycle/#maturing )
12
12
[ ![ Monthly
13
13
Downloads] ( https://cranlogs.r-pkg.org/badges/last-month/salesforcer )] ( https://cran.r-project.org/package=salesforcer )
14
14
[ ![ Coverage
15
- Status] ( https://codecov.io/gh/StevenMMortimer /salesforcer/branch/main/graph/badge.svg )] ( https://codecov.io/gh/StevenMMortimer /salesforcer?branch=main )
15
+ Status] ( https://codecov.io/gh/stevenmmortimer /salesforcer/branch/main/graph/badge.svg )] ( https://codecov.io/gh/stevenmmortimer /salesforcer?branch=main )
16
16
<!-- badges: end -->
17
17
18
18
{salesforcer} is an R package that connects to Salesforce Platform APIs
19
- using tidy principles. The package implements actions from the SOAP ,
20
- REST , Bulk 1.0, Bulk 2.0, and Metadata APIs.
19
+ using tidy principles. The package implements actions from the REST ,
20
+ SOAP , Bulk 1.0, Bulk 2.0, Reports and Dashboards , and Metadata APIs.
21
21
22
22
Package features include:
23
23
@@ -69,7 +69,7 @@ Package features include:
69
69
## Installation
70
70
71
71
``` r
72
- # install the current CRAN version (0.2.0 )
72
+ # install the current CRAN version (0.2.2 )
73
73
install.packages(" salesforcer" )
74
74
75
75
# or get the development version on GitHub
@@ -79,31 +79,31 @@ remotes::install_github("StevenMMortimer/salesforcer")
79
79
80
80
If you encounter an issue while using this package, please file a
81
81
minimal reproducible example on
82
- [ GitHub] ( https://github.com/StevenMMortimer /salesforcer/issues ) .
82
+ [ GitHub] ( https://github.com/stevenmmortimer /salesforcer/issues ) .
83
83
84
84
## Vignettes
85
85
86
86
The README below outlines the basic package functionality. For more
87
- information please feel free to browse the ` pkgdown ` site at
88
- < https://StevenMMortimer .github.io/salesforcer > which contains the
87
+ information please feel free to browse the {salesforcer} website at
88
+ < https://stevenmmortimer .github.io/salesforcer/ > which contains the
89
89
following vignettes:
90
90
91
91
- [ Getting
92
- Started] ( https://StevenMMortimer .github.io/salesforcer/articles/getting-started.html )
92
+ Started] ( https://stevenmmortimer .github.io/salesforcer/articles/getting-started.html )
93
93
- [ Supported
94
- Queries] ( https://StevenMMortimer .github.io/salesforcer/articles/supported-queries.html )
94
+ Queries] ( https://stevenmmortimer .github.io/salesforcer/articles/supported-queries.html )
95
95
- [ Working with Bulk
96
- APIs] ( https://StevenMMortimer .github.io/salesforcer/articles/working-with-bulk-apis.html )
96
+ APIs] ( https://stevenmmortimer .github.io/salesforcer/articles/working-with-bulk-apis.html )
97
97
- [ Working with
98
- Reports] ( https://StevenMMortimer .github.io/salesforcer/articles/working-with-reports.html )
98
+ Reports] ( https://stevenmmortimer .github.io/salesforcer/articles/working-with-reports.html )
99
99
- [ Working with
100
- Attachments] ( https://StevenMMortimer .github.io/salesforcer/articles/working-with-attachments.html )
100
+ Attachments] ( https://stevenmmortimer .github.io/salesforcer/articles/working-with-attachments.html )
101
101
- [ Working with
102
- Metadata] ( https://StevenMMortimer .github.io/salesforcer/articles/working-with-metadata.html )
102
+ Metadata] ( https://stevenmmortimer .github.io/salesforcer/articles/working-with-metadata.html )
103
103
- [ Passing Control
104
- Args] ( https://StevenMMortimer .github.io/salesforcer/articles/passing-control-args.html )
104
+ Args] ( https://stevenmmortimer .github.io/salesforcer/articles/passing-control-args.html )
105
105
- [ Transitioning from
106
- RForcecom] ( https://StevenMMortimer .github.io/salesforcer/articles/transitioning-from-RForcecom.html )
106
+ RForcecom] ( https://stevenmmortimer .github.io/salesforcer/articles/transitioning-from-RForcecom.html )
107
107
108
108
## Usage
109
109
@@ -168,8 +168,8 @@ created_records
168
168
# > # A tibble: 2 x 2
169
169
# > id success
170
170
# > <chr> <lgl>
171
- # > 1 0033s000014Ad6NAAS TRUE
172
- # > 2 0033s000014Ad6OAAS TRUE
171
+ # > 1 0033s000014AgdIAAS TRUE
172
+ # > 2 0033s000014AgdJAAS TRUE
173
173
```
174
174
175
175
### Query
@@ -194,16 +194,16 @@ queried_records
194
194
# > # A tibble: 2 x 3
195
195
# > Id FirstName LastName
196
196
# > <chr> <chr> <chr>
197
- # > 1 0033s000014Ad6NAAS Test Contact-Create-1
198
- # > 2 0033s000014Ad6OAAS Test Contact-Create-2
197
+ # > 1 0033s000014AgdIAAS Test Contact-Create-1
198
+ # > 2 0033s000014AgdJAAS Test Contact-Create-2
199
199
```
200
200
201
201
** NOTE** : In the example above, you’ll notice that the ` "Account.Name" `
202
202
column does not appear in the results. This is because the SOAP and REST
203
203
APIs only return an empty Account object for the record if there is no
204
- relationship to an account ( see
204
+ relationship to an account (see
205
205
<a rel="noopener noreferrer" target="_ blank"
206
- href="https://github.com/StevenMMortimer /salesforcer/issues/78">\#78 </a >).
206
+ href="https://github.com/stevenmmortimer /salesforcer/issues/78">\#78 </a >).
207
207
There is no reliable way to extract and rebuild the empty columns based
208
208
on the query string. If there were Account information, an additional
209
209
column titled ` "Account.Name" ` would appear in the results. Note, that
@@ -232,8 +232,8 @@ updated_records
232
232
# > # A tibble: 2 x 2
233
233
# > id success
234
234
# > <chr> <lgl>
235
- # > 1 0033s000014Ad6NAAS TRUE
236
- # > 2 0033s000014Ad6OAAS TRUE
235
+ # > 1 0033s000014AgdIAAS TRUE
236
+ # > 2 0033s000014AgdJAAS TRUE
237
237
```
238
238
239
239
### Bulk Operations
@@ -270,8 +270,8 @@ created_records
270
270
# > # A tibble: 2 x 4
271
271
# > Id Success Created Error
272
272
# > <chr> <lgl> <lgl> <lgl>
273
- # > 1 0033s000014Ad6WAAS TRUE TRUE NA
274
- # > 2 0033s000014Ad6XAAS TRUE TRUE NA
273
+ # > 1 0033s000014AgfhAAC TRUE TRUE NA
274
+ # > 2 0033s000014AgfiAAC TRUE TRUE NA
275
275
276
276
# query large recordsets using the Bulk API
277
277
my_soql <- sprintf(" SELECT Id,
@@ -286,17 +286,17 @@ queried_records
286
286
# > # A tibble: 2 x 3
287
287
# > Id FirstName LastName
288
288
# > <chr> <chr> <chr>
289
- # > 1 0033s000014Ad6WAAS Test Contact-Create-1
290
- # > 2 0033s000014Ad6XAAS Test Contact-Create-2
289
+ # > 1 0033s000014AgfhAAC Test Contact-Create-1
290
+ # > 2 0033s000014AgfiAAC Test Contact-Create-2
291
291
292
292
# delete these records using the Bulk 2.0 API
293
293
deleted_records <- sf_delete(queried_records $ Id , " Contact" , api_type = " Bulk 2.0" )
294
294
deleted_records
295
295
# > # A tibble: 2 x 4
296
296
# > Id sf__Id sf__Created sf__Error
297
297
# > <chr> <chr> <lgl> <lgl>
298
- # > 1 0033s000014Ad6WAAS 0033s000014Ad6WAAS FALSE NA
299
- # > 2 0033s000014Ad6XAAS 0033s000014Ad6XAAS FALSE NA
298
+ # > 1 0033s000014AgfhAAC 0033s000014AgfhAAC FALSE NA
299
+ # > 2 0033s000014AgfiAAC 0033s000014AgfiAAC FALSE NA
300
300
```
301
301
302
302
### Using the Metadata API
@@ -433,16 +433,16 @@ and improve functionality. For details on formatting, attributes, and
433
433
methods please refer to [ Salesforce’s
434
434
documentation] ( https://trailhead.salesforce.com/en/content/learn/modules/api_basics/api_basics_overview )
435
435
as they are explained better there. More information is also available
436
- on the ` pkgdown ` site at
437
- < https://StevenMMortimer .github.io/salesforcer > .
436
+ on the {salesforcer} pkgdown website at
437
+ < https://stevenmmortimer .github.io/salesforcer/ > .
438
438
439
439
[ Get supported salesforcer with the Tidelift
440
440
Subscription] ( https://tidelift.com/subscription/pkg/cran-salesforcer?utm_source=cran-salesforcer&utm_medium=referral&utm_campaign=readme )
441
441
442
442
-----
443
443
444
444
Please note that this project is released with a [ Contributor Code of
445
- Conduct] ( https://github.com/StevenMMortimer /salesforcer/blob/main/.github/CODE_OF_CONDUCT.md ) .
445
+ Conduct] ( https://github.com/stevenmmortimer /salesforcer/blob/main/.github/CODE_OF_CONDUCT.md ) .
446
446
By participating in this project you agree to abide by its terms.
447
447
448
448
[ Top] ( #salesforcer )
0 commit comments