freshservice-sdk-python 0.0.3

An unofficial freshservice API v2 SDK written in Python.

freshservice-sdk-python

This sdk is an unofficial freshservice API v2 SDK written in Python.

The library is based on the official Freshservice api found here

It currently supports the manipulation of resources listed below:

• Tickets
• Changes
• Problems
• Tasks (tickets, changes and problems)
• Many more to come!

Getting Started

To install the SDK in your project:

pip install freshservice-sdk-python

You'll also need

• A Freshservice domain name, your_company.freshservice.com
• An API key

You will need to pre set these two values in your deployment's environment variables before using the library. You can either set it in a bash script or pre code it so that you have it in your environment variable on runtime:

os.environ['FRESHSERVICE_API_KEY'] = "XXXXXX"

os.environ['FRESHSERVICE_DOMAIN'] = "your_company.freshservice.com"

Tickets

You can manipulate tickets using the Ticket model from the sdk. The Ticket model will handle this part of the api in freshservice.

You can import the model as shown below:

from freshservice.v2.ticket import Ticket

Creating a ticket

from freshservice.v2.ticket import Ticket

ticket = Ticket.create(
	requester_email, 
        subject, 
        description, 
        status: Status, 
        priority: TicketModel.Priority, 
        department_id = None,
        group_id = None,
        category = None,
        sub_category = None,
        item_category = None,
        custom_fields: dict = {}
)

Fetching a ticket

You can fetch a ticket by providing the ticket id when initializing the ticket object as shown below.

This will go and fetch the ticket details.

from freshservice.v2.ticket import Ticket

ticket = Ticket(
	id=your_ticket_id
)

Updating a ticket

To update a ticket, you can just update the ticket's attribute and then hit the update() on the ticket's object to update it.

from freshservice.v2.ticket import Ticket

ticket.subject = "new subject"
ticket.description = "new description"
ticket.update()

Closing a ticket

Closing a ticket works similarly to updating it. You can set all the required attributes of the ticket to match the ticket closure rules and then hit the close() function

from freshservice.v2.ticket import Ticket

ticket.category = "Other"
ticket.close()

Changes

You can manipulate changes using the `Change` model from the sdk. The `Change` model will handle [this](https://api.freshservice.com/#changes) part of the api in freshservice.

You can import the model as shown below:

from freshservice.v2.change import Change

Creating a Change

from freshservice.v2 import Change

from freshservice.v2.change import Change

Change.create(
    requester_email: str,
    subject: str,
    description: str,
    department_id, 
    group_id, 
    category,
    sub_category,
    item_category,
    custom_fields,
    planned_start_date: datetime,
    planned_end_date: datetime,
    priority: TicketModel.Priority = TicketModel.Priority.LOW,
    planning_fields = {}
)

Fetching a change

You can fetch a change by providing the change id when initializing the change object as shown below.

This will go and fetch the change details.

from freshservice.v2.change import Change

change = Change(
        id=your_change_id
)

Updating a change

To update a change, you can just update the change's attribute and then hit the update() on the change's object to update it.

from freshservice.v2.change import Change

change.subject = "new subject"
change.description = "new description"
change.update()

Closing a change

Closing a change works similarly to updating it. You can set all the required attributes of the change to match the ticket closure rules and then hit the close() function

from freshservice.v2.change import Change

change.category = "Other"
change.close()

Problems

You can manipulate problems using the Problem model from the sdk. The Problem model will handle this part of the api in freshservice.

You can import the model as shown below:

from freshservice.v2.problem import Problem

Creating a problem

from freshservice.v2.problem import Problem

problem = Problem.create(
	requester_email, 
        subject, 
        description, 
        status: Status, 
        priority: TicketModel.Priority, 
        department_id = None,
        group_id = None,
        category = None,
        sub_category = None,
        item_category = None,
        custom_fields: dict = {}
)

Fetching a problem

You can fetch a problem by providing the problem id when initializing the problem object as shown below.

This will go and fetch the problem details.

from freshservice.v2.problem import Problem

problem = Problem(
	id=your_problem_id
)

Updating a problem

To update a problem, you can just update the problem's attribute and then hit the update() on the problem's object to update it.

from freshservice.v2.problem import Problem

problem.subject = "new subject"
problem.description = "new description"
problem.update()

Closing a problem

Closing a problem works similarly to updating it. You can set all the required attributes of the problem to match the problem closure rules and then hit the close() function

from freshservice.v2.problem import Problem

problem.category = "Other"
problem.close()

Tasks

You can manipulate tasks as well for tickets, changes and problems.

To get all tasks for a specific ticket, use the get_tasks() from the ticket object and this will return a list of Tasks objects to manipulate

Below is an example with ticket (This works the same for change and problems as well)

from freshservice.v2.ticket import Ticket

ticket = Ticket(id=3)

tasks = ticket.get_tasks()

Creating a task

from freshservice.v2.models.task import Task

task = Task.create(
    url,
    ticket_id,
    agent_id,
    title,
    description,
    group_id,
    notify_before = 0,
    status = Status.OPEN,
    due_date = None,
) 

Updating a task

To update a task, you can just update the task's attribute and then hit the update() on the task's object to update it.

task.title = "new title"
task.description = "new description"
task.update()

Closing a task

Closing a task works similarly to updating it. You can set all the required attributes of the task to match the problem task rules and then hit the close() function

task.close()

Building the SDK

In most cases, you won't need to build the SDK from source. If you want to build it yourself, you'll need these preequisites:

• Clone the repo
• Run python setup.py build from the root of the project (assuming Python is installed)

Contributing

We're happy to accept contributions and PRs!