frontapp 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f3e435b63630c56d64d442d07157db616154e354
+  data.tar.gz: 42a573b784d7888ab23cb8262315403b7215d1b8
+SHA512:
+  metadata.gz: 5050cb6fb326a571606ab64594e4863b93112392cffb0d20c0843d7ec105756dc058ca865a93d4ce4abc995996bd75c6614022f4f3ae5663b94831675ef0da9b
+  data.tar.gz: d76fe968f65a4d7ea0e72771d3cf72c3f94adc4327e685369358f60e23b2617df8cbdcfca80fa86147dea30a2ce6f9decf1ff49ed97113921681127d0b887ead

data/lib/frontapp.rb

@@ -0,0 +1,5 @@
+require_relative 'frontapp/utils/hash.rb'
+require_relative 'frontapp/client.rb'
+require 'openssl'
+require 'http'
+require 'json'

data/lib/frontapp/client.rb

@@ -0,0 +1,116 @@
+require 'uri'
+require 'http'
+require 'json'
+require_relative 'client/channels.rb'
+require_relative 'client/comments.rb'
+require_relative 'client/contact_groups.rb'
+require_relative 'client/contacts.rb'
+require_relative 'client/conversations.rb'
+require_relative 'client/events.rb'
+require_relative 'client/inboxes.rb'
+require_relative 'client/messages.rb'
+require_relative 'client/rules.rb'
+require_relative 'client/tags.rb'
+require_relative 'client/teammates.rb'
+
+module Frontapp
+  class Client
+
+    include Frontapp::Client::Channels
+    include Frontapp::Client::Comments
+    include Frontapp::Client::ContactGroups
+    include Frontapp::Client::Contacts
+    include Frontapp::Client::Conversations
+    include Frontapp::Client::Events
+    include Frontapp::Client::Inboxes
+    include Frontapp::Client::Messages
+    include Frontapp::Client::Rules
+    include Frontapp::Client::Tags
+    include Frontapp::Client::Teammates
+
+    def initialize(options={})
+      auth_token = options[:auth_token]
+      @headers = HTTP.headers({
+        Accept: "application/json",
+        Authorization: "Bearer #{auth_token}"
+      })
+    end
+
+    def list(path, params = {})
+      items = []
+      last_page = false
+      query = format_query(params)
+      url = "#{base_url}#{path}?#{query}"
+      until last_page
+        res = @headers.get(url)
+        response = JSON.parse(res.to_s)
+        items.concat(response["_results"]) if response["_results"]
+        pagination = response["_pagination"]
+        if pagination.nil? || pagination["next"].nil?
+          last_page = true
+        else
+          url = pagination["next"]
+        end
+      end
+      items
+    end
+
+    def get(path)
+      res = @headers.get("#{base_url}#{path}")
+      JSON.parse(res.to_s)
+    end
+
+    def create(path, body)
+      res = @headers.post("#{base_url}#{path}", json: body)
+      response = JSON.parse(res.to_s)
+      if !res.status.success?
+        raise "Response: #{res.inspect}\n Body: #{res.body}\nRequest: #{body.to_json.inspect}"
+      end
+      response
+    end
+
+    def create_without_response(path, body)
+      res = @headers.post("#{base_url}#{path}", json: body)
+      if !res.status.success?
+        raise "Response: #{res.inspect}\n Body: #{res.body}\nRequest: #{body.to_json.inspect}"
+      end
+    end
+
+    def update(path, body)
+      res = @headers.patch("#{base_url}#{path}", json: body)
+      if !res.status.success?
+        raise "Response: #{res.inspect}\n Body: #{res.body}\nRequest: #{body.to_json.inspect}"
+      end
+    end
+
+    def delete(path, body = {})
+      res = @headers.delete("#{base_url}#{path}", json: body)
+      if !res.status.success?
+        raise "Response: #{res.inspect}\n Body: #{res.body}\nRequest: #{body.to_json.inspect}"
+      end
+    end
+
+  private
+    def format_query(params)
+      res = []
+      q = params.delete(:q)
+      if q && q.is_a?(Hash)
+        res << q.map do |k, v|
+          case v
+          when Symbol, String
+            "q[#{k}][]=#{URI.encode(v)}"
+          when Array then
+            v.map { |c| "q[#{k}][]=#{URI.encode(c)}" }.join("&")
+          end
+        end
+      end
+      res << params.map {|k,v| "#{k}=#{URI.encode(v)}"}
+      res.join("&")
+    end
+
+    def base_url
+      "https://api2.frontapp.com/"
+    end
+
+  end
+end

data/lib/frontapp/client/channels.rb

@@ -0,0 +1,68 @@
+module Frontapp
+  class Client
+    module Channels
+
+      def channels(params = {})
+        list("channels", params)
+      end
+
+      # Parameters
+      # Name        Type    Description
+      # -------------------------------
+      # channel_id  string  Id of the requested channel
+      # -------------------------------
+      def get_channel(channel_id)
+        get("channels/#{channel_id}")
+      end
+
+      # Only custom channels can be updated through the api!
+      #
+      # Parameters
+      # Name        Type    Description
+      # -------------------------------
+      # channel_id  string  Id of the requested channel
+      # -------------------------------
+      #
+      # Allowed attributes:
+      # Name                  Type              Description
+      # ---------------------------------------------------
+      # settings              object
+      # settings.webhook_url  string (optional) custom type only. URL to which will be sent the replies of a custom message.
+      # ---------------------------------------------------
+      def update_channel!(channel_id, params = {})
+        cleaned = params.permit({ settings: [:webhook_url] })
+        update("channels/#{channel_id}", cleaned)
+      end
+
+      # Only custom channels can be created through the api!
+      #
+      # Parameters
+      # Name      Type    Description
+      # -----------------------------
+      # inbox_id  string  Id of the inbox into which the channel messages will go
+      # -----------------------------
+      #
+      # Allowed attributes:
+      # Name                  Type               Description
+      # ----------------------------------------------------
+      # type                  enum               Type of the channel.
+      # settings              object
+      # settings.webhook_url  string (optional)  custom type only. URL to which will be sent the replies of a custom message.
+      # ----------------------------------------------------
+      def create_channel!(inbox_id, params = {})
+        cleaned = params.permit(:type, { settings: [:webhook_url] })
+        create("inboxes/#{inbox_id}/channels", cleaned)
+      end
+
+      # Parameters
+      # Name        Type    Description
+      # -------------------------------
+      # channel_id  string  Id of the requested channel
+      # -------------------------------
+      def get_channel_inbox(channel_id)
+        get("channels/#{channel_id}/inbox")
+      end
+
+    end
+  end
+end

data/lib/frontapp/client/comments.rb

@@ -0,0 +1,51 @@
+module Frontapp
+  class Client
+    module Comments
+
+      # Parameters
+      # Name             Type    Description
+      # ------------------------------------
+      # conversation_id  string  Id of the requested conversation
+      # ------------------------------------
+      #
+      # Allowed attributes:
+      # Name       Type    Description
+      # ------------------------------
+      # author_id  string  Id of the teammate creating the comment
+      # body       string  Content of the comment
+      # ------------------------------
+      def create_comment!(conversation_id, params = {})
+        cleaned = params.permit(:author_id,:body)
+        create("conversations/#{conversation_id}/comments", cleaned)
+      end
+
+      # Parameters
+      # Name             Type    Description
+      # ------------------------------------
+      # conversation_id  string  Id of the requested conversation
+      # ------------------------------------
+      def get_conversation_comments(conversation_id)
+        list("conversations/#{conversation_id}/comments")
+      end
+
+      # Parameters
+      # Name        Type    Description
+      # -------------------------------
+      # comment_id  string  Id of the requested comment
+      # -------------------------------
+      def get_comment(comment_id)
+        get("comments/#{comment_id}")
+      end
+
+      # Parameters
+      # Name        Type    Description
+      # -------------------------------
+      # comment_id  string  Id of the requested comment
+      # -------------------------------
+      def get_comment_mentions(comment_id)
+        get("comments/#{comment_id}/mentions")
+      end
+
+    end
+  end
+end

data/lib/frontapp/client/contact_groups.rb

@@ -0,0 +1,55 @@
+module Frontapp
+  class Client
+    module ContactGroups
+
+      def contact_groups(params = {})
+        list("contact_groups", params)
+      end
+
+      # Allowed attributes:
+      # Name          Type              Description
+      # -------------------------------------------
+      # name          string            Name of the group
+      # -------------------------------------------
+      def create_contact_group!(params = {})
+        cleaned = params.permit(:name)
+        create("contact_groups", cleaned)
+      end
+
+      # Parameters
+      # Name      Type    Description
+      # -------------------------------
+      # group_id  string  Id of the requested group
+      # -------------------------------
+      def delete_contact_group!(group_id)
+        delete("contact_groups/#{group_id}")
+      end
+
+
+      # Parameters
+      # Name      Type    Description
+      # -------------------------------
+      # group_id  string  Id of the requested group
+      # -------------------------------
+      def get_contact_group_contacts(group_id)
+        get("contact_groups/#{group_id}/contacts")
+      end
+
+      # Parameters
+      # Name      Type    Description
+      # -------------------------------
+      # group_id  string  Id of the requested group
+      # -------------------------------
+      #
+      # Allowed attributes:
+      # Name         Type   Description
+      # --------------------------------------------
+      # contact_ids  array  List of ids or aliases of the contacts to add in the requested group
+      # --------------------------------------------
+      def add_contacts_to_contact_group!(group_id, params = {})
+        cleaned = params.permit(:contact_ids)
+        create_without_response("contact_groups/#{group_id}/contacts", cleaned)
+      end
+    end
+  end
+end

data/lib/frontapp/client/contacts.rb

@@ -0,0 +1,153 @@
+module Frontapp
+  class Client
+    module Contacts
+
+      def contacts(params = {})
+        list("contacts", params)
+      end
+
+      # Parameters
+      # Name        Type    Description
+      # -------------------------------
+      # contact_id  string  Id or alias of the requested contact
+      # -------------------------------
+      def get_contact(contact_id)
+        get("contacts/#{contact_id}")
+      end
+
+      # Parameters
+      # Name        Type    Description
+      # -------------------------------
+      # contact_id  string  Id or alias of the requested contact
+      # -------------------------------
+      #
+      # Allowed attributes:
+      # Name         Type                Description
+      # --------------------------------------------
+      # name         string (optional)   Contact name
+      # description  string (optional)   Contact description
+      # avatar_url   string (optional)   URL of the contact’s avatar
+      # is_spammer   boolean (optional)  Whether or not the contact is marked as a spammer
+      # links        array (optional)    List of all the links of the contact
+      # group_names  array (optional)    List of all the group names the contact belongs to. It will automatically create missing groups.
+      # --------------------------------------------
+      def update_contact!(contact_id, params = {})
+        cleaned = params.permit(:name,
+                                :description,
+                                :avatar_url,
+                                :is_spammer,
+                                :links,
+                                :group_names)
+        update("contacts/#{contact_id}", cleaned)
+      end
+
+      # Allowed attributes:
+      # Name         Type                Description
+      # --------------------------------------------
+      # name         string (optional)   Contact name
+      # description  string (optional)   Contact description
+      # avatar_url   string (optional)   URL of the contact’s avatar
+      # is_spammer   boolean (optional)  Whether or not the contact is marked as a spammer
+      # links        array (optional)    List of all the links of the contact
+      # group_names  array (optional)    List of all the group names the contact belongs to. It will automatically create missing groups.
+      # handles      array               List
+      # --------------------------------------------
+      def create_contact!(params = {})
+        cleaned = params.permit(:name,
+                                :description,
+                                :avatar_url,
+                                :is_spammer,
+                                :links,
+                                :group_names,
+                                :handles)
+        create("contacts", cleaned)
+      end
+
+      # Name        Type    Description
+      # -------------------------------
+      # contact_id  string  Id or alias of the requested contact
+      # -------------------------------
+      def delete_contact!(contact_id)
+        delete("contacts/#{contact_id}")
+      end
+
+      # Parameters
+      # Name        Type    Description
+      # -------------------------------
+      # contact_id  string  Id or alias of the requested contact
+      # -------------------------------
+      #
+      # Allowed params:
+      # Name        Type               Description
+      # ----------------------------------------------
+      # q           object (optional)  Search query.
+      # q.statuses  array (optional)   List of the statuses of the conversations you want to list
+      # ----------------------------------------------
+      def get_contact_conversations(contact_id, params = {})
+        cleaned = params.permit({ q: [:statuses] })
+        list("contacts/#{contact_id}/conversations", cleaned)
+      end
+
+      # Parameters
+      # Name        Type    Description
+      # -------------------------------
+      # contact_id  string  Id or alias of the requested contact
+      # -------------------------------
+      #
+      # Allowed attributes:
+      # Name    Type    Description
+      # ---------------------------
+      # handle  string  Handle used to reach the contact. Can be an email address, a twitter, handle, a phone number, …
+      # source  enum    Can be 'twitter’, 'email’ or 'phone’.
+      # ---------------------------
+      def add_contact_handle!(contact_id, params = {})
+        cleaned = params.permit(:handle, :source)
+        create_without_response("contacts/#{contact_id}/handles", cleaned)
+      end
+
+      # Parameters
+      # Name        Type    Description
+      # -------------------------------
+      # contact_id  string  Id or alias of the requested contact
+      # -------------------------------
+      #
+      # Allowed attributes:
+      # Name    Type    Description
+      # ---------------------------
+      # handle  string  Handle used to reach the contact. Can be an email address, a twitter, handle, a phone number, …
+      # source  enum    Can be 'twitter’, 'email’ or 'phone’.
+      # ---------------------------
+      def delete_contact_handle!(contact_id, params = {})
+        cleaned = params.permit(:handle, :source)
+        delete("contacts/#{contact_id}/handles", cleaned)
+      end
+
+      # Parameters
+      # Name        Type    Description
+      # -------------------------------
+      # contact_id  string  Id or alias of the requested contact
+      # -------------------------------
+      def get_contact_notes(contact_id)
+        list("contacts/#{contact_id}/notes")
+      end
+
+      # Parameters
+      # Name        Type    Description
+      # -------------------------------
+      # contact_id  string  Id or alias of the requested contact
+      # -------------------------------
+      #
+      # Allowed attributes:
+      # Name       Type    Description
+      # ------------------------------
+      # author_id  string  Id of the teammate creating the note
+      # body       string  Content of the note
+      # ------------------------------
+      def add_contact_note!(contact_id, params = {})
+        cleaned = params.permit(:author_id, :body)
+        create("contacts/#{contact_id}/notes", cleaned)
+      end
+
+    end
+  end
+end

data/lib/frontapp/client/conversations.rb

@@ -0,0 +1,74 @@
+module Frontapp
+  class Client
+    module Conversations
+
+      def conversations(params = {})
+        list("conversations", params)
+      end
+
+      # Parameters
+      # Name             Type    Description
+      # ------------------------------------
+      # conversation_id  string  Id of the requested conversation
+      # ------------------------------------
+      def get_conversation(conversation_id)
+        get("conversations/#{conversation_id}")
+      end
+
+      # 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.
+      # 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
+      def update_conversation!(conversation_id, params = {})
+        cleaned = params.permit(:assignee_id, :status, :tags)
+        update("conversations/#{conversation_id}", cleaned)
+      end
+
+      # Parameters
+      # Name         Type    Description
+      # --------------------------------
+      # conversation_id  string  Id or email of the requested conversation
+      # --------------------------------
+      def get_conversation_inboxes(conversation_id)
+        get("conversations/#{conversation_id}/inboxes")
+      end
+
+      # Parameters
+      # Name         Type    Description
+      # --------------------------------
+      # conversation_id  string  Id or email of the requested conversation
+      # --------------------------------
+      def get_conversation_followers(conversation_id)
+        get("conversations/#{conversation_id}/followers")
+      end
+
+      # Parameters
+      # Name         Type    Description
+      # --------------------------------
+      # conversation_id  string  Id or email of the requested conversation
+      # --------------------------------
+      def get_conversation_events(conversation_id)
+        list("conversations/#{conversation_id}/events")
+      end
+
+      # Parameters
+      # Name         Type    Description
+      # --------------------------------
+      # conversation_id  string  Id or email of the requested conversation
+      # --------------------------------
+      def get_conversation_messages(conversation_id)
+        list("conversations/#{conversation_id}/messages")
+      end
+    end
+  end
+end

data/lib/frontapp/client/events.rb

@@ -0,0 +1,20 @@
+module Frontapp
+  class Client
+    module Events
+
+      def events(params = {})
+        list("events", params)
+      end
+
+      # Parameters
+      # Name      Type    Description
+      # -----------------------------
+      # event_id  string  Id of the requested event
+      # -----------------------------
+      def get_event(event_id)
+        get("events/#{event_id}")
+      end
+
+    end
+  end
+end

data/lib/frontapp/client/inboxes.rb

@@ -0,0 +1,66 @@
+module Frontapp
+  class Client
+    module Inboxes
+
+      def inboxes(params = {})
+        list("inboxes", params)
+      end
+
+      # Parameters
+      # Name      Type    Description
+      # -----------------------------
+      # inbox_id  string  Id of the requested inbox
+      # -----------------------------
+      def get_inbox(inbox_id)
+        get("inboxes/#{inbox_id}")
+      end
+
+      # 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.
+      # -------------------------------------------
+      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
+      # -----------------------------
+      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
+      # ----------------------------------------------
+      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
+      # -----------------------------
+      def get_inbox_teammates(inbox_id)
+        get("inboxes/#{inbox_id}/teammates")
+      end
+
+    end
+  end
+end

data/lib/frontapp/client/messages.rb

@@ -0,0 +1,157 @@
+module Frontapp
+  class Client
+    module Messages
+
+      # Parameters
+      # Name        Type    Description
+      # -------------------------------
+      # message_id  string  Id of the requested message
+      # -------------------------------
+      def get_message(message_id)
+        get("messages/#{message_id}")
+      end
+
+      # Parameters
+      # Name        Type    Description
+      # -------------------------------
+      # channel_id  string  Id or address of the channel from which to send the message
+      # -------------------------------
+      #
+      # Allowed attributes:
+      # Name             Type                Description
+      # ------------------------------------------------
+      # author_id        string (optional)   Id of the teammate on behalf of whom the answer is sent
+      # subject          string (optional)   Subject of the message for email message
+      # body             string              Body of the message
+      # text             string (optional)   Text version of the body for messages with non-text body
+      # options          object (optional)   Sending options
+      # options.tags     array (optional)    List of tag names to add to the conversation (unknown tags will automatically be created)
+      # options.archive  boolean (optional)  Archive the conversation right when sending the reply (Default: true)
+      # to               array               List of the recipient handles who will receive this message
+      # cc               array (optional)    List of the recipient handles who will receive a copy of this message
+      # bcc              array (optional)    List of the recipient handles who will receive a blind copy of this message
+      # ------------------------------------------------
+      def send_message(channel_id, params)
+        cleaned = params.permit(:author_id,
+                                :subject,
+                                :body,
+                                :text,
+                                { options: [:tags, :archive] },
+                                :to,
+                                :cc,
+                                :bcc)
+        create("channels/#{channel_id}/messages", cleaned)
+      end
+
+      # Parameters
+      # Name             Type    Description
+      # ------------------------------------
+      # conversation_id  string  Id of the conversation
+      # ------------------------------------
+      #
+      # Allowed attributes:
+      # Name             Type                Description
+      # ------------------------------------------------
+      # author_id        string (optional)   ID of the teammate on behalf of whom the answer is sent
+      # subject          string (optional)   Subject of the message for email message
+      # body             string              Body of the message
+      # text             string (optional)   Text version of the body for messages with non-text body
+      # options          object (optional)   Sending options
+      # options.tags     array (optional)    List of tag names to add to the conversation (unknown tags will automatically be created)
+      # options.archive  boolean (optional)  Archive the conversation right when sending the reply (Default: true)
+      # channel_id       string (optional)   Channel through which to send the message. Defaults to the original conversation channel. For imported messages or messages received on multiple channels, you MUST specify a channel ID.
+      # to               array (optional)    List of the recipient handles who will receive this message. By default it will use the recipients of the last received message.
+      # cc               array (optional)    List of the recipient handles who will receive a copy of this message. By default it will use the cc'ed recipients of the last received message.
+      # bcc              array (optional)    List of the recipient handles who will receive a blind copy of this message
+      # ------------------------------------------------
+      def send_reply(conversation_id, params)
+        cleaned = params.permit(:author_id,
+                                :subject,
+                                :body,
+                                :text,
+                                { options: [:tags, :archive] },
+                                :channel_id,
+                                :to,
+                                :cc,
+                                :bcc)
+        create_without_response("conversations/#{conversation_id}/messages", cleaned)
+      end
+
+      # Parameters
+      # Name        Type    Description
+      # ------------------------------------
+      # channel_id  string  Id of the requested custom channel
+      # ------------------------------------
+      #
+      # Allowed attributes:
+      # Name                  Type               Description
+      # ----------------------------------------------------
+      # sender                object             Data of the sender
+      # sender.contact_id     string (optional)  ID of the contact in Front corresponding to the sender
+      # sender.name           string (optional)  Name of the sender
+      # sender.handle         string             Handle of the sender. It can be any string used to uniquely identify the sender
+      # subject               string (optional)  Subject of the message
+      # body                  string             Body of the message
+      # body_format           enum (optional)    Format of the message body. (Default: 'markdown')
+      # metadata              object (optional)
+      # metadata.thread_ref   string (optional)  Custom reference which will be used to thread messages. If you ommit this field, we’ll thread by sender instead
+      # metadata.headers      object (optional)  Custom object where any internal information can be stored
+      # ----------------------------------------------------
+      def receive_custom_message(channel_id, params)
+        cleaned = params.permit({ sender: [:contact_id, :name, :handle] },
+                                :subject,
+                                :body,
+                                :body_format,
+                                { metadata: [:thread_ref, :headers] })
+        create("channels/#{channel_id}/incoming_messages", cleaned)
+      end
+
+      # Parameters
+      # Name      Type    Description
+      # -----------------------------
+      # inbox_id  string  Id of the inbox into which the message should be append.
+      # -----------------------------
+      #
+      # Allowed attributes:
+      # Name                        Type                Description
+      # -----------------------------------------------------------
+      # sender                      object
+      # sender.handle               string              Handle used to reach the contact. Can be an email address, a twitter, handle, a phone number, …
+      # sender.name                 string (optional)   Name of the contact.
+      # sender.author_id            string (optional)   Id of the teammate who is the author of the message. Ignored if the message is inbound.
+      # to                          array               List of recipient handles who received the message.
+      # cc                          array (optional)    List of recipient handles who received a copy of the message.
+      # bcc                         array (optional)    List of the recipeient handles who received a blind copy of the message.
+      # subject                     string (optional)   Subject of the message.
+      # body                        string              Body of the message.
+      # body_format                 enum (optional)     Format of the message body. Ignored if the message type is not email. (Default: 'markdown')
+      # external_id                 string              External identifier of the message. Front won’t import two messages with the same external ID.
+      # created_at                  number              Date at which the message as been sent or received.
+      # type                        enum (optional)     Type of the message to import. (Default: 'email')
+      # assignee_id                 string (optional)   Id of the teammate who will be assigned to the conversation.
+      # tags                        array (optional)    List of tag names to add to the conversation (unknown tags will automatically be created).
+      # metadata                    object
+      # metadata.thread_ref         string (optional)   Custom reference which will be used to thread messages. If you ommit this field, we’ll thread by sender instead.
+      # metadata.is_inbound         boolean             Whether or not the message is received (inbound) or sent (outbound) by you.
+      # metadata.is_archived        boolean (optional)  Whether or not the message should be directly archived once imported. (Default: true)
+      # metadata.should_skip_rules  boolean (optional)  Whether or not the rules should apply to this message. (Default: true)
+      # -----------------------------------------------------------
+      def import_message(inbox_id, params)
+        cleaned = params.permit({ sender: [:handle, :name, :author_id] },
+                                :to,
+                                :cc,
+                                :bcc,
+                                :subject,
+                                :body,
+                                :body_format,
+                                :external_id,
+                                :created_at,
+                                :type,
+                                :assignee_id,
+                                :tags,
+                                { metadata: [:thread_ref, :is_inbound, :is_archived, :should_skip_rules] })
+        create("inboxes/#{inbox_id}/imported_messages", cleaned)
+      end
+    end
+  end
+end

data/lib/frontapp/client/rules.rb

@@ -0,0 +1,20 @@
+module Frontapp
+  class Client
+    module Rules
+
+      def rules(params = {})
+        list("rules", params)
+      end
+
+      # Parameters
+      # Name     Type    Description
+      # ----------------------------
+      # rule_id  string  Id of the requested rule
+      # ----------------------------
+      def get_rule(rule_id)
+        get("rules/#{rule_id}")
+      end
+
+    end
+  end
+end

data/lib/frontapp/client/tags.rb

@@ -0,0 +1,46 @@
+module Frontapp
+  class Client
+    module Tags
+
+      def tags(params = {})
+        list("tags", params)
+      end
+
+      # Parameters
+      # Name    Type    Description
+      # ---------------------------
+      # tag_id  string  Id of the requested tag
+      # ---------------------------
+      def get_tag(tag_id)
+        get("tags/#{tag_id}")
+      end
+      
+      # Allowed attributes:
+      # Name  Type    Description
+      # -------------------------
+      # name  string  Name of the tag to create
+      # -------------------------
+      def create_tag!(params = {})
+        cleaned = params.permit(:name)
+        create("tags", cleaned)
+      end
+
+      # Parameters
+      # Name    Type    Description
+      # ---------------------------
+      # tag_id  string  Id of the requested tag
+      # ---------------------------
+      #
+      # Allowed params:
+      # Name        Type               Description
+      # ----------------------------------------------
+      # q           object (optional)  Search query. 
+      # q.statuses  array (optional)   List of the statuses of the conversations you want to list
+      # ----------------------------------------------
+      def get_tag_conversations(tag_id, params = {})
+        cleaned = params.permit({ q: [:statuses] })
+        list("tags/#{tag_id}/conversations", cleaned)
+      end
+    end
+  end
+end

data/lib/frontapp/client/teammates.rb

@@ -0,0 +1,66 @@
+module Frontapp
+  class Client
+    module Teammates
+
+      def teammates(params = {})
+        list("teammates", params)
+      end
+
+      # Parameters
+      # Name         Type    Description
+      # --------------------------------
+      # teammate_id  string  Id or email of the requested teammate
+      # --------------------------------
+      def get_teammate(teammate_id)
+        get("teammates/#{teammate_id}")
+      end
+
+      # Parameters
+      # Name         Type    Description
+      # --------------------------------
+      # teammate_id  string  Id or email of the requested teammate
+      # --------------------------------
+      #
+      # Allowed attributes:
+      # Name          Type                Description
+      # ----------------------------------------------
+      # username      string (optional)   New username. It must be unique and can only contains lowercase letters, numbers and underscores.
+      # first_name    string (optional)   New first name
+      # last_name     string (optional)   New last name
+      # is_admin      boolean (optional)  New admin status
+      # is_available  boolean (optional)  New availability status
+      # ----------------------------------------------
+      def update_teammate!(teammate_id, params = {})
+        cleaned = params.permit(:username, :first_name, :last_name, :is_admin, :is_available)
+        update("teammates/#{teammate_id}", cleaned)
+      end
+
+      # Parameters
+      # Name         Type    Description
+      # --------------------------------
+      # teammate_id  string  Id or email of the requested teammate
+      # --------------------------------
+      #
+      # Allowed params:
+      # Name        Type               Description
+      # ----------------------------------------------
+      # q           object (optional)  Search query.
+      # q.statuses  array (optional)   List of the statuses of the conversations you want to list
+      # ----------------------------------------------
+      def get_teammate_conversations(teammate_id, params = {})
+        cleaned = params.permit({ q: [:statuses] })
+        list("teammates/#{teammate_id}/conversations", cleaned)
+      end
+
+      # Parameters
+      # Name         Type    Description
+      # --------------------------------
+      # teammate_id  string  Id or email of the requested teammate
+      # --------------------------------
+      def get_teammate_inboxes(teammate_id)
+        get("teammates/#{teammate_id}/inboxes")
+      end
+
+    end
+  end
+end

data/lib/frontapp/utils/hash.rb

@@ -0,0 +1,15 @@
+class Hash
+  def permit(*filters)
+    res = {}
+    filters.flatten.each do |filter|
+      case filter
+      when Symbol, String
+        res[filter] = self[filter] if self.keys.include?(filter)
+      when Hash then
+        key = filter.keys.first
+        res[key] = self[key].permit(filter[key]) if self.keys.include?(key)
+      end
+    end
+    res
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: frontapp
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Niels van der Zanden
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+description: Ruby client for Frontapp API
+email: niels@phusion.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/frontapp.rb
+- lib/frontapp/client.rb
+- lib/frontapp/client/channels.rb
+- lib/frontapp/client/comments.rb
+- lib/frontapp/client/contact_groups.rb
+- lib/frontapp/client/contacts.rb
+- lib/frontapp/client/conversations.rb
+- lib/frontapp/client/events.rb
+- lib/frontapp/client/inboxes.rb
+- lib/frontapp/client/messages.rb
+- lib/frontapp/client/rules.rb
+- lib/frontapp/client/tags.rb
+- lib/frontapp/client/teammates.rb
+- lib/frontapp/utils/hash.rb
+homepage: https://github.com/phusion/frontapp
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Ruby client for Frontapp API
+test_files: []