Primary Modules¶
This section provides details around the primary modules used in the freshpy package, which are listed below.
Init Module (freshpy)¶
The Init Module is covered on this page.
Core Module (freshpy.core)¶
The Core Module is covered on this page.
API Module (freshpy.api)¶
This module handles interactions with the Freshservice API.
- Module:
freshpy.api
- Synopsis:
This module handles interactions with the Freshservice REST API
- Created By:
Jeff Shurtliff
- Last Modified:
Jeff Shurtliff
- Modified Date:
04 Jan 2022
- freshpy.api.define_auth(api_key)[source]¶
This function defines the authentication dictionary to use in API calls.
New in version 1.0.0.
- freshpy.api.define_headers()[source]¶
This function defines the headers to use in API calls.
New in version 1.0.0.
- freshpy.api.get_request_with_retries(fresh_object, uri, headers=None, return_json=True, verify_ssl=True)[source]¶
This function performs a GET request and will retry several times if a failure occurs.
Changed in version 1.1.0: Added the ability to disable SSL verification on API calls.
New in version 1.0.0.
- Parameters:
fresh_object – The instantiated
freshpy.core.FreshPy
object.uri (string) – The URI to query
headers (dict, None) – The HTTP headers to utilize in the REST API call
return_json (bool) – Determines if JSON data should be returned
verify_ssl (bool) – Determines if SSL verification should occur (
True
by default)
- Returns:
The JSON data from the response or the raw
requests
response.- Raises:
Tickets Module (freshpy.tickets)¶
This module handles interactions with Freshservice tickets.
- Module:
freshpy.tickets
- Synopsis:
Functions for interacting with Freshservice tickets
- Created By:
Jeff Shurtliff
- Last Modified:
Jeff Shurtliff
- Modified Date:
04 Jan 2022
- freshpy.tickets.get_ticket(freshpy_object, ticket_number, include=None, verify_ssl=True)[source]¶
This function returns the data for a specific ticket.
Changed in version 1.1.0: Added the ability to disable SSL verification on API calls.
New in version 1.0.0.
- Parameters:
freshpy_object (class[freshpy.FreshPy]) – The core
freshpy.FreshPy
objectticket_number (str, int) – The ticket number for which to return data
include (str, tuple, list, set, None) – A string or iterable of embedding options
verify_ssl (bool) – Determines if SSL verification should occur (
True
by default)
- Returns:
JSON data for the given ticket
- Raises:
- freshpy.tickets.get_tickets(freshpy_object, include=None, predefined_filter=None, filters=None, filter_logic='AND', requester_id=None, requester_email=None, ticket_type=None, updated_since=None, ascending=None, descending=None, per_page=None, page=None, verify_ssl=True)[source]¶
This function returns a sequence of tickets with optional filters.
Changed in version 1.1.0: Added the ability to disable SSL verification on API calls.
New in version 1.0.0.
- Parameters:
freshpy_object (class[freshpy.FreshPy]) – The core
freshpy.FreshPy
objectinclude (str, tuple, list, set, None) –
A string or iterable of embedding options
predefined_filter (str, None) – One of the predefined filters (‘new_and_my_open’, ‘watching’, ‘spam’, ‘deleted’)
filters (str, dict, None) – Query filter(s) in the form of a structured query string or a dictionary of values
filter_logic – Defines the logic to use as necessary in a filter query string (default is
AND
)requester_id (str, int, None) – The numeric ID of a requester
requester_email (str, None) – The email address of a requester
ticket_type (str, None) – The type of ticket (e.g.
Incident
,Service Request
, etc.)updated_since (str, None) – A date or timestamp (in UTC format) to be a threshold for when the ticket was last updated
ascending (bool, None) – Determines if the tickets should be sorted in ascending order
descending (bool, None) – Determines if the tickets should be sorted in descending order (default)
per_page (str, int, None) – Displays a certain number of results per query
page (str, int, None) – Returns a specific page number (used for paginated results)
verify_ssl (bool) – Determines if SSL verification should occur (
True
by default)
- Returns:
A list of JSON objects for tickets
- Raises:
freshpy.errors.exceptions.InvalidPredefinedFilterError
,freshpy.errors.exceptions.APIConnectionError