Package: salesforcer 1.0.2

Steven M. Mortimer

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/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.

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

salesforcer_1.0.2.tar.gz
salesforcer_1.0.2.tar.gz(r-4.5-noble)salesforcer_1.0.2.tar.gz(r-4.4-noble)
salesforcer_1.0.2.tgz(r-4.4-emscripten)salesforcer_1.0.2.tgz(r-4.3-emscripten)
salesforcer.pdf |salesforcer.html✨
salesforcer/json (API)
NEWS

# Install 'salesforcer' in R:
install.packages('salesforcer', repos = c('https://cran.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/stevenmmortimer/salesforcer/issues

6.09 score 191 scripts 16k downloads 261 exports 47 dependencies

Last updated 16 days agofrom:3c94c388b1. Checks:OK: 2. Indexed: no.

TargetResultDate
Doc / VignettesOKNov 07 2024
R-4.5-linuxOKNov 07 2024

Exports:accepted_controls_by_apiaccepted_controls_by_operationbind_query_resultsetsbuild_manifest_xml_from_listbuild_metadata_xml_from_listbuild_proxybuild_soap_xml_from_listcatch_errorscatch_unknown_apicheck_and_encode_filescollapse_list_with_dupe_namescombine_parent_and_child_resultsetscompact2drop_attributesdrop_attributes_recursivelydrop_empty_recursivelydrop_nested_child_recordsextract_nested_child_recordsextract_records_from_xml_nodeextract_records_from_xml_nodesetextract_records_from_xml_nodeset_of_recordsfilter_valid_controlsflatten_tbl_dfformat_headers_for_verboseformat_report_rowget_osguess_object_name_from_soqlis_legit_tokenlist_extract_parent_and_child_resultmake_analytics_folder_child_operations_urlmake_analytics_folder_collections_urlmake_analytics_folder_operations_urlmake_analytics_folder_share_by_id_urlmake_analytics_folder_share_recipients_urlmake_analytics_folder_shares_urlmake_analytics_notification_operations_urlmake_analytics_notifications_limits_urlmake_analytics_notifications_list_urlmake_base_metadata_urlmake_base_rest_urlmake_base_soap_urlmake_bulk_batch_details_urlmake_bulk_batch_status_urlmake_bulk_batches_urlmake_bulk_create_job_urlmake_bulk_delete_job_urlmake_bulk_end_job_generic_urlmake_bulk_get_all_jobs_urlmake_bulk_get_all_query_jobs_urlmake_bulk_get_job_urlmake_bulk_job_records_urlmake_bulk_query_result_urlmake_bulk_query_urlmake_chatter_users_urlmake_composite_batch_urlmake_composite_urlmake_dashboard_copy_urlmake_dashboard_describe_urlmake_dashboard_filter_operators_list_urlmake_dashboard_filter_options_analysis_urlmake_dashboard_status_urlmake_dashboard_urlmake_dashboards_list_urlmake_login_urlmake_parameterized_search_urlmake_query_urlmake_report_copy_urlmake_report_create_urlmake_report_describe_urlmake_report_execute_urlmake_report_fields_urlmake_report_filter_operators_list_urlmake_report_instance_urlmake_report_instances_list_urlmake_report_query_urlmake_report_type_describe_urlmake_report_types_list_urlmake_report_urlmake_reports_list_urlmake_rest_describe_urlmake_rest_objects_urlmake_rest_record_urlmake_search_urlmake_soap_xml_skeletonmake_verbose_httr_messagemap_sf_type_to_r_typemerge_null_to_namessage_w_errors_listedmetadata_type_validatorparameterized_search_controlparse_error_code_and_messageparse_report_detail_rowspatched_tempdirrDELETErecords_list_to_tblremove_empty_linked_object_colsreturn_matching_controlsrforcecom.bulkActionrforcecom.bulkQueryrforcecom.createrforcecom.deleterforcecom.getObjectDescriptionrforcecom.getServerTimestamprforcecom.loginrforcecom.queryrforcecom.retrieverforcecom.searchrforcecom.updaterforcecom.upsertrGETrPATCHrPOSTrPUTsafe_bind_rowssalesforcer_statesession_id_availableset_null_elements_to_naset_null_elements_to_na_recursivelysf_abort_job_bulksf_access_tokensf_analytics_notification_createsf_analytics_notification_deletesf_analytics_notification_describesf_analytics_notification_updatesf_analytics_notifications_limitssf_analytics_notifications_listsf_authsf_auth_checksf_auth_refreshsf_batch_details_bulksf_batch_status_bulksf_build_cols_specsf_bulk_operationsf_close_job_bulksf_controlsf_convert_leadsf_copy_dashboardsf_copy_reportsf_createsf_create_attachmentsf_create_batches_bulksf_create_job_bulksf_create_job_bulk_v1sf_create_job_bulk_v2sf_create_metadatasf_create_reportsf_deletesf_delete_attachmentsf_delete_dashboardsf_delete_job_bulksf_delete_metadatasf_delete_reportsf_delete_report_instancesf_describe_dashboardsf_describe_dashboard_componentssf_describe_metadatasf_describe_object_fieldssf_describe_objectssf_describe_reportsf_describe_report_typesf_download_attachmentsf_empty_recycle_binsf_end_job_bulksf_execute_reportsf_filter_dashboard_operators_listsf_filter_dashboard_options_analysissf_find_duplicatessf_find_duplicates_by_idsf_format_datesf_format_datetimesf_format_timesf_get_all_jobs_bulksf_get_all_query_jobs_bulksf_get_dashboard_datasf_get_dashboard_resultssf_get_dashboard_statussf_get_deletedsf_get_job_bulksf_get_job_records_bulksf_get_report_instance_resultssf_get_updatedsf_guess_colssf_input_data_validationsf_job_batches_bulksf_list_api_limitssf_list_dashboardssf_list_metadatasf_list_objectssf_list_report_fieldssf_list_report_filter_operatorssf_list_report_instancessf_list_report_typessf_list_reportssf_list_resourcessf_list_rest_api_versionssf_mergesf_querysf_query_bulksf_query_bulk_v1sf_query_bulk_v2sf_query_reportsf_query_result_bulksf_query_result_bulk_v1sf_query_result_bulk_v2sf_read_metadatasf_refresh_dashboardsf_rename_metadatasf_reorder_colssf_report_folder_childrensf_report_folder_createsf_report_folder_deletesf_report_folder_describesf_report_folder_share_deletesf_report_folder_share_describesf_report_folder_share_recipientssf_report_folder_share_updatesf_report_folder_shares_addsf_report_folder_shares_listsf_report_folder_shares_updatesf_report_folder_updatesf_report_folders_listsf_reset_passwordsf_rest_listsf_retrievesf_retrieve_metadatasf_retrieve_metadata_check_statussf_run_bulk_operationsf_run_bulk_querysf_run_reportsf_searchsf_server_timestampsf_session_idsf_set_dashboard_sticky_filtersf_set_passwordsf_submit_query_bulksf_undeletesf_updatesf_update_attachmentsf_update_dashboardsf_update_metadatasf_update_reportsf_upload_complete_bulksf_upsertsf_upsert_metadatasf_user_infosf_write_csvsimplify_report_metadatastop_w_errors_listedtoken_availableunbox_list_elementsunbox_list_elements_recursivelyunnest_colvalid_metadata_listvalidate_get_all_jobs_paramsVERB_nwarn_w_errors_listedxml_drop_and_unlistxml_drop_and_unlist_recursivelyxml_extract_parent_and_child_resultxml_nodeset_to_dfxmlToList2

Dependencies:anytimeaskpassbase64encBHbitbit64clicliprcpp11crayoncurldata.tabledplyrfansigenericsgluehmshttrjsonlitelifecyclelubridatemagrittrmimeopensslpillarpkgconfigprettyunitsprogresspurrrR6Rcppreadrrlangrlistsystibbletidyselecttimechangetzdbutf8vctrsvroomwithrXMLxml2yamlzip

Getting Started

Steven M. Mortimer

Rendered fromgetting-started.Rmdusingknitr::rmarkdownon Nov 07 2024.

Last update: 2024-11-06
Started: 2018-04-13

Passing Control Args

Steven M. Mortimer

Rendered frompassing-control-args.Rmdusingknitr::rmarkdownon Nov 07 2024.

Last update: 2022-03-01
Started: 2019-06-10

Supported Queries

Steven M. Mortimer

Rendered fromsupported-queries.Rmdusingknitr::rmarkdownon Nov 07 2024.

Last update: 2024-11-06
Started: 2020-07-21

Transitioning from RForcecom

Steven M. Mortimer

Rendered fromtransitioning-from-RForcecom.Rmdusingknitr::rmarkdownon Nov 07 2024.

Last update: 2022-03-01
Started: 2018-04-13

Working with Attachments

Steven M. Mortimer

Rendered fromworking-with-attachments.Rmdusingknitr::rmarkdownon Nov 07 2024.

Last update: 2024-11-06
Started: 2020-06-13

Working with Bulk APIs

Steven M. Mortimer

Rendered fromworking-with-bulk-apis.Rmdusingknitr::rmarkdownon Nov 07 2024.

Last update: 2024-11-06
Started: 2020-07-21

Working with Metadata

Steven M. Mortimer

Rendered fromworking-with-metadata.Rmdusingknitr::rmarkdownon Nov 07 2024.

Last update: 2022-03-01
Started: 2020-06-13

Working with Reports

Steven M. Mortimer

Rendered fromworking-with-reports.Rmdusingknitr::rmarkdownon Nov 07 2024.

Last update: 2024-11-06
Started: 2020-07-21

Readme and manuals

Help Manual

Help pageTopics
Collapse Elements in List with Same Namecollapse_list_with_dupe_names
Metadata Data Type Validatormetadata_type_validator
Auxiliary for Controlling Parametrized Searchesparameterized_search_control
The 'salesforcer' backwards compatible version of the RForcecom function 'rforcecom.bulkAction'rforcecom.bulkAction
The 'salesforcer' backwards compatible version of 'RForcecom::rforcecom.bulkQuery'rforcecom.bulkQuery
The 'salesforcer' backwards compatible version of 'RForcecom::rforcecom.create'rforcecom.create
The 'salesforcer' backwards compatible version of 'RForcecom::rforcecom.delete'rforcecom.delete
The 'salesforcer' backwards compatible version of 'RForcecom::rforcecom.getObjectDescription'rforcecom.getObjectDescription
The 'salesforcer' backwards compatible version of 'RForcecom::rforcecom.getServerTimestamp'rforcecom.getServerTimestamp
The 'salesforcer' backwards compatible version of 'RForcecom::rforcecom.login'rforcecom.login
The 'salesforcer' backwards compatible version of 'RForcecom::rforcecom.query'rforcecom.query
The 'salesforcer' backwards compatible version of 'RForcecom::rforcecom.retrieve'rforcecom.retrieve
The 'salesforcer' backwards compatible version of 'RForcecom::rforcecom.search'rforcecom.search
The 'salesforcer' backwards compatible version of 'RForcecom::rforcecom.update'rforcecom.update
The 'salesforcer' backwards compatible version of 'RForcecom::rforcecom.upsert'rforcecom.upsert
Abort Bulk API Jobsf_abort_job_bulk
Create an analytics notificationsf_analytics_notification_create
Delete an analytics notificationsf_analytics_notification_delete
Describe an analytics notificationsf_analytics_notification_describe
Update an analytics notificationsf_analytics_notification_update
Return limits of analytics notificationssf_analytics_notifications_limits
List analytics notificationssf_analytics_notifications_list
Log in to Salesforcesf_auth
Returning the Details of a Batch in a Bulk API Jobsf_batch_details_bulk
Checking the Status of a Batch in a Bulk API Jobsf_batch_status_bulk
Close Bulk API Jobsf_close_job_bulk
Auxiliary for Controlling Calls to Salesforce APIssf_control
Convert Leadssf_convert_lead
Copy a dashboardsf_copy_dashboard
Copy a reportsf_copy_report
Create Recordssf_create
Create Attachmentssf_create_attachment
Add Batches to a Bulk API Jobsf_create_batches_bulk
Create Bulk API Jobsf_create_job_bulk
Create Object or Field Metadata in Salesforcesf_create_metadata
Create a reportsf_create_report
Delete Recordssf_delete
Delete Attachmentssf_delete_attachment
Delete a dashboardsf_delete_dashboard
Delete Bulk API Jobsf_delete_job_bulk
Delete Object or Field Metadata in Salesforcesf_delete_metadata
Delete a reportsf_delete_report
Delete a report instancesf_delete_report_instance
Describe a dashboardsf_describe_dashboard
Describe dashboard componentssf_describe_dashboard_components
Describe the Metadata in an Organizationsf_describe_metadata
Describe Object Fieldssf_describe_object_fields
SObject Basic Informationsf_describe_objects
Describe a reportsf_describe_report
Describe a report typesf_describe_report_type
Download an Attachmentsf_download_attachment
Empty Recycle Binsf_empty_recycle_bin
Execute a reportsf_execute_report
List dashboard filter operatorssf_filter_dashboard_operators_list
Get an analysis of the filter options for a dashboardsf_filter_dashboard_options_analysis
Find Duplicate Recordssf_find_duplicates
Find Duplicate Records By Idsf_find_duplicates_by_id
Get All Bulk API Jobssf_get_all_jobs_bulk
Get All Bulk API Query Jobssf_get_all_query_jobs_bulk
Get dashboard data in a tabular formatsf_get_dashboard_data
Get the results of an existing dashboardsf_get_dashboard_results
Get the status of a dashboardsf_get_dashboard_status
Get Deleted Records from a Timeframesf_get_deleted
Get Bulk API Jobsf_get_job_bulk
Returning the Details of a Bulk API Jobsf_get_job_records_bulk
Get report instance resultssf_get_report_instance_results
Get Updated Records from a Timeframesf_get_updated
Checking the Status of a Batch in a Bulk API Jobsf_job_batches_bulk
List the Limits for an APIsf_list_api_limits
List dashboardssf_list_dashboards
List All Objects of a Certain Metadata Type in Salesforcesf_list_metadata
List Organization Objects and their Metadatasf_list_objects
Get a list of report fieldssf_list_report_fields
List report filter operatorssf_list_report_filter_operators
List report instancessf_list_report_instances
List report typessf_list_report_types
List reportssf_list_reports
List the Resources for an APIsf_list_resources
List REST API Versionssf_list_rest_api_versions
Merge Recordssf_merge
Perform SOQL Querysf_query
Run Bulk 1.0 querysf_query_bulk_v1
Run Bulk 2.0 querysf_query_bulk_v2
Get Report Data without Saving Changes to or Creating a Reportsf_query_report
Retrieve the results of a completed bulk querysf_query_result_bulk
Retrieve the results of a Bulk 1.0 querysf_query_result_bulk_v1
Retrieve the results of a Bulk 2.0 querysf_query_result_bulk_v2
Read Object or Field Metadata from Salesforcesf_read_metadata
Refresh an existing dashboardsf_refresh_dashboard
Rename Metadata Elements in Salesforcesf_rename_metadata
Get the subfolders (children) of a report foldersf_report_folder_children
Create report foldersf_report_folder_create
Delete a report foldersf_report_folder_delete
Describe a report foldersf_report_folder_describe
Delete a report folder sharesf_report_folder_share_delete
Describe a report folder sharesf_report_folder_share_describe
Get report folder share recipientssf_report_folder_share_recipients
Update a report folder sharesf_report_folder_share_update
Add shares to a report foldersf_report_folder_shares_add
List the shares in a report foldersf_report_folder_shares_list
Update the shares for a report foldersf_report_folder_shares_update
Update a report foldersf_report_folder_update
List report folderssf_report_folders_list
Reset User Passwordsf_reset_password
Retrieve Records By Idsf_retrieve
Make A Request to Retrieve the Metadatasf_retrieve_metadata
Run Bulk Operationsf_bulk_operation sf_run_bulk_operation
Run bulk querysf_query_bulk sf_run_bulk_query
Get a report's data in tabular formatsf_run_report
Perform SOSL Searchsf_search
Salesforce Server Timestampsf_server_timestamp
Set a sticky dashboard filtersf_set_dashboard_sticky_filter
Set User Passwordsf_set_password
Submit Bulk Query Batch to a Bulk API Jobsf_submit_query_bulk
Undelete Recordssf_undelete
Update Recordssf_update
Update Attachmentssf_update_attachment
Update a dashboardsf_update_dashboard
Update Object or Field Metadata in Salesforcesf_update_metadata
Update a reportsf_update_report
Signal Upload Complete to Bulk API Jobsf_upload_complete_bulk
Upsert Recordssf_upsert
Upsert Object or Field Metadata in Salesforcesf_upsert_metadata
Return Current User Infosf_user_info
List of Valid Data Typesvalid_metadata_list