module Frontapp::Client::Inboxes
Public Instance Methods
Allowed attributes: Name Type Description
name string Name of the inbox teammate_ids array (optional) List of all the teammate ids who will have access to this inbox. If omitted, it will automatically select all the administrators in your company.
# File lib/frontapp/client/inboxes.rb, line 24 def create_inbox!(params = {}) cleaned = params.permit(:name, :teammate_ids) create("inboxes", cleaned) end
Parameters Name Type Description
inbox_id string Id of the requested inbox
# File lib/frontapp/client/inboxes.rb, line 14 def get_inbox(inbox_id) get("inboxes/#{inbox_id}") end
Parameters Name Type Description
inbox_id string Id of the requested inbox
# File lib/frontapp/client/inboxes.rb, line 34 def get_inbox_channels(inbox_id) get("inboxes/#{inbox_id}/channels") end
Parameters Name Type Description
inbox_id string Id of the requested inbox
Allowed attributes: Name Type Description
q object (optional) Search query. q.statuses array (optional) List of the statuses of the conversations you want to list
# File lib/frontapp/client/inboxes.rb, line 50 def get_inbox_conversations(inbox_id, params = {}) cleaned = params.permit({ q: [:statuses] }) list("inboxes/#{inbox_id}/conversations", cleaned) end
Parameters Name Type Description
inbox_id string Id of the requested inbox
# File lib/frontapp/client/inboxes.rb, line 60 def get_inbox_teammates(inbox_id) get("inboxes/#{inbox_id}/teammates") end
# File lib/frontapp/client/inboxes.rb, line 5 def inboxes(params = {}) list("inboxes", params) end