frontapp 0.0.9 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c84f037b7cc7663aee1d15e20998de2ba93ac6b9
-  data.tar.gz: '0587e127ce575fd3e15b710e89238dc9064baab4'
+SHA256:
+  metadata.gz: 137dd83548a9b04722f92973d145361bc5a9cc54a8f3b4ef7838123fa1d577f2
+  data.tar.gz: 2e27f67b3cb694fa4d9d80b7080c5164ade7279ca1882433f3838cfaa3211a21
 SHA512:
-  metadata.gz: d93206614d9d0524e19e2322dd77457a39ed0682aad6da9f6e1ea12c4e9b860d2a56a916ee8fb731f72120e3f80af99ae569f845e8e59f3a4699bc88aa7fa50c
-  data.tar.gz: b5878450b98cd27e239f24748ed8efab4785bc9d57850cf7d36a35be792eeebdf93eb3c76087856faf41f7b34df91cc78ee181a2df79bd5b6f9e857a979aec5c
+  metadata.gz: 1c535fe7e6d2576bcff22a3f0b9cad3626d64a7abfd998cb0314b727722a3eec79ad0ea57f34cc46173b7bba7c5a316f7773af8f76d171f7a045d7d76bc73bd9
+  data.tar.gz: e59366a309d89dffe65ee6383d79211267ae135883c0c93bbf79941ffcc81942b3826a974e1166ce17f7a66c97d291a4c4443eb929c39da3ba3586e033d5f5b6

data/lib/frontapp/client/attachments.rb

@@ -0,0 +1,15 @@
+module Frontapp
+  class Client
+    module Attachments
+
+      # Parameters
+      # Name                Type    Description
+      # ----------------------------------------------------------
+      # attachment_link_id  string  Id of the requested attachment
+      # ----------------------------------------------------------
+      def download_attachment(attachment_link_id)
+        get_raw("download/#{attachment_link_id}")
+      end
+    end
+  end
+end

data/lib/frontapp/client/conversations.rb

@@ -70,6 +70,51 @@ module Frontapp
       def get_conversation_messages(conversation_id)
         list("conversations/#{conversation_id}/messages")
       end
+
+      # Parameters
+      # Name             Type              Description
+      # ----------------------------------------------
+      # conversation_id     string            The conversation Id
+      # link_ids            array (optional)  Link IDs to add Either link_ids or link_external_urls must be specified but not both
+      # link_external_urls  array (optional)  Link external urls to add. Creates links if necessary. Either link_ids or link_external_urls must be specified but not both
+      # ----------------------------------------------
+      def add_conversation_links!(conversation_id, params = {})
+        cleaned = params.permit(:link_ids, :link_external_urls)
+        create_without_response("conversations/#{conversation_id}/links", cleaned)
+      end
+
+      # Parameters
+      # Name             Type              Description
+      # ----------------------------------------------
+      # conversation_id  string            The conversation Id
+      # link_ids        array of strings  link IDs to remove
+      # ----------------------------------------------
+      def remove_conversation_links!(conversation_id, params = {})
+        cleaned = params.permit(:link_ids)
+        delete("conversations/#{conversation_id}/links", cleaned)
+      end
+
+      # Parameters
+      # Name             Type              Description
+      # ----------------------------------------------
+      # conversation_id  string            The conversation Id
+      # teammate_ids     array of strings  follower IDs to remove
+      # ----------------------------------------------
+      def remove_conversation_followers!(conversation_id, params = {})
+        cleaned = params.permit(:teammate_ids)
+        delete("conversations/#{conversation_id}/followers", cleaned)
+      end
+
+      # Parameters
+      # Name             Type              Description
+      # ----------------------------------------------
+      # conversation_id  string            The conversation Id
+      # teammate_ids     array of strings  follower IDs to add
+      # ----------------------------------------------
+      def add_conversation_followers!(conversation_id, params = {})
+        cleaned = params.permit(:teammate_ids)
+        create_without_response("conversations/#{conversation_id}/followers", cleaned)
+      end
     end
   end
-end
+end

data/lib/frontapp/client/links.rb

@@ -0,0 +1,64 @@
+module Frontapp
+  class Client
+    module Links
+
+      def links(params = {})
+        cleaned = params.permit({ q: [:statuses] })
+        list("links", cleaned)
+      end
+
+      # Parameters
+      # Name      Type    Description
+      # -------------------------------
+      # link_id  string  Id of the requested link
+      # -------------------------------
+      def get_link(link_id)
+        get("links/#{link_id}")
+      end
+
+      # Allowed attributes:
+      # Name          Type               Description
+      # ------------------------------------
+      # name          string (optional)  Name of the link. If none is specified, the external_url is used as a default
+      # external_url  string             Underlying identifying link/url of the link
+      # ------------------------------------
+      def create_link!(params = {})
+        cleaned = params.permit(:name, :external_url)
+        create("links", cleaned)
+      end
+
+      # Parameters
+      # Name      Type    Description
+      # -----------------------------
+      # link_id  string  Id of the requested link
+      # -----------------------------
+      #
+      # Allowed attributes:
+      # Name  Type    Description
+      # ------------------------------------
+      # name  string  New name of the link
+      # ------------------------------------
+      def update_link!(link_id, params = {})
+        cleaned = params.permit(:name)
+        update("links/#{link_id}", cleaned)
+      end
+
+      # Parameters
+      # Name      Type    Description
+      # -----------------------------
+      # link_id  string  Id of the requested link
+      # -----------------------------
+      #
+      # 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_link_conversations(link_id, params = {})
+        cleaned = params.permit({ q: [:statuses] })
+        list("links/#{link_id}/conversations", cleaned)
+      end
+    end
+  end
+end

data/lib/frontapp/client/topics.rb

@@ -15,9 +15,10 @@ module Frontapp
       # q.statuses  array (optional)   List of the statuses of the conversations you want to list
       # ------------------------------------------
       def get_topic_conversations(topic_id, params = {})
-        cleaned = params.permit({ q: [:statuses] })
-        list("topics/#{topic_id}/conversations", cleaned)
+        warn "[DEPRECATION] `Topics` is deprecated.  Please use `Links` instead."
+
+        get_link_conversations(topic_id, params)
       end
     end
   end
-end
+end

data/lib/frontapp/client.rb

@@ -1,6 +1,7 @@
 require 'uri'
 require 'http'
 require 'json'
+require_relative 'client/attachments.rb'
 require_relative 'client/channels.rb'
 require_relative 'client/comments.rb'
 require_relative 'client/contact_groups.rb'
@@ -14,6 +15,7 @@ require_relative 'client/tags.rb'
 require_relative 'client/teammates.rb'
 require_relative 'client/teams.rb'
 require_relative 'client/topics.rb'
+require_relative 'client/links.rb'
 require_relative 'client/exports.rb'
 require_relative 'error'
 require_relative 'version'
@@ -21,6 +23,7 @@ require_relative 'version'
 module Frontapp
   class Client
 
+    include Frontapp::Client::Attachments
     include Frontapp::Client::Channels
     include Frontapp::Client::Comments
     include Frontapp::Client::ContactGroups
@@ -34,6 +37,7 @@ module Frontapp
     include Frontapp::Client::Teammates
     include Frontapp::Client::Teams
     include Frontapp::Client::Topics
+    include Frontapp::Client::Links
     include Frontapp::Client::Exports
 
     def initialize(options={})
@@ -75,7 +79,7 @@ module Frontapp
       end
       JSON.parse(res.to_s)
     end
-    
+
     def get_plain(path)
       headers_copy = @headers.dup
       res = @headers.accept("text/plain").get("#{base_url}#{path}")
@@ -85,6 +89,15 @@ module Frontapp
       res.to_s
     end
 
+    def get_raw(path)
+      headers_copy = @headers.dup
+      res = @headers.get("#{base_url}#{path}")
+      if !res.status.success?
+        raise Error.from_response(res)
+      end
+      res
+    end
+
     def create(path, body)
       res = @headers.post("#{base_url}#{path}", json: body)
       response = JSON.parse(res.to_s)

data/lib/frontapp/version.rb

@@ -1,3 +1,3 @@
 module Frontapp
-  VERSION = "0.0.9"
+  VERSION = "0.0.12"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: frontapp
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.12
 platform: ruby
 authors:
 - Niels van der Zanden
@@ -74,6 +74,7 @@ extra_rdoc_files: []
 files:
 - lib/frontapp.rb
 - lib/frontapp/client.rb
+- lib/frontapp/client/attachments.rb
 - lib/frontapp/client/channels.rb
 - lib/frontapp/client/comments.rb
 - lib/frontapp/client/contact_groups.rb
@@ -82,6 +83,7 @@ files:
 - lib/frontapp/client/events.rb
 - lib/frontapp/client/exports.rb
 - lib/frontapp/client/inboxes.rb
+- lib/frontapp/client/links.rb
 - lib/frontapp/client/messages.rb
 - lib/frontapp/client/rules.rb
 - lib/frontapp/client/tags.rb
@@ -110,8 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Ruby client for Frontapp API