Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TicketUtil

Hierarchy

  • TicketUtil

Index

Methods

Methods

create

  • create(ticket: Ticket): Promise<any>

  • Create a new Ticket in Freshservice

    Parameters

    • ticket: Ticket

      details of the Freshservice Ticket to be created

    Returns Promise<any>

    • Returns a promise with data of type Freshservice.models.Ticket

createChildTicket

  • createChildTicket(parentId: number, childTicket: Ticket): Promise<any>

  • Create a new child Ticket on an existing Freshservice Ticket

    Parameters

    • parentId: number

      ID of ticket request for which child ticket needs to be created (Parent Ticket ID)

    • childTicket: Ticket

      details of child ticket to be created

    Returns Promise<any>

    • Returns a promise with data of type Freshservice.models.Ticket

createSource

createTask

  • createTask(ticketId: number, task: Task): Promise<any>

  • Parameters

    • ticketId: number

      ID of ticket request for which tasks are to be created

    • task: Task

      details of task to be created

    Returns Promise<any>

    • Returns a promise with data type Task

createTimeEntry

  • createTimeEntry(ticketId: number, timeEntry: TimeEntry): Promise<any>

  • Create a new time entry on a freshservice ticket

    Parameters

    • ticketId: number

      ID of ticket request for which time entries are to be added

    • timeEntry: TimeEntry

      details of time entry to be created

    Returns Promise<any>

    • Returns promise with type Freshservice.models.TimeEntry

delete

  • delete(id: number): Promise<Response>

  • Parameters

    • id: number

      ID of the ticket to be deleted

    Returns Promise<Response>

    • returns a Promise

deleteTask

  • deleteTask(ticketId: number, taskId: number): Promise<Response>

  • Delete the task on a ticket with the given ID from Freshservice

    Parameters

    • ticketId: number

      is a Ticket identifier for which task is to be deleted

    • taskId: number

      is identifier of the task which is to be deleted

    Returns Promise<Response>

    • Returns a promise

deleteTimeEntry

  • deleteTimeEntry(ticketId: number, timeEntryId: number): Promise<Response>

  • Remove a time entry on a freshservice ticket

    Parameters

    • ticketId: number

      ID of ticket request for which time entries are to be retrieved

    • timeEntryId: number

      ID of the time entry to be updated

    Returns Promise<Response>

    • Returns promise with no content and status 200 OK

get

  • get(id: number, opts?: { include: string }): Promise<any>

  • View a Ticket - Get the details of a FreshService Ticket

    Parameters

    • id: number

      Identifier of the ticket

    • opts: { include: string } = {}
      • include: string

    Returns Promise<any>

    • Response with applicants list in the response body

getTask

  • getTask(ticketId: number, taskId: number): Promise<any>

  • Retrieve a task on a ticket with the given ID from Freshservice

    Parameters

    • ticketId: number

      is a Ticket identifier for which task is to be retrieved

    • taskId: number

      is identifier of the task which is to be retrieved

    Returns Promise<any>

    • Returns a promise with data type Task

getTasks

  • Retrieve the tasks on a ticket request with the given ID from Freshservice

    Parameters

    • ticketId: number

      ID of ticket request for which tasks are to be retrieved

    • opts: PaginationQuery = {}

      optional parameters

    Returns Promise<any>

    • Returns a promise with data type Freshservice.models.Tasks

list

  • List all Tickets - Fetch the list of all Tickets in FreshService

    Parameters

    Returns Promise<any>

    • Response with applicants list in the response body

restore

  • restore(id: number): Promise<Response>

  • Restore a deleted Freshservice Ticket

    Parameters

    • id: number

      ID of the ticket to be restored

    Returns Promise<Response>

    • returns a Promise

timeEntries

  • View all time entries on ticket with the given ID from Freshservice

    Parameters

    Returns Promise<any>

    • Returns a promise with data of type Freshservice.models.TimeEntries

timeEntry

  • timeEntry(ticketId: number, timeEntryId: number): Promise<any>

  • View a time entry on a ticket with the given ID from Freshservice

    Parameters

    • ticketId: number

      ID of ticket

    • timeEntryId: number

      ID of the time entry

    Returns Promise<any>

    • Returns a promise with data of type Freshservice.models.TimeEntry

update

  • update(id: number, ticket: Ticket): Promise<any>

  • Parameters

    • id: number

      ID of the ticket to be updated

    • ticket: Ticket

      Details of the ticket to be updated

    Returns Promise<any>

    • Updated ticket information for ticket with given ID

updateTask

  • updateTask(ticketId: number, taskId: number, task: Task): Promise<any>

  • Update an existing task on an existing ticket request in Freshservice

    Parameters

    • ticketId: number

      is a Ticket identifier for which task is to be retrieved

    • taskId: number

      is identifier of the task which is to be retrieved

    • task: Task

      details of task to be updated

    Returns Promise<any>

    • Returns a promise with data type Freshservice.models.Task

updateTimeEntry

  • updateTimeEntry(ticketId: number, timeEntryId: number, timeEntry: TimeEntry): Promise<any>

  • Create a new time entry on a freshservice ticket

    Parameters

    • ticketId: number

      ID of ticket request for which time entries are to be retrieved

    • timeEntryId: number

      ID of the time entry to be updated

    • timeEntry: TimeEntry

      details of time entry to be updated

    Returns Promise<any>

    • Returns promise with type Freshservice.models.TimeEntry

Generated using TypeDoc