Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

salesforcer

An Implementation of 'Salesforce' APIs Using Tidy Principles

Functions connecting to the 'Salesforce' Platform APIs (REST, SOAP, Bulk 1.0, Bulk 2.0, Metadata, Reports and Dashboards) <https://trailhead.salesforce.com/en/content/learn/modules/api_basics/api_basics_overview>. "API" is an acronym for "application programming interface". Most all calls from these APIs are supported as they use CSV, XML or JSON data that can be parsed into R data structures. For more details please see the 'Salesforce' API documentation and this package's website <https://stevenmmortimer.github.io/salesforcer/> for more information, documentation, and examples.

Functions (285)

VERB_n

Generic implementation of HTTP methods with retries and authentication

accepted_controls_by_api

Return the Accepted Control Arguments by API Type

accepted_controls_by_operation

Return the Accepted Control Arguments by Operation

bind_query_resultsets

Bind the results of paginated queries

build_manifest_xml_from_list

Bulk Binary Attachments Manifest List to XML Converter

build_metadata_xml_from_list

Metadata List to XML Converter

build_proxy

Function to build a proxy object to pass along with httr requests

build_soap_xml_from_list

Build XML Request Body

catch_errors

Function to catch and print HTTP errors

catch_unknown_api

Catch unknown API type

check_and_encode_files

Check that file paths exist and data is encoded if specified

collapse_list_with_dupe_names

Collapse Elements in List with Same Name

combine_parent_and_child_resultsets

Bind the records from nested parent-to-child queries

compact2

Remove all zero-length elements from list ignoring AsIs elements

drop_attributes

Remove Salesforce attributes data from list

drop_attributes_recursively

Recursively remove attributes data from list

drop_empty_recursively

Remove all NULL or zero-length elements from list

drop_nested_child_records

Drop nested child records in a record

extract_nested_child_records

Extract nested child records in a record

extract_records_from_xml_node

Pulls out a tibble of record info from an XML node

extract_records_from_xml_nodeset

Pulls out a tibble of record info from an XML node

extract_records_from_xml_nodeset_of_records

Pulls out a tibble of record info from a nodeset of "records" elements

filter_valid_controls

Filter Out Control Arguments by API or Operation

flatten_tbl_df

Flatten list and convert to tibble

format_headers_for_verbose

Format Headers for Printing

format_report_row

Format a single "rows" element from a report fact map

get_os

Determine the host operating system

guess_object_name_from_soql

Try to Guess the Object if User Does Not Specify for Bulk Queries

is_legit_token

Check that token appears to be legitimate

list_extract_parent_and_child_result

Extract tibble of a parent-child record from one JSON element

make_analytics_folder_child_operations_url

Analytics Folder child operations URL generator

make_analytics_folder_collections_url

Analytics Folder collections URL generator

make_analytics_folder_operations_url

Analytics Folder operations URL generator

make_analytics_folder_share_by_id_url

Analytics Folder share by Id URL generator

make_analytics_folder_share_recipients_url

Analytics Folder share recipients URL generator

make_analytics_folder_shares_url

Analytics Folder shares URL generator

make_analytics_notification_operations_url

Analytics Notification operations URL generator

make_analytics_notifications_limits_url

Analytics Notification limits URL generator

make_analytics_notifications_list_url

Analytics Notification list URL generator

make_base_metadata_url

Base Metadata API URL Generator

make_base_rest_url

Base REST API URL Generator

make_base_soap_url

Base SOAP API URL Generator

make_bulk_batch_details_url

Bulk Batch Details URL Generator

make_bulk_batch_status_url

Bulk Batch Status URL Generator

make_bulk_batches_url

Bulk Batches URL Generator

make_bulk_create_job_url

Bulk Create Job URL Generator

make_bulk_delete_job_url

Bulk Delete Job Generic URL Generator

make_bulk_end_job_generic_url

Bulk End Job Generic URL Generator

make_bulk_get_all_jobs_url

Bulk Get All Jobs Generic URL Generator

make_bulk_get_all_query_jobs_url

Bulk Get All Query Jobs Generic URL Generator

make_bulk_get_job_url

Bulk Get Job Generic URL Generator

make_bulk_job_records_url

Bulk Job Records URL Generator

make_bulk_query_result_url

Bulk Query Result URL Generator

make_bulk_query_url

Bulk Query URL Generator

make_chatter_users_url

Chatter Users URL Generator

make_composite_batch_url

Composite Batch URL Generator

make_composite_url

Composite URL Generator

make_dashboard_copy_url

Dashboard Copy URL generator

make_dashboard_describe_url

Dashboard describe URL generator

make_dashboard_filter_operators_list_url

Dashboard filter operators list URL generator

make_dashboard_filter_options_analysis_url

Dashboard filter options analysis URL generator

make_dashboard_status_url

Dashboard status URL generator

make_dashboard_url

Dashboard URL generator

make_dashboards_list_url

Dashboard list URL generator

make_login_url

make_parameterized_search_url

Parameterized Search URL Generator

make_query_url

Query URL Generator

make_report_copy_url

Report Copy URL generator

make_report_create_url

Report Create URL generator

make_report_describe_url

Report Describe URL generator

make_report_execute_url

Report Execute URL generator

make_report_fields_url

Report Fields URL generator

make_report_filter_operators_list_url

Report Filter Operator List URL generator

make_report_instance_url

Report Instance URL generator

make_report_instances_list_url

Report Instances List URL generator

make_report_query_url

Report Query URL generator

make_report_type_describe_url

Report Type Describe URL generator

make_report_types_list_url

Report Type List URL generator

make_report_url

Report URL generator

make_reports_list_url

Reports List URL generator

make_rest_describe_url

REST API Describe URL Generator

make_rest_objects_url

REST Objects URL Generator

make_rest_record_url

REST Individual Record URL Generator

make_search_url

Search URL Generator

make_soap_xml_skeleton

Make SOAP XML Request Skeleton

make_verbose_httr_message

Format Verbose Call

map_sf_type_to_r_type

Map Salesforce data types to R data types

merge_null_to_na

Return NA if NULL

message_w_errors_listed

List a vector of issues and in a message

metadata_type_validator

Metadata Data Type Validator

parameterized_search_control

Auxiliary for Controlling Parametrized Searches

parse_error_code_and_message

Function to parse out the message and status code of an HTTP error

parse_report_detail_rows

Format the detailed data from the "T!T" fact map in a tabular report

patched_tempdir

Create a temporary directory path without a double slash

rDELETE

DELETEs with retries and authentication

rGET

GETs with retries and authentication

rPATCH

PATCHs with retries and authentication

rPOST

POSTs with retries and authentication

rPUT

PUTs with retries and authentication

records_list_to_tbl

Extract tibble based on the "records" element of a list

remove_empty_linked_object_cols

Remove NA Columns Created by Empty Related Entity Values

return_matching_controls

Of All Args Return Ones Matching Control Arguments

rforcecom.bulkAction

The salesforcer backwards compatible version of the RForcecom function rforcecom.bulkAction

rforcecom.bulkQuery

The salesforcer backwards compatible version of rforcecom.bulkQuery

rforcecom.create

The salesforcer backwards compatible version of rforcecom.create

rforcecom.delete

The salesforcer backwards compatible version of rforcecom.delete

rforcecom.getObjectDescription

The salesforcer backwards compatible version of rforcecom.getObjectDescription

rforcecom.getServerTimestamp

The salesforcer backwards compatible version of rforcecom.getServerTimestamp

rforcecom.login

The salesforcer backwards compatible version of rforcecom.login

rforcecom.query

The salesforcer backwards compatible version of rforcecom.query

rforcecom.retrieve

The salesforcer backwards compatible version of rforcecom.retrieve

rforcecom.search

The salesforcer backwards compatible version of rforcecom.search

rforcecom.update

The salesforcer backwards compatible version of rforcecom.update

rforcecom.upsert

The salesforcer backwards compatible version of rforcecom.upsert

safe_bind_rows

Stack data frames which may have differing types in the same column

salesforcer-package

salesforcer package

salesforcer_state

Return the package's .state environment variable

session_id_available

Check session_id availability

set_null_elements_to_na

Set all NULL or zero-length elements from list to NA

set_null_elements_to_na_recursively

Recursively set all NULL or zero-length elements from list to NA

sf_abort_job_bulk

Abort Bulk API Job

sf_access_token

Return access_token attribute of OAuth 2.0 Token

sf_analytics_notification_create

Create an analytics notification

sf_analytics_notification_delete

Delete an analytics notification

sf_analytics_notification_describe

Describe an analytics notification

sf_analytics_notification_update

Update an analytics notification

sf_analytics_notifications_limits

Return limits of analytics notifications

sf_analytics_notifications_list

List analytics notifications

sf_auth

sf_auth_check

Check that an Authorized Salesforce Session Exists

sf_auth_refresh

Refresh an existing Authorized Salesforce Token

sf_batch_details_bulk

Returning the Details of a Batch in a Bulk API Job

sf_batch_status_bulk

Checking the Status of a Batch in a Bulk API Job

sf_build_cols_spec

Produce spec to convert Salesforce data types to R data types

sf_close_job_bulk

Close Bulk API Job

sf_control

Auxiliary for Controlling Calls to Salesforce APIs

sf_convert_lead

Convert Leads

sf_copy_report

Copy a report

sf_create

Create Records

sf_create_attachment

Create Attachments

sf_create_attachment_bulk_v1

Create Attachments using Bulk 1.0 API

sf_create_attachment_rest

Create Attachment using REST API

sf_create_attachment_soap

Create Attachment using SOAP API

sf_create_batches_bulk

Add Batches to a Bulk API Job

sf_create_bulk_v1

Create Records using Bulk 1.0 API

sf_create_bulk_v2

Create Records using Bulk 2.0 API

sf_create_job_bulk

Create Bulk API Job

sf_create_job_bulk_v1

Create Job using Bulk 1.0 API

sf_create_job_bulk_v2

Create Job using Bulk 2.0 API

sf_create_metadata

Create Object or Field Metadata in Salesforce

sf_create_report

Create a report

sf_create_rest

Create Records using REST API

sf_create_soap

Create Records using SOAP API

sf_dashboard_components_describe

Describe dashboard components

sf_dashboard_copy

Copy a dashboard

sf_dashboard_delete

Delete a dashboard

sf_dashboard_describe

Describe a dashboard

sf_dashboard_filter_operators_list

List dashboard filter operators

sf_dashboard_filter_options_analysis

Get an analysis of the filter options for a dashboard

sf_dashboard_refresh

Refresh an existing dashboard

sf_dashboard_results

Get the results of an existing dashboard

sf_dashboard_set_sticky_filter

Set a sticky dashboard filter

sf_dashboard_status

Get the status of a dashboard

sf_dashboard_update

Update a dashboard

sf_dashboards_list

List dashboards

sf_delete

Delete Records

sf_delete_attachment

Delete Attachments

sf_delete_bulk_v1

Delete records using Bulk 1.0 API

sf_delete_bulk_v2

Delete records using Bulk 2.0 API

sf_delete_job_bulk

Delete Bulk API Job

sf_delete_metadata

Delete Object or Field Metadata in Salesforce

sf_delete_report

Delete a report

sf_delete_report_instance

Delete a report instance

sf_delete_rest

Delete records using REST API

sf_delete_soap

Delete records using SOAP API

sf_describe_metadata

Describe the Metadata in an Organization

sf_describe_object_fields

Describe Object Fields

sf_describe_objects

SObject Basic Information

sf_describe_report

Describe a report

sf_describe_report_type

Describe a report type

sf_download_attachment

Download an Attachment

sf_empty_recycle_bin

Empty Recycle Bin

sf_end_job_bulk

End Bulk API Job

sf_execute_report

Execute a report

sf_find_duplicates

Find Duplicate Records

sf_find_duplicates_by_id

Find Duplicate Records By Id

sf_format_date

Format Dates for Create and Update operations

sf_format_datetime

Format Datetimes for Create and Update operations

sf_format_time.data.frame

Format all Date and Datetime columns in a dataset

sf_format_time.list

Format all Date and Datetime columns in a list

sf_get_all_jobs_bulk

Get All Bulk API Jobs

sf_get_all_query_jobs_bulk

Get All Bulk API Query Jobs

sf_get_dashboard_data

Get dashboard data in a tabular format

sf_get_deleted

Get Deleted Records from a Timeframe

sf_get_job_bulk

Get Bulk API Job

sf_get_job_records_bulk

Returning the Details of a Bulk API Job

sf_get_report_instance_results

Get report instance results

sf_get_updated

Get Updated Records from a Timeframe

sf_guess_cols

Reorder resultset columns to prioritize sObject and Id

sf_input_data_validation

Validate the input for an operation

sf_job_batches_bulk

Checking the Status of a Batch in a Bulk API Job

sf_list_api_limits

List the Limits for an API

sf_list_metadata

List All Objects of a Certain Metadata Type in Salesforce

sf_list_objects

List Organization Objects and their Metadata

sf_list_report_fields

Get a list of report fields

sf_list_report_filter_operators

List report filter operators

sf_list_report_instances

List report instances

sf_list_report_types

List report types

sf_list_reports

List reports

sf_list_resources

List the Resources for an API

sf_list_rest_api_versions

List REST API Versions

sf_merge

Merge Records

sf_query

Perform SOQL Query

sf_query_bulk_v1

Run Bulk 1.0 query

sf_query_bulk_v2

Run Bulk 2.0 query

sf_query_report

Get Report Data without Saving Changes to or Creating a Report

sf_query_result_bulk

Retrieve the results of a completed bulk query

sf_query_result_bulk_v1

Retrieve the results of a Bulk 1.0 query

sf_query_result_bulk_v2

Retrieve the results of a Bulk 2.0 query

sf_read_metadata

Read Object or Field Metadata from Salesforce

sf_rename_metadata

Rename Metadata Elements in Salesforce

sf_reorder_cols

Reorder resultset columns to prioritize sObject and Id

sf_report_folder_children

Get the subfolders (children) of a report folder

sf_report_folder_create

Create report folder

sf_report_folder_delete

Delete a report folder

sf_report_folder_describe

Describe a report folder

sf_report_folder_share_delete

Delete a report folder share

sf_report_folder_share_describe

Describe a report folder share

sf_report_folder_share_recipients

Get report folder share recipients

sf_report_folder_share_update

Update a report folder share

sf_report_folder_shares_add

Add shares to a report folder

sf_report_folder_shares_list

List the shares in a report folder

sf_report_folder_shares_update

Update the shares for a report folder

sf_report_folder_update

Update a report folder

sf_report_folders_list

List report folders

sf_reset_password

Reset User Password

sf_rest_list

Execute a non-paginated REST API call to list items

sf_retrieve

Retrieve Records By Id

sf_retrieve_metadata

Make A Request to Retrieve the Metadata

sf_retrieve_metadata_check_status

Check on Retrieve Calls and Get Contents If Available

sf_retrieve_rest

Retrieve records using REST API

sf_retrieve_soap

Retrieve records using SOAP API

sf_run_bulk_operation

Run Bulk Operation

sf_run_bulk_query

Run bulk query

sf_run_report

Get a report's data in tabular format

sf_search

Perform SOSL Search

sf_server_timestamp

Salesforce Server Timestamp

sf_session_id

Return session_id resulting from Basic auth routine

sf_set_password

Set User Password

sf_submit_query_bulk

Submit Bulk Query Batch to a Bulk API Job

sf_undelete

Undelete Records

sf_update

Update Records

sf_update_attachment

Update Attachments

sf_update_attachment_bulk_v1

Update Attachments using Bulk 1.0 API

sf_update_attachment_rest

Update Attachment using REST API

sf_update_attachment_soap

Update Attachment using SOAP API

sf_update_bulk_v1

Update Records using Bulk 1.0 API

sf_update_bulk_v2

Update Records using Bulk 2.0 API

sf_update_metadata

Update Object or Field Metadata in Salesforce

sf_update_report

Update a report

sf_update_rest

Update Records using REST API

sf_update_soap

Update Records using SOAP API

sf_upload_complete_bulk

Signal Upload Complete to Bulk API Job

sf_upsert

Upsert Records

sf_upsert_bulk_v1

Upsert Records using Bulk 1.0 API

sf_upsert_bulk_v2

Upsert Records using Bulk 2.0 API

sf_upsert_metadata

Upsert Object or Field Metadata in Salesforce

sf_upsert_rest

Upsert Records using REST API

sf_upsert_soap

Upsert Records using SOAP API

sf_user_info

Return Current User Info

sf_write_csv

Write a CSV file in format acceptable to Salesforce APIs

simplify_report_metadata

Simplify the reportMetadata property of a report

stop_w_errors_listed

List a vector of errors and stop execution

token_available

Check token availability

unbox_list_elements

Unlist all list elements of length 1 if they are not a list

unbox_list_elements_recursively

Recursively unlist all list elements of length 1 if they are not a list

unnest_col

Flatten list column

valid_metadata_list

List of Valid Data Types

validate_get_all_jobs_params

Validate Query Parameters When Getting List of All Bulk Jobs

warn_w_errors_listed

List a vector of errors and provide a warning

xmlToList2

xmlToList2

xml_drop_and_unlist

Drop type and Id attributes on XML queried records and unlist

xml_drop_and_unlist_recursively

Recursively Drop type and Id attributes and flatten a list

xml_extract_parent_and_child_result

Extract tibble of a parent-child record from one XML node

xml_nodeset_to_df

xml_nodeset_to_df

salesforcer

An Implementation of 'Salesforce' APIs Using Tidy Principles

v0.2.2

MIT + file LICENSE

Authors

Steven M. Mortimer [aut, cre], Takekatsu Hiramura [ctb], Jennifer Bryan [ctb, cph], Joanna Zhao [ctb, cph]

Initial release

2020-09-07

salesforcer

Functions (285)

salesforcer

We don't support your browser anymore