##################
Supporting Modules
##################
This section provides details around the supporting modules used in the **salespyforce** package,
which are listed below.

* `Classes & Exceptions`_
    * `Errors Module (salespyforce.errors)`_
        * `Exceptions Module (salespyforce.errors.exceptions)`_
        * `Handlers Module (salespyforce.errors.handlers)`_
* `Tools & Utilities`_
    * `Core Utilities Module (salespyforce.utils.core_utils)`_
    * `Helper Module (salespyforce.utils.helper)`_
    * `Logging Utilities Module (salespyforce.utils.log_utils)`_
    * `Version Module (salespyforce.utils.version)`_
* `Unit Testing`_
    * `Tests Module (salespyforce.utils.tests)`_
        * `Resources Module (salespyforce.utils.tests.resources)`_
        * `Test Instantiate Object Module (salespyforce.utils.tests.test_instantiate_object)`_
        * `Test sObjects Module (salespyforce.utils.tests.test_sobjects)`_
        * `Test SOQL Module (salespyforce.utils.tests.test_soql)`_
        * `Test SOSL Module (salespyforce.utils.tests.test_sosl)`_

|

********************
Classes & Exceptions
********************
This section includes modules that contain the classes and exceptions used throughout the package.

|

Errors Module (salespyforce.errors)
===================================
This module contains all of the exception classes and error handling functions leveraged throughout the library.

.. automodule:: salespyforce.errors
   :members:

:doc:`Return to Top <supporting-modules>`

|

Exceptions Module (salespyforce.errors.exceptions)
--------------------------------------------------
This sub-module defines custom exceptions that are leveraged throughout the library.

.. automodule:: salespyforce.errors.exceptions
   :members:

:doc:`Return to Top <supporting-modules>`

|

Handlers Module (salespyforce.errors.handlers)
----------------------------------------------
This sub-module contains various error handling functions that are leveraged throughout the library.

.. automodule:: salespyforce.errors.handlers
   :members:

:doc:`Return to Top <supporting-modules>`

|

*****************
Tools & Utilities
*****************
This section includes modules that contain tools and utilities leveraged by other scripts.

|

Core Utilities Module (salespyforce.utils.core_utils)
=====================================================
This module includes various utilities to assist with the core functionality.

.. automodule:: salespyforce.utils.core_utils
   :members:

:doc:`Return to Top <supporting-modules>`

|

Helper Module (salespyforce.utils.helper)
=========================================
This module enables the use of helper files to define core object configuration.

.. automodule:: salespyforce.utils.helper
   :members:

:doc:`Return to Top <supporting-modules>`

|

Logging Utilities Module (salespyforce.utils.log_utils)
=======================================================
This module includes various utilities to assist with logging.

.. automodule:: salespyforce.utils.log_utils
   :members:

:doc:`Return to Top <supporting-modules>`

|

Version Module (salespyforce.utils.version)
===========================================
This module is the primary source of the current version of the salespyforce package.

.. automodule:: salespyforce.utils.version
   :members:

:doc:`Return to Top <supporting-modules>`

|

************
Unit Testing
************
This section includes modules that are used in unit testing the library.

|

Tests Module (salespyforce.utils.tests)
=======================================
This module includes unit tests for the package that are performed using pytest.

.. automodule:: salespyforce.utils.tests
   :members:

:doc:`Return to Top <supporting-modules>`

|

Resources Module (salespyforce.utils.tests.resources)
-----------------------------------------------------
This module includes frequently used resources for performing unit testing.

.. automodule:: salespyforce.utils.tests.resources
   :members:

:doc:`Return to Top <supporting-modules>`

|

Test Instantiate Object Module (salespyforce.utils.tests.test_instantiate_object)
---------------------------------------------------------------------------------
This module is used by pytest to verify that the core object can be instantiated successfully.

.. automodule:: salespyforce.utils.tests.test_instantiate_object
   :members:

:doc:`Return to Top <supporting-modules>`

|

Test sObjects Module (salespyforce.utils.tests.test_sobjects)
-------------------------------------------------------------
This module is used by pytest to verify that the sObject-related functions work properly.

.. automodule:: salespyforce.utils.tests.test_sobjects
   :members:

:doc:`Return to Top <supporting-modules>`

|

Test SOQL Module (salespyforce.utils.tests.test_soql)
-----------------------------------------------------
This module is used by pytest to verify that SOQL queries work properly.

.. automodule:: salespyforce.utils.tests.test_soql
   :members:

:doc:`Return to Top <supporting-modules>`

|

Test SOSL Module (salespyforce.utils.tests.test_sosl)
-----------------------------------------------------
This module is used by pytest to verify that SOSL queries work properly.

.. automodule:: salespyforce.utils.tests.test_sosl
   :members:

:doc:`Return to Top <supporting-modules>`

|