Man pages for salesforcer
An Implementation of 'Salesforce' APIs Using Tidy Principles

accepted_controls_by_apiReturn the Accepted Control Arguments by API Type
accepted_controls_by_operationReturn the Accepted Control Arguments by Operation
bind_query_resultsetsBind the results of paginated queries
build_manifest_xml_from_listBulk Binary Attachments Manifest List to XML Converter
build_metadata_xml_from_listMetadata List to XML Converter
build_proxyFunction to build a proxy object to pass along with httr...
build_soap_xml_from_listBuild XML Request Body
catch_errorsFunction to catch and print HTTP errors
catch_unknown_apiCatch unknown API type
check_and_encode_filesCheck that file paths exist and data is encoded if specified
collapse_list_with_dupe_namesCollapse Elements in List with Same Name
combine_parent_and_child_resultsetsBind the records from nested parent-to-child queries
compact2Remove all zero-length elements from list ignoring AsIs...
drop_attributesRemove Salesforce attributes data from list
drop_attributes_recursivelyRecursively remove attributes data from list
drop_empty_recursivelyRemove all NULL or zero-length elements from list
drop_nested_child_recordsDrop nested child records in a record
extract_nested_child_recordsExtract nested child records in a record
extract_records_from_xml_nodePulls out a tibble of record info from an XML node
extract_records_from_xml_nodesetPulls out a tibble of record info from an XML node
extract_records_from_xml_nodeset_of_recordsPulls out a tibble of record info from a nodeset of "records"...
filter_valid_controlsFilter Out Control Arguments by API or Operation
flatten_tbl_dfFlatten list and convert to tibble
format_headers_for_verboseFormat Headers for Printing
format_report_rowFormat a single "rows" element from a report fact map
get_osDetermine the host operating system
guess_object_name_from_soqlTry to Guess the Object if User Does Not Specify for Bulk...
is_legit_tokenCheck that token appears to be legitimate
list_extract_parent_and_child_resultExtract tibble of a parent-child record from one JSON element
make_analytics_folder_child_operations_urlAnalytics Folder child operations URL generator
make_analytics_folder_collections_urlAnalytics Folder collections URL generator
make_analytics_folder_operations_urlAnalytics Folder operations URL generator
make_analytics_folder_share_by_id_urlAnalytics Folder share by Id URL generator
make_analytics_folder_share_recipients_urlAnalytics Folder share recipients URL generator
make_analytics_folder_shares_urlAnalytics Folder shares URL generator
make_analytics_notification_operations_urlAnalytics Notification operations URL generator
make_analytics_notifications_limits_urlAnalytics Notification limits URL generator
make_analytics_notifications_list_urlAnalytics Notification list URL generator
make_base_metadata_urlBase Metadata API URL Generator
make_base_rest_urlBase REST API URL Generator
make_base_soap_urlBase SOAP API URL Generator
make_bulk_batch_details_urlBulk Batch Details URL Generator
make_bulk_batches_urlBulk Batches URL Generator
make_bulk_batch_status_urlBulk Batch Status URL Generator
make_bulk_create_job_urlBulk Create Job URL Generator
make_bulk_delete_job_urlBulk Delete Job Generic URL Generator
make_bulk_end_job_generic_urlBulk End Job Generic URL Generator
make_bulk_get_all_jobs_urlBulk Get All Jobs Generic URL Generator
make_bulk_get_all_query_jobs_urlBulk Get All Query Jobs Generic URL Generator
make_bulk_get_job_urlBulk Get Job Generic URL Generator
make_bulk_job_records_urlBulk Job Records URL Generator
make_bulk_query_result_urlBulk Query Result URL Generator
make_bulk_query_urlBulk Query URL Generator
make_chatter_users_urlChatter Users URL Generator
make_composite_batch_urlComposite Batch URL Generator
make_composite_urlComposite URL Generator
make_dashboard_copy_urlDashboard Copy URL generator
make_dashboard_describe_urlDashboard describe URL generator
make_dashboard_filter_operators_list_urlDashboard filter operators list URL generator
make_dashboard_filter_options_analysis_urlDashboard filter options analysis URL generator
make_dashboards_list_urlDashboard list URL generator
make_dashboard_status_urlDashboard status URL generator
make_dashboard_urlDashboard URL generator
make_login_urlLogin URL Generator
make_parameterized_search_urlParameterized Search URL Generator
make_query_urlQuery URL Generator
make_report_copy_urlReport Copy URL generator
make_report_create_urlReport Create URL generator
make_report_describe_urlReport Describe URL generator
make_report_execute_urlReport Execute URL generator
make_report_fields_urlReport Fields URL generator
make_report_filter_operators_list_urlReport Filter Operator List URL generator
make_report_instances_list_urlReport Instances List URL generator
make_report_instance_urlReport Instance URL generator
make_report_query_urlReport Query URL generator
make_reports_list_urlReports List URL generator
make_report_type_describe_urlReport Type Describe URL generator
make_report_types_list_urlReport Type List URL generator
make_report_urlReport URL generator
make_rest_describe_urlREST API Describe URL Generator
make_rest_objects_urlREST Objects URL Generator
make_rest_record_urlREST Individual Record URL Generator
make_search_urlSearch URL Generator
make_soap_xml_skeletonMake SOAP XML Request Skeleton
make_verbose_httr_messageFormat Verbose Call
map_sf_type_to_r_typeMap Salesforce data types to R data types
merge_null_to_naReturn NA if NULL
message_w_errors_listedList a vector of issues and in a message
metadata_type_validatorMetadata Data Type Validator
parameterized_search_controlAuxiliary for Controlling Parametrized Searches
parse_error_code_and_messageFunction to parse out the message and status code of an HTTP...
parse_report_detail_rowsFormat the detailed data from the "T!T" fact map in a tabular...
patched_tempdirCreate a temporary directory path without a double slash
rDELETEDELETEs with retries and authentication
records_list_to_tblExtract tibble based on the "records" element of a list
remove_empty_linked_object_colsRemove NA Columns Created by Empty Related Entity Values
return_matching_controlsOf All Args Return Ones Matching Control Arguments
rforcecom.bulkActionThe 'salesforcer' backwards compatible version of the...
rforcecom.bulkQueryThe 'salesforcer' backwards compatible version of...
rforcecom.createThe 'salesforcer' backwards compatible version of...
rforcecom.deleteThe 'salesforcer' backwards compatible version of...
rforcecom.getObjectDescriptionThe 'salesforcer' backwards compatible version of...
rforcecom.getServerTimestampThe 'salesforcer' backwards compatible version of...
rforcecom.loginThe 'salesforcer' backwards compatible version of...
rforcecom.queryThe 'salesforcer' backwards compatible version of...
rforcecom.retrieveThe 'salesforcer' backwards compatible version of...
rforcecom.searchThe 'salesforcer' backwards compatible version of...
rforcecom.updateThe 'salesforcer' backwards compatible version of...
rforcecom.upsertThe 'salesforcer' backwards compatible version of...
rGETGETs with retries and authentication
rPATCHPATCHs with retries and authentication
rPOSTPOSTs with retries and authentication
rPUTPUTs with retries and authentication
safe_bind_rowsStack data frames which may have differing types in the same...
salesforcer-package'salesforcer' package
salesforcer_stateReturn the package's .state environment variable
session_id_availableCheck session_id availability
set_null_elements_to_naSet all NULL or zero-length elements from list to NA
set_null_elements_to_na_recursivelyRecursively set all NULL or zero-length elements from list to...
sf_abort_job_bulkAbort Bulk API Job
sf_access_tokenReturn access_token attribute of OAuth 2.0 Token
sf_analytics_notification_createCreate an analytics notification
sf_analytics_notification_deleteDelete an analytics notification
sf_analytics_notification_describeDescribe an analytics notification
sf_analytics_notifications_limitsReturn limits of analytics notifications
sf_analytics_notifications_listList analytics notifications
sf_analytics_notification_updateUpdate an analytics notification
sf_authLog in to Salesforce
sf_auth_checkCheck that an Authorized Salesforce Session Exists
sf_auth_refreshRefresh an existing Authorized Salesforce Token
sf_batch_details_bulkReturning the Details of a Batch in a Bulk API Job
sf_batch_status_bulkChecking the Status of a Batch in a Bulk API Job
sf_build_cols_specProduce spec to convert Salesforce data types to R data types
sf_close_job_bulkClose Bulk API Job
sf_controlAuxiliary for Controlling Calls to Salesforce APIs
sf_convert_leadConvert Leads
sf_copy_dashboardCopy a dashboard
sf_copy_reportCopy a report
sf_createCreate Records
sf_create_attachmentCreate Attachments
sf_create_attachment_bulk_v1Create Attachments using Bulk 1.0 API
sf_create_attachment_restCreate Attachment using REST API
sf_create_attachment_soapCreate Attachment using SOAP API
sf_create_batches_bulkAdd Batches to a Bulk API Job
sf_create_bulk_v1Create Records using Bulk 1.0 API
sf_create_bulk_v2Create Records using Bulk 2.0 API
sf_create_job_bulkCreate Bulk API Job
sf_create_job_bulk_v1Create Job using Bulk 1.0 API
sf_create_job_bulk_v2Create Job using Bulk 2.0 API
sf_create_metadataCreate Object or Field Metadata in Salesforce
sf_create_reportCreate a report
sf_create_restCreate Records using REST API
sf_create_soapCreate Records using SOAP API
sf_deleteDelete Records
sf_delete_attachmentDelete Attachments
sf_delete_bulk_v1Delete records using Bulk 1.0 API
sf_delete_bulk_v2Delete records using Bulk 2.0 API
sf_delete_dashboardDelete a dashboard
sf_delete_job_bulkDelete Bulk API Job
sf_delete_metadataDelete Object or Field Metadata in Salesforce
sf_delete_reportDelete a report
sf_delete_report_instanceDelete a report instance
sf_delete_restDelete records using REST API
sf_delete_soapDelete records using SOAP API
sf_describe_dashboardDescribe a dashboard
sf_describe_dashboard_componentsDescribe dashboard components
sf_describe_metadataDescribe the Metadata in an Organization
sf_describe_object_fieldsDescribe Object Fields
sf_describe_objectsSObject Basic Information
sf_describe_reportDescribe a report
sf_describe_report_typeDescribe a report type
sf_download_attachmentDownload an Attachment
sf_empty_recycle_binEmpty Recycle Bin
sf_end_job_bulkEnd Bulk API Job
sf_execute_reportExecute a report
sf_filter_dashboard_operators_listList dashboard filter operators
sf_filter_dashboard_options_analysisGet an analysis of the filter options for a dashboard
sf_find_duplicatesFind Duplicate Records
sf_find_duplicates_by_idFind Duplicate Records By Id
sf_format_dateFormat Dates for Create and Update operations
sf_format_datetimeFormat Datetimes for Create and Update operations
sf_format_timeFormat all Date and Datetime values in an object
sf_get_all_jobs_bulkGet All Bulk API Jobs
sf_get_all_query_jobs_bulkGet All Bulk API Query Jobs
sf_get_dashboard_dataGet dashboard data in a tabular format
sf_get_dashboard_resultsGet the results of an existing dashboard
sf_get_dashboard_statusGet the status of a dashboard
sf_get_deletedGet Deleted Records from a Timeframe
sf_get_job_bulkGet Bulk API Job
sf_get_job_records_bulkReturning the Details of a Bulk API Job
sf_get_report_instance_resultsGet report instance results
sf_get_updatedGet Updated Records from a Timeframe
sf_guess_colsParse resultset columns to a known datatype in R
sf_input_data_validationValidate the input for an operation
sf_job_batches_bulkChecking the Status of a Batch in a Bulk API Job
sf_list_api_limitsList the Limits for an API
sf_list_dashboardsList dashboards
sf_list_metadataList All Objects of a Certain Metadata Type in Salesforce
sf_list_objectsList Organization Objects and their Metadata
sf_list_report_fieldsGet a list of report fields
sf_list_report_filter_operatorsList report filter operators
sf_list_report_instancesList report instances
sf_list_reportsList reports
sf_list_report_typesList report types
sf_list_resourcesList the Resources for an API
sf_list_rest_api_versionsList REST API Versions
sf_mergeMerge Records
sf_queryPerform SOQL Query
sf_query_bulk_v1Run Bulk 1.0 query
sf_query_bulk_v2Run Bulk 2.0 query
sf_query_reportGet Report Data without Saving Changes to or Creating a...
sf_query_result_bulkRetrieve the results of a completed bulk query
sf_query_result_bulk_v1Retrieve the results of a Bulk 1.0 query
sf_query_result_bulk_v2Retrieve the results of a Bulk 2.0 query
sf_read_metadataRead Object or Field Metadata from Salesforce
sf_refresh_dashboardRefresh an existing dashboard
sf_rename_metadataRename Metadata Elements in Salesforce
sf_reorder_colsReorder resultset columns to prioritize 'sObject' and 'Id'
sf_report_folder_childrenGet the subfolders (children) of a report folder
sf_report_folder_createCreate report folder
sf_report_folder_deleteDelete a report folder
sf_report_folder_describeDescribe a report folder
sf_report_folder_share_deleteDelete a report folder share
sf_report_folder_share_describeDescribe a report folder share
sf_report_folder_share_recipientsGet report folder share recipients
sf_report_folder_shares_addAdd shares to a report folder
sf_report_folder_shares_listList the shares in a report folder
sf_report_folder_shares_updateUpdate the shares for a report folder
sf_report_folder_share_updateUpdate a report folder share
sf_report_folders_listList report folders
sf_report_folder_updateUpdate a report folder
sf_reset_passwordReset User Password
sf_rest_listExecute a non-paginated REST API call to list items
sf_retrieveRetrieve Records By Id
sf_retrieve_metadataMake A Request to Retrieve the Metadata
sf_retrieve_metadata_check_statusCheck on Retrieve Calls and Get Contents If Available
sf_retrieve_restRetrieve records using REST API
sf_retrieve_soapRetrieve records using SOAP API
sf_run_bulk_operationRun Bulk Operation
sf_run_bulk_queryRun bulk query
sf_run_reportGet a report's data in tabular format
sf_searchPerform SOSL Search
sf_server_timestampSalesforce Server Timestamp
sf_session_idReturn session_id resulting from Basic auth routine
sf_set_dashboard_sticky_filterSet a sticky dashboard filter
sf_set_passwordSet User Password
sf_submit_query_bulkSubmit Bulk Query Batch to a Bulk API Job
sf_undeleteUndelete Records
sf_updateUpdate Records
sf_update_attachmentUpdate Attachments
sf_update_attachment_bulk_v1Update Attachments using Bulk 1.0 API
sf_update_attachment_restUpdate Attachment using REST API
sf_update_attachment_soapUpdate Attachment using SOAP API
sf_update_bulk_v1Update Records using Bulk 1.0 API
sf_update_bulk_v2Update Records using Bulk 2.0 API
sf_update_dashboardUpdate a dashboard
sf_update_metadataUpdate Object or Field Metadata in Salesforce
sf_update_reportUpdate a report
sf_update_restUpdate Records using REST API
sf_update_soapUpdate Records using SOAP API
sf_upload_complete_bulkSignal Upload Complete to Bulk API Job
sf_upsertUpsert Records
sf_upsert_bulk_v1Upsert Records using Bulk 1.0 API
sf_upsert_bulk_v2Upsert Records using Bulk 2.0 API
sf_upsert_metadataUpsert Object or Field Metadata in Salesforce
sf_upsert_restUpsert Records using REST API
sf_upsert_soapUpsert Records using SOAP API
sf_user_infoReturn Current User Info
sf_write_csvWrite a CSV file in format acceptable to Salesforce APIs
simplify_report_metadataSimplify the 'reportMetadata' property of a report
stop_w_errors_listedList a vector of errors and stop execution
token_availableCheck token availability
unbox_list_elementsUnlist all list elements of length 1 if they are not a list
unbox_list_elements_recursivelyRecursively unlist all list elements of length 1 if they are...
unnest_colFlatten list column
validate_get_all_jobs_paramsValidate Query Parameters When Getting List of All Bulk Jobs
valid_metadata_listList of Valid Data Types
VERB_nGeneric implementation of HTTP methods with retries and...
warn_w_errors_listedList a vector of errors and provide a warning
xml_drop_and_unlistDrop 'type' and 'Id' attributes on XML queried records and...
xml_drop_and_unlist_recursivelyRecursively Drop 'type' and 'Id' attributes and flatten a...
xml_extract_parent_and_child_resultExtract tibble of a parent-child record from one XML node
xml_nodeset_to_dfxml_nodeset_to_df
xmlToList2xmlToList2
salesforcer documentation built on March 18, 2022, 6:26 p.m.