Change Log

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

v3.0.0.dev0

Release Date: TBD

Added

Core Object

Additions to the FreshPy Core Object.

• Added the freshpy.core.FreshPy.post() method

• Added the freshpy.core.FreshPy.put() method

• Added the freshpy.core.FreshPy.patch() method

• Added the following methods to the freshpy.core.FreshPy.Agents inner class:

  • freshpy.core.FreshPy.Agents.get_agent_role()

  • freshpy.core.FreshPy.Agents.get_all_agent_roles()

• Added the following methods to the freshpy.core.FreshPy.Tickets inner class:

  • freshpy.core.FreshPy.Tickets.get_ticket_fields()

  • freshpy.core.FreshPy.Tickets.get_ticket_field()

• Added the freshpy.core.FreshPy.Workspaces inner class with the following methods:

  • freshpy.core.FreshPy.Workspaces.get_workspace()

  • freshpy.core.FreshPy.Workspaces.get_all_workspaces()

• Added the freshpy.core.FreshPy.Objects inner class with the following methods:

  • freshpy.core.FreshPy.Objects.get_custom_object()

  • freshpy.core.FreshPy.Objects.get_all_custom_objects()

• Added the freshpy.core.FreshPy._import_objects_class() method

• Added the freshpy.core.FreshPy._import_workspaces_class() method

Primary Modules

Additions to the primary modules.

• Added the freshpy.workspaces module with the following functions:

  • freshpy.workspaces.get_workspace()

  • freshpy.workspaces.get_all_workspaces()

• Added the freshpy.objects module with the following functions:

  • freshpy.objects.get_custom_object()

  • freshpy.objects.get_all_custom_objects()

• Added the following functions to the freshpy.api module:

  • freshpy.api.api_call_with_payload()

  • freshpy.api._raise_exception_for_api_method()

• Added the following functions to the freshpy.agents module:

  • freshpy.agents.get_agent_role()

  • freshpy.agents.get_all_agent_roles()

  • freshpy.agents.get_agent_group()

  • freshpy.agents.get_all_agent_groups()

• Added the following functions to the freshpy.tickets module:

  • A:py:func:freshpy.tickets.get_ticket_fields

  • A:py:func:freshpy.tickets.get_ticket_field

  • A:py:func:freshpy.tickets.create_ticket

Supporting Modules

Additions to the supporting modules are listed below.

• Added the following new test modules:

  • freshpy.utils.tests.test_log_utils

  • freshpy.utils.tests.test_version_utils

• Added the new custom exception classes:

  • freshpy.errors.exceptions.InvalidDataTypeError

  • freshpy.errors.exceptions.PATCHRequestError

• Added the freshpy.errors.handlers.get_exception_type() function

• Added the following functions to the freshpy.utils.core_utils module:

  • freshpy.utils.core_utils.is_iterable()

  • freshpy.utils.core_utils.is_data_type()

  • freshpy.utils.core_utils.validate_data_type()

  • freshpy.utils.core_utils.validate_numeric_value()

• Added the freshpy.models.enums module with defined strongly-typed, immutable enumerations for ticket-related constants

General

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

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

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

Changed

Core Object

Changes to the FreshPy Core Object.

• Improved and standardized the handling of SSL verification when performing API calls

  • Added the verify_ssl parameter to the object instantiation method (which defaults to True if not defined) which allows SSL verification to be enabled or disabled at the object-level

  • Added the freshpy.core.FreshPy._determine_ssl_verification() method and called it in relevant core object methods to determine the appropriate SSL verification setting

  • Changed the default value of the verify_ssl parameter in core methods to be None rather than True

• Introduced the ability to utilize environment variables instead of passing in settings with parameters

  • Added the freshpy.core.FreshPy._get_env_variable_names() method to get the environment variable names

  • Added the freshpy.core.FreshPy._get_env_variables() method to retrieve the defined environment variables

• Added the parameters params and timeout to the freshpy.core.FreshPy.get() method

Primary Modules

Changes to the primary modules.

• Updated the freshpy.api.get_request_with_retries() function to return the full Response object if the response cannot be successfully converted to JSON rather than just returning error details

• Added the parameters params and timeout to the freshpy.api.get_request_with_retries() function

• Updated the freshpy.api._report_failed_attempt() function to use the logging functionality

• Updated the freshpy.api._raise_exception_for_repeated_timeouts() function to use the logging functionality

Supporting Modules

Changes to the supporting modules are listed below.

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

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

• Updated all custom exceptions in freshpy.errors.exceptions to display the default message if a None value is passed to the exception class

• Updated the freshpy.errors.exceptions.MissingRequiredDataError exception to allow a specific missing argument to be specified for the init message when applicable

General

• 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

  • Switched from setuptools to poetry

  • 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

  • Added bandit with SARIF support to the dev dependencies

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

• Moved the tests/ directory from the root level to under src/freshpy/utils/ instead

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

Removed

General

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

• Removed .github/workflows/codeql-analysis.yml (replaced by .github/workflows/ci.yml)

• Removed the .readthedocs.yml file (replaced by .readthedocs.yaml)

---

v2.0.0

Release Date: 2025-01-29

Added

Core Object

Additions to the FreshPy Core Object.

• Added the freshpy.core.FreshPy.Agents class with the following methods:

  • freshpy.core.FreshPy.Agents.get_user_info()

  • freshpy.core.FreshPy.Agents.get_all_agents()

  • freshpy.core.FreshPy.Agents.get_agent_id()

  • freshpy.core.FreshPy.Agents.get_assignment_history()

Primary Modules

Additions to the primary modules.

• Added the freshpy.agents with the following functions:

  • freshpy.agents.get_user_info()

  • freshpy.agents.get_all_agents()

  • freshpy.agents.get_agent_id()

  • freshpy.agents.get_assignment_history()

  • freshpy.agents._get_user_info_by_email()

Supporting Modules

Additions to the supporting modules.

• Added the freshpy.errors.exceptions.InvalidFilterError exception.

Changed

Primary Modules

Changes to the primary modules.

• Added error handling to the freshpy.api.get_request_with_retries() function.

• Replaced a generic py:exc:Exception with a py:exc:RuntimeError exception in the py:func:freshpy.api._report_failed_attempt function.

• Removed an unnecessary return statement from the freshpy.api._report_failed_attempt() function.

---

v1.1.1

Release Date: 2023-05-08

Changed

General

• Updated the required packages in the requirements.txt file.

• Adjusted the required install packages in the setup.py script.

---

v1.1.0

Release Date: 2021-01-05

Added

Supporting Modules

Additions to the supporting modules.

• Added the freshpy.utils.version.get_major_minor_version() function.

Documentation

The documentation was fully created and hosted.

Changed

Core Object

Changes to the FreshPy Core Object.

• Added the ability to disable SSL verification on API calls in the following methods:

  • freshpy.core.FreshPy.get()

  • freshpy.core.FreshPy.Tickets.get_ticket()

  • freshpy.core.FreshPy.Tickets.get_tickets()

Primary Modules

Changes to the primary modules.

• Added the ability to disable SSL verification on API calls in the following functions:

  • freshpy.api.get_request_with_retries()

  • freshpy.tickets.get_ticket()

  • freshpy.tickets.get_tickets()