module Desk::Client::Case

Defines methods related to cases

Public Instance Methods

case(case_id, *args)
Alias for: show_case
case_endpoints() click to toggle source
# File lib/desk/client/case.rb, line 6
def case_endpoints
  [ :list, :search, :create, :update, :delete,
    :list_replies, :show_reply, :create_reply, :update_reply,
    :list_notes, :show_note, :create_note,
    :list_attachments, :show_attachment, :create_attachment, :delete_attachment,
    :list_history
  ]
end
case_message(case_id)
Alias for: show_case_message
case_message_attachment(case_id, attachment_id)
case_message_attachments(case_id, *args)
case_reply_attachment(case_id, reply_id, attachment_id)
case_reply_attachments(case_id, reply_id, *args)
case_url(case_id) click to toggle source
# File lib/desk/client/case.rb, line 67
def case_url(case_id)
  "https://#{subdomain}.#{domain}/agent/case/#{case_id}"
end
create_case_message_attachment(case_id, *args) click to toggle source
# File lib/desk/client/case.rb, line 49
def create_case_message_attachment(case_id, *args)
  options = args.last.is_a?(Hash) ? args.pop : {}
  post("cases/#{case_id}/message/attachments", options)
end
create_case_reply_attachment(case_id, reply_id, *args) click to toggle source
# File lib/desk/client/case.rb, line 54
def create_case_reply_attachment(case_id, reply_id, *args)
  options = args.last.is_a?(Hash) ? args.pop : {}
  post("cases/#{case_id}/replies/#{reply_id}/attachments", options)
end
delete_case_message_attachment(case_id, attachment_id) click to toggle source
# File lib/desk/client/case.rb, line 59
def delete_case_message_attachment(case_id, attachment_id)
  delete("cases/#{case_id}/message/attachments/#{attachment_id}")
end
delete_case_reply_attachment(case_id, reply_id, attachment_id) click to toggle source
# File lib/desk/client/case.rb, line 63
def delete_case_reply_attachment(case_id, reply_id, attachment_id)
  delete("cases/#{case_id}/replies/#{reply_id}/attachments/#{attachment_id}")
end
list_case_message_attachments(case_id, *args) click to toggle source
# File lib/desk/client/case.rb, line 27
def list_case_message_attachments(case_id, *args)
  options = args.last.is_a?(Hash) ? args.pop : {}
  get("cases/#{case_id}/message/attachments", options)
end
Also aliased as: case_message_attachments
list_case_reply_attachments(case_id, reply_id, *args) click to toggle source
# File lib/desk/client/case.rb, line 33
def list_case_reply_attachments(case_id, reply_id, *args)
  options = args.last.is_a?(Hash) ? args.pop : {}
  get("cases/#{case_id}/replies/#{reply_id}/attachments", options)
end
Also aliased as: case_reply_attachments
show_case(case_id, *args) click to toggle source
# File lib/desk/client/case.rb, line 15
def show_case(case_id, *args)
  options = args.last.is_a?(Hash) ? args.pop : {}
  case_id = "e-#{case_id}" if options[:by] == "external_id"
  get("cases/#{case_id}")
end
Also aliased as: case
show_case_message(case_id) click to toggle source
# File lib/desk/client/case.rb, line 22
def show_case_message(case_id)
  get("cases/#{case_id}/message")
end
Also aliased as: case_message
show_case_message_attachment(case_id, attachment_id) click to toggle source
# File lib/desk/client/case.rb, line 39
def show_case_message_attachment(case_id, attachment_id)
  get("cases/#{case_id}/message/attachments/#{attachment_id}")
end
Also aliased as: case_message_attachment
show_case_reply_attachment(case_id, reply_id, attachment_id) click to toggle source
# File lib/desk/client/case.rb, line 44
def show_case_reply_attachment(case_id, reply_id, attachment_id)
  get("cases/#{case_id}/replies/#{reply_id}/attachments/#{attachment_id}")
end
Also aliased as: case_reply_attachment