Change Log

This page documents the additions, changes, fixes, deprecations and removals made in each release.

v1.4.0

Release Date: 2026-02-04

Added

Core Object

Additions to the SalesPyForce Core Object are listed below.

• Added the salespyforce.core.Salesforce.get_latest_api_version() method which retrieves the latest API version by querying the authorized Salesforce org, returning the version as a string (e.g. 65.0)

• Added the FALLBACK_SFDC_API_VERSION constant that is leveraged if the salespyforce.core.Salesforce.get_latest_api_version() method fails to retrieve the latest API version for the authorized Salesforce org

• Added the salespyforce.core.Salesforce.delete() method to perform DELETE requests against the authorized Salesforce instance

• Added the salespyforce.core.Salesforce.retrieve_current_user_info() method to retrieve the userinfo data for the current/running user and store it in the instantiated core object

• Added the salespyforce.core.Salesforce._get_cached_user_info() private method to retrieve a field value from the current user info, optionally attempting to retrieve the data from the API again if the field and/or data is missing

• Added the salespyforce.core.Salesforce.check_user_record_access() method to check the Read, Edit, and Delete access for a given record and user

• Added the salespyforce.core.Salesforce.can_access_record() method

• Added the salespyforce.core.Salesforce.can_read_record() method

• Added the salespyforce.core.Salesforce.can_edit_record() method

• Added the salespyforce.core.Salesforce.can_delete_record() method

• Added the salespyforce.core.Salesforce._eval_user_record_access() private static method to check for an access level given the field and the record access data

• Added the salespyforce.core.Salesforce.get_18_char_id() method to convert 15-character Id values

Primary Modules

Additions to the primary modules are listed below.

• Added the salespyforce.api.delete() function to perform DELETE API requests

• Added the salespyforce.api._construct_full_query_url() function to evaluate and construct the URL to utilize during an API call

• Added the salespyforce.knowledge.delete_article_draft() function to delete knowledge article drafts

• Created the salespyforce.decorators module containing the following decorators:

  • salespyforce.decorators.deprecated() to flag a callable as deprecated

Supporting Modules

Additions to the supporting modules are listed below.

• Added the salespyforce.utils.core_utils.get_18_char_id() function to convert 15-character Id values

• Added the salespyforce.utils.core_utils.matches_regex_pattern() function to compare strings with regex patterns

• Added the salespyforce.utils.core_utils.is_valid_salesforce_url() function to verify a URL is valid

• Added the salespyforce.errors.handlers.get_exception_type() function to aid in handling exceptions

• Added the salespyforce.errors.handlers.display_warning() function to better handle runtime warnings

• Added the salespyforce.utils.tests.conftest module to configure pytest for unit testing

• Added the salespyforce.utils.tests.test_core_utils module to test the core utilities

• Added the salespyforce.utils.tests.test_log_utils module to test the logging functionality

General

• Created the .readthedocs.yaml file to manage the integration with the ReadTheDocs documentation

• Added the new .github/workflows/ci.yml CI workflow to follow best practices and improve deployments

• Added the docs/ci.md Markdown document with CI-related instructions and notes

• Added the .github/scripts/decrypt_helper_local.sh script to assist with pytest and CI

• Added the AGENTS.md file to define agent guidelines with the package

Changed

Core Object

Changes to the SalesPyForce Core Object are listed below.

• Updated the init method for the salespyforce.core.Salesforce class to define the following class-scoped variables:

  Variable	Data Type	Description
  org_id	str	Salesforce Org ID
  current_user_info	dict	Details about current/running user

• Updated the docstring for the salespyforce.core.Salesforce.get_api_versions() method to explicitly state what the method returns and its data type

• Updated the following methods to use a globally defined default timeout value to use when a value is not explicitly defined in the respective parameter:

  • salespyforce.core.Salesforce.get()

  • salespyforce.core.Salesforce.api_call_with_payload()

  • salespyforce.core.Salesforce.post()

  • salespyforce.core.Salesforce.patch()

  • salespyforce.core.Salesforce.put()

• Updated the salespyforce.core.Salesforce.Knowledge.get_validation_status() method to use a more specific exception class and to return an empty string on lookup failures versus a None value

• Updated the salespyforce.core.Salesforce.Knowledge.get_article_details() method to fix a logic issue and to introduce the optional use_knowledge_articles_endpoint parameter with respective functionality

Primary Modules

Changes to the primary modules are listed below.

• Updated the functions below to support full URLs to be passed as the endpoint with the URLs being evaluated to ensure they are valid Salesforce URLs:

  • salespyforce.api.get()

  • salespyforce.api.api_call_with_payload()

• Updated the functions below to use a global constant for the timeout parameter value default:

  • salespyforce.api.get()

  • salespyforce.api.api_call_with_payload()

• Updated the salespyforce.knowledge.get_article_details() function to fix a logic issue and to introduce the optional use_knowledge_articles_endpoint parameter with respective functionality

• Updated the salespyforce.knowledge.get_articles_list() function to log errors using the logger rather than to stderr in the console

• Updated the salespyforce.knowledge.get_article_id_from_number() function to resolve a logic issue and to make the function more robust and stable

  • A warning has also been added when the return_uri parameter is leveraged to inform users that its functionality will be moved to a separate function in a future release

• Updated the primary modules to add some type hints and make other minor improvements

Supporting Modules

Changes to the supporting modules are listed below.

• Completely refactored the salespyforce.utils.version module to retrieve the version from the package metadata and using it to define the __version__ special variable

• Updated the HELPER_FILE_NAME value in the salespyforce.utils.tests.resources module

• Updated the following unit test modules to leverage the new pytest configuration:

  • salespyforce.utils.tests.test_instantiate_object

  • salespyforce.utils.tests.test_sobjects

  • salespyforce.utils.tests.test_soql

  • salespyforce.utils.tests.test_sosl

• Updated the salespyforce.utils.log_utils module to always define a default logging level

• Added a comment to skip assert checks by bandit in the modules used by pytest

General

• Updated the Sphinx configuration (docs/conf.py) to follow recommendations and best practices

• Updated the pyproject.toml file to follow best practices and to include the following changes:

  • Changed the minimum supported Python version to be 3.9

  • Added hyperlinks to available resources and documentation

  • Added Trove classifiers for PyPI

  • Moved pytest to a dev dependency group

  • Removed setuptools and urllib3 from runtime dependencies

  • Updated dependency versions 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

  • Added bandit with SARIF support to the dev dependencies

• Updated the requirements.txt file to be runtime-only and mirror the pyproject.toml file

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

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

  • Added certifi to requirements.txt 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

• Replaced the .github/workflows/pythonpackage.yml workflow with .github/workflows/ci.yml which has several improvements over the original file, including:

  • Dropping Python 3.6-3.8 and testing 3.9–3.12 on ubuntu-latest and macos-latest

  • Using actions/checkout@v4 and actions/setup-python@v5

  • Installing Poetry via pipx and using poetry install --with dev

  • Building wheel/sdist with poetry build

  • Running Bandit only on Ubuntu (to save time)

  • Caching Poetry/pip downloads for speed

  • Removing the obsolete macOS target matrix

• Completely refactored the .github/scripts/encrypt_secret.sh script to add features and functionality

• Added a new helper file in .github/encrypted/ for use with CI and unit testing with pytest

• Updated the .github/scripts/decrypt_helper.sh script to use the new helper file

Deprecated

Supporting Modules

Deprecations in the supporting modules are listed below.

• salespyforce.utils.core_utils.display_warning()

  • Use the salespyforce.errors.handlers.display_warning() function instead.

Removed

Core Object

Removals in the SalesPyForce Core Object are listed below.

• Removed the hardcoded CURRENT_SFDC_VERSION constant in the salespyforce.core.Salesforce __init__ method as it is now obsolete

General

• Removed .github/workflows/pythonpackage.yml (replaced by .github/workflows/ci.yml)

• Removed the obsolete .github/encrypted/helper_shurt.yml.old.gpg helper file

• Removed the setup.py file as it is no longer needed for this package

---

v1.3.0

Release Date: 2025-11-11

Added

Core Object

Additions to the SalesPyForce Core Object are listed below.

• Added the salespyforce.core.Salesforce.Knowledge.archive_article() method

• Added the next_records_url parameter in the salespyforce.core.Salesforce.soql_query() method and added the ability to query using a nextRecordsUrl value

Primary Modules

Additions to the primary modules are listed below.

• Added the salespyforce.knowledge.archive_article() function

---

v1.2.2

Release Date: 2023-11-14

Changed

Core Object

Changes to the SalesPyForce Core Object are listed below.

• Updated the salespyforce.core.Salesforce.Knowledge.check_for_existing_article() method to specify whether archived articles will be included in the query results

Primary Modules

Changes to the primary modules are listed below.

• Updated the salespyforce.knowledge.check_for_existing_article() function to specify whether archived articles will be included in the query results

---

v1.2.1

Release Date: 2023-09-01

Changed

Core Object

Changes to the SalesPyForce Core Object are listed below.

• Changed the CURRENT_SFDC_VERSION value to be 58.0

• Updated the salespyforce.core.Salesforce.Knowledge.publish_article() method to return a Boolean value indicating the successful outcome by default, while optionally being able to return the full API response

Primary Modules

Changes to the primary modules are listed below.

• Updated the salespyforce.knowledge.publish_article() function to return a Boolean value indicating the successful outcome by default, while optionally being able to return the full API response

---

v1.2.0

Release Date: 2023-08-31

Added

Core Object

Additions to the SalesPyForce Core Object are listed below.

• Added the salespyforce.core.Salesforce.Knowledge.assign_data_category() method

Primary Modules

Additions to the primary modules are listed below.

• Added the salespyforce.knowledge.assign_data_category() function

Changed

Primary Modules

Changes to the primary modules are listed below.

• Updated when Lightning URLs are defined and fixed an extraneous slash issue with the salespyforce.knowledge.get_article_url() function

---

v1.1.2

Release Date: 2023-06-05

Changed

General

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

---

v1.1.1

Release Date: 2023-06-05

Changed

General

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

---

v1.1.0

Release Date: 2023-05-29

Added

Core Object

Additions to the SalesPyForce Core Object are listed below.

• Added the salespyforce.core.Salesforce.get_org_limits() method

• Added the salespyforce.core.Salesforce.search_string() method

Supporting Modules

Additions to the supporting modules are listed below.

• Added the salespyforce.utils.tests.resources module with the following functions and classes:

  • salespyforce.utils.tests.resources.MockResponse

  • salespyforce.utils.tests.resources.mock_success_post()

  • salespyforce.utils.tests.resources.mock_error_post()

  • salespyforce.utils.tests.resources.mock_sosl_get()

  • salespyforce.utils.tests.resources.set_package_path()

  • salespyforce.utils.tests.resources.import_modules()

  • salespyforce.utils.tests.resources.secrets_helper_exists()

  • salespyforce.utils.tests.resources.local_helper_exists()

  • salespyforce.utils.tests.resources.get_core_object()

  • salespyforce.utils.tests.resources.instantiate_with_secrets_helper()

  • salespyforce.utils.tests.resources.instantiate_with_local_helper()

• Added the salespyforce.utils.tests.test_instantiate_object module with the following functions:

  • salespyforce.utils.tests.test_instantiate_object.test_instantiate_core_object()

  • salespyforce.utils.tests.test_instantiate_object.test_get_api_versions()

  • salespyforce.utils.tests.test_instantiate_object.test_get_rest_resources()

  • salespyforce.utils.tests.test_instantiate_object.test_get_org_limits()

• Added the salespyforce.utils.tests.test_sobjects module with the following functions:

  • salespyforce.utils.tests.test_sobjects.test_get_all_sobjects()

  • salespyforce.utils.tests.test_sobjects.test_get_and_describe_sobject()

  • salespyforce.utils.tests.test_sobjects.test_create_record()

• Added the salespyforce.utils.tests.test_soql module with the following functions:

  • salespyforce.utils.tests.test_soql.test_soql_query()