module Frontapp::Client::Conversations

Public Instance Methods

conversations(params = {}) click to toggle source
# File lib/frontapp/client/conversations.rb, line 5
def conversations(params = {})
  list("conversations", params)
end
get_conversation(conversation_id) click to toggle source

Parameters Name Type Description


conversation_id string Id of the requested conversation


# File lib/frontapp/client/conversations.rb, line 14
def get_conversation(conversation_id)
  get("conversations/#{conversation_id}")
end
get_conversation_events(conversation_id) click to toggle source

Parameters Name Type Description


conversation_id string Id or email of the requested conversation


# File lib/frontapp/client/conversations.rb, line 61
def get_conversation_events(conversation_id)
  list("conversations/#{conversation_id}/events")
end
get_conversation_followers(conversation_id) click to toggle source

Parameters Name Type Description


conversation_id string Id or email of the requested conversation


# File lib/frontapp/client/conversations.rb, line 52
def get_conversation_followers(conversation_id)
  get("conversations/#{conversation_id}/followers")
end
get_conversation_inboxes(conversation_id) click to toggle source

Parameters Name Type Description


conversation_id string Id or email of the requested conversation


# File lib/frontapp/client/conversations.rb, line 43
def get_conversation_inboxes(conversation_id)
  get("conversations/#{conversation_id}/inboxes")
end
get_conversation_messages(conversation_id) click to toggle source

Parameters Name Type Description


conversation_id string Id or email of the requested conversation


# File lib/frontapp/client/conversations.rb, line 70
def get_conversation_messages(conversation_id)
  list("conversations/#{conversation_id}/messages")
end
update_conversation!(conversation_id, params = {}) click to toggle source

Parameters Name Type Description


conversation_id string Id of the requested conversation


Allowed attributes: Name Type Description


assignee_id string (optional) ID of the teammate to assign the conversation to. Set it to null to unassign. inbox_id string (optional) ID of the inbox to move the conversation to. status enum (optional) New status of the conversation tags array (optional) List of all the tag names replacing the old conversation tags


The assignee id is their Frontapp handle, e.g. @username

# File lib/frontapp/client/conversations.rb, line 33
def update_conversation!(conversation_id, params = {})
  cleaned = params.permit(:assignee_id, :inbox_id, :status, :tags)
  update("conversations/#{conversation_id}", cleaned)
end