Changelog

This project uses a curated changelog to highlight notable changes by release. Detailed commit history remains available in GitHub.

The format is based on the Keep a Changelog guidelines, and this project adheres to Semantic Versioning.

---

Unreleased

Added

No unreleased additions at this time.

Changed

No unreleased changes at this time.

---

1.5.0 - 2026-07-22

This release adds new utilities, improves API and Knowledge behavior, centralizes package constants, modernizes documentation and quality tooling, and refreshes security-sensitive dependency constraints.

Warning

SalesPyForce 1.5.0 is the final release supporting Python 3.9, 3.10, and 3.11.

SalesPyForce 2.0.0 and newer will require Python 3.12 or newer.

Added

• The salespyforce.utils.version.get_version_from_pyproject() function was added as a fallback method for retrieving the current package version when the package is not installed.

• The salespyforce.errors.exceptions.PATCHRequestError exception class has been added to leverage with PATCH request exceptions.

• The ensure_starts_with() and ensure_ends_with() core utility functions have been added to assist with input validation.

Changed

• Successful GET, POST, PATCH, PUT, and DELETE responses with empty bodies are now returned as raw response objects instead of being passed to JSON decoding. This prevents successful 204 No Content DELETE operations from raising JSON decode errors.

• The salespyforce.Salesforce.patch() method once again defaults return_json to False, preserving the public behavior released in version 1.4.0.

• String helper paths now infer JSON or YAML parsing from their .json, .yml, or .yaml file extensions. Explicit sequence, set, and mapping helper forms remain supported.

• Knowledge article publishing now uses the centralized REST_PATHS.ARTICLE_MASTER_VERSION_BY_ID endpoint template.

• Regression coverage has been added for API response handling, Knowledge and Chatter endpoint construction, helper file selection, and API request exception messages.

• Adopted Ruff for linting, import sorting, and formatting; added project configuration, replaced flake8 validation in CI, and documented the contributor quality checks.

• CI now verifies the security-sensitive dependency versions selected for each Python release, isolates pytest temporary files, and validates built artifacts with Twine.

• Added prominent README and Sphinx documentation notices that version 1.5.0 is the final release supporting Python 3.9 through 3.11 and that version 2.0.0 will require Python 3.12 or newer.

• The constants used by the package have been centralized within the new salespyforce.constants module and the other modules have been updated accordingly.

• The download_image() method now logs errors and raises exceptions when failing to successfully download an image.

• The salespyforce.utils.version.get_full_version() and salespyforce.utils.version.get_major_minor_version() functions now attempt to retrieve the version from the pyproject.toml file if it cannot be retrieved via the package metadata.

• The salespyforce.Salesforce.Knowledge.delete_article_draft() method (and underlying function) now supports the sobject parameter to specify the sObject against which to query.

• The salespyforce.Salesforce.Knowledge.get_validation_status() method (and underlying function) now includes the use_knowledge_articles_endpoint parameter so you can specify the REST path to utilize.

• The following methods (and underlying functions) now raise the MissingRequiredDataError exception rather than generic RuntimeError or ValueError exceptions when required data is missing:

  • salespyforce.Salesforce.Chatter.post_feed_item()

  • salespyforce.Salesforce.Chatter.post_comment()

  • salespyforce.Salesforce.Knowledge.get_article_url()

  • salespyforce.Salesforce.Knowledge.create_draft_from_master_version()

  • salespyforce.Salesforce.Knowledge.publish_multiple_articles()

• The salespyforce.utils.core_utils.download_image() function now raises more specific exceptions instead of the generic RuntimeError exception.

  • The salespyforce.errors.exceptions.MissingRequiredDataError exception is raised if neither an image URL nor an API response are provided when calling the function.

  • The salespyforce.errors.exceptions.GETRequestError exception is raised if the GET request fails to download the image.

• The salespyforce.utils.helper.import_helper_file() and salespyforce.utils.helper.get_helper_settings() functions now support both yml and yaml extensions for YAML files.

• The documentation for this project has updated to a more modern and intuitive theme, layout, and structure. The intent was to be less verbose and instead make the documentation more human-oriented with helpful guides and tutorials.

  • The previous Sphinx content has been preserved in docs_legacy/ for historical purposes.

• The test suite has been moved from src/salespyforce/utils/tests/ to the root-level tests/ directory to better align with standard Python project layout practices.

• The root-level test suite is now organized into tests/unit/ and tests/integration/ to separate deterministic unit coverage from opt-in environment-dependent integration coverage.

Removed

• The salespyforce.utils.helper.HelperParsing class has been removed as its functionality has been replaced by the YAML_BOOLEAN_MAPPING constant in the salespyforce.constants module.

Security

• Updated idna to 3.15 or newer to address CVE-2026-45409 on every supported Python version.

• Constrained the documentation dependencies to soupsieve 2.8.4 or newer to address CVE-2026-49476 and CVE-2026-49477. Soup Sieve remains required transitively by the PyData Sphinx Theme through Beautiful Soup.

• Constrained development and documentation environments to Pygments 2.20.0 or newer to address CVE-2026-4539.

• Python 3.10 and newer now require Requests 2.33.0 or newer, urllib3 2.7.0 or newer, and pytest 9.0.3 or newer to address CVE-2026-25645, CVE-2026-44431, CVE-2026-44432, and CVE-2025-71176.

• Python 3.9 retains the newest compatible Requests, urllib3, and pytest release lines because the corresponding fixed releases require Python 3.10 or newer. SalesPyForce does not use Requests’ vulnerable extract_zipped_paths() utility or directly invoke urllib3’s affected low-level proxy redirect and streaming APIs. pytest is development-only, and the Python 3.9 CI jobs use an isolated, owner-only temporary directory on ephemeral runners.

• Version 1.5.0 is the final SalesPyForce release supporting Python versions below 3.12. The next release line will remove these Python 3.9 dependency exceptions when it raises the minimum supported Python version to 3.12.

---

1.4.0 - 2026-02-04

Added

• Several new methods have been introduced within the core object to perform various tasks:

  • The delete() method performs DELETE API calls.

  • The get_latest_api_version() method retrieves the latest Salesforce API version.

  • The retrieve_current_user_info() method retrieves information for the current/running user that was leveraged to connect to the Salesforce REST API.

    • This method now runs during the core object instantiation so that the running user information can be utilized as default parameter values with certain methods/functions.

  • Several new methods were added to check the user access for a specific record:

    • can_access_record()

    • can_read_record()

    • can_edit_record()

    • can_delete_record()

  • The get_18_char_id() method converts a 15-character Id value into a valid 18-character value.

• Added several new functions in the utilities modules:

  • The new salespyforce.utils.core_utils.is_valid_salesforce_url() function is now utilized to ensure that URLs passed to the API call methods (e.g., get(), put(), etc.) to ensure they are valid Salesforce URLs.

Changed

• The Salesforce client now defines and stores the org_id (str)
  and current_user_info (dict) for use in client API calls as default parameter values.

• The salespyforce.Salesforce.Knowledge.get_validation_status() method has been updated to use a more specific exception class, and to return an empty string on lookup failures versus a None value.

• The salespyforce.Salesforce.Knowledge.get_article_details() method now accepts the optional use_knowledge_articles_endpoint parameter, which forces the knowledgeArticles endpoint to be used for the GET request rather than the sobjects endpoint.

• The client methods for API calls (e.g. get(), post(), etc.) now support passing full URLs as the endpoint as long as they are valid Salesforce.com URLs.

• The salespyforce.Salesforce.Knowledge.get_articles_list() method now logs errors using the logger rather than writing to stderr in the console.

Deprecated

• The function salespyforce.utils.core_utils.display_warning() has been deprecated
  and has been moved to salespyforce.errors.handlers.display_warning() instead.

Fixed

• A logic issue was found and resolved in the salespyforce.Salesforce.Knowledge.get_article_id_from_number() method.

Security

• Several dependency versions were updated to mitigate known vulnerabilities found in earlier versions:

  • Explicitly pinned urllib3 to require version 1.26.19 or above (below v3) in order to avoid CVE-2024-37891.

  • Explicitly pinned idna to require version 3.7 or above (below v4) in order to avoid CVE-2024-3651.

  • Explicitly pinned certifi to require version 2024.7.4 or above in order to mitigate CA removals (e-Tugra, GLOBALTRUST) per CVE-2023-37920 and CVE-2024-39689.

---

1.3.0 - 2025-11-11

Added

• The new salespyforce.Salesforce.Knowledge.archive_article() method was added to easily archive knowledge articles.

Changed

• The next_records_url parameter was added to the soql_query() method which introduces the ability to query using a nextRecordsUrl value.

---

1.2.2 - 2023-11-14

Changed

• The salespyforce.Salesforce.Knowledge.check_for_existing_article() method has been updated to introduce the include_archived parameter, which specifies whether archived articles will be included in the query results.

---

1.2.1 - 2023-09-01

Changed

• The salespyforce.Salesforce.Knowledge.publish_article() method now returns a Boolean value by default, which indicates whether the operation was successful. It is still possible to optionally return the full API response.

---

1.2.0 - 2023-08-31

Added

• The new salespyforce.Salesforce.Knowledge.assign_data_category() method has been added, which introduces the ability to assign data categories to a knowledge article draft.

Fixed

• The underlying function for the salespyforce.Salesforce.Knowledge.get_article_url() method was updated to fix an extraneous slash issue.

---

1.1.2 - 2023-06-05

Changed

• Only the version was changed in this release to address an issue with PyPI distribution.

---

1.1.1 - 2023-06-05

Changed

• Only the version was changed in this release to address an issue with PyPI distribution.

---

1.1.0 - 2023-05-29

Added

• The get_org_limits() method was added to retrieve the governor limits for the connected Salesforce org.

• The search_string() method was added to introduce the ability to perform a SOSL query to search for a given string.

---

1.0.0 - 2023-05-08

This was the first release of the salespyforce package on PyPI with its original features and functionality.