salespyforce 1.4.0.dev1__py3-none-any.whl → 1.4.0.dev2__py3-none-any.whl

salespyforce/api.py

@@ -4,7 +4,7 @@
 :Synopsis:          Defines the basic functions associated with the Salesforce API
 :Created By:        Jeff Shurtliff
 :Last Modified:     Jeff Shurtliff
-:Modified Date:     17 Feb 2023
+:Modified Date:     29 Jan 2026
 """
 
 import requests
@@ -117,6 +117,49 @@ def api_call_with_payload(sfdc_object, method, endpoint, payload, params=None, h
     return response
 
 
+def delete(sfdc_object, endpoint, params=None, headers=None, timeout=30, show_full_error=True, return_json=True):
+    """This method performs a DELETE request against the Salesforce instance.
+
+    .. version-added:: 1.4.0
+
+    :param sfdc_object: The instantiated SalesPyForce object
+    :param endpoint: The API endpoint to query
+    :type endpoint: str
+    :param params: The query parameters (where applicable)
+    :type params: dict, None
+    :param headers: Specific API headers to use when performing the API call
+    :type headers: dict, None
+    :param timeout: The timeout period in seconds (defaults to ``30``)
+    :type timeout: int, str, None
+    :param show_full_error: Determines if the full error message should be displayed (defaults to ``True``)
+    :type show_full_error: bool
+    :param return_json: Determines if the response should be returned in JSON format (defaults to ``True``)
+    :returns: The API response in JSON format or as a ``requests`` object
+    """
+    # Define the parameters as an empty dictionary if none are provided
+    params = {} if params is None else params
+
+    # Define the headers
+    default_headers = _get_headers(sfdc_object.access_token)
+    headers = default_headers if not headers else headers
+
+    # Make sure the endpoint begins with a slash
+    endpoint = f'/{endpoint}' if not endpoint.startswith('/') else endpoint
+
+    # Perform the API call
+    response = requests.delete(f'{sfdc_object.instance_url}{endpoint}', headers=headers, params=params,
+                               timeout=timeout)
+    if response.status_code >= 300:
+        if show_full_error:
+            raise RuntimeError(f'The DELETE request failed with a {response.status_code} status code.\n'
+                               f'{response.text}')
+        else:
+            raise RuntimeError(f'The DELETE request failed with a {response.status_code} status code.')
+    if return_json:
+        response = response.json()
+    return response
+
+
 def _get_headers(_access_token, _header_type='default'):
     """This function returns the appropriate HTTP headers to use for different types of API calls."""
     headers = {

salespyforce/core.py

@@ -6,7 +6,7 @@
 :Example:           ``sfdc = Salesforce(helper=helper_file_path)``
 :Created By:        Jeff Shurtliff
 :Last Modified:     Jeff Shurtliff
-:Modified Date:     17 Nov 2025
+:Modified Date:     30 Jan 2026
 """
 
 import re
@@ -60,7 +60,8 @@ class Salesforce(object):
         :param helper: The file path of a helper file
         :type helper: str, None
         :returns: The instantiated object
-        :raises: :py:exc:`TypeError`
+        :raises: :py:exc:`TypeError`,
+                 :py:exc:`RuntimeError`
         """
         # Define the default settings
         self._helper_settings = {}
@@ -147,6 +148,7 @@ class Salesforce(object):
         (`Reference <https://jereze.com/code/authentification-salesforce-rest-api-python/>`_)
 
         :returns: The API call response with the authorization information
+        :raises: :py:exc:`RuntimeError`
         """
         params = {
             'grant_type': 'password',
@@ -176,6 +178,7 @@ class Salesforce(object):
         :type show_full_error: bool
         :param return_json: Determines if the response should be returned in JSON format (defaults to ``True``)
         :returns: The API response in JSON format or as a ``requests`` object
+        :raises: :py:exc:`RuntimeError`
         """
         return api.get(self, endpoint=endpoint, params=params, headers=headers, timeout=timeout,
                        show_full_error=show_full_error, return_json=return_json)
@@ -201,6 +204,7 @@ class Salesforce(object):
         :type show_full_error: bool
         :param return_json: Determines if the response should be returned in JSON format (defaults to ``True``)
         :returns: The API response in JSON format or as a ``requests`` object
+        :raises: :py:exc:`RuntimeError`
         """
         return api.api_call_with_payload(self, method=method, endpoint=endpoint, payload=payload, params=params,
                                          headers=headers, timeout=timeout, show_full_error=show_full_error,
@@ -224,6 +228,7 @@ class Salesforce(object):
         :type show_full_error: bool
         :param return_json: Determines if the response should be returned in JSON format (defaults to ``True``)
         :returns: The API response in JSON format or as a ``requests`` object
+        :raises: :py:exc:`RuntimeError`
         """
         return api.api_call_with_payload(self, 'post', endpoint=endpoint, payload=payload, params=params,
                                          headers=headers, timeout=timeout, show_full_error=show_full_error,
@@ -247,6 +252,7 @@ class Salesforce(object):
         :type show_full_error: bool
         :param return_json: Determines if the response should be returned in JSON format (defaults to ``True``)
         :returns: The API response in JSON format or as a ``requests`` object
+        :raises: :py:exc:`RuntimeError`
         """
         return api.api_call_with_payload(self, 'patch', endpoint=endpoint, payload=payload, params=params,
                                          headers=headers, timeout=timeout, show_full_error=show_full_error,
@@ -270,16 +276,41 @@ class Salesforce(object):
         :type show_full_error: bool
         :param return_json: Determines if the response should be returned in JSON format (defaults to ``True``)
         :returns: The API response in JSON format or as a ``requests`` object
+        :raises: :py:exc:`RuntimeError`
         """
         return api.api_call_with_payload(self, 'put', endpoint=endpoint, payload=payload, params=params,
                                          headers=headers, timeout=timeout, show_full_error=show_full_error,
                                          return_json=return_json)
 
+    def delete(self, endpoint, params=None, headers=None, timeout=30, show_full_error=True, return_json=True):
+        """This method performs a DELETE request against the Salesforce instance.
+        (`Reference <https://jereze.com/code/authentification-salesforce-rest-api-python/>`_)
+
+        .. version-added:: 1.4.0
+
+        :param endpoint: The API endpoint to query
+        :type endpoint: str
+        :param params: The query parameters (where applicable)
+        :type params: dict, None
+        :param headers: Specific API headers to use when performing the API call
+        :type headers: dict, None
+        :param timeout: The timeout period in seconds (defaults to ``30``)
+        :type timeout: int, str, None
+        :param show_full_error: Determines if the full error message should be displayed (defaults to ``True``)
+        :type show_full_error: bool
+        :param return_json: Determines if the response should be returned in JSON format (defaults to ``True``)
+        :returns: The API response in JSON format or as a ``requests`` object
+        :raises: :py:exc:`RuntimeError`
+        """
+        return api.delete(self, endpoint=endpoint, params=params, headers=headers, timeout=timeout,
+                          show_full_error=show_full_error, return_json=return_json)
+
     def get_api_versions(self) -> list:
         """This method returns the API versions for the Salesforce releases.
         (`Reference <https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_versions.htm>`_)
 
         :returns: A list containing the API metadata from the ``/services/data`` endpoint.
+        :raises: :py:exc:`RuntimeError`
         """
         return self.get('/services/data')
 
@@ -305,13 +336,19 @@ class Salesforce(object):
     def get_org_limits(self):
         """This method returns a list of all org limits.
 
-        .. versionadded:: 1.1.0
+        .. version-added:: 1.1.0
+
+        :returns: The Salesforce org governor limits data
+        :raises: :py:exc:`RuntimeError`
         """
         return self.get(f'/services/data/{self.version}/limits')
 
     def get_all_sobjects(self):
         """This method returns a list of all Salesforce objects. (i.e. sObjects)
         (`Reference <https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_describeGlobal.htm>`_)
+
+        :returns: The list of all Salesforce objects
+        :raises: :py:exc:`RuntimeError`
         """
         return self.get(f'/services/data/{self.version}/sobjects')
 
@@ -325,6 +362,7 @@ class Salesforce(object):
         :param describe: Determines if the full (i.e. ``describe``) data should be returned (defaults to ``False``)
         :type describe: bool
         :returns: The Salesforce object data
+        :raises: :py:exc:`RuntimeError`
         """
         uri = f'/services/data/{self.version}/sobjects/{object_name}'
         uri = f'{uri}/describe' if describe else uri
@@ -337,15 +375,32 @@ class Salesforce(object):
         :param object_name: The name of the Salesforce object
         :type object_name: str
         :returns: The Salesforce object data
+        :raises: :py:exc:`RuntimeError`
         """
         return self.get_sobject(object_name, describe=True)
 
     def get_rest_resources(self):
         """This method returns a list of all available REST resources.
         (`Reference <https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_discoveryresource.htm>`_)
+
+        :returns: The list of all available REST resources for the Salesforce org
+        :raises: :py:exc:`RuntimeError`
         """
         return self.get(f'/services/data/{self.version}')
 
+    @staticmethod
+    def get_18_char_id(record_id: str) -> str:
+        """This method converts a 15-character Salesforce record ID to its 18-character case-insensitive form.
+
+        .. version-added:: 1.4.0
+
+        :param record_id: The Salesforce record ID to convert (or return unchanged if already 18 characters)
+        :type record_id: str
+        :returns: The 18-character Salesforce record ID
+        :raises: :py:exc:`ValueError`
+        """
+        return core_utils.get_18_char_id(record_id=record_id)
+
     def soql_query(self, query, replace_quotes=True, next_records_url=False):
         """This method performs a SOQL query and returns the results in JSON format.
         (`Reference 1 <https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_query.htm>`_,
@@ -358,6 +413,7 @@ class Salesforce(object):
         :param next_records_url: Indicates that the ``query`` parameter is a ``nextRecordsUrl`` value.
         :type next_records_url: bool
         :returns: The result of the SOQL query
+        :raises: :py:exc:`RuntimeError`
         """
         if next_records_url:
             query = re.sub(r'^.*/', '', query) if '/' in query else query
@@ -372,11 +428,12 @@ class Salesforce(object):
         """This method performs a SOSL query to search for a given string.
         (`Reference <https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search.htm>`_)
 
-        .. versionadded:: 1.1.0
+        .. version-added:: 1.1.0
 
         :param string_to_search: The string for which to search
         :type string_to_search: str
         :returns: The SOSL response data in JSON format
+        :raises: :py:exc:`RuntimeError`
         """
         query = 'FIND {' + string_to_search + '}'
         query = core_utils.url_encode(query)
@@ -391,7 +448,8 @@ class Salesforce(object):
         :param payload: The JSON payload with the record details
         :type payload: dict
         :returns: The API response from the POST request
-        :raises: :py:exc:`RuntimeError`, :py:exc:`TypeError`
+        :raises: :py:exc:`RuntimeError`,
+                 :py:exc:`TypeError`
         """
         # Ensure the payload is in the appropriate format
         if not isinstance(payload, dict):
@@ -412,7 +470,8 @@ class Salesforce(object):
         :param payload: The JSON payload with the record details to be updated
         :type payload: dict
         :returns: The API response from the PATCH request
-        :raises: :py:exc:`RuntimeError`, :py:exc:`TypeError`
+        :raises: :py:exc:`RuntimeError`,
+                 :py:exc:`TypeError`
         """
         # Ensure the payload is in the appropriate format
         if not isinstance(payload, dict):
@@ -596,7 +655,8 @@ class Salesforce(object):
             :param return_uri: Determines if the URI of the article should be returned rather than the ID (``False`` by default)
             :type return_uri: bool
             :returns: The Article ID or Article URI, or a blank string if no article is found
-            :raises: :py:exc:`ValueError`
+            :raises: :py:exc:`ValueError`,
+                     :py:exc:`RuntimeError`
             """
             return knowledge_module.get_article_id_from_number(self.sfdc_object, article_number=article_number,
                                                                sobject=sobject, return_uri=return_uri)
@@ -616,6 +676,7 @@ class Salesforce(object):
             :param page_num: The starting page number (``1`` by default)
             :type page_num: int
             :returns: The list of retrieved knowledge articles
+            :raises: :py:exc:`RuntimeError`
             """
             return knowledge_module.get_articles_list(self.sfdc_object, query=query, sort=sort, order=order,
                                                       page_size=page_size, page_num=page_num)
@@ -629,6 +690,7 @@ class Salesforce(object):
             :param sobject: The Salesforce object to query (``Knowledge__kav`` by default)
             :type sobject: str, None
             :returns: The details for the knowledge article
+            :raises: :py:exc:`RuntimeError`
             """
             return knowledge_module.get_article_details(self.sfdc_object, article_id=article_id, sobject=sobject)
 
@@ -680,7 +742,8 @@ class Salesforce(object):
             :param sobject: The Salesforce object to query (``Knowledge__kav`` by default)
             :type sobject: str, None
             :returns: The article URL as a string
-            :raises: :py:exc:`ValueError`
+            :raises: :py:exc:`ValueError`,
+                     :py:exc:`RuntimeError`
             """
             return knowledge_module.get_article_url(self.sfdc_object, article_id=article_id,
                                                     article_number=article_number, sobject=sobject)
@@ -696,7 +759,9 @@ class Salesforce(object):
             :param full_response: Determines if the full API response should be returned instead of the article ID (``False`` by default)
             :type full_response: bool
             :returns: The API response or the ID of the article draft
-            :raises: :py:exc:`ValueError`, :py:exc:`TypeError`
+            :raises: :py:exc:`ValueError`,
+                     :py:exc:`TypeError`,
+                     :py:exc:`RuntimeError`
             """
             return knowledge_module.create_article(self.sfdc_object, article_data=article_data, sobject=sobject,
                                                    full_response=full_response)
@@ -714,7 +779,9 @@ class Salesforce(object):
             :param include_status_code: Determines if the API response status code should be returned (``False`` by default)
             :type include_status_code: bool
             :returns: A Boolean indicating if the update operation was successful, and optionally the API response status code
-            :raises: :py:exc:`ValueError`, :py:exc:`TypeError`, :py:exc:`RuntimeError`
+            :raises: :py:exc:`ValueError`,
+                     :py:exc:`TypeError`,
+                     :py:exc:`RuntimeError`
             """
             return knowledge_module.update_article(self.sfdc_object, record_id=record_id, article_data=article_data,
                                                    sobject=sobject, include_status_code=include_status_code)
@@ -781,7 +848,9 @@ class Salesforce(object):
             :param major_version: Determines if the published article should be a major version (``True`` by default)
             :type major_version: bool
             :returns: The API response from the POST request
-            :raises: :py:exc:`RuntimeError`, :py:exc:`TypeError`, :py:exc:`ValueError`
+            :raises: :py:exc:`RuntimeError`,
+                     :py:exc:`TypeError`,
+                     :py:exc:`ValueError`
             """
             return knowledge_module.publish_multiple_articles(self.sfdc_object, article_id_list=article_id_list,
                                                               major_version=major_version)
@@ -790,7 +859,7 @@ class Salesforce(object):
             """This method assigns a single data category for a knowledge article.
             (`Reference <https://itsmemohit.medium.com/quick-win-15-salesforce-knowledge-rest-apis-bb0725b2040e>`_)
 
-            .. versionadded:: 1.2.0
+            .. version-added:: 1.2.0
 
             :param article_id: The ID of the article to update
             :type article_id: str
@@ -809,7 +878,7 @@ class Salesforce(object):
             """This function archives a published knowledge article.
             (`Reference <https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/knowledge_REST_archive_master_version.htm>`_)
 
-            .. versionadded:: 1.3.0
+            .. version-added:: 1.3.0
 
             :param article_id: The ID of the article to archive
             :type article_id: str
@@ -818,6 +887,18 @@ class Salesforce(object):
             """
             return knowledge_module.archive_article(self.sfdc_object, article_id=article_id)
 
+        def delete_article_draft(self, version_id):
+            """This function deletes an unpublished knowledge article draft.
+
+            .. version-added:: 1.4.0
+
+            :param version_id: The 15-character or 18-character ``Id`` (Knowledge Article Version ID) value
+            :type version_id: str
+            :returns: The API response from the DELETE request
+            :raises: :py:exc:`RuntimeError`
+            """
+            return knowledge_module.delete_article_draft(self.sfdc_object, version_id=version_id)
+
 
 def define_connection_info():
     """This function prompts the user for the connection information.

salespyforce/knowledge.py

@@ -4,7 +4,7 @@
 :Synopsis:          Defines the Knowledge-related functions associated with the Salesforce API
 :Created By:        Jeff Shurtliff
 :Last Modified:     Jeff Shurtliff
-:Modified Date:     14 Nov 2023
+:Modified Date:     30 Jan 2026
 """
 
 from . import errors
@@ -20,7 +20,7 @@ def check_for_existing_article(sfdc_object, title, sobject=None, return_id=False
     (`Reference 1 <https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_query.htm>`_,
     `Reference 2 <https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/knowledge_development_soql_sosl_intro.htm>`_)
 
-    .. versionchanged:: 1.2.2
+    .. version-changed:: 1.2.2
        You can now specify whether archived articles are included in the query results.
 
     :param sfdc_object: The instantiated SalesPyForce object
@@ -230,7 +230,7 @@ def get_article_version(sfdc_object, article_id):
 def get_article_url(sfdc_object, article_id=None, article_number=None, sobject=None):
     """This function constructs the URL to view a knowledge article in Lightning or Classic.
 
-    .. versionchanged:: 1.2.0
+    .. version-changed:: 1.2.0
        Changed when lightning URLs are defined and fixed an issue with extraneous slashes.
 
     :param sfdc_object: The instantiated SalesPyForce object
@@ -483,7 +483,7 @@ def assign_data_category(sfdc_object, article_id, category_group_name, category_
     """This function assigns a single data category for a knowledge article.
     (`Reference <https://itsmemohit.medium.com/quick-win-15-salesforce-knowledge-rest-apis-bb0725b2040e>`_)
 
-    .. versionadded:: 1.2.0
+    .. version-added:: 1.2.0
 
     :param sfdc_object: The instantiated SalesPyForce object
     :type sfdc_object: class[salespyforce.Salesforce]
@@ -512,7 +512,7 @@ def archive_article(sfdc_object, article_id):
     """This function archives a published knowledge article.
     (`Reference <https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/knowledge_REST_archive_master_version.htm>`_)
 
-    .. versionadded:: 1.3.0
+    .. version-added:: 1.3.0
 
     :param sfdc_object: The instantiated SalesPyForce object
     :type sfdc_object: class[salespyforce.Salesforce]
@@ -529,3 +529,19 @@ def archive_article(sfdc_object, article_id):
     # Perform the API call
     endpoint = f'/services/data/{sfdc_object.version}/knowledgeManagement/articleVersions/masterVersions/{article_id}'
     return sfdc_object.patch(endpoint, payload)
+
+
+def delete_article_draft(sfdc_object, version_id):
+    """This function deletes an unpublished knowledge article draft.
+    
+    .. version-added:: 1.4.0
+    
+    :param sfdc_object: The instantiated SalesPyForce object
+    :type sfdc_object: class[salespyforce.Salesforce]
+    :param version_id: The 15-character or 18-character ``Id`` (Knowledge Article Version ID) value
+    :type version_id: str
+    :returns: The API response from the DELETE request
+    :raises: :py:exc:`RuntimeError`
+    """
+    endpoint = f'/services/data/{sfdc_object.version}/sobjects/Knowledge__kav/{version_id}'
+    return sfdc_object.delete(endpoint)

salespyforce/utils/core_utils.py

@@ -6,7 +6,7 @@
 :Example:           ``encoded_string = core_utils.encode_url(decoded_string)``
 :Created By:        Jeff Shurtliff
 :Last Modified:     Jeff Shurtliff
-:Modified Date:     29 May 2023
+:Modified Date:     30 Jan 2026
 """
 
 import random
@@ -23,6 +23,9 @@ from .. import errors
 # Initialize the logger for this module
 logger = log_utils.initialize_logging(__name__)
 
+# Define constants
+SALESFORCE_ID_SUFFIX_ALPHABET = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ012345'
+
 
 def url_encode(raw_string):
     """This function encodes a string for use in URLs.
@@ -60,7 +63,8 @@ def get_file_type(file_path):
     :param file_path: The full path to the file
     :type file_path: str
     :returns: The file type in string format (e.g. ``yaml`` or ``json``)
-    :raises: :py:exc:`FileNotFoundError`, :py:exc:`khoros.errors.exceptions.UnknownFileTypeError`
+    :raises: :py:exc:`FileNotFoundError`,
+             :py:exc:`salespyforce.errors.exceptions.UnknownFileTypeError`
     """
     file_type = 'unknown'
     if os.path.isfile(file_path):
@@ -97,6 +101,44 @@ def get_random_string(length=32, prefix_string=""):
     return f"{prefix_string}{''.join([random.choice(string.ascii_letters + string.digits) for _ in range(length)])}"
 
 
+def get_18_char_id(record_id: str) -> str:
+    """This function converts a 15-character Salesforce record ID to its 18-character case-insensitive form.
+
+    .. version-added:: 1.4.0
+
+    :param record_id: The Salesforce record ID to convert (or return unchanged if already 18 characters)
+    :type record_id: str
+    :returns: The 18-character Salesforce record ID
+    :raises: :py:exc:`ValueError`
+    """
+    # Ensure the provided record ID is a string
+    if not isinstance(record_id, str):
+        raise ValueError("Salesforce ID must be a string")
+
+    # Return the record ID unchanged if it is already 18 characters in length
+    if len(record_id) == 18:
+        return record_id
+
+    # Ensure the record ID is a valid 15-character value
+    if len(record_id) != 15:
+        raise ValueError("Salesforce ID must be 15 or 18 characters long")
+
+    # Define the checksum suffix (additional 3 characters)
+    suffix = ""
+    for i in range(0, 15, 5):
+        chunk = record_id[i:i + 5]
+        bitmask = 0
+
+        for index, char in enumerate(chunk):
+            if "A" <= char <= "Z":
+                bitmask |= 1 << index
+
+        suffix += SALESFORCE_ID_SUFFIX_ALPHABET[bitmask]
+
+    # Return the 18-character ID value
+    return record_id + suffix
+
+
 def get_image_ref_id(image_url):
     """This function parses an image URL to identify the reference ID (refid) value.
     (`Reference 1 <https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_sobject_rich_text_image_retrieve.htm>`_,

salespyforce/utils/log_utils.py

@@ -121,7 +121,7 @@ def _set_logging_level(_logger, _log_level):
     """This function sets the logging level for a :py:class:`logging.Logger` instance.
 
     :param _logger: The :py:class:`logging.Logger` instance
-    :type _logger: Logger
+    :type _logger: class[logging.Logger]
     :param _log_level: The log level as a string (``debug``, ``info``, ``warning``, ``error`` or ``critical``)
     :type _log_level: str
     :returns: The :py:class:`logging.Logger` instance with a logging level set where applicable
@@ -162,7 +162,7 @@ def _add_file_handler(_logger, _log_level, _log_file, _overwrite, _formatter):
     """This function adds a :py:class:`logging.FileHandler` to the :py:class:`logging.Logger` instance.
 
     :param _logger: The :py:class:`logging.Logger` instance
-    :type _logger: Logger
+    :type _logger: class[logging.Logger]
     :param _log_level: The log level to set for the handler
     :type _log_level: str
     :param _log_file: The log file (as a file name or a file path) to which messages should be written
@@ -174,7 +174,7 @@ def _add_file_handler(_logger, _log_level, _log_file, _overwrite, _formatter):
     :param _overwrite: Determines if messages should be appended to the file (default) or overwrite it
     :type _overwrite: bool
     :param _formatter: The :py:class:`logging.Formatter` to apply to messages passed through the handler
-    :type _formatter: Formatter
+    :type _formatter: class[logging.Formatter]
     :returns: The :py:class:`logging.Logger` instance with the added :py:class:`logging.FileHandler`
     """
     # Define the log file to use
@@ -203,11 +203,11 @@ def _add_stream_handler(_logger, _log_level, _formatter):
     """This function adds a :py:class:`logging.StreamHandler` to the :py:class:`logging.Logger` instance.
 
     :param _logger: The :py:class:`logging.Logger` instance
-    :type _logger: Logger
+    :type _logger: class[logging.Logger]
     :param _log_level: The log level to set for the handler
     :type _log_level: str
     :param _formatter: The :py:class:`logging.Formatter` to apply to messages passed through the handler
-    :type _formatter: Formatter
+    :type _formatter: class[logging.Formatter]
     :returns: The :py:class:`logging.Logger` instance with the added :py:class:`logging.StreamHandler`
     """
     _log_level = HANDLER_DEFAULTS.get('console_log_level') if not _log_level else _log_level
@@ -229,11 +229,11 @@ def _add_split_stream_handlers(_logger, _log_level, _formatter):
                  more information on how this filtering is implemented and for credit to the original author.
 
     :param _logger: The :py:class:`logging.Logger` instance
-    :type _logger: Logger
+    :type _logger: class[logging.Logger]
     :param _log_level: The log level provided for the stream handler (i.e. console output)
     :type _log_level: str
     :param _formatter: The :py:class:`logging.Formatter` to apply to messages passed through the handlers
-    :type _formatter: Formatter
+    :type _formatter: class[logging.Formatter]
     :returns: The logger instance with the two handlers added
     """
     # Configure and add the STDOUT handler

salespyforce/utils/tests/test_core_utils.py

@@ -5,7 +5,7 @@
 :Synopsis:       This module is used by pytest to test core utility functions
 :Created By:     Jeff Shurtliff
 :Last Modified:  Jeff Shurtliff
-:Modified Date:  20 Dec 2025
+:Modified Date:  30 Jan 2026
 """
 
 import os
@@ -115,6 +115,45 @@ def test_get_random_string_returns_expected_length(monkeypatch):
     assert all(char in alphabet for char in result.replace("pre_", ""))
 
 
+def test_converts_15_char_id_to_18_char():
+    """This function tests the conversion of a 15-character Salesforce ID into the 18-character equivalent.
+
+    .. version-added:: 1.4.0
+    """
+    id_15 = "ka4PO0000002hby"
+    id_18 = core_utils.get_18_char_id(id_15)
+
+    assert len(id_18) == 18
+    assert id_18.startswith(id_15)
+
+
+def test_returns_18_char_id_unchanged():
+    """This function tests that an 18-character Salesforce ID is returned unchanged during conversion attempt.
+
+    .. version-added:: 1.4.0
+    """
+    id_18 = "ka4PO0000002hbyYAA"
+    assert core_utils.get_18_char_id(id_18) == id_18
+
+
+def test_invalid_id_length_raises_error():
+    """This function tests to ensure passing an invalid Salesforce ID length raises an exception.
+
+    .. version-added:: 1.4.0
+    """
+    with pytest.raises(ValueError):
+        core_utils.get_18_char_id("short")
+
+
+def test_non_string_id_input_raises_error():
+    """This function tests to ensure passing a non-string to the get_18_char_id function raises an exception.
+
+    .. version-added:: 1.4.0
+    """
+    with pytest.raises(ValueError):
+        core_utils.get_18_char_id(12345)
+
+
 def test_get_image_ref_id_parses_query_param():
     """This function tests get_image_ref_id parsing.
 

salespyforce/utils/tests/test_log_utils.py

@@ -22,7 +22,7 @@ def _cleanup_logger(logger: logging.Logger) -> None:
     .. version-added:: 1.4.0
 
     :param logger: The logger instance to clean up
-    :type logger: logging.Logger
+    :type logger: class[logging.Logger]
     :returns: None
     """
     for handler in list(logger.handlers):
@@ -51,7 +51,7 @@ def test_initialize_logging_applies_default_level_to_console_handler(caplog: pyt
     .. version-added:: 1.4.0
 
     :param caplog: Pytest fixture capturing log records for assertions
-    :type caplog: pytest.LogCaptureFixture
+    :type caplog: class[pytest.LogCaptureFixture]
     :returns: None
     """
     logger_name = "salespyforce.test.console.default"

{salespyforce-1.4.0.dev1.dist-info → salespyforce-1.4.0.dev2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: salespyforce
-Version: 1.4.0.dev1
+Version: 1.4.0.dev2
 Summary: A Python toolset for performing Salesforce API calls
 License: MIT License
          
@@ -151,14 +151,6 @@ The package can be installed via pip using the syntax below.
 pip install salespyforce --upgrade
 ```
 
-You may also clone the repository and install from source using below.
-
-```sh
-git clone git://github.com/jeffshurtliff/salespyforce.git
-cd salespyforce/
-python setup.py install
-```
-
 ## Change Log
 The change log can be found in the [documentation](https://salespyforce.readthedocs.io/en/latest/changelog.html).
 

{salespyforce-1.4.0.dev1.dist-info → salespyforce-1.4.0.dev2.dist-info}/RECORD

@@ -1,27 +1,27 @@
 salespyforce/__init__.py,sha256=W2RY2_kojLcXtTHJrto5FtU6q1umVPaU1RZe_QkFgNY,2031
-salespyforce/api.py,sha256=JoqYyOo7Psx-l-bEC7iFdFfQVziIkqINcOKOnlpa_jM,5763
+salespyforce/api.py,sha256=fSMZYH1bpdZGS2sq924f1we0Bkubx8rrTx810Xyl3Ug,7732
 salespyforce/chatter.py,sha256=GI9iXmq2mrbrH7daW8Kc3gt2O04dRthSVocJq4BVwCU,7494
-salespyforce/core.py,sha256=OPn5TsY9oCjg_jtEFWCq3yQz4-B7pTeYKsSGOtfo8yI,49148
+salespyforce/core.py,sha256=x-D8HsjsRSS7ti1XnwSxKFfqysntI8TttgKBqjsKwh4,52661
 salespyforce/errors/__init__.py,sha256=Tnl4lB2ycpK2UmwmoBoSYuWDtovDNA4CxC5Cku2hDYs,320
 salespyforce/errors/exceptions.py,sha256=6ATDNCPNXnjOzXcaaLZVUy39lsFt2Se5cCvqkd_8faM,17057
 salespyforce/errors/handlers.py,sha256=8Hp-WrpYooMlC7cuuowTkOFyBH8OQFfHKmB8XxDPlyk,479
-salespyforce/knowledge.py,sha256=YCUbVDr8n23mdUzeuqlNToHIaaD9mzcSZ5Rvr_J8kAw,24770
+salespyforce/knowledge.py,sha256=5a1kllrggh83vOmFrR-NLaz2YDpoKQweQ1B4e2AwghA,25407
 salespyforce/utils/__init__.py,sha256=ATE6BsWd2qDxsy1fQpvaoSJimZgfCmNPYpcFEucES6Q,292
-salespyforce/utils/core_utils.py,sha256=ESuQVb8L00KoP56_nAKTj3i09u_6BqK0MxJtYV5QbwI,5674
+salespyforce/utils/core_utils.py,sha256=_uVVxHcVwCb-h6m-B7IKY77ItaSsHtGwydZN923yIic,7038
 salespyforce/utils/helper.py,sha256=zwbysqwddWwhp3mfzKJf0aeTTkVqoR35L9dLu6ZVJtU,5661
-salespyforce/utils/log_utils.py,sha256=zLQUljJiKU2x8YPG5mo5b5vXAwFLB8DcbrRUOJU14Qw,11831
+salespyforce/utils/log_utils.py,sha256=-7qgSNCUQRstRgz2wXBX6LRWO-GMjIXS5WjxkHGvBHk,11936
 salespyforce/utils/tests/__init__.py,sha256=Iv7M9gPyKv5f5tR-pxc089cd2nrWn5M0ZZpWqiB2htc,242
 salespyforce/utils/tests/conftest.py,sha256=zYB5pYNtRHc6cIxY_cBMQHNM52Is6NjLfcCywCD3-Bw,6661
 salespyforce/utils/tests/resources.py,sha256=-PEqzLMsEQSVj3dz_8VTHXINbSeMvmjX3gZRMTJgoac,4774
-salespyforce/utils/tests/test_core_utils.py,sha256=C8oqr4hQkkAEi36lgbtpwMd6HOoaPXgKVwGA51nIf4w,6132
+salespyforce/utils/tests/test_core_utils.py,sha256=8b3qjzr028wVeQAxBvIeajcqnWCsqUhNgqcquznGQKg,7272
 salespyforce/utils/tests/test_instantiate_object.py,sha256=O_DTljj_QCBZlDiA1KBUmSL2CZfsVU_7K2h6ypEN0D8,2002
-salespyforce/utils/tests/test_log_utils.py,sha256=saUmCNuDUXipfW5YWFtxraLNIqHIl3HwcTU4u9JCBkw,2314
+salespyforce/utils/tests/test_log_utils.py,sha256=FxPC21vXRQbFvqmTi_FL1DsGwuH8JHPkl9XytVoe7uY,2328
 salespyforce/utils/tests/test_sobjects.py,sha256=AeKli_LjSkeaspGxHZoZsM1IafKS2HkJ1wzajSXt6Dc,2120
 salespyforce/utils/tests/test_soql.py,sha256=SSOAN-4QZNpwUON-cLndb5W6AAs28Ja1u-Zt1WBx0VA,776
 salespyforce/utils/tests/test_sosl.py,sha256=3Ny1uF0onjcvI_InfMYRdh31rR5MJADTB3DWSm--EjE,868
 salespyforce/utils/tests/test_version_utils.py,sha256=njRKMiwtCCyUHEAFvfxvavuh03fJ_EupM1TUYmdsZAo,2465
 salespyforce/utils/version.py,sha256=uEWnq3DHmN9wZVohiRCRE1KzNF1XVhP4oVY4vBBgoVU,1781
-salespyforce-1.4.0.dev1.dist-info/LICENSE,sha256=b_Ch0pvcZN6Mr4dQ9Bo3It-J3MihQYcj_-EIdaZHuWw,1071
-salespyforce-1.4.0.dev1.dist-info/METADATA,sha256=ZbUy8c8YPOSLSRL3fQvyZ3KdYQtwR1Hjhv_wyR835w4,10582
-salespyforce-1.4.0.dev1.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-salespyforce-1.4.0.dev1.dist-info/RECORD,,
+salespyforce-1.4.0.dev2.dist-info/LICENSE,sha256=b_Ch0pvcZN6Mr4dQ9Bo3It-J3MihQYcj_-EIdaZHuWw,1071
+salespyforce-1.4.0.dev2.dist-info/METADATA,sha256=7Loir-UVgxd2NpPpLKFQo-0nnt540mMC2ZSh-0uIyxA,10400
+salespyforce-1.4.0.dev2.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+salespyforce-1.4.0.dev2.dist-info/RECORD,,