Include Stats in get_ticket method (#59)

Author: jstitch

README.md

@@ -142,6 +142,23 @@ Or converted from indexes to their descriptions:
 'phone'
 ```
 
+You can get additional details of the ticket in the response using extra arguments.
+
+Please take a look at the FreshDesk documentation for more details: [View a Ticket](http://developer.freshdesk.com/api/#view_a_ticket)
+
+```python
+>>> ticket = a.tickets.get_ticket(4, "conversation", "requester", "company", "stats")
+>>> ticket.stats
+{'agent_responded_at': '2020-06-26T01:23:39Z',
+ 'requester_responded_at': '2020-06-25T23:10:15Z',
+ 'first_responded_at': '2020-06-17T20:23:43Z',
+ 'status_updated_at': '2020-07-24T15:35:21Z',
+ 'reopened_at': None,
+ 'resolved_at': '2020-07-24T15:35:21Z',
+ 'closed_at': None,
+ 'pending_since': None}
+```
+
 Creating a ticket can be done by calling `create_ticket()`:
 
 ```python

freshdesk/v2/api.py

@@ -30,9 +30,14 @@ class TicketAPI(object):
     def __init__(self, api):
         self._api = api
 
-    def get_ticket(self, ticket_id):
-        """Fetches the ticket for the given ticket ID"""
-        url = "tickets/%d" % ticket_id
+    def get_ticket(self, ticket_id, *include):
+        """
+            Fetches the ticket for the given ticket ID
+            You can pass strings for the include parameter and they'll be included as include params to the request
+            ex: get_ticket(some_id, "stats", "conversations", "requester", "company") will result in the following request:
+            tickets/[some_id]?include=stats,conversations,requester,company
+        """
+        url = "tickets/%d%s" % (ticket_id, "?include=%s" % ",".join(include) if include else "")
         ticket = self._api._get(url)
         return Ticket(**ticket)
 

freshdesk/v2/tests/conftest.py

@@ -23,6 +23,7 @@ def __init__(self, *args):
                 re.compile(r"tickets\?filter=new_and_my_open&updated_since=2014-01-01&page=1&per_page=100"): self.read_test_file("all_tickets.json"),
                 re.compile(r"tickets\?page=1&per_page=100"): self.read_test_file("all_tickets.json"),
                 re.compile(r"tickets/1$"): self.read_test_file("ticket_1.json"),
+                re.compile(r"tickets/1?include=stats,requester$"): self.read_test_file("ticket_1.json"),
                 re.compile(r"tickets/1/conversations"): self.read_test_file("conversations.json"),
                 re.compile(r"companies\?page=1&per_page=100$"): self.read_test_file("companies.json"),
                 re.compile(r"companies/1$"): self.read_test_file("company.json"),

freshdesk/v2/tests/sample_json_data/ticket_1.json

@@ -48,5 +48,22 @@
             "created_at":"2014-07-28T16:20:03+05:30",
             "updated_at":"2014-07-28T16:20:03+05:30"
         }
-    ]
+    ],
+    "stats": {
+        "agent_responded_at":"2020-06-26T01:23:39Z",
+        "requester_responded_at":"2020-06-25T23:10:15Z",
+        "first_responded_at": "2020-06-17T20:23:43Z",
+        "status_updated_at": "2020-07-24T15:35:21Z",
+        "reopened_at": null,
+        "resolved_at": "2020-07-24T15:35:21Z",
+        "closed_at": null,
+        "pending_since": null
+    },
+    "requester": {
+        "id": 43026449322,
+        "name": "Dummyname",
+        "email": "[email protected]",
+        "mobile": null,
+        "phone": null
+    }
 }

freshdesk/v2/tests/test_ticket.py

@@ -13,6 +13,11 @@ def ticket(api):
     return api.tickets.get_ticket(1)
 
 
+@pytest.fixture
+def ticket_include(api):
+    return api.tickets.get_ticket(1,"stats","requester")
+
+
 @pytest.fixture
 def ticket_json():
     return json.loads(open(os.path.join(os.path.dirname(__file__), "sample_json_data", "ticket_1.json")).read())
@@ -210,4 +215,4 @@ def test_filter_query(api, ticket):
 def test_updated_since_filter(api):
     tickets = api.tickets.list_tickets(updated_since="2014-01-01")
     assert isinstance(tickets, list)
-    assert len(tickets) == 1
+    assert len(tickets) == 1