Adding Pagination and header changes to Freshservice Tickets endpoint

Adding Pagination and header changes to Freshservice Tickets endpoint

Author: thakurganeshsinghfw

docs/freshservice/tickets.md

@@ -12,7 +12,11 @@ A ticket can be an incident or a service request. An incident is a disruption to
 
 ## Ticket
 
-These APIs help to list, retrive, create, update, delete, restore and other operations associated with FreshService tickets
+These APIs help to list, retrive, create, update, delete, restore and other operations associated with FreshService tickets. All the methods return response into Response object. The response object has 3 supported elements and 1 method as depicted below
+
+- Use object.json() to access the object elements
+- Use object.statusCode to access object HTTP status code returned by the endpoint
+- Use object.header to access returned headers.
 
 ### List tickets
 
@@ -21,6 +25,9 @@ Fetch the list of all Tickets in Freshservice
 ```js
 // Using with query parameters included
 const tickets = await fs.tickets.list();
+// use tickets.json() to access object elements
+// use tickets.header access returned headers
+// use tickets.statusCode access returned HTTP status code
 ```
 
 ```js
@@ -32,6 +39,9 @@ const query = {
   order_type: "asc"
 };
 const tickets = await fs.tickets.list(query);
+// use tickets.json() to access object elements
+// use tickets.header access returned headers
+// use tickets.statusCode access returned HTTP status code
 ```
 
 - Returns a `Promise` that resolves to an [`Freshservice.models.Tickets`](../api/classes/freshservice_models.Tickets.html) object
@@ -45,13 +55,19 @@ Get the details of a Freshservice Ticket
 // Using without query parameters included
 const ticket_id = 99999;
 const ticket = await fs.tickets.get(ticket_id);
+// use ticket.json() to access object elements
+// use ticket.header access returned headers
+// use ticket.statusCode access returned HTTP status code
 ```
 
 ```js
 // Using with query parameters included
 const ticket_id = 99999;
 const include = "stats";
 const ticket = await fs.tickets.get(ticket_id, { include });
+// use ticket.json() to access object elements
+// use ticket.header access returned headers
+// use ticket.statusCode access returned HTTP status code
 ```
 
 - The first argument is the ticket ID - identifier of the ticket to be updated
@@ -91,6 +107,9 @@ const ticket = {
   ]
 }
 const newTicket = await fs.tickets.create(ticket);
+// use newTicket.json() to access object elements
+// use newTicket.header access returned headers
+// use newTicket.statusCode access returned HTTP status code
 ```
 
 - Returns a `Promise` that resolves to a [`Freshservice.models.Ticket`](../api/classes/freshservice_models.Ticket.html) object
@@ -101,6 +120,7 @@ Edit an existing Freshservice Ticket
 
 ```js
 const updatedTicket = await fs.tickets.update(id, ticket);
+// use updatedTicket.json() to access object elements
 ```
 
 - The first argument is the ticket ID - identifier of the ticket to be updated
@@ -128,6 +148,7 @@ Restore a deleted Freshservice Ticket
 // Restore ticket with given ticket ID
 const ticket_id = 14000239432;
 const restoredTicket = await fs.tickets.restoreTicket(ticket_id);
+// use restoredTicket.json() to access object elements
 ```
 
 - The first argument is the ticket ID - identifier of the ticket to be restored
@@ -165,6 +186,7 @@ const childTicket = {
   ]
 }
 const newChildTicket = await fs.tickets.createChildTicket(childTicket, ticket_id);
+// use newChildTicket.json() to access object elements
 
 ```
 
@@ -184,6 +206,7 @@ View all time entries on a ticket with the given ID from Freshservice
 // List all time entries for given ticket ID with default pagination option i.e., page = 1 and per_page = 30
 const ticket_id = 14000239432;
 const timeEntries = await fs.tickets.timeEntries(ticket_id);
+// use timeEntries.json() to access object elements
 ```
 
 ```js
@@ -194,6 +217,7 @@ const opts = {
   per_page: 10
 };
 const timeEntries = await fs.tickets.timeEntries(ticket_id, opts);
+// use timeEntries.json() to access object elements
 ```
 
 - The First argument is an ID of ticket
@@ -209,6 +233,7 @@ View all time entries on ticket with the given ticket ID from Freshservice
 const ticket_id = 14000239432;
 const time_entry_id = 14702899;
 const timeEntry = await fs.tickets.timeEntry(ticket_id, time_entry_id);
+// use timeEntry.json() to access object elements
 ```
 
 - The First argument is an ID of ticket
@@ -221,6 +246,7 @@ Create a new time entry on a freshservice ticket
 
 ```js
 const newTimeEntry = await fs.tickets.createTimeEntry(time_entry, ticket_id);
+// use newTimeEntry.json() to access object elements
 ```
 
 - The first argument is an object of type [`Freshservice.models.TimeEntry`](.../api/classes/freshservice_models.TimeEntry.html) containing the details of time entry to be created
@@ -233,6 +259,7 @@ Update time entry for ticket with given ticket ID and time entry ID
 
 ```js
 const updatedTimeEntry = await fs.tickets.updateTimeEntry(time_entry, ticket_id, time_entry_id);
+// use updatedTimeEntry.json() to access object elements
 ```
 
 - The first argument is an object of type [`Freshservice.models.TimeEntry`](.../api/classes/freshservice_models.TimeEntry.html) containing the details of time entry to be updated
@@ -246,6 +273,7 @@ Remove a time entry on a freshservice ticket
 
 ```js
 const deleteTimeEntry = await fs.tickets.deleteTimeEntry(ticket_id, time_entry_id);
+// use deleteTimeEntry.json() to access object elements
 ```
 
 - The first argument is the ticket ID - identifier of the ticket for which time entry is to be deleted
@@ -262,6 +290,7 @@ const source = {
   position: 1
 };
 const fieldSource = await fs.tickets.source(source);
+// use fieldSource.json() to access object elements
 ```
 
 - The source argument is an object of type [`Freshservice.models.TicketSource`](../api/classes/freshservice_models.TicketSource.html) containing the details of custom ticket source to be created
@@ -286,6 +315,7 @@ const task = {
   start_date: "2021-11-22T16:58:45Z"
 };
 const newTask = await fs.tickets.createTask(task, ticket_id);
+// use newTask.json() to access object elements
 ```
 
 - The first argument is an object of type [`Freshservice.models.Task`](../api/classes/freshservice_models.Task.html) containing details of task to be created
@@ -300,6 +330,7 @@ Retrieve a task on a ticket request with the given ID from Freshservice
 const ticket_id = 14000239432;
 const task_id = 48;
 const taskDetail = await fs.tickets.getTask(ticket_id, task_id);
+// use taskDetail.json() to access object elements
 ```
 
 - The first argument is a Ticket identifier for which task is to be retrieved
@@ -318,12 +349,14 @@ const opts = {
   per_page: 10
 };
 const taskList = await fs.tickets.getTasks(ticket_id, opts);
+// use taskList.json() to access object elements
 ```
 
 ```js
 // Retrieve all the tasks for ticket with given ticket ID without optional parameter
 const ticket_id = 14000239432;
 const taskList = await fs.tickets.getTasks(ticket_id);
+// use taskList.json() to access object elements
 ```
 
 - The first argument is a Ticket identifier for which task is to be retrieved
@@ -346,6 +379,7 @@ const task = {
   start_date: "2021-11-22T16:58:45Z"
 };
 const updateTask = await fs.tickets.updateTask(task, ticket_id, task_id);
+// use updateTask.json() to access object elements
 ```
 
 - The first argument is an object of type [`Freshservice.models.Task`](../api/classes/freshservice_models.Task.html) containing details of task to be updated
@@ -361,6 +395,7 @@ Delete the task on a ticket request with the given ID from Freshservice
 const ticket_id = 14000239432;
 const task_id = 48;
 const deleteTask = await fs.tickets.deleteTask(ticket_id, task_id);
+// use deleteTask.json() to access object elements
 ```
 
 - The first argument is the ticket ID - identifier of the ticket for which task is to be deleted