-
-
Notifications
You must be signed in to change notification settings - Fork 19
/
_pkgdown.yml
211 lines (208 loc) · 6.8 KB
/
_pkgdown.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
title: salesforcer
url: https://stevenmmortimer.github.io/salesforcer/
template:
bootstrap: 5
opengraph:
image:
src: man/figures/salesforcer.png
alt: "salesforcer package logo"
params:
bootswatch: spacelab
ganalytics: UA-98603021-2
docsearch:
app_id: BBX5BTLUTL
api_key: f3a7c81cd6794f9050f32bfee2620882
index_name: salesforcer
home:
strip_header: true
navbar:
type: default
left:
- text: "Articles"
icon: fas fa-book
menu:
- text: Getting Started
href: articles/getting-started.html
- text: Supported Queries
href: articles/supported-queries.html
- text: Working with Bulk APIs
href: articles/working-with-bulk-apis.html
- text: Working with Reports
href: articles/working-with-reports.html
- text: Working with Attachments
href: articles/working-with-attachments.html
- text: Working with Metadata
href: articles/working-with-metadata.html
- text: Passing Control Args
href: articles/passing-control-args.html
- text: Transitioning from RForcecom
href: articles/transitioning-from-RForcecom.html
- text: Reference
icon: fa-file-code-o
href: reference/index.html
- text: News
icon: fa-newspaper-o
href: news/index.html
right:
- text: GitHub
icon: fa-github fa-lg
href: https://github.com/StevenMMortimer/salesforcer
reference:
- title: Authentication
desc: Function to authenticate to your Salesforce Org.
contents:
- '`sf_auth`'
- title: Query/Search Functions
desc: Functions to query and search records.
contents:
- '`sf_query`'
- '`sf_search`'
- title: CRUD Functions
desc: Functions to perform create, retrieve, update, and delete (CRUD) operations on records.
contents:
- '`sf_create`'
- '`sf_retrieve`'
- '`sf_update`'
- '`sf_upsert`'
- '`sf_delete`'
- '`sf_undelete`'
- '`sf_get_deleted`'
- '`sf_get_updated`'
- title: Attachment Functions
desc: Convenience functions to work with attachments.
contents:
- '`sf_create_attachment`'
- '`sf_download_attachment`'
- '`sf_update_attachment`'
- '`sf_delete_attachment`'
- title: Bulk API Functions
desc: Convenience functions to perform async CRUD and query operations.
contents:
- '`sf_run_bulk_query`'
- '`sf_run_bulk_operation`'
- title: Report Functions
desc: Functions to create, retrieve, update, delete and query reports and their data.
contents:
- '`sf_run_report`'
- '`sf_list_reports`'
- '`sf_describe_report`'
- '`sf_create_report`'
- '`sf_copy_report`'
- '`sf_update_report`'
- '`sf_execute_report`'
- '`sf_delete_report`'
- '`sf_list_report_instances`'
- '`sf_get_report_instance_results`'
- '`sf_delete_report_instance`'
- '`sf_list_report_types`'
- '`sf_describe_report_type`'
- '`sf_list_report_fields`'
- '`sf_list_report_filter_operators`'
- title: Dashboard Functions
desc: Functions to create, retrieve, update, delete and query dashboards and their data.
contents:
- '`sf_list_dashboards`'
- '`sf_describe_dashboard`'
- '`sf_describe_dashboard_components`'
- '`sf_get_dashboard_status`'
- '`sf_get_dashboard_results`'
- '`sf_get_dashboard_data`'
- '`sf_filter_dashboard_operators_list`'
- '`sf_filter_dashboard_options_analysis`'
- '`sf_refresh_dashboard`'
- '`sf_copy_dashboard`'
- '`sf_update_dashboard`'
- '`sf_set_dashboard_sticky_filter`'
- '`sf_delete_dashboard`'
- title: Metadata Functions
desc: Functions to create, retrieve, update, and delete metadata.
contents:
- '`sf_create_metadata`'
- '`sf_update_metadata`'
- '`sf_upsert_metadata`'
- '`sf_delete_metadata`'
- '`sf_rename_metadata`'
- '`sf_read_metadata`'
- '`sf_list_metadata`'
- '`sf_retrieve_metadata`'
- '`sf_describe_metadata`'
- '`sf_describe_objects`'
- '`sf_describe_object_fields`'
- title: Salesforce Org Utility Functions
desc: Functions to perform basic org-wide routines.
contents:
- '`sf_merge`'
- '`sf_convert_lead`'
- '`sf_find_duplicates`'
- '`sf_find_duplicates_by_id`'
- '`sf_empty_recycle_bin`'
- '`sf_get_all_jobs_bulk`'
- '`sf_get_all_query_jobs_bulk`'
- '`sf_list_rest_api_versions`'
- '`sf_list_resources`'
- '`sf_list_api_limits`'
- '`sf_list_objects`'
- '`sf_user_info`'
- '`sf_server_timestamp`'
- '`sf_set_password`'
- '`sf_reset_password`'
- '`sf_control`'
- title: Backward Compatibility with RForcecom
desc: Functions that mimic {RForcecom} to ease code transitions between {salesforcer} and {RForcecom}.
contents:
- '`rforcecom.login`'
- '`rforcecom.getServerTimestamp`'
- '`rforcecom.getObjectDescription`'
- '`rforcecom.create`'
- '`rforcecom.retrieve`'
- '`rforcecom.update`'
- '`rforcecom.delete`'
- '`rforcecom.upsert`'
- '`rforcecom.search`'
- '`rforcecom.query`'
- '`rforcecom.bulkQuery`'
- title: internal
desc: Functions included for internal use only.
contents:
- '`collapse_list_with_dupe_names`'
- '`metadata_type_validator`'
- '`parameterized_search_control`'
- '`rforcecom.bulkAction`'
- '`sf_abort_job_bulk`'
- '`sf_analytics_notification_create`'
- '`sf_analytics_notification_delete`'
- '`sf_analytics_notification_describe`'
- '`sf_analytics_notification_update`'
- '`sf_analytics_notifications_limits`'
- '`sf_analytics_notifications_list`'
- '`sf_batch_details_bulk`'
- '`sf_batch_status_bulk`'
- '`sf_close_job_bulk`'
- '`sf_create_batches_bulk`'
- '`sf_create_job_bulk`'
- '`sf_delete_job_bulk`'
- '`sf_get_job_bulk`'
- '`sf_get_job_records_bulk`'
- '`sf_job_batches_bulk`'
- '`sf_query_bulk_v1`'
- '`sf_query_bulk_v2`'
- '`sf_query_report`'
- '`sf_query_result_bulk`'
- '`sf_query_result_bulk_v1`'
- '`sf_query_result_bulk_v2`'
- '`sf_report_folder_children`'
- '`sf_report_folder_create`'
- '`sf_report_folder_delete`'
- '`sf_report_folder_describe`'
- '`sf_report_folder_share_delete`'
- '`sf_report_folder_share_describe`'
- '`sf_report_folder_share_recipients`'
- '`sf_report_folder_share_update`'
- '`sf_report_folder_shares_add`'
- '`sf_report_folder_shares_list`'
- '`sf_report_folder_shares_update`'
- '`sf_report_folder_update`'
- '`sf_report_folders_list`'
- '`sf_submit_query_bulk`'
- '`sf_upload_complete_bulk`'
- '`valid_metadata_list`'