class Freshdesk::Api::Client::Ticket
Constants
- NOTES
- TICKETS
Public Class Methods
new(base_url, api_key)
click to toggle source
Initialize with your freshdesk account url and api key.
# File lib/freshdesk/api/client/ticket.rb, line 9 def initialize base_url, api_key @connection = Freshdesk::Api::Client::Request.new base_url, api_key end
Public Instance Methods
add_note(ticket_id, payload)
click to toggle source
Add note by passing the ticket id and payload. Please refer Please refer freshdesk.com/api#ticket
# File lib/freshdesk/api/client/ticket.rb, line 52 def add_note ticket_id, payload begin Freshdesk::Api::Client.convert_to_hash( @connection.post "tickets/#{ticket_id}/#{NOTES}", payload ) rescue Freshdesk::Api::InvalidEndpointError false end end
create_ticket(payload)
click to toggle source
Create ticket with payload. Please refer freshdesk.com/api#ticket
# File lib/freshdesk/api/client/ticket.rb, line 14 def create_ticket payload Freshdesk::Api::Client.convert_to_hash( @connection.post TICKETS, payload ) end
delete_ticket(id)
click to toggle source
Delete a ticket by its id.
# File lib/freshdesk/api/client/ticket.rb, line 24 def delete_ticket id Freshdesk::Api::Client.delete_status_wrapper do ( @connection.delete TICKETS, id ).code end end
get_ticket(id)
click to toggle source
Get a ticket by its id.
# File lib/freshdesk/api/client/ticket.rb, line 31 def get_ticket id Freshdesk::Api::Client.convert_to_hash( @connection.get TICKETS, id ) end
is_ticket_id_available?(id)
click to toggle source
Check is ticket id is available by passing the id.
# File lib/freshdesk/api/client/ticket.rb, line 41 def is_ticket_id_available? id begin return false if id.to_i.zero? get_ticket id.to_i return false rescue Freshdesk::Api::InvalidEndpointError true end end
list_tickets()
click to toggle source
List all tickets.
# File lib/freshdesk/api/client/ticket.rb, line 36 def list_tickets Freshdesk::Api::Client.convert_to_hash( @connection.get TICKETS ) end
update_ticket(id, payload)
click to toggle source
Update a ticket by passing its id and payload. Please refer freshdesk.com/api#ticket
# File lib/freshdesk/api/client/ticket.rb, line 19 def update_ticket id, payload Freshdesk::Api::Client.convert_to_hash( @connection.put TICKETS, id, payload ) end